org.el 849 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
  4. ;;
  5. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  6. ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
  7. ;; Keywords: outlines, hypermedia, calendar, wp
  8. ;; Homepage: http://orgmode.org
  9. ;;
  10. ;; This file is part of GNU Emacs.
  11. ;;
  12. ;; GNU Emacs is free software: you can redistribute it and/or modify
  13. ;; it under the terms of the GNU General Public License as published by
  14. ;; the Free Software Foundation, either version 3 of the License, or
  15. ;; (at your option) any later version.
  16. ;; GNU Emacs is distributed in the hope that it will be useful,
  17. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. ;; GNU General Public License for more details.
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  22. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  23. ;;
  24. ;;; Commentary:
  25. ;;
  26. ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  27. ;; project planning with a fast and effective plain-text system.
  28. ;;
  29. ;; Org-mode develops organizational tasks around NOTES files that contain
  30. ;; information about projects as plain text. Org-mode is implemented on
  31. ;; top of outline-mode, which makes it possible to keep the content of
  32. ;; large files well structured. Visibility cycling and structure editing
  33. ;; help to work with the tree. Tables are easily created with a built-in
  34. ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
  35. ;; and scheduling. It dynamically compiles entries into an agenda that
  36. ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
  37. ;; Plain text URL-like links connect to websites, emails, Usenet
  38. ;; messages, BBDB entries, and any files related to the projects. For
  39. ;; printing and sharing of notes, an Org-mode file can be exported as a
  40. ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
  41. ;; iCalendar file. It can also serve as a publishing tool for a set of
  42. ;; linked webpages.
  43. ;;
  44. ;; Installation and Activation
  45. ;; ---------------------------
  46. ;; See the corresponding sections in the manual at
  47. ;;
  48. ;; http://orgmode.org/org.html#Installation
  49. ;;
  50. ;; Documentation
  51. ;; -------------
  52. ;; The documentation of Org-mode can be found in the TeXInfo file. The
  53. ;; distribution also contains a PDF version of it. At the homepage of
  54. ;; Org-mode, you can read the same text online as HTML. There is also an
  55. ;; excellent reference card made by Philip Rooke. This card can be found
  56. ;; in the etc/ directory of Emacs 22.
  57. ;;
  58. ;; A list of recent changes can be found at
  59. ;; http://orgmode.org/Changes.html
  60. ;;
  61. ;;; Code:
  62. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  63. (defvar org-table-formula-constants-local nil
  64. "Local version of `org-table-formula-constants'.")
  65. (make-variable-buffer-local 'org-table-formula-constants-local)
  66. ;;;; Require other packages
  67. (eval-when-compile
  68. (require 'cl)
  69. (require 'gnus-sum))
  70. (require 'calendar)
  71. (require 'find-func)
  72. (require 'format-spec)
  73. (load "org-loaddefs.el" t t)
  74. ;; `org-outline-regexp' ought to be a defconst but is let-binding in
  75. ;; some places -- e.g. see the macro org-with-limited-levels.
  76. ;;
  77. ;; In Org buffers, the value of `outline-regexp' is that of
  78. ;; `org-outline-regexp'. The only function still directly relying on
  79. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  80. ;; job when `orgstruct-mode' is active.
  81. (defvar org-outline-regexp "\\*+ "
  82. "Regexp to match Org headlines.")
  83. (defvar org-outline-regexp-bol "^\\*+ "
  84. "Regexp to match Org headlines.
  85. This is similar to `org-outline-regexp' but additionally makes
  86. sure that we are at the beginning of the line.")
  87. (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  88. "Matches an headline, putting stars and text into groups.
  89. Stars are put in group 1 and the trimmed body in group 2.")
  90. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  91. (when (fboundp 'defvaralias)
  92. (unless (boundp 'calendar-view-holidays-initially-flag)
  93. (defvaralias 'calendar-view-holidays-initially-flag
  94. 'view-calendar-holidays-initially))
  95. (unless (boundp 'calendar-view-diary-initially-flag)
  96. (defvaralias 'calendar-view-diary-initially-flag
  97. 'view-diary-entries-initially))
  98. (unless (boundp 'diary-fancy-buffer)
  99. (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
  100. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  101. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  102. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  103. (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
  104. (declare-function org-at-clock-log-p "org-clock" ())
  105. (declare-function org-clock-get-last-clock-out-time "org-clock" ())
  106. (declare-function org-clock-timestamps-up "org-clock" ())
  107. (declare-function org-clock-timestamps-down "org-clock" ())
  108. (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
  109. (declare-function orgtbl-mode "org-table" (&optional arg))
  110. (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
  111. (declare-function org-beamer-mode "org-beamer" ())
  112. (declare-function org-table-edit-field "org-table" (arg))
  113. (declare-function org-table-justify-field-maybe "org-table" (&optional new))
  114. (declare-function org-id-get-create "org-id" (&optional force))
  115. (declare-function org-id-find-id-file "org-id" (id))
  116. (declare-function org-tags-view "org-agenda" (&optional todo-only match))
  117. (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
  118. (declare-function org-table-align "org-table" ())
  119. (declare-function org-table-paste-rectangle "org-table" ())
  120. (declare-function org-table-maybe-eval-formula "org-table" ())
  121. (declare-function org-table-maybe-recalculate-line "org-table" ())
  122. ;; load languages based on value of `org-babel-load-languages'
  123. (defvar org-babel-load-languages)
  124. ;;;###autoload
  125. (defun org-babel-do-load-languages (sym value)
  126. "Load the languages defined in `org-babel-load-languages'."
  127. (set-default sym value)
  128. (mapc (lambda (pair)
  129. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  130. (if active
  131. (progn
  132. (require (intern (concat "ob-" lang))))
  133. (progn
  134. (funcall 'fmakunbound
  135. (intern (concat "org-babel-execute:" lang)))
  136. (funcall 'fmakunbound
  137. (intern (concat "org-babel-expand-body:" lang)))))))
  138. org-babel-load-languages))
  139. (defcustom org-babel-load-languages '((emacs-lisp . t))
  140. "Languages which can be evaluated in Org-mode buffers.
  141. This list can be used to load support for any of the languages
  142. below, note that each language will depend on a different set of
  143. system executables and/or Emacs modes. When a language is
  144. \"loaded\", then code blocks in that language can be evaluated
  145. with `org-babel-execute-src-block' bound by default to C-c
  146. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  147. be set to remove code block evaluation from the C-c C-c
  148. keybinding. By default only Emacs Lisp (which has no
  149. requirements) is loaded."
  150. :group 'org-babel
  151. :set 'org-babel-do-load-languages
  152. :version "24.1"
  153. :type '(alist :tag "Babel Languages"
  154. :key-type
  155. (choice
  156. (const :tag "Awk" awk)
  157. (const :tag "C" C)
  158. (const :tag "R" R)
  159. (const :tag "Asymptote" asymptote)
  160. (const :tag "Calc" calc)
  161. (const :tag "Clojure" clojure)
  162. (const :tag "CSS" css)
  163. (const :tag "Ditaa" ditaa)
  164. (const :tag "Dot" dot)
  165. (const :tag "Emacs Lisp" emacs-lisp)
  166. (const :tag "Fortran" fortran)
  167. (const :tag "Gnuplot" gnuplot)
  168. (const :tag "Haskell" haskell)
  169. (const :tag "IO" io)
  170. (const :tag "Java" java)
  171. (const :tag "Javascript" js)
  172. (const :tag "LaTeX" latex)
  173. (const :tag "Ledger" ledger)
  174. (const :tag "Lilypond" lilypond)
  175. (const :tag "Lisp" lisp)
  176. (const :tag "Maxima" maxima)
  177. (const :tag "Matlab" matlab)
  178. (const :tag "Mscgen" mscgen)
  179. (const :tag "Ocaml" ocaml)
  180. (const :tag "Octave" octave)
  181. (const :tag "Org" org)
  182. (const :tag "Perl" perl)
  183. (const :tag "Pico Lisp" picolisp)
  184. (const :tag "PlantUML" plantuml)
  185. (const :tag "Python" python)
  186. (const :tag "Ruby" ruby)
  187. (const :tag "Sass" sass)
  188. (const :tag "Scala" scala)
  189. (const :tag "Scheme" scheme)
  190. (const :tag "Screen" screen)
  191. (const :tag "Shell Script" sh)
  192. (const :tag "Shen" shen)
  193. (const :tag "Sql" sql)
  194. (const :tag "Sqlite" sqlite))
  195. :value-type (boolean :tag "Activate" :value t)))
  196. ;;;; Customization variables
  197. (defcustom org-clone-delete-id nil
  198. "Remove ID property of clones of a subtree.
  199. When non-nil, clones of a subtree don't inherit the ID property.
  200. Otherwise they inherit the ID property with a new unique
  201. identifier."
  202. :type 'boolean
  203. :version "24.1"
  204. :group 'org-id)
  205. ;;; Version
  206. (require 'org-compat)
  207. (org-check-version)
  208. ;;;###autoload
  209. (defun org-version (&optional here full message)
  210. "Show the org-mode version in the echo area.
  211. With prefix argument HERE, insert it at point.
  212. When FULL is non-nil, use a verbose version string.
  213. When MESSAGE is non-nil, display a message with the version."
  214. (interactive "P")
  215. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  216. (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs.el")))
  217. (org-trash (or
  218. (and (fboundp 'org-release) (fboundp 'org-git-version))
  219. (load (concat org-dir "org-version.el")
  220. 'noerror 'nomessage 'nosuffix)))
  221. (org-version (org-release))
  222. (git-version (org-git-version))
  223. (version (format "Org-mode version %s (%s @ %s)"
  224. org-version
  225. git-version
  226. (if org-install-dir
  227. (if (string= org-dir org-install-dir)
  228. org-install-dir
  229. (concat "mixed installation! " org-install-dir " and " org-dir))
  230. "org-loaddefs.el can not be found!")))
  231. (_version (if full version org-version)))
  232. (if (org-called-interactively-p 'interactive)
  233. (if here
  234. (insert version)
  235. (message version))
  236. (if message (message _version))
  237. _version)))
  238. (defconst org-version (org-version))
  239. ;;; Compatibility constants
  240. ;;; The custom variables
  241. (defgroup org nil
  242. "Outline-based notes management and organizer."
  243. :tag "Org"
  244. :group 'outlines
  245. :group 'calendar)
  246. (defcustom org-mode-hook nil
  247. "Mode hook for Org-mode, run after the mode was turned on."
  248. :group 'org
  249. :type 'hook)
  250. (defcustom org-load-hook nil
  251. "Hook that is run after org.el has been loaded."
  252. :group 'org
  253. :type 'hook)
  254. (defcustom org-log-buffer-setup-hook nil
  255. "Hook that is run after an Org log buffer is created."
  256. :group 'org
  257. :version "24.1"
  258. :type 'hook)
  259. (defvar org-modules) ; defined below
  260. (defvar org-modules-loaded nil
  261. "Have the modules been loaded already?")
  262. (defun org-load-modules-maybe (&optional force)
  263. "Load all extensions listed in `org-modules'."
  264. (when (or force (not org-modules-loaded))
  265. (mapc (lambda (ext)
  266. (condition-case nil (require ext)
  267. (error (message "Problems while trying to load feature `%s'" ext))))
  268. org-modules)
  269. (setq org-modules-loaded t)))
  270. (defun org-set-modules (var value)
  271. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  272. (set var value)
  273. (when (featurep 'org)
  274. (org-load-modules-maybe 'force)))
  275. (when (org-bound-and-true-p org-modules)
  276. (let ((a (member 'org-infojs org-modules)))
  277. (and a (setcar a 'org-jsinfo))))
  278. (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)
  279. "Modules that should always be loaded together with org.el.
  280. If a description starts with <C>, the file is not part of Emacs
  281. and loading it will require that you have downloaded and properly installed
  282. the org-mode distribution.
  283. You can also use this system to load external packages (i.e. neither Org
  284. core modules, nor modules from the CONTRIB directory). Just add symbols
  285. to the end of the list. If the package is called org-xyz.el, then you need
  286. to add the symbol `xyz', and the package must have a call to
  287. (provide 'org-xyz)"
  288. :group 'org
  289. :set 'org-set-modules
  290. :type
  291. '(set :greedy t
  292. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  293. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  294. (const :tag " crypt: Encryption of subtrees" org-crypt)
  295. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  296. (const :tag " docview: Links to doc-view buffers" org-docview)
  297. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  298. (const :tag " id: Global IDs for identifying entries" org-id)
  299. (const :tag " info: Links to Info nodes" org-info)
  300. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  301. (const :tag " habit: Track your consistency with habits" org-habit)
  302. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  303. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  304. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  305. (const :tag " mew Links to Mew folders/messages" org-mew)
  306. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  307. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  308. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  309. (const :tag " special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  310. (const :tag " vm: Links to VM folders/messages" org-vm)
  311. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  312. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  313. (const :tag " mouse: Additional mouse support" org-mouse)
  314. (const :tag " TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  315. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  316. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  317. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  318. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  319. (const :tag "C collector: Collect properties into tables" org-collector)
  320. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  321. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  322. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  323. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  324. (const :tag "C eval: Include command output as text" org-eval)
  325. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  326. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  327. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  328. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  329. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  330. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  331. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  332. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  333. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  334. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  335. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  336. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  337. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  338. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  339. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  340. (const :tag "C registry: A registry for Org-mode links" org-registry)
  341. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  342. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  343. (const :tag "C secretary: Team management with org-mode" org-secretary)
  344. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  345. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  346. (const :tag "C track: Keep up with Org-mode development" org-track)
  347. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  348. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  349. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  350. (defcustom org-support-shift-select nil
  351. "Non-nil means make shift-cursor commands select text when possible.
  352. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  353. start selecting a region, or enlarge regions started in this way.
  354. In Org-mode, in special contexts, these same keys are used for
  355. other purposes, important enough to compete with shift selection.
  356. Org tries to balance these needs by supporting `shift-select-mode'
  357. outside these special contexts, under control of this variable.
  358. The default of this variable is nil, to avoid confusing behavior. Shifted
  359. cursor keys will then execute Org commands in the following contexts:
  360. - on a headline, changing TODO state (left/right) and priority (up/down)
  361. - on a time stamp, changing the time
  362. - in a plain list item, changing the bullet type
  363. - in a property definition line, switching between allowed values
  364. - in the BEGIN line of a clock table (changing the time block).
  365. Outside these contexts, the commands will throw an error.
  366. When this variable is t and the cursor is not in a special
  367. context, Org-mode will support shift-selection for making and
  368. enlarging regions. To make this more effective, the bullet
  369. cycling will no longer happen anywhere in an item line, but only
  370. if the cursor is exactly on the bullet.
  371. If you set this variable to the symbol `always', then the keys
  372. will not be special in headlines, property lines, and item lines,
  373. to make shift selection work there as well. If this is what you
  374. want, you can use the following alternative commands: `C-c C-t'
  375. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  376. can be used to switch TODO sets, `C-c -' to cycle item bullet
  377. types, and properties can be edited by hand or in column view.
  378. However, when the cursor is on a timestamp, shift-cursor commands
  379. will still edit the time stamp - this is just too good to give up.
  380. XEmacs user should have this variable set to nil, because
  381. `shift-select-mode' is in Emacs 23 or later only."
  382. :group 'org
  383. :type '(choice
  384. (const :tag "Never" nil)
  385. (const :tag "When outside special context" t)
  386. (const :tag "Everywhere except timestamps" always)))
  387. (defcustom org-loop-over-headlines-in-active-region nil
  388. "Shall some commands act upon headlines in the active region?
  389. When set to `t', some commands will be performed in all headlines
  390. within the active region.
  391. When set to `start-level', some commands will be performed in all
  392. headlines within the active region, provided that these headlines
  393. are of the same level than the first one.
  394. When set to a string, those commands will be performed on the
  395. matching headlines within the active region. Such string must be
  396. a tags/property/todo match as it is used in the agenda tags view.
  397. The list of commands is: `org-schedule', `org-deadline',
  398. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  399. `org-archive-to-archive-sibling'. The archiving commands skip
  400. already archived entries."
  401. :type '(choice (const :tag "Don't loop" nil)
  402. (const :tag "All headlines in active region" t)
  403. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  404. (string :tag "Tags/Property/Todo matcher"))
  405. :version "24.1"
  406. :group 'org-todo
  407. :group 'org-archive)
  408. (defgroup org-startup nil
  409. "Options concerning startup of Org-mode."
  410. :tag "Org Startup"
  411. :group 'org)
  412. (defcustom org-startup-folded t
  413. "Non-nil means entering Org-mode will switch to OVERVIEW.
  414. This can also be configured on a per-file basis by adding one of
  415. the following lines anywhere in the buffer:
  416. #+STARTUP: fold (or `overview', this is equivalent)
  417. #+STARTUP: nofold (or `showall', this is equivalent)
  418. #+STARTUP: content
  419. #+STARTUP: showeverything"
  420. :group 'org-startup
  421. :type '(choice
  422. (const :tag "nofold: show all" nil)
  423. (const :tag "fold: overview" t)
  424. (const :tag "content: all headlines" content)
  425. (const :tag "show everything, even drawers" showeverything)))
  426. (defcustom org-startup-truncated t
  427. "Non-nil means entering Org-mode will set `truncate-lines'.
  428. This is useful since some lines containing links can be very long and
  429. uninteresting. Also tables look terrible when wrapped."
  430. :group 'org-startup
  431. :type 'boolean)
  432. (defcustom org-startup-indented nil
  433. "Non-nil means turn on `org-indent-mode' on startup.
  434. This can also be configured on a per-file basis by adding one of
  435. the following lines anywhere in the buffer:
  436. #+STARTUP: indent
  437. #+STARTUP: noindent"
  438. :group 'org-structure
  439. :type '(choice
  440. (const :tag "Not" nil)
  441. (const :tag "Globally (slow on startup in large files)" t)))
  442. (defcustom org-use-sub-superscripts t
  443. "Non-nil means interpret \"_\" and \"^\" for export.
  444. When this option is turned on, you can use TeX-like syntax for sub- and
  445. superscripts. Several characters after \"_\" or \"^\" will be
  446. considered as a single item - so grouping with {} is normally not
  447. needed. For example, the following things will be parsed as single
  448. sub- or superscripts.
  449. 10^24 or 10^tau several digits will be considered 1 item.
  450. 10^-12 or 10^-tau a leading sign with digits or a word
  451. x^2-y^3 will be read as x^2 - y^3, because items are
  452. terminated by almost any nonword/nondigit char.
  453. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  454. Still, ambiguity is possible - so when in doubt use {} to enclose the
  455. sub/superscript. If you set this variable to the symbol `{}',
  456. the braces are *required* in order to trigger interpretations as
  457. sub/superscript. This can be helpful in documents that need \"_\"
  458. frequently in plain text.
  459. Not all export backends support this, but HTML does.
  460. This option can also be set with the #+OPTIONS line, e.g. \"^:nil\"."
  461. :group 'org-startup
  462. :group 'org-export-translation
  463. :version "24.1"
  464. :type '(choice
  465. (const :tag "Always interpret" t)
  466. (const :tag "Only with braces" {})
  467. (const :tag "Never interpret" nil)))
  468. (if (fboundp 'defvaralias)
  469. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
  470. (defcustom org-startup-with-beamer-mode nil
  471. "Non-nil means turn on `org-beamer-mode' on startup.
  472. This can also be configured on a per-file basis by adding one of
  473. the following lines anywhere in the buffer:
  474. #+STARTUP: beamer"
  475. :group 'org-startup
  476. :version "24.1"
  477. :type 'boolean)
  478. (defcustom org-startup-align-all-tables nil
  479. "Non-nil means align all tables when visiting a file.
  480. This is useful when the column width in tables is forced with <N> cookies
  481. in table fields. Such tables will look correct only after the first re-align.
  482. This can also be configured on a per-file basis by adding one of
  483. the following lines anywhere in the buffer:
  484. #+STARTUP: align
  485. #+STARTUP: noalign"
  486. :group 'org-startup
  487. :type 'boolean)
  488. (defcustom org-startup-with-inline-images nil
  489. "Non-nil means show inline images when loading a new Org file.
  490. This can also be configured on a per-file basis by adding one of
  491. the following lines anywhere in the buffer:
  492. #+STARTUP: inlineimages
  493. #+STARTUP: noinlineimages"
  494. :group 'org-startup
  495. :version "24.1"
  496. :type 'boolean)
  497. (defcustom org-insert-mode-line-in-empty-file nil
  498. "Non-nil means insert the first line setting Org-mode in empty files.
  499. When the function `org-mode' is called interactively in an empty file, this
  500. normally means that the file name does not automatically trigger Org-mode.
  501. To ensure that the file will always be in Org-mode in the future, a
  502. line enforcing Org-mode will be inserted into the buffer, if this option
  503. has been set."
  504. :group 'org-startup
  505. :type 'boolean)
  506. (defcustom org-replace-disputed-keys nil
  507. "Non-nil means use alternative key bindings for some keys.
  508. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  509. These keys are also used by other packages like shift-selection-mode'
  510. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  511. If you want to use Org-mode together with one of these other modes,
  512. or more generally if you would like to move some Org-mode commands to
  513. other keys, set this variable and configure the keys with the variable
  514. `org-disputed-keys'.
  515. This option is only relevant at load-time of Org-mode, and must be set
  516. *before* org.el is loaded. Changing it requires a restart of Emacs to
  517. become effective."
  518. :group 'org-startup
  519. :type 'boolean)
  520. (defcustom org-use-extra-keys nil
  521. "Non-nil means use extra key sequence definitions for certain commands.
  522. This happens automatically if you run XEmacs or if `window-system'
  523. is nil. This variable lets you do the same manually. You must
  524. set it before loading org.
  525. Example: on Carbon Emacs 22 running graphically, with an external
  526. keyboard on a Powerbook, the default way of setting M-left might
  527. not work for either Alt or ESC. Setting this variable will make
  528. it work for ESC."
  529. :group 'org-startup
  530. :type 'boolean)
  531. (if (fboundp 'defvaralias)
  532. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  533. (defcustom org-disputed-keys
  534. '(([(shift up)] . [(meta p)])
  535. ([(shift down)] . [(meta n)])
  536. ([(shift left)] . [(meta -)])
  537. ([(shift right)] . [(meta +)])
  538. ([(control shift right)] . [(meta shift +)])
  539. ([(control shift left)] . [(meta shift -)]))
  540. "Keys for which Org-mode and other modes compete.
  541. This is an alist, cars are the default keys, second element specifies
  542. the alternative to use when `org-replace-disputed-keys' is t.
  543. Keys can be specified in any syntax supported by `define-key'.
  544. The value of this option takes effect only at Org-mode's startup,
  545. therefore you'll have to restart Emacs to apply it after changing."
  546. :group 'org-startup
  547. :type 'alist)
  548. (defun org-key (key)
  549. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  550. Or return the original if not disputed.
  551. Also apply the translations defined in `org-xemacs-key-equivalents'."
  552. (when org-replace-disputed-keys
  553. (let* ((nkey (key-description key))
  554. (x (org-find-if (lambda (x)
  555. (equal (key-description (car x)) nkey))
  556. org-disputed-keys)))
  557. (setq key (if x (cdr x) key))))
  558. (when (featurep 'xemacs)
  559. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  560. key)
  561. (defun org-find-if (predicate seq)
  562. (catch 'exit
  563. (while seq
  564. (if (funcall predicate (car seq))
  565. (throw 'exit (car seq))
  566. (pop seq)))))
  567. (defun org-defkey (keymap key def)
  568. "Define a key, possibly translated, as returned by `org-key'."
  569. (define-key keymap (org-key key) def))
  570. (defcustom org-ellipsis nil
  571. "The ellipsis to use in the Org-mode outline.
  572. When nil, just use the standard three dots. When a string, use that instead,
  573. When a face, use the standard 3 dots, but with the specified face.
  574. The change affects only Org-mode (which will then use its own display table).
  575. Changing this requires executing `M-x org-mode' in a buffer to become
  576. effective."
  577. :group 'org-startup
  578. :type '(choice (const :tag "Default" nil)
  579. (face :tag "Face" :value org-warning)
  580. (string :tag "String" :value "...#")))
  581. (defvar org-display-table nil
  582. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  583. (defgroup org-keywords nil
  584. "Keywords in Org-mode."
  585. :tag "Org Keywords"
  586. :group 'org)
  587. (defcustom org-deadline-string "DEADLINE:"
  588. "String to mark deadline entries.
  589. A deadline is this string, followed by a time stamp. Should be a word,
  590. terminated by a colon. You can insert a schedule keyword and
  591. a timestamp with \\[org-deadline].
  592. Changes become only effective after restarting Emacs."
  593. :group 'org-keywords
  594. :type 'string)
  595. (defcustom org-scheduled-string "SCHEDULED:"
  596. "String to mark scheduled TODO entries.
  597. A schedule is this string, followed by a time stamp. Should be a word,
  598. terminated by a colon. You can insert a schedule keyword and
  599. a timestamp with \\[org-schedule].
  600. Changes become only effective after restarting Emacs."
  601. :group 'org-keywords
  602. :type 'string)
  603. (defcustom org-closed-string "CLOSED:"
  604. "String used as the prefix for timestamps logging closing a TODO entry."
  605. :group 'org-keywords
  606. :type 'string)
  607. (defcustom org-clock-string "CLOCK:"
  608. "String used as prefix for timestamps clocking work hours on an item."
  609. :group 'org-keywords
  610. :type 'string)
  611. (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
  612. org-scheduled-string "\\|"
  613. org-deadline-string "\\|"
  614. org-closed-string "\\|"
  615. org-clock-string "\\)")
  616. "Matches a line with planning or clock info.")
  617. (defcustom org-comment-string "COMMENT"
  618. "Entries starting with this keyword will never be exported.
  619. An entry can be toggled between COMMENT and normal with
  620. \\[org-toggle-comment].
  621. Changes become only effective after restarting Emacs."
  622. :group 'org-keywords
  623. :type 'string)
  624. (defcustom org-quote-string "QUOTE"
  625. "Entries starting with this keyword will be exported in fixed-width font.
  626. Quoting applies only to the text in the entry following the headline, and does
  627. not extend beyond the next headline, even if that is lower level.
  628. An entry can be toggled between QUOTE and normal with
  629. \\[org-toggle-fixed-width-section]."
  630. :group 'org-keywords
  631. :type 'string)
  632. (defconst org-repeat-re
  633. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  634. "Regular expression for specifying repeated events.
  635. After a match, group 1 contains the repeat expression.")
  636. (defgroup org-structure nil
  637. "Options concerning the general structure of Org-mode files."
  638. :tag "Org Structure"
  639. :group 'org)
  640. (defgroup org-reveal-location nil
  641. "Options about how to make context of a location visible."
  642. :tag "Org Reveal Location"
  643. :group 'org-structure)
  644. (defconst org-context-choice
  645. '(choice
  646. (const :tag "Always" t)
  647. (const :tag "Never" nil)
  648. (repeat :greedy t :tag "Individual contexts"
  649. (cons
  650. (choice :tag "Context"
  651. (const agenda)
  652. (const org-goto)
  653. (const occur-tree)
  654. (const tags-tree)
  655. (const link-search)
  656. (const mark-goto)
  657. (const bookmark-jump)
  658. (const isearch)
  659. (const default))
  660. (boolean))))
  661. "Contexts for the reveal options.")
  662. (defcustom org-show-hierarchy-above '((default . t))
  663. "Non-nil means show full hierarchy when revealing a location.
  664. Org-mode often shows locations in an org-mode file which might have
  665. been invisible before. When this is set, the hierarchy of headings
  666. above the exposed location is shown.
  667. Turning this off for example for sparse trees makes them very compact.
  668. Instead of t, this can also be an alist specifying this option for different
  669. contexts. Valid contexts are
  670. agenda when exposing an entry from the agenda
  671. org-goto when using the command `org-goto' on key C-c C-j
  672. occur-tree when using the command `org-occur' on key C-c /
  673. tags-tree when constructing a sparse tree based on tags matches
  674. link-search when exposing search matches associated with a link
  675. mark-goto when exposing the jump goal of a mark
  676. bookmark-jump when exposing a bookmark location
  677. isearch when exiting from an incremental search
  678. default default for all contexts not set explicitly"
  679. :group 'org-reveal-location
  680. :type org-context-choice)
  681. (defcustom org-show-following-heading '((default . nil))
  682. "Non-nil means show following heading when revealing a location.
  683. Org-mode often shows locations in an org-mode file which might have
  684. been invisible before. When this is set, the heading following the
  685. match is shown.
  686. Turning this off for example for sparse trees makes them very compact,
  687. but makes it harder to edit the location of the match. In such a case,
  688. use the command \\[org-reveal] to show more context.
  689. Instead of t, this can also be an alist specifying this option for different
  690. contexts. See `org-show-hierarchy-above' for valid contexts."
  691. :group 'org-reveal-location
  692. :type org-context-choice)
  693. (defcustom org-show-siblings '((default . nil) (isearch t))
  694. "Non-nil means show all sibling heading when revealing a location.
  695. Org-mode often shows locations in an org-mode file which might have
  696. been invisible before. When this is set, the sibling of the current entry
  697. heading are all made visible. If `org-show-hierarchy-above' is t,
  698. the same happens on each level of the hierarchy above the current entry.
  699. By default this is on for the isearch context, off for all other contexts.
  700. Turning this off for example for sparse trees makes them very compact,
  701. but makes it harder to edit the location of the match. In such a case,
  702. use the command \\[org-reveal] to show more context.
  703. Instead of t, this can also be an alist specifying this option for different
  704. contexts. See `org-show-hierarchy-above' for valid contexts."
  705. :group 'org-reveal-location
  706. :type org-context-choice)
  707. (defcustom org-show-entry-below '((default . nil))
  708. "Non-nil means show the entry below a headline when revealing a location.
  709. Org-mode often shows locations in an org-mode file which might have
  710. been invisible before. When this is set, the text below the headline that is
  711. exposed is also shown.
  712. By default this is off for all contexts.
  713. Instead of t, this can also be an alist specifying this option for different
  714. contexts. See `org-show-hierarchy-above' for valid contexts."
  715. :group 'org-reveal-location
  716. :type org-context-choice)
  717. (defcustom org-indirect-buffer-display 'other-window
  718. "How should indirect tree buffers be displayed?
  719. This applies to indirect buffers created with the commands
  720. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  721. Valid values are:
  722. current-window Display in the current window
  723. other-window Just display in another window.
  724. dedicated-frame Create one new frame, and re-use it each time.
  725. new-frame Make a new frame each time. Note that in this case
  726. previously-made indirect buffers are kept, and you need to
  727. kill these buffers yourself."
  728. :group 'org-structure
  729. :group 'org-agenda-windows
  730. :type '(choice
  731. (const :tag "In current window" current-window)
  732. (const :tag "In current frame, other window" other-window)
  733. (const :tag "Each time a new frame" new-frame)
  734. (const :tag "One dedicated frame" dedicated-frame)))
  735. (defcustom org-use-speed-commands nil
  736. "Non-nil means activate single letter commands at beginning of a headline.
  737. This may also be a function to test for appropriate locations where speed
  738. commands should be active."
  739. :group 'org-structure
  740. :type '(choice
  741. (const :tag "Never" nil)
  742. (const :tag "At beginning of headline stars" t)
  743. (function)))
  744. (defcustom org-speed-commands-user nil
  745. "Alist of additional speed commands.
  746. This list will be checked before `org-speed-commands-default'
  747. when the variable `org-use-speed-commands' is non-nil
  748. and when the cursor is at the beginning of a headline.
  749. The car if each entry is a string with a single letter, which must
  750. be assigned to `self-insert-command' in the global map.
  751. The cdr is either a command to be called interactively, a function
  752. to be called, or a form to be evaluated.
  753. An entry that is just a list with a single string will be interpreted
  754. as a descriptive headline that will be added when listing the speed
  755. commands in the Help buffer using the `?' speed command."
  756. :group 'org-structure
  757. :type '(repeat :value ("k" . ignore)
  758. (choice :value ("k" . ignore)
  759. (list :tag "Descriptive Headline" (string :tag "Headline"))
  760. (cons :tag "Letter and Command"
  761. (string :tag "Command letter")
  762. (choice
  763. (function)
  764. (sexp))))))
  765. (defgroup org-cycle nil
  766. "Options concerning visibility cycling in Org-mode."
  767. :tag "Org Cycle"
  768. :group 'org-structure)
  769. (defcustom org-cycle-skip-children-state-if-no-children t
  770. "Non-nil means skip CHILDREN state in entries that don't have any."
  771. :group 'org-cycle
  772. :type 'boolean)
  773. (defcustom org-cycle-max-level nil
  774. "Maximum level which should still be subject to visibility cycling.
  775. Levels higher than this will, for cycling, be treated as text, not a headline.
  776. When `org-odd-levels-only' is set, a value of N in this variable actually
  777. means 2N-1 stars as the limiting headline.
  778. When nil, cycle all levels.
  779. Note that the limiting level of cycling is also influenced by
  780. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  781. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  782. than its value."
  783. :group 'org-cycle
  784. :type '(choice
  785. (const :tag "No limit" nil)
  786. (integer :tag "Maximum level")))
  787. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  788. "Names of drawers. Drawers are not opened by cycling on the headline above.
  789. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  790. this:
  791. :DRAWERNAME:
  792. .....
  793. :END:
  794. The drawer \"PROPERTIES\" is special for capturing properties through
  795. the property API.
  796. Drawers can be defined on the per-file basis with a line like:
  797. #+DRAWERS: HIDDEN STATE PROPERTIES"
  798. :group 'org-structure
  799. :group 'org-cycle
  800. :type '(repeat (string :tag "Drawer Name")))
  801. (defcustom org-hide-block-startup nil
  802. "Non-nil means entering Org-mode will fold all blocks.
  803. This can also be set in on a per-file basis with
  804. #+STARTUP: hideblocks
  805. #+STARTUP: showblocks"
  806. :group 'org-startup
  807. :group 'org-cycle
  808. :type 'boolean)
  809. (defcustom org-cycle-global-at-bob nil
  810. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  811. This makes it possible to do global cycling without having to use S-TAB or
  812. \\[universal-argument] TAB. For this special case to work, the first line
  813. of the buffer must not be a headline -- it may be empty or some other text.
  814. When used in this way, `org-cycle-hook' is disabled temporarily to make
  815. sure the cursor stays at the beginning of the buffer. When this option is
  816. nil, don't do anything special at the beginning of the buffer."
  817. :group 'org-cycle
  818. :type 'boolean)
  819. (defcustom org-cycle-level-after-item/entry-creation t
  820. "Non-nil means cycle entry level or item indentation in new empty entries.
  821. When the cursor is at the end of an empty headline, i.e with only stars
  822. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  823. and then all possible ancestor states, before returning to the original state.
  824. This makes data entry extremely fast: M-RET to create a new headline,
  825. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  826. When the cursor is at the end of an empty plain list item, one TAB will
  827. make it a subitem, two or more tabs will back up to make this an item
  828. higher up in the item hierarchy."
  829. :group 'org-cycle
  830. :type 'boolean)
  831. (defcustom org-cycle-emulate-tab t
  832. "Where should `org-cycle' emulate TAB.
  833. nil Never
  834. white Only in completely white lines
  835. whitestart Only at the beginning of lines, before the first non-white char
  836. t Everywhere except in headlines
  837. exc-hl-bol Everywhere except at the start of a headline
  838. If TAB is used in a place where it does not emulate TAB, the current subtree
  839. visibility is cycled."
  840. :group 'org-cycle
  841. :type '(choice (const :tag "Never" nil)
  842. (const :tag "Only in completely white lines" white)
  843. (const :tag "Before first char in a line" whitestart)
  844. (const :tag "Everywhere except in headlines" t)
  845. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  846. ))
  847. (defcustom org-cycle-separator-lines 2
  848. "Number of empty lines needed to keep an empty line between collapsed trees.
  849. If you leave an empty line between the end of a subtree and the following
  850. headline, this empty line is hidden when the subtree is folded.
  851. Org-mode will leave (exactly) one empty line visible if the number of
  852. empty lines is equal or larger to the number given in this variable.
  853. So the default 2 means at least 2 empty lines after the end of a subtree
  854. are needed to produce free space between a collapsed subtree and the
  855. following headline.
  856. If the number is negative, and the number of empty lines is at least -N,
  857. all empty lines are shown.
  858. Special case: when 0, never leave empty lines in collapsed view."
  859. :group 'org-cycle
  860. :type 'integer)
  861. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  862. (defcustom org-pre-cycle-hook nil
  863. "Hook that is run before visibility cycling is happening.
  864. The function(s) in this hook must accept a single argument which indicates
  865. the new state that will be set right after running this hook. The
  866. argument is a symbol. Before a global state change, it can have the values
  867. `overview', `content', or `all'. Before a local state change, it can have
  868. the values `folded', `children', or `subtree'."
  869. :group 'org-cycle
  870. :type 'hook)
  871. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  872. org-cycle-hide-drawers
  873. org-cycle-hide-inline-tasks
  874. org-cycle-show-empty-lines
  875. org-optimize-window-after-visibility-change)
  876. "Hook that is run after `org-cycle' has changed the buffer visibility.
  877. The function(s) in this hook must accept a single argument which indicates
  878. the new state that was set by the most recent `org-cycle' command. The
  879. argument is a symbol. After a global state change, it can have the values
  880. `overview', `contents', or `all'. After a local state change, it can have
  881. the values `folded', `children', or `subtree'."
  882. :group 'org-cycle
  883. :type 'hook)
  884. (defgroup org-edit-structure nil
  885. "Options concerning structure editing in Org-mode."
  886. :tag "Org Edit Structure"
  887. :group 'org-structure)
  888. (defcustom org-odd-levels-only nil
  889. "Non-nil means skip even levels and only use odd levels for the outline.
  890. This has the effect that two stars are being added/taken away in
  891. promotion/demotion commands. It also influences how levels are
  892. handled by the exporters.
  893. Changing it requires restart of `font-lock-mode' to become effective
  894. for fontification also in regions already fontified.
  895. You may also set this on a per-file basis by adding one of the following
  896. lines to the buffer:
  897. #+STARTUP: odd
  898. #+STARTUP: oddeven"
  899. :group 'org-edit-structure
  900. :group 'org-appearance
  901. :type 'boolean)
  902. (defcustom org-adapt-indentation t
  903. "Non-nil means adapt indentation to outline node level.
  904. When this variable is set, Org assumes that you write outlines by
  905. indenting text in each node to align with the headline (after the stars).
  906. The following issues are influenced by this variable:
  907. - When this is set and the *entire* text in an entry is indented, the
  908. indentation is increased by one space in a demotion command, and
  909. decreased by one in a promotion command. If any line in the entry
  910. body starts with text at column 0, indentation is not changed at all.
  911. - Property drawers and planning information is inserted indented when
  912. this variable s set. When nil, they will not be indented.
  913. - TAB indents a line relative to context. The lines below a headline
  914. will be indented when this variable is set.
  915. Note that this is all about true indentation, by adding and removing
  916. space characters. See also `org-indent.el' which does level-dependent
  917. indentation in a virtual way, i.e. at display time in Emacs."
  918. :group 'org-edit-structure
  919. :type 'boolean)
  920. (defcustom org-special-ctrl-a/e nil
  921. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  922. When t, `C-a' will bring back the cursor to the beginning of the
  923. headline text, i.e. after the stars and after a possible TODO
  924. keyword. In an item, this will be the position after bullet and
  925. check-box, if any. When the cursor is already at that position,
  926. another `C-a' will bring it to the beginning of the line.
  927. `C-e' will jump to the end of the headline, ignoring the presence
  928. of tags in the headline. A second `C-e' will then jump to the
  929. true end of the line, after any tags. This also means that, when
  930. this variable is non-nil, `C-e' also will never jump beyond the
  931. end of the heading of a folded section, i.e. not after the
  932. ellipses.
  933. When set to the symbol `reversed', the first `C-a' or `C-e' works
  934. normally, going to the true line boundary first. Only a directly
  935. following, identical keypress will bring the cursor to the
  936. special positions.
  937. This may also be a cons cell where the behavior for `C-a' and
  938. `C-e' is set separately."
  939. :group 'org-edit-structure
  940. :type '(choice
  941. (const :tag "off" nil)
  942. (const :tag "on: after stars/bullet and before tags first" t)
  943. (const :tag "reversed: true line boundary first" reversed)
  944. (cons :tag "Set C-a and C-e separately"
  945. (choice :tag "Special C-a"
  946. (const :tag "off" nil)
  947. (const :tag "on: after stars/bullet first" t)
  948. (const :tag "reversed: before stars/bullet first" reversed))
  949. (choice :tag "Special C-e"
  950. (const :tag "off" nil)
  951. (const :tag "on: before tags first" t)
  952. (const :tag "reversed: after tags first" reversed)))))
  953. (if (fboundp 'defvaralias)
  954. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  955. (defcustom org-special-ctrl-k nil
  956. "Non-nil means `C-k' will behave specially in headlines.
  957. When nil, `C-k' will call the default `kill-line' command.
  958. When t, the following will happen while the cursor is in the headline:
  959. - When the cursor is at the beginning of a headline, kill the entire
  960. line and possible the folded subtree below the line.
  961. - When in the middle of the headline text, kill the headline up to the tags.
  962. - When after the headline text, kill the tags."
  963. :group 'org-edit-structure
  964. :type 'boolean)
  965. (defcustom org-ctrl-k-protect-subtree nil
  966. "Non-nil means, do not delete a hidden subtree with C-k.
  967. When set to the symbol `error', simply throw an error when C-k is
  968. used to kill (part-of) a headline that has hidden text behind it.
  969. Any other non-nil value will result in a query to the user, if it is
  970. OK to kill that hidden subtree. When nil, kill without remorse."
  971. :group 'org-edit-structure
  972. :version "24.1"
  973. :type '(choice
  974. (const :tag "Do not protect hidden subtrees" nil)
  975. (const :tag "Protect hidden subtrees with a security query" t)
  976. (const :tag "Never kill a hidden subtree with C-k" error)))
  977. (defcustom org-catch-invisible-edits nil
  978. "Check if in invisible region before inserting or deleting a character.
  979. Valid values are:
  980. nil Do not check, so just do invisible edits.
  981. error Throw an error and do nothing.
  982. show Make point visible, and do the requested edit.
  983. show-and-error Make point visible, then throw an error and abort the edit.
  984. smart Make point visible, and do insertion/deletion if it is
  985. adjacent to visible text and the change feels predictable.
  986. Never delete a previously invisible character or add in the
  987. middle or right after an invisible region. Basically, this
  988. allows insertion and backward-delete right before ellipses.
  989. FIXME: maybe in this case we should not even show?"
  990. :group 'org-edit-structure
  991. :version "24.1"
  992. :type '(choice
  993. (const :tag "Do not check" nil)
  994. (const :tag "Throw error when trying to edit" error)
  995. (const :tag "Unhide, but do not do the edit" show-and-error)
  996. (const :tag "Show invisible part and do the edit" show)
  997. (const :tag "Be smart and do the right thing" smart)))
  998. (defcustom org-yank-folded-subtrees t
  999. "Non-nil means when yanking subtrees, fold them.
  1000. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  1001. it starts with a heading and all other headings in it are either children
  1002. or siblings, then fold all the subtrees. However, do this only if no
  1003. text after the yank would be swallowed into a folded tree by this action."
  1004. :group 'org-edit-structure
  1005. :type 'boolean)
  1006. (defcustom org-yank-adjusted-subtrees nil
  1007. "Non-nil means when yanking subtrees, adjust the level.
  1008. With this setting, `org-paste-subtree' is used to insert the subtree, see
  1009. this function for details."
  1010. :group 'org-edit-structure
  1011. :type 'boolean)
  1012. (defcustom org-M-RET-may-split-line '((default . t))
  1013. "Non-nil means M-RET will split the line at the cursor position.
  1014. When nil, it will go to the end of the line before making a
  1015. new line.
  1016. You may also set this option in a different way for different
  1017. contexts. Valid contexts are:
  1018. headline when creating a new headline
  1019. item when creating a new item
  1020. table in a table field
  1021. default the value to be used for all contexts not explicitly
  1022. customized"
  1023. :group 'org-structure
  1024. :group 'org-table
  1025. :type '(choice
  1026. (const :tag "Always" t)
  1027. (const :tag "Never" nil)
  1028. (repeat :greedy t :tag "Individual contexts"
  1029. (cons
  1030. (choice :tag "Context"
  1031. (const headline)
  1032. (const item)
  1033. (const table)
  1034. (const default))
  1035. (boolean)))))
  1036. (defcustom org-insert-heading-respect-content nil
  1037. "Non-nil means insert new headings after the current subtree.
  1038. When nil, the new heading is created directly after the current line.
  1039. The commands \\[org-insert-heading-respect-content] and
  1040. \\[org-insert-todo-heading-respect-content] turn this variable on
  1041. for the duration of the command."
  1042. :group 'org-structure
  1043. :type 'boolean)
  1044. (defcustom org-blank-before-new-entry '((heading . auto)
  1045. (plain-list-item . auto))
  1046. "Should `org-insert-heading' leave a blank line before new heading/item?
  1047. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1048. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1049. which case Org will look at the surrounding headings/items and try to
  1050. make an intelligent decision whether to insert a blank line or not.
  1051. For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
  1052. set, the setting here is ignored and no empty line is inserted, to avoid
  1053. breaking the list structure."
  1054. :group 'org-edit-structure
  1055. :type '(list
  1056. (cons (const heading)
  1057. (choice (const :tag "Never" nil)
  1058. (const :tag "Always" t)
  1059. (const :tag "Auto" auto)))
  1060. (cons (const plain-list-item)
  1061. (choice (const :tag "Never" nil)
  1062. (const :tag "Always" t)
  1063. (const :tag "Auto" auto)))))
  1064. (defcustom org-insert-heading-hook nil
  1065. "Hook being run after inserting a new heading."
  1066. :group 'org-edit-structure
  1067. :type 'hook)
  1068. (defcustom org-enable-fixed-width-editor t
  1069. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1070. This currently only means they are never auto-wrapped.
  1071. When nil, such lines will be treated like ordinary lines.
  1072. See also the QUOTE keyword."
  1073. :group 'org-edit-structure
  1074. :type 'boolean)
  1075. (defcustom org-goto-auto-isearch t
  1076. "Non-nil means typing characters in `org-goto' starts incremental search."
  1077. :group 'org-edit-structure
  1078. :type 'boolean)
  1079. (defgroup org-sparse-trees nil
  1080. "Options concerning sparse trees in Org-mode."
  1081. :tag "Org Sparse Trees"
  1082. :group 'org-structure)
  1083. (defcustom org-highlight-sparse-tree-matches t
  1084. "Non-nil means highlight all matches that define a sparse tree.
  1085. The highlights will automatically disappear the next time the buffer is
  1086. changed by an edit command."
  1087. :group 'org-sparse-trees
  1088. :type 'boolean)
  1089. (defcustom org-remove-highlights-with-change t
  1090. "Non-nil means any change to the buffer will remove temporary highlights.
  1091. Such highlights are created by `org-occur' and `org-clock-display'.
  1092. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1093. The highlights created by `org-preview-latex-fragment' always need
  1094. `C-c C-c' to be removed."
  1095. :group 'org-sparse-trees
  1096. :group 'org-time
  1097. :type 'boolean)
  1098. (defcustom org-occur-hook '(org-first-headline-recenter)
  1099. "Hook that is run after `org-occur' has constructed a sparse tree.
  1100. This can be used to recenter the window to show as much of the structure
  1101. as possible."
  1102. :group 'org-sparse-trees
  1103. :type 'hook)
  1104. (defgroup org-imenu-and-speedbar nil
  1105. "Options concerning imenu and speedbar in Org-mode."
  1106. :tag "Org Imenu and Speedbar"
  1107. :group 'org-structure)
  1108. (defcustom org-imenu-depth 2
  1109. "The maximum level for Imenu access to Org-mode headlines.
  1110. This also applied for speedbar access."
  1111. :group 'org-imenu-and-speedbar
  1112. :type 'integer)
  1113. (defgroup org-table nil
  1114. "Options concerning tables in Org-mode."
  1115. :tag "Org Table"
  1116. :group 'org)
  1117. (defcustom org-enable-table-editor 'optimized
  1118. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1119. When nil, such lines will be treated like ordinary lines.
  1120. When equal to the symbol `optimized', the table editor will be optimized to
  1121. do the following:
  1122. - Automatic overwrite mode in front of whitespace in table fields.
  1123. This makes the structure of the table stay in tact as long as the edited
  1124. field does not exceed the column width.
  1125. - Minimize the number of realigns. Normally, the table is aligned each time
  1126. TAB or RET are pressed to move to another field. With optimization this
  1127. happens only if changes to a field might have changed the column width.
  1128. Optimization requires replacing the functions `self-insert-command',
  1129. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1130. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1131. very good at guessing when a re-align will be necessary, but you can always
  1132. force one with \\[org-ctrl-c-ctrl-c].
  1133. If you would like to use the optimized version in Org-mode, but the
  1134. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1135. This variable can be used to turn on and off the table editor during a session,
  1136. but in order to toggle optimization, a restart is required.
  1137. See also the variable `org-table-auto-blank-field'."
  1138. :group 'org-table
  1139. :type '(choice
  1140. (const :tag "off" nil)
  1141. (const :tag "on" t)
  1142. (const :tag "on, optimized" optimized)))
  1143. (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
  1144. (version<= emacs-version "24.1"))
  1145. "Non-nil means cluster self-insert commands for undo when possible.
  1146. If this is set, then, like in the Emacs command loop, 20 consecutive
  1147. characters will be undone together.
  1148. This is configurable, because there is some impact on typing performance."
  1149. :group 'org-table
  1150. :type 'boolean)
  1151. (defcustom org-table-tab-recognizes-table.el t
  1152. "Non-nil means TAB will automatically notice a table.el table.
  1153. When it sees such a table, it moves point into it and - if necessary -
  1154. calls `table-recognize-table'."
  1155. :group 'org-table-editing
  1156. :type 'boolean)
  1157. (defgroup org-link nil
  1158. "Options concerning links in Org-mode."
  1159. :tag "Org Link"
  1160. :group 'org)
  1161. (defvar org-link-abbrev-alist-local nil
  1162. "Buffer-local version of `org-link-abbrev-alist', which see.
  1163. The value of this is taken from the #+LINK lines.")
  1164. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1165. (defcustom org-link-abbrev-alist nil
  1166. "Alist of link abbreviations.
  1167. The car of each element is a string, to be replaced at the start of a link.
  1168. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1169. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1170. [[linkkey:tag][description]]
  1171. The 'linkkey' must be a word word, starting with a letter, followed
  1172. by letters, numbers, '-' or '_'.
  1173. If REPLACE is a string, the tag will simply be appended to create the link.
  1174. If the string contains \"%s\", the tag will be inserted there. If the string
  1175. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1176. at that point (see the function `url-hexify-string'). If the string contains
  1177. the specifier \"%(my-function)\", then the custom function `my-function' will
  1178. be invoked: this function takes the tag as its only argument and must return
  1179. a string.
  1180. REPLACE may also be a function that will be called with the tag as the
  1181. only argument to create the link, which should be returned as a string.
  1182. See the manual for examples."
  1183. :group 'org-link
  1184. :type '(repeat
  1185. (cons
  1186. (string :tag "Protocol")
  1187. (choice
  1188. (string :tag "Format")
  1189. (function)))))
  1190. (defcustom org-descriptive-links t
  1191. "Non-nil means Org will display descriptive links.
  1192. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1193. \"Org Website\", hiding the link itself and just displaying its
  1194. description. When set to `nil', Org will display the full links
  1195. literally.
  1196. You can interactively set the value of this variable by calling
  1197. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1198. :group 'org-link
  1199. :type 'boolean)
  1200. (defcustom org-link-file-path-type 'adaptive
  1201. "How the path name in file links should be stored.
  1202. Valid values are:
  1203. relative Relative to the current directory, i.e. the directory of the file
  1204. into which the link is being inserted.
  1205. absolute Absolute path, if possible with ~ for home directory.
  1206. noabbrev Absolute path, no abbreviation of home directory.
  1207. adaptive Use relative path for files in the current directory and sub-
  1208. directories of it. For other files, use an absolute path."
  1209. :group 'org-link
  1210. :type '(choice
  1211. (const relative)
  1212. (const absolute)
  1213. (const noabbrev)
  1214. (const adaptive)))
  1215. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1216. "Types of links that should be activated in Org-mode files.
  1217. This is a list of symbols, each leading to the activation of a certain link
  1218. type. In principle, it does not hurt to turn on most link types - there may
  1219. be a small gain when turning off unused link types. The types are:
  1220. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1221. angle Links in angular brackets that may contain whitespace like
  1222. <bbdb:Carsten Dominik>.
  1223. plain Plain links in normal text, no whitespace, like http://google.com.
  1224. radio Text that is matched by a radio target, see manual for details.
  1225. tag Tag settings in a headline (link to tag search).
  1226. date Time stamps (link to calendar).
  1227. footnote Footnote labels.
  1228. Changing this variable requires a restart of Emacs to become effective."
  1229. :group 'org-link
  1230. :type '(set :greedy t
  1231. (const :tag "Double bracket links" bracket)
  1232. (const :tag "Angular bracket links" angle)
  1233. (const :tag "Plain text links" plain)
  1234. (const :tag "Radio target matches" radio)
  1235. (const :tag "Tags" tag)
  1236. (const :tag "Timestamps" date)
  1237. (const :tag "Footnotes" footnote)))
  1238. (defcustom org-make-link-description-function nil
  1239. "Function to use for generating link descriptions from links.
  1240. When nil, the link location will be used. This function must take
  1241. two parameters: the first one is the link, the second one is the
  1242. description generated by `org-insert-link'. The function should
  1243. return the description to use."
  1244. :group 'org-link
  1245. :type 'function)
  1246. (defgroup org-link-store nil
  1247. "Options concerning storing links in Org-mode."
  1248. :tag "Org Store Link"
  1249. :group 'org-link)
  1250. (defcustom org-url-hexify-p t
  1251. "When non-nil, hexify URL when creating a link."
  1252. :type 'boolean
  1253. :version "24.3"
  1254. :group 'org-link-store)
  1255. (defcustom org-email-link-description-format "Email %c: %.30s"
  1256. "Format of the description part of a link to an email or usenet message.
  1257. The following %-escapes will be replaced by corresponding information:
  1258. %F full \"From\" field
  1259. %f name, taken from \"From\" field, address if no name
  1260. %T full \"To\" field
  1261. %t first name in \"To\" field, address if no name
  1262. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1263. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1264. %s subject
  1265. %d date
  1266. %m message-id.
  1267. You may use normal field width specification between the % and the letter.
  1268. This is for example useful to limit the length of the subject.
  1269. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1270. :group 'org-link-store
  1271. :type 'string)
  1272. (defcustom org-from-is-user-regexp
  1273. (let (r1 r2)
  1274. (when (and user-mail-address (not (string= user-mail-address "")))
  1275. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1276. (when (and user-full-name (not (string= user-full-name "")))
  1277. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1278. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1279. "Regexp matched against the \"From:\" header of an email or usenet message.
  1280. It should match if the message is from the user him/herself."
  1281. :group 'org-link-store
  1282. :type 'regexp)
  1283. (defcustom org-context-in-file-links t
  1284. "Non-nil means file links from `org-store-link' contain context.
  1285. A search string will be added to the file name with :: as separator and
  1286. used to find the context when the link is activated by the command
  1287. `org-open-at-point'. When this option is t, the entire active region
  1288. will be placed in the search string of the file link. If set to a
  1289. positive integer, only the first n lines of context will be stored.
  1290. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1291. negates this setting for the duration of the command."
  1292. :group 'org-link-store
  1293. :type '(choice boolean integer))
  1294. (defcustom org-keep-stored-link-after-insertion nil
  1295. "Non-nil means keep link in list for entire session.
  1296. The command `org-store-link' adds a link pointing to the current
  1297. location to an internal list. These links accumulate during a session.
  1298. The command `org-insert-link' can be used to insert links into any
  1299. Org-mode file (offering completion for all stored links). When this
  1300. option is nil, every link which has been inserted once using \\[org-insert-link]
  1301. will be removed from the list, to make completing the unused links
  1302. more efficient."
  1303. :group 'org-link-store
  1304. :type 'boolean)
  1305. (defgroup org-link-follow nil
  1306. "Options concerning following links in Org-mode."
  1307. :tag "Org Follow Link"
  1308. :group 'org-link)
  1309. (defcustom org-link-translation-function nil
  1310. "Function to translate links with different syntax to Org syntax.
  1311. This can be used to translate links created for example by the Planner
  1312. or emacs-wiki packages to Org syntax.
  1313. The function must accept two parameters, a TYPE containing the link
  1314. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1315. which is everything after the link protocol. It should return a cons
  1316. with possibly modified values of type and path.
  1317. Org contains a function for this, so if you set this variable to
  1318. `org-translate-link-from-planner', you should be able follow many
  1319. links created by planner."
  1320. :group 'org-link-follow
  1321. :type 'function)
  1322. (defcustom org-follow-link-hook nil
  1323. "Hook that is run after a link has been followed."
  1324. :group 'org-link-follow
  1325. :type 'hook)
  1326. (defcustom org-tab-follows-link nil
  1327. "Non-nil means on links TAB will follow the link.
  1328. Needs to be set before org.el is loaded.
  1329. This really should not be used, it does not make sense, and the
  1330. implementation is bad."
  1331. :group 'org-link-follow
  1332. :type 'boolean)
  1333. (defcustom org-return-follows-link nil
  1334. "Non-nil means on links RET will follow the link."
  1335. :group 'org-link-follow
  1336. :type 'boolean)
  1337. (defcustom org-mouse-1-follows-link
  1338. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1339. "Non-nil means mouse-1 on a link will follow the link.
  1340. A longer mouse click will still set point. Does not work on XEmacs.
  1341. Needs to be set before org.el is loaded."
  1342. :group 'org-link-follow
  1343. :type 'boolean)
  1344. (defcustom org-mark-ring-length 4
  1345. "Number of different positions to be recorded in the ring.
  1346. Changing this requires a restart of Emacs to work correctly."
  1347. :group 'org-link-follow
  1348. :type 'integer)
  1349. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1350. "Non-nil means internal links in Org files must exactly match a headline.
  1351. When nil, the link search tries to match a phrase with all words
  1352. in the search text."
  1353. :group 'org-link-follow
  1354. :version "24.1"
  1355. :type '(choice
  1356. (const :tag "Use fuzzy text search" nil)
  1357. (const :tag "Match only exact headline" t)
  1358. (const :tag "Match exact headline or query to create it"
  1359. query-to-create)))
  1360. (defcustom org-link-frame-setup
  1361. '((vm . vm-visit-folder-other-frame)
  1362. (vm-imap . vm-visit-imap-folder-other-frame)
  1363. (gnus . org-gnus-no-new-news)
  1364. (file . find-file-other-window)
  1365. (wl . wl-other-frame))
  1366. "Setup the frame configuration for following links.
  1367. When following a link with Emacs, it may often be useful to display
  1368. this link in another window or frame. This variable can be used to
  1369. set this up for the different types of links.
  1370. For VM, use any of
  1371. `vm-visit-folder'
  1372. `vm-visit-folder-other-window'
  1373. `vm-visit-folder-other-frame'
  1374. For Gnus, use any of
  1375. `gnus'
  1376. `gnus-other-frame'
  1377. `org-gnus-no-new-news'
  1378. For FILE, use any of
  1379. `find-file'
  1380. `find-file-other-window'
  1381. `find-file-other-frame'
  1382. For Wanderlust use any of
  1383. `wl'
  1384. `wl-other-frame'
  1385. For the calendar, use the variable `calendar-setup'.
  1386. For BBDB, it is currently only possible to display the matches in
  1387. another window."
  1388. :group 'org-link-follow
  1389. :type '(list
  1390. (cons (const vm)
  1391. (choice
  1392. (const vm-visit-folder)
  1393. (const vm-visit-folder-other-window)
  1394. (const vm-visit-folder-other-frame)))
  1395. (cons (const gnus)
  1396. (choice
  1397. (const gnus)
  1398. (const gnus-other-frame)
  1399. (const org-gnus-no-new-news)))
  1400. (cons (const file)
  1401. (choice
  1402. (const find-file)
  1403. (const find-file-other-window)
  1404. (const find-file-other-frame)))
  1405. (cons (const wl)
  1406. (choice
  1407. (const wl)
  1408. (const wl-other-frame)))))
  1409. (defcustom org-display-internal-link-with-indirect-buffer nil
  1410. "Non-nil means use indirect buffer to display infile links.
  1411. Activating internal links (from one location in a file to another location
  1412. in the same file) normally just jumps to the location. When the link is
  1413. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1414. is displayed in
  1415. another window. When this option is set, the other window actually displays
  1416. an indirect buffer clone of the current buffer, to avoid any visibility
  1417. changes to the current buffer."
  1418. :group 'org-link-follow
  1419. :type 'boolean)
  1420. (defcustom org-open-non-existing-files nil
  1421. "Non-nil means `org-open-file' will open non-existing files.
  1422. When nil, an error will be generated.
  1423. This variable applies only to external applications because they
  1424. might choke on non-existing files. If the link is to a file that
  1425. will be opened in Emacs, the variable is ignored."
  1426. :group 'org-link-follow
  1427. :type 'boolean)
  1428. (defcustom org-open-directory-means-index-dot-org nil
  1429. "Non-nil means a link to a directory really means to index.org.
  1430. When nil, following a directory link will run dired or open a finder/explorer
  1431. window on that directory."
  1432. :group 'org-link-follow
  1433. :type 'boolean)
  1434. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1435. "Function and arguments to call for following mailto links.
  1436. This is a list with the first element being a Lisp function, and the
  1437. remaining elements being arguments to the function. In string arguments,
  1438. %a will be replaced by the address, and %s will be replaced by the subject
  1439. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1440. :group 'org-link-follow
  1441. :type '(choice
  1442. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1443. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1444. (const :tag "message-mail" (message-mail "%a" "%s"))
  1445. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1446. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1447. "Non-nil means ask for confirmation before executing shell links.
  1448. Shell links can be dangerous: just think about a link
  1449. [[shell:rm -rf ~/*][Google Search]]
  1450. This link would show up in your Org-mode document as \"Google Search\",
  1451. but really it would remove your entire home directory.
  1452. Therefore we advise against setting this variable to nil.
  1453. Just change it to `y-or-n-p' if you want to confirm with a
  1454. single keystroke rather than having to type \"yes\"."
  1455. :group 'org-link-follow
  1456. :type '(choice
  1457. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1458. (const :tag "with y-or-n (faster)" y-or-n-p)
  1459. (const :tag "no confirmation (dangerous)" nil)))
  1460. (put 'org-confirm-shell-link-function
  1461. 'safe-local-variable
  1462. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1463. (defcustom org-confirm-shell-link-not-regexp ""
  1464. "A regexp to skip confirmation for shell links."
  1465. :group 'org-link-follow
  1466. :version "24.1"
  1467. :type 'regexp)
  1468. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1469. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1470. Elisp links can be dangerous: just think about a link
  1471. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1472. This link would show up in your Org-mode document as \"Google Search\",
  1473. but really it would remove your entire home directory.
  1474. Therefore we advise against setting this variable to nil.
  1475. Just change it to `y-or-n-p' if you want to confirm with a
  1476. single keystroke rather than having to type \"yes\"."
  1477. :group 'org-link-follow
  1478. :type '(choice
  1479. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1480. (const :tag "with y-or-n (faster)" y-or-n-p)
  1481. (const :tag "no confirmation (dangerous)" nil)))
  1482. (put 'org-confirm-shell-link-function
  1483. 'safe-local-variable
  1484. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1485. (defcustom org-confirm-elisp-link-not-regexp ""
  1486. "A regexp to skip confirmation for Elisp links."
  1487. :group 'org-link-follow
  1488. :version "24.1"
  1489. :type 'regexp)
  1490. (defconst org-file-apps-defaults-gnu
  1491. '((remote . emacs)
  1492. (system . mailcap)
  1493. (t . mailcap))
  1494. "Default file applications on a UNIX or GNU/Linux system.
  1495. See `org-file-apps'.")
  1496. (defconst org-file-apps-defaults-macosx
  1497. '((remote . emacs)
  1498. (t . "open %s")
  1499. (system . "open %s")
  1500. ("ps.gz" . "gv %s")
  1501. ("eps.gz" . "gv %s")
  1502. ("dvi" . "xdvi %s")
  1503. ("fig" . "xfig %s"))
  1504. "Default file applications on a MacOS X system.
  1505. The system \"open\" is known as a default, but we use X11 applications
  1506. for some files for which the OS does not have a good default.
  1507. See `org-file-apps'.")
  1508. (defconst org-file-apps-defaults-windowsnt
  1509. (list
  1510. '(remote . emacs)
  1511. (cons t
  1512. (list (if (featurep 'xemacs)
  1513. 'mswindows-shell-execute
  1514. 'w32-shell-execute)
  1515. "open" 'file))
  1516. (cons 'system
  1517. (list (if (featurep 'xemacs)
  1518. 'mswindows-shell-execute
  1519. 'w32-shell-execute)
  1520. "open" 'file)))
  1521. "Default file applications on a Windows NT system.
  1522. The system \"open\" is used for most files.
  1523. See `org-file-apps'.")
  1524. (defcustom org-file-apps
  1525. '(
  1526. (auto-mode . emacs)
  1527. ("\\.mm\\'" . default)
  1528. ("\\.x?html?\\'" . default)
  1529. ("\\.pdf\\'" . default)
  1530. )
  1531. "External applications for opening `file:path' items in a document.
  1532. Org-mode uses system defaults for different file types, but
  1533. you can use this variable to set the application for a given file
  1534. extension. The entries in this list are cons cells where the car identifies
  1535. files and the cdr the corresponding command. Possible values for the
  1536. file identifier are
  1537. \"string\" A string as a file identifier can be interpreted in different
  1538. ways, depending on its contents:
  1539. - Alphanumeric characters only:
  1540. Match links with this file extension.
  1541. Example: (\"pdf\" . \"evince %s\")
  1542. to open PDFs with evince.
  1543. - Regular expression: Match links where the
  1544. filename matches the regexp. If you want to
  1545. use groups here, use shy groups.
  1546. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1547. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1548. to open *.html and *.xhtml with firefox.
  1549. - Regular expression which contains (non-shy) groups:
  1550. Match links where the whole link, including \"::\", and
  1551. anything after that, matches the regexp.
  1552. In a custom command string, %1, %2, etc. are replaced with
  1553. the parts of the link that were matched by the groups.
  1554. For backwards compatibility, if a command string is given
  1555. that does not use any of the group matches, this case is
  1556. handled identically to the second one (i.e. match against
  1557. file name only).
  1558. In a custom lisp form, you can access the group matches with
  1559. (match-string n link).
  1560. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1561. to open [[file:document.pdf::5]] with evince at page 5.
  1562. `directory' Matches a directory
  1563. `remote' Matches a remote file, accessible through tramp or efs.
  1564. Remote files most likely should be visited through Emacs
  1565. because external applications cannot handle such paths.
  1566. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1567. so all files Emacs knows how to handle. Using this with
  1568. command `emacs' will open most files in Emacs. Beware that this
  1569. will also open html files inside Emacs, unless you add
  1570. (\"html\" . default) to the list as well.
  1571. t Default for files not matched by any of the other options.
  1572. `system' The system command to open files, like `open' on Windows
  1573. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1574. that will be selected if you call `C-c C-o' with a double
  1575. \\[universal-argument] \\[universal-argument] prefix.
  1576. Possible values for the command are:
  1577. `emacs' The file will be visited by the current Emacs process.
  1578. `default' Use the default application for this file type, which is the
  1579. association for t in the list, most likely in the system-specific
  1580. part.
  1581. This can be used to overrule an unwanted setting in the
  1582. system-specific variable.
  1583. `system' Use the system command for opening files, like \"open\".
  1584. This command is specified by the entry whose car is `system'.
  1585. Most likely, the system-specific version of this variable
  1586. does define this command, but you can overrule/replace it
  1587. here.
  1588. string A command to be executed by a shell; %s will be replaced
  1589. by the path to the file.
  1590. sexp A Lisp form which will be evaluated. The file path will
  1591. be available in the Lisp variable `file'.
  1592. For more examples, see the system specific constants
  1593. `org-file-apps-defaults-macosx'
  1594. `org-file-apps-defaults-windowsnt'
  1595. `org-file-apps-defaults-gnu'."
  1596. :group 'org-link-follow
  1597. :type '(repeat
  1598. (cons (choice :value ""
  1599. (string :tag "Extension")
  1600. (const :tag "System command to open files" system)
  1601. (const :tag "Default for unrecognized files" t)
  1602. (const :tag "Remote file" remote)
  1603. (const :tag "Links to a directory" directory)
  1604. (const :tag "Any files that have Emacs modes"
  1605. auto-mode))
  1606. (choice :value ""
  1607. (const :tag "Visit with Emacs" emacs)
  1608. (const :tag "Use default" default)
  1609. (const :tag "Use the system command" system)
  1610. (string :tag "Command")
  1611. (sexp :tag "Lisp form")))))
  1612. (defcustom org-doi-server-url "http://dx.doi.org/"
  1613. "The URL of the DOI server."
  1614. :type 'string
  1615. :version "24.3"
  1616. :group 'org-link-follow)
  1617. (defgroup org-refile nil
  1618. "Options concerning refiling entries in Org-mode."
  1619. :tag "Org Refile"
  1620. :group 'org)
  1621. (defcustom org-directory "~/org"
  1622. "Directory with org files.
  1623. This is just a default location to look for Org files. There is no need
  1624. at all to put your files into this directory. It is only used in the
  1625. following situations:
  1626. 1. When a capture template specifies a target file that is not an
  1627. absolute path. The path will then be interpreted relative to
  1628. `org-directory'
  1629. 2. When a capture note is filed away in an interactive way (when exiting the
  1630. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1631. with `org-directory' as the default path."
  1632. :group 'org-refile
  1633. :group 'org-remember
  1634. :group 'org-capture
  1635. :type 'directory)
  1636. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1637. "Default target for storing notes.
  1638. Used as a fall back file for org-remember.el and org-capture.el, for
  1639. templates that do not specify a target file."
  1640. :group 'org-refile
  1641. :group 'org-remember
  1642. :group 'org-capture
  1643. :type '(choice
  1644. (const :tag "Default from remember-data-file" nil)
  1645. file))
  1646. (defcustom org-goto-interface 'outline
  1647. "The default interface to be used for `org-goto'.
  1648. Allowed values are:
  1649. outline The interface shows an outline of the relevant file
  1650. and the correct heading is found by moving through
  1651. the outline or by searching with incremental search.
  1652. outline-path-completion Headlines in the current buffer are offered via
  1653. completion. This is the interface also used by
  1654. the refile command."
  1655. :group 'org-refile
  1656. :type '(choice
  1657. (const :tag "Outline" outline)
  1658. (const :tag "Outline-path-completion" outline-path-completion)))
  1659. (defcustom org-goto-max-level 5
  1660. "Maximum target level when running `org-goto' with refile interface."
  1661. :group 'org-refile
  1662. :type 'integer)
  1663. (defcustom org-reverse-note-order nil
  1664. "Non-nil means store new notes at the beginning of a file or entry.
  1665. When nil, new notes will be filed to the end of a file or entry.
  1666. This can also be a list with cons cells of regular expressions that
  1667. are matched against file names, and values."
  1668. :group 'org-remember
  1669. :group 'org-capture
  1670. :group 'org-refile
  1671. :type '(choice
  1672. (const :tag "Reverse always" t)
  1673. (const :tag "Reverse never" nil)
  1674. (repeat :tag "By file name regexp"
  1675. (cons regexp boolean))))
  1676. (defcustom org-log-refile nil
  1677. "Information to record when a task is refiled.
  1678. Possible values are:
  1679. nil Don't add anything
  1680. time Add a time stamp to the task
  1681. note Prompt for a note and add it with template `org-log-note-headings'
  1682. This option can also be set with on a per-file-basis with
  1683. #+STARTUP: nologrefile
  1684. #+STARTUP: logrefile
  1685. #+STARTUP: lognoterefile
  1686. You can have local logging settings for a subtree by setting the LOGGING
  1687. property to one or more of these keywords.
  1688. When bulk-refiling from the agenda, the value `note' is forbidden and
  1689. will temporarily be changed to `time'."
  1690. :group 'org-refile
  1691. :group 'org-progress
  1692. :version "24.1"
  1693. :type '(choice
  1694. (const :tag "No logging" nil)
  1695. (const :tag "Record timestamp" time)
  1696. (const :tag "Record timestamp with note." note)))
  1697. (defcustom org-refile-targets nil
  1698. "Targets for refiling entries with \\[org-refile].
  1699. This is a list of cons cells. Each cell contains:
  1700. - a specification of the files to be considered, either a list of files,
  1701. or a symbol whose function or variable value will be used to retrieve
  1702. a file name or a list of file names. If you use `org-agenda-files' for
  1703. that, all agenda files will be scanned for targets. Nil means consider
  1704. headings in the current buffer.
  1705. - A specification of how to find candidate refile targets. This may be
  1706. any of:
  1707. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1708. This tag has to be present in all target headlines, inheritance will
  1709. not be considered.
  1710. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1711. todo keyword.
  1712. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1713. headlines that are refiling targets.
  1714. - a cons cell (:level . N). Any headline of level N is considered a target.
  1715. Note that, when `org-odd-levels-only' is set, level corresponds to
  1716. order in hierarchy, not to the number of stars.
  1717. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1718. Note that, when `org-odd-levels-only' is set, level corresponds to
  1719. order in hierarchy, not to the number of stars.
  1720. Each element of this list generates a set of possible targets.
  1721. The union of these sets is presented (with completion) to
  1722. the user by `org-refile'.
  1723. You can set the variable `org-refile-target-verify-function' to a function
  1724. to verify each headline found by the simple criteria above.
  1725. When this variable is nil, all top-level headlines in the current buffer
  1726. are used, equivalent to the value `((nil . (:level . 1))'."
  1727. :group 'org-refile
  1728. :type '(repeat
  1729. (cons
  1730. (choice :value org-agenda-files
  1731. (const :tag "All agenda files" org-agenda-files)
  1732. (const :tag "Current buffer" nil)
  1733. (function) (variable) (file))
  1734. (choice :tag "Identify target headline by"
  1735. (cons :tag "Specific tag" (const :value :tag) (string))
  1736. (cons :tag "TODO keyword" (const :value :todo) (string))
  1737. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1738. (cons :tag "Level number" (const :value :level) (integer))
  1739. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1740. (defcustom org-refile-target-verify-function nil
  1741. "Function to verify if the headline at point should be a refile target.
  1742. The function will be called without arguments, with point at the
  1743. beginning of the headline. It should return t and leave point
  1744. where it is if the headline is a valid target for refiling.
  1745. If the target should not be selected, the function must return nil.
  1746. In addition to this, it may move point to a place from where the search
  1747. should be continued. For example, the function may decide that the entire
  1748. subtree of the current entry should be excluded and move point to the end
  1749. of the subtree."
  1750. :group 'org-refile
  1751. :type 'function)
  1752. (defcustom org-refile-use-cache nil
  1753. "Non-nil means cache refile targets to speed up the process.
  1754. The cache for a particular file will be updated automatically when
  1755. the buffer has been killed, or when any of the marker used for flagging
  1756. refile targets no longer points at a live buffer.
  1757. If you have added new entries to a buffer that might themselves be targets,
  1758. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1759. find that easier, `C-u C-u C-u C-c C-w'."
  1760. :group 'org-refile
  1761. :version "24.1"
  1762. :type 'boolean)
  1763. (defcustom org-refile-use-outline-path nil
  1764. "Non-nil means provide refile targets as paths.
  1765. So a level 3 headline will be available as level1/level2/level3.
  1766. When the value is `file', also include the file name (without directory)
  1767. into the path. In this case, you can also stop the completion after
  1768. the file name, to get entries inserted as top level in the file.
  1769. When `full-file-path', include the full file path."
  1770. :group 'org-refile
  1771. :type '(choice
  1772. (const :tag "Not" nil)
  1773. (const :tag "Yes" t)
  1774. (const :tag "Start with file name" file)
  1775. (const :tag "Start with full file path" full-file-path)))
  1776. (defcustom org-outline-path-complete-in-steps t
  1777. "Non-nil means complete the outline path in hierarchical steps.
  1778. When Org-mode uses the refile interface to select an outline path
  1779. \(see variable `org-refile-use-outline-path'), the completion of
  1780. the path can be done is a single go, or if can be done in steps down
  1781. the headline hierarchy. Going in steps is probably the best if you
  1782. do not use a special completion package like `ido' or `icicles'.
  1783. However, when using these packages, going in one step can be very
  1784. fast, while still showing the whole path to the entry."
  1785. :group 'org-refile
  1786. :type 'boolean)
  1787. (defcustom org-refile-allow-creating-parent-nodes nil
  1788. "Non-nil means allow to create new nodes as refile targets.
  1789. New nodes are then created by adding \"/new node name\" to the completion
  1790. of an existing node. When the value of this variable is `confirm',
  1791. new node creation must be confirmed by the user (recommended)
  1792. When nil, the completion must match an existing entry.
  1793. Note that, if the new heading is not seen by the criteria
  1794. listed in `org-refile-targets', multiple instances of the same
  1795. heading would be created by trying again to file under the new
  1796. heading."
  1797. :group 'org-refile
  1798. :type '(choice
  1799. (const :tag "Never" nil)
  1800. (const :tag "Always" t)
  1801. (const :tag "Prompt for confirmation" confirm)))
  1802. (defcustom org-refile-active-region-within-subtree nil
  1803. "Non-nil means also refile active region within a subtree.
  1804. By default `org-refile' doesn't allow refiling regions if they
  1805. don't contain a set of subtrees, but it might be convenient to
  1806. do so sometimes: in that case, the first line of the region is
  1807. converted to a headline before refiling."
  1808. :group 'org-refile
  1809. :version "24.1"
  1810. :type 'boolean)
  1811. (defgroup org-todo nil
  1812. "Options concerning TODO items in Org-mode."
  1813. :tag "Org TODO"
  1814. :group 'org)
  1815. (defgroup org-progress nil
  1816. "Options concerning Progress logging in Org-mode."
  1817. :tag "Org Progress"
  1818. :group 'org-time)
  1819. (defvar org-todo-interpretation-widgets
  1820. '((:tag "Sequence (cycling hits every state)" sequence)
  1821. (:tag "Type (cycling directly to DONE)" type))
  1822. "The available interpretation symbols for customizing `org-todo-keywords'.
  1823. Interested libraries should add to this list.")
  1824. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1825. "List of TODO entry keyword sequences and their interpretation.
  1826. \\<org-mode-map>This is a list of sequences.
  1827. Each sequence starts with a symbol, either `sequence' or `type',
  1828. indicating if the keywords should be interpreted as a sequence of
  1829. action steps, or as different types of TODO items. The first
  1830. keywords are states requiring action - these states will select a headline
  1831. for inclusion into the global TODO list Org-mode produces. If one of
  1832. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1833. signify that no further action is necessary. If \"|\" is not found,
  1834. the last keyword is treated as the only DONE state of the sequence.
  1835. The command \\[org-todo] cycles an entry through these states, and one
  1836. additional state where no keyword is present. For details about this
  1837. cycling, see the manual.
  1838. TODO keywords and interpretation can also be set on a per-file basis with
  1839. the special #+SEQ_TODO and #+TYP_TODO lines.
  1840. Each keyword can optionally specify a character for fast state selection
  1841. \(in combination with the variable `org-use-fast-todo-selection')
  1842. and specifiers for state change logging, using the same syntax that
  1843. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  1844. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1845. indicates to record a time stamp each time this state is selected.
  1846. Each keyword may also specify if a timestamp or a note should be
  1847. recorded when entering or leaving the state, by adding additional
  1848. characters in the parenthesis after the keyword. This looks like this:
  1849. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1850. record only the time of the state change. With X and Y being either
  1851. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1852. Y when leaving the state if and only if the *target* state does not
  1853. define X. You may omit any of the fast-selection key or X or /Y,
  1854. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1855. For backward compatibility, this variable may also be just a list
  1856. of keywords. In this case the interpretation (sequence or type) will be
  1857. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1858. :group 'org-todo
  1859. :group 'org-keywords
  1860. :type '(choice
  1861. (repeat :tag "Old syntax, just keywords"
  1862. (string :tag "Keyword"))
  1863. (repeat :tag "New syntax"
  1864. (cons
  1865. (choice
  1866. :tag "Interpretation"
  1867. ;;Quick and dirty way to see
  1868. ;;`org-todo-interpretations'. This takes the
  1869. ;;place of item arguments
  1870. :convert-widget
  1871. (lambda (widget)
  1872. (widget-put widget
  1873. :args (mapcar
  1874. #'(lambda (x)
  1875. (widget-convert
  1876. (cons 'const x)))
  1877. org-todo-interpretation-widgets))
  1878. widget))
  1879. (repeat
  1880. (string :tag "Keyword"))))))
  1881. (defvar org-todo-keywords-1 nil
  1882. "All TODO and DONE keywords active in a buffer.")
  1883. (make-variable-buffer-local 'org-todo-keywords-1)
  1884. (defvar org-todo-keywords-for-agenda nil)
  1885. (defvar org-done-keywords-for-agenda nil)
  1886. (defvar org-drawers-for-agenda nil)
  1887. (defvar org-todo-keyword-alist-for-agenda nil)
  1888. (defvar org-tag-alist-for-agenda nil)
  1889. (defvar org-agenda-contributing-files nil)
  1890. (defvar org-not-done-keywords nil)
  1891. (make-variable-buffer-local 'org-not-done-keywords)
  1892. (defvar org-done-keywords nil)
  1893. (make-variable-buffer-local 'org-done-keywords)
  1894. (defvar org-todo-heads nil)
  1895. (make-variable-buffer-local 'org-todo-heads)
  1896. (defvar org-todo-sets nil)
  1897. (make-variable-buffer-local 'org-todo-sets)
  1898. (defvar org-todo-log-states nil)
  1899. (make-variable-buffer-local 'org-todo-log-states)
  1900. (defvar org-todo-kwd-alist nil)
  1901. (make-variable-buffer-local 'org-todo-kwd-alist)
  1902. (defvar org-todo-key-alist nil)
  1903. (make-variable-buffer-local 'org-todo-key-alist)
  1904. (defvar org-todo-key-trigger nil)
  1905. (make-variable-buffer-local 'org-todo-key-trigger)
  1906. (defcustom org-todo-interpretation 'sequence
  1907. "Controls how TODO keywords are interpreted.
  1908. This variable is in principle obsolete and is only used for
  1909. backward compatibility, if the interpretation of todo keywords is
  1910. not given already in `org-todo-keywords'. See that variable for
  1911. more information."
  1912. :group 'org-todo
  1913. :group 'org-keywords
  1914. :type '(choice (const sequence)
  1915. (const type)))
  1916. (defcustom org-use-fast-todo-selection t
  1917. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1918. This variable describes if and under what circumstances the cycling
  1919. mechanism for TODO keywords will be replaced by a single-key, direct
  1920. selection scheme.
  1921. When nil, fast selection is never used.
  1922. When the symbol `prefix', it will be used when `org-todo' is called
  1923. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  1924. `C-u t' in an agenda buffer.
  1925. When t, fast selection is used by default. In this case, the prefix
  1926. argument forces cycling instead.
  1927. In all cases, the special interface is only used if access keys have
  1928. actually been assigned by the user, i.e. if keywords in the configuration
  1929. are followed by a letter in parenthesis, like TODO(t)."
  1930. :group 'org-todo
  1931. :type '(choice
  1932. (const :tag "Never" nil)
  1933. (const :tag "By default" t)
  1934. (const :tag "Only with C-u C-c C-t" prefix)))
  1935. (defcustom org-provide-todo-statistics t
  1936. "Non-nil means update todo statistics after insert and toggle.
  1937. ALL-HEADLINES means update todo statistics by including headlines
  1938. with no TODO keyword as well, counting them as not done.
  1939. A list of TODO keywords means the same, but skip keywords that are
  1940. not in this list.
  1941. When this is set, todo statistics is updated in the parent of the
  1942. current entry each time a todo state is changed."
  1943. :group 'org-todo
  1944. :type '(choice
  1945. (const :tag "Yes, only for TODO entries" t)
  1946. (const :tag "Yes, including all entries" 'all-headlines)
  1947. (repeat :tag "Yes, for TODOs in this list"
  1948. (string :tag "TODO keyword"))
  1949. (other :tag "No TODO statistics" nil)))
  1950. (defcustom org-hierarchical-todo-statistics t
  1951. "Non-nil means TODO statistics covers just direct children.
  1952. When nil, all entries in the subtree are considered.
  1953. This has only an effect if `org-provide-todo-statistics' is set.
  1954. To set this to nil for only a single subtree, use a COOKIE_DATA
  1955. property and include the word \"recursive\" into the value."
  1956. :group 'org-todo
  1957. :type 'boolean)
  1958. (defcustom org-after-todo-state-change-hook nil
  1959. "Hook which is run after the state of a TODO item was changed.
  1960. The new state (a string with a TODO keyword, or nil) is available in the
  1961. Lisp variable `org-state'."
  1962. :group 'org-todo
  1963. :type 'hook)
  1964. (defvar org-blocker-hook nil
  1965. "Hook for functions that are allowed to block a state change.
  1966. Each function gets as its single argument a property list, see
  1967. `org-trigger-hook' for more information about this list.
  1968. If any of the functions in this hook returns nil, the state change
  1969. is blocked.")
  1970. (defvar org-trigger-hook nil
  1971. "Hook for functions that are triggered by a state change.
  1972. Each function gets as its single argument a property list with at least
  1973. the following elements:
  1974. (:type type-of-change :position pos-at-entry-start
  1975. :from old-state :to new-state)
  1976. Depending on the type, more properties may be present.
  1977. This mechanism is currently implemented for:
  1978. TODO state changes
  1979. ------------------
  1980. :type todo-state-change
  1981. :from previous state (keyword as a string), or nil, or a symbol
  1982. 'todo' or 'done', to indicate the general type of state.
  1983. :to new state, like in :from")
  1984. (defcustom org-enforce-todo-dependencies nil
  1985. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1986. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1987. be blocked if any prior sibling is not yet done.
  1988. Finally, if the parent is blocked because of ordered siblings of its own,
  1989. the child will also be blocked."
  1990. :set (lambda (var val)
  1991. (set var val)
  1992. (if val
  1993. (add-hook 'org-blocker-hook
  1994. 'org-block-todo-from-children-or-siblings-or-parent)
  1995. (remove-hook 'org-blocker-hook
  1996. 'org-block-todo-from-children-or-siblings-or-parent)))
  1997. :group 'org-todo
  1998. :type 'boolean)
  1999. (defcustom org-enforce-todo-checkbox-dependencies nil
  2000. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2001. When this is nil, checkboxes have no influence on switching TODO states.
  2002. When non-nil, you first need to check off all check boxes before the TODO
  2003. entry can be switched to DONE.
  2004. This variable needs to be set before org.el is loaded, and you need to
  2005. restart Emacs after a change to make the change effective. The only way
  2006. to change is while Emacs is running is through the customize interface."
  2007. :set (lambda (var val)
  2008. (set var val)
  2009. (if val
  2010. (add-hook 'org-blocker-hook
  2011. 'org-block-todo-from-checkboxes)
  2012. (remove-hook 'org-blocker-hook
  2013. 'org-block-todo-from-checkboxes)))
  2014. :group 'org-todo
  2015. :type 'boolean)
  2016. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2017. "Non-nil means inserting a TODO heading is treated as state change.
  2018. So when the command \\[org-insert-todo-heading] is used, state change
  2019. logging will apply if appropriate. When nil, the new TODO item will
  2020. be inserted directly, and no logging will take place."
  2021. :group 'org-todo
  2022. :type 'boolean)
  2023. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2024. "Non-nil means switching TODO states with S-cursor counts as state change.
  2025. This is the default behavior. However, setting this to nil allows a
  2026. convenient way to select a TODO state and bypass any logging associated
  2027. with that."
  2028. :group 'org-todo
  2029. :type 'boolean)
  2030. (defcustom org-todo-state-tags-triggers nil
  2031. "Tag changes that should be triggered by TODO state changes.
  2032. This is a list. Each entry is
  2033. (state-change (tag . flag) .......)
  2034. State-change can be a string with a state, and empty string to indicate the
  2035. state that has no TODO keyword, or it can be one of the symbols `todo'
  2036. or `done', meaning any not-done or done state, respectively."
  2037. :group 'org-todo
  2038. :group 'org-tags
  2039. :type '(repeat
  2040. (cons (choice :tag "When changing to"
  2041. (const :tag "Not-done state" todo)
  2042. (const :tag "Done state" done)
  2043. (string :tag "State"))
  2044. (repeat
  2045. (cons :tag "Tag action"
  2046. (string :tag "Tag")
  2047. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2048. (defcustom org-log-done nil
  2049. "Information to record when a task moves to the DONE state.
  2050. Possible values are:
  2051. nil Don't add anything, just change the keyword
  2052. time Add a time stamp to the task
  2053. note Prompt for a note and add it with template `org-log-note-headings'
  2054. This option can also be set with on a per-file-basis with
  2055. #+STARTUP: nologdone
  2056. #+STARTUP: logdone
  2057. #+STARTUP: lognotedone
  2058. You can have local logging settings for a subtree by setting the LOGGING
  2059. property to one or more of these keywords."
  2060. :group 'org-todo
  2061. :group 'org-progress
  2062. :type '(choice
  2063. (const :tag "No logging" nil)
  2064. (const :tag "Record CLOSED timestamp" time)
  2065. (const :tag "Record CLOSED timestamp with note." note)))
  2066. ;; Normalize old uses of org-log-done.
  2067. (cond
  2068. ((eq org-log-done t) (setq org-log-done 'time))
  2069. ((and (listp org-log-done) (memq 'done org-log-done))
  2070. (setq org-log-done 'note)))
  2071. (defcustom org-log-reschedule nil
  2072. "Information to record when the scheduling date of a tasks is modified.
  2073. Possible values are:
  2074. nil Don't add anything, just change the date
  2075. time Add a time stamp to the task
  2076. note Prompt for a note and add it with template `org-log-note-headings'
  2077. This option can also be set with on a per-file-basis with
  2078. #+STARTUP: nologreschedule
  2079. #+STARTUP: logreschedule
  2080. #+STARTUP: lognotereschedule"
  2081. :group 'org-todo
  2082. :group 'org-progress
  2083. :type '(choice
  2084. (const :tag "No logging" nil)
  2085. (const :tag "Record timestamp" time)
  2086. (const :tag "Record timestamp with note." note)))
  2087. (defcustom org-log-redeadline nil
  2088. "Information to record when the deadline date of a tasks is modified.
  2089. Possible values are:
  2090. nil Don't add anything, just change the date
  2091. time Add a time stamp to the task
  2092. note Prompt for a note and add it with template `org-log-note-headings'
  2093. This option can also be set with on a per-file-basis with
  2094. #+STARTUP: nologredeadline
  2095. #+STARTUP: logredeadline
  2096. #+STARTUP: lognoteredeadline
  2097. You can have local logging settings for a subtree by setting the LOGGING
  2098. property to one or more of these keywords."
  2099. :group 'org-todo
  2100. :group 'org-progress
  2101. :type '(choice
  2102. (const :tag "No logging" nil)
  2103. (const :tag "Record timestamp" time)
  2104. (const :tag "Record timestamp with note." note)))
  2105. (defcustom org-log-note-clock-out nil
  2106. "Non-nil means record a note when clocking out of an item.
  2107. This can also be configured on a per-file basis by adding one of
  2108. the following lines anywhere in the buffer:
  2109. #+STARTUP: lognoteclock-out
  2110. #+STARTUP: nolognoteclock-out"
  2111. :group 'org-todo
  2112. :group 'org-progress
  2113. :type 'boolean)
  2114. (defcustom org-log-done-with-time t
  2115. "Non-nil means the CLOSED time stamp will contain date and time.
  2116. When nil, only the date will be recorded."
  2117. :group 'org-progress
  2118. :type 'boolean)
  2119. (defcustom org-log-note-headings
  2120. '((done . "CLOSING NOTE %t")
  2121. (state . "State %-12s from %-12S %t")
  2122. (note . "Note taken on %t")
  2123. (reschedule . "Rescheduled from %S on %t")
  2124. (delschedule . "Not scheduled, was %S on %t")
  2125. (redeadline . "New deadline from %S on %t")
  2126. (deldeadline . "Removed deadline, was %S on %t")
  2127. (refile . "Refiled on %t")
  2128. (clock-out . ""))
  2129. "Headings for notes added to entries.
  2130. The value is an alist, with the car being a symbol indicating the note
  2131. context, and the cdr is the heading to be used. The heading may also be the
  2132. empty string.
  2133. %t in the heading will be replaced by a time stamp.
  2134. %T will be an active time stamp instead the default inactive one
  2135. %d will be replaced by a short-format time stamp.
  2136. %D will be replaced by an active short-format time stamp.
  2137. %s will be replaced by the new TODO state, in double quotes.
  2138. %S will be replaced by the old TODO state, in double quotes.
  2139. %u will be replaced by the user name.
  2140. %U will be replaced by the full user name.
  2141. In fact, it is not a good idea to change the `state' entry, because
  2142. agenda log mode depends on the format of these entries."
  2143. :group 'org-todo
  2144. :group 'org-progress
  2145. :type '(list :greedy t
  2146. (cons (const :tag "Heading when closing an item" done) string)
  2147. (cons (const :tag
  2148. "Heading when changing todo state (todo sequence only)"
  2149. state) string)
  2150. (cons (const :tag "Heading when just taking a note" note) string)
  2151. (cons (const :tag "Heading when clocking out" clock-out) string)
  2152. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2153. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2154. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2155. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2156. (cons (const :tag "Heading when refiling" refile) string)))
  2157. (unless (assq 'note org-log-note-headings)
  2158. (push '(note . "%t") org-log-note-headings))
  2159. (defcustom org-log-into-drawer nil
  2160. "Non-nil means insert state change notes and time stamps into a drawer.
  2161. When nil, state changes notes will be inserted after the headline and
  2162. any scheduling and clock lines, but not inside a drawer.
  2163. The value of this variable should be the name of the drawer to use.
  2164. LOGBOOK is proposed as the default drawer for this purpose, you can
  2165. also set this to a string to define the drawer of your choice.
  2166. A value of t is also allowed, representing \"LOGBOOK\".
  2167. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2168. will be ignored.
  2169. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2170. a subtree."
  2171. :group 'org-todo
  2172. :group 'org-progress
  2173. :type '(choice
  2174. (const :tag "Not into a drawer" nil)
  2175. (const :tag "LOGBOOK" t)
  2176. (string :tag "Other")))
  2177. (if (fboundp 'defvaralias)
  2178. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  2179. (defun org-log-into-drawer ()
  2180. "Return the value of `org-log-into-drawer', but let properties overrule.
  2181. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2182. used instead of the default value."
  2183. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
  2184. (cond
  2185. ((or (not p) (equal p "nil")) org-log-into-drawer)
  2186. ((equal p "t") "LOGBOOK")
  2187. (t p))))
  2188. (defcustom org-log-state-notes-insert-after-drawers nil
  2189. "Non-nil means insert state change notes after any drawers in entry.
  2190. Only the drawers that *immediately* follow the headline and the
  2191. deadline/scheduled line are skipped.
  2192. When nil, insert notes right after the heading and perhaps the line
  2193. with deadline/scheduling if present.
  2194. This variable will have no effect if `org-log-into-drawer' is
  2195. set."
  2196. :group 'org-todo
  2197. :group 'org-progress
  2198. :type 'boolean)
  2199. (defcustom org-log-states-order-reversed t
  2200. "Non-nil means the latest state note will be directly after heading.
  2201. When nil, the state change notes will be ordered according to time."
  2202. :group 'org-todo
  2203. :group 'org-progress
  2204. :type 'boolean)
  2205. (defcustom org-todo-repeat-to-state nil
  2206. "The TODO state to which a repeater should return the repeating task.
  2207. By default this is the first task in a TODO sequence, or the previous state
  2208. in a TODO_TYP set. But you can specify another task here.
  2209. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2210. :group 'org-todo
  2211. :version "24.1"
  2212. :type '(choice (const :tag "Head of sequence" nil)
  2213. (string :tag "Specific state")))
  2214. (defcustom org-log-repeat 'time
  2215. "Non-nil means record moving through the DONE state when triggering repeat.
  2216. An auto-repeating task is immediately switched back to TODO when
  2217. marked DONE. If you are not logging state changes (by adding \"@\"
  2218. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2219. record a closing note, there will be no record of the task moving
  2220. through DONE. This variable forces taking a note anyway.
  2221. nil Don't force a record
  2222. time Record a time stamp
  2223. note Prompt for a note and add it with template `org-log-note-headings'
  2224. This option can also be set with on a per-file-basis with
  2225. #+STARTUP: nologrepeat
  2226. #+STARTUP: logrepeat
  2227. #+STARTUP: lognoterepeat
  2228. You can have local logging settings for a subtree by setting the LOGGING
  2229. property to one or more of these keywords."
  2230. :group 'org-todo
  2231. :group 'org-progress
  2232. :type '(choice
  2233. (const :tag "Don't force a record" nil)
  2234. (const :tag "Force recording the DONE state" time)
  2235. (const :tag "Force recording a note with the DONE state" note)))
  2236. (defgroup org-priorities nil
  2237. "Priorities in Org-mode."
  2238. :tag "Org Priorities"
  2239. :group 'org-todo)
  2240. (defcustom org-enable-priority-commands t
  2241. "Non-nil means priority commands are active.
  2242. When nil, these commands will be disabled, so that you never accidentally
  2243. set a priority."
  2244. :group 'org-priorities
  2245. :type 'boolean)
  2246. (defcustom org-highest-priority ?A
  2247. "The highest priority of TODO items. A character like ?A, ?B etc.
  2248. Must have a smaller ASCII number than `org-lowest-priority'."
  2249. :group 'org-priorities
  2250. :type 'character)
  2251. (defcustom org-lowest-priority ?C
  2252. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2253. Must have a larger ASCII number than `org-highest-priority'."
  2254. :group 'org-priorities
  2255. :type 'character)
  2256. (defcustom org-default-priority ?B
  2257. "The default priority of TODO items.
  2258. This is the priority an item gets if no explicit priority is given.
  2259. When starting to cycle on an empty priority the first step in the cycle
  2260. depends on `org-priority-start-cycle-with-default'. The resulting first
  2261. step priority must not exceed the range from `org-highest-priority' to
  2262. `org-lowest-priority' which means that `org-default-priority' has to be
  2263. in this range exclusive or inclusive the range boundaries. Else the
  2264. first step refuses to set the default and the second will fall back
  2265. to (depending on the command used) the highest or lowest priority."
  2266. :group 'org-priorities
  2267. :type 'character)
  2268. (defcustom org-priority-start-cycle-with-default t
  2269. "Non-nil means start with default priority when starting to cycle.
  2270. When this is nil, the first step in the cycle will be (depending on the
  2271. command used) one higher or lower than the default priority.
  2272. See also `org-default-priority'."
  2273. :group 'org-priorities
  2274. :type 'boolean)
  2275. (defcustom org-get-priority-function nil
  2276. "Function to extract the priority from a string.
  2277. The string is normally the headline. If this is nil Org computes the
  2278. priority from the priority cookie like [#A] in the headline. It returns
  2279. an integer, increasing by 1000 for each priority level.
  2280. The user can set a different function here, which should take a string
  2281. as an argument and return the numeric priority."
  2282. :group 'org-priorities
  2283. :version "24.1"
  2284. :type 'function)
  2285. (defgroup org-time nil
  2286. "Options concerning time stamps and deadlines in Org-mode."
  2287. :tag "Org Time"
  2288. :group 'org)
  2289. (defcustom org-insert-labeled-timestamps-at-point nil
  2290. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2291. When nil, these labeled time stamps are forces into the second line of an
  2292. entry, just after the headline. When scheduling from the global TODO list,
  2293. the time stamp will always be forced into the second line."
  2294. :group 'org-time
  2295. :type 'boolean)
  2296. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2297. "Formats for `format-time-string' which are used for time stamps.
  2298. It is not recommended to change this constant.")
  2299. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2300. "Number of minutes to round time stamps to.
  2301. These are two values, the first applies when first creating a time stamp.
  2302. The second applies when changing it with the commands `S-up' and `S-down'.
  2303. When changing the time stamp, this means that it will change in steps
  2304. of N minutes, as given by the second value.
  2305. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2306. numbers should be factors of 60, so for example 5, 10, 15.
  2307. When this is larger than 1, you can still force an exact time stamp by using
  2308. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2309. and by using a prefix arg to `S-up/down' to specify the exact number
  2310. of minutes to shift."
  2311. :group 'org-time
  2312. :get #'(lambda (var) ; Make sure both elements are there
  2313. (if (integerp (default-value var))
  2314. (list (default-value var) 5)
  2315. (default-value var)))
  2316. :type '(list
  2317. (integer :tag "when inserting times")
  2318. (integer :tag "when modifying times")))
  2319. ;; Normalize old customizations of this variable.
  2320. (when (integerp org-time-stamp-rounding-minutes)
  2321. (setq org-time-stamp-rounding-minutes
  2322. (list org-time-stamp-rounding-minutes
  2323. org-time-stamp-rounding-minutes)))
  2324. (defcustom org-display-custom-times nil
  2325. "Non-nil means overlay custom formats over all time stamps.
  2326. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2327. To turn this on on a per-file basis, insert anywhere in the file:
  2328. #+STARTUP: customtime"
  2329. :group 'org-time
  2330. :set 'set-default
  2331. :type 'sexp)
  2332. (make-variable-buffer-local 'org-display-custom-times)
  2333. (defcustom org-time-stamp-custom-formats
  2334. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2335. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2336. These are overlaid over the default ISO format if the variable
  2337. `org-display-custom-times' is set. Time like %H:%M should be at the
  2338. end of the second format. The custom formats are also honored by export
  2339. commands, if custom time display is turned on at the time of export."
  2340. :group 'org-time
  2341. :type 'sexp)
  2342. (defun org-time-stamp-format (&optional long inactive)
  2343. "Get the right format for a time string."
  2344. (let ((f (if long (cdr org-time-stamp-formats)
  2345. (car org-time-stamp-formats))))
  2346. (if inactive
  2347. (concat "[" (substring f 1 -1) "]")
  2348. f)))
  2349. (defcustom org-time-clocksum-format "%d:%02d"
  2350. "The format string used when creating CLOCKSUM lines.
  2351. This is also used when org-mode generates a time duration."
  2352. :group 'org-time
  2353. :type 'string)
  2354. (defcustom org-time-clocksum-use-fractional nil
  2355. "If non-nil, \\[org-clock-display] uses fractional times.
  2356. org-mode generates a time duration."
  2357. :group 'org-time
  2358. :type 'boolean)
  2359. (defcustom org-time-clocksum-fractional-format "%.2f"
  2360. "The format string used when creating CLOCKSUM lines, or when
  2361. org-mode generates a time duration."
  2362. :group 'org-time
  2363. :type 'string)
  2364. (defcustom org-deadline-warning-days 14
  2365. "No. of days before expiration during which a deadline becomes active.
  2366. This variable governs the display in sparse trees and in the agenda.
  2367. When 0 or negative, it means use this number (the absolute value of it)
  2368. even if a deadline has a different individual lead time specified.
  2369. Custom commands can set this variable in the options section."
  2370. :group 'org-time
  2371. :group 'org-agenda-daily/weekly
  2372. :type 'integer)
  2373. (defcustom org-read-date-prefer-future t
  2374. "Non-nil means assume future for incomplete date input from user.
  2375. This affects the following situations:
  2376. 1. The user gives a month but not a year.
  2377. For example, if it is April and you enter \"feb 2\", this will be read
  2378. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2379. 2. The user gives a day, but no month.
  2380. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2381. read this as the third of *next* month. However, if you enter \"17\",
  2382. it will be considered as *this* month.
  2383. If you set this variable to the symbol `time', then also the following
  2384. will work:
  2385. 3. If the user gives a time.
  2386. If the time is before now, it will be interpreted as tomorrow.
  2387. Currently none of this works for ISO week specifications.
  2388. When this option is nil, the current day, month and year will always be
  2389. used as defaults.
  2390. See also `org-agenda-jump-prefer-future'."
  2391. :group 'org-time
  2392. :type '(choice
  2393. (const :tag "Never" nil)
  2394. (const :tag "Check month and day" t)
  2395. (const :tag "Check month, day, and time" time)))
  2396. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2397. "Should the agenda jump command prefer the future for incomplete dates?
  2398. The default is to do the same as configured in `org-read-date-prefer-future'.
  2399. But you can also set a deviating value here.
  2400. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2401. :group 'org-agenda
  2402. :group 'org-time
  2403. :version "24.1"
  2404. :type '(choice
  2405. (const :tag "Use org-read-date-prefer-future"
  2406. org-read-date-prefer-future)
  2407. (const :tag "Never" nil)
  2408. (const :tag "Always" t)))
  2409. (defcustom org-read-date-force-compatible-dates t
  2410. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2411. Depending on the system Emacs is running on, certain dates cannot
  2412. be represented with the type used internally to represent time.
  2413. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2414. correctly. Some systems allow for earlier dates, some for later,
  2415. some for both. One way to find out it to insert any date into an
  2416. Org buffer, putting the cursor on the year and hitting S-up and
  2417. S-down to test the range.
  2418. When this variable is set to t, the date/time prompt will not let
  2419. you specify dates outside the 1970-2037 range, so it is certain that
  2420. these dates will work in whatever version of Emacs you are
  2421. running, and also that you can move a file from one Emacs implementation
  2422. to another. WHenever Org is forcing the year for you, it will display
  2423. a message and beep.
  2424. When this variable is nil, Org will check if the date is
  2425. representable in the specific Emacs implementation you are using.
  2426. If not, it will force a year, usually the current year, and beep
  2427. to remind you. Currently this setting is not recommended because
  2428. the likelihood that you will open your Org files in an Emacs that
  2429. has limited date range is not negligible.
  2430. A workaround for this problem is to use diary sexp dates for time
  2431. stamps outside of this range."
  2432. :group 'org-time
  2433. :version "24.1"
  2434. :type 'boolean)
  2435. (defcustom org-read-date-display-live t
  2436. "Non-nil means display current interpretation of date prompt live.
  2437. This display will be in an overlay, in the minibuffer."
  2438. :group 'org-time
  2439. :type 'boolean)
  2440. (defcustom org-read-date-popup-calendar t
  2441. "Non-nil means pop up a calendar when prompting for a date.
  2442. In the calendar, the date can be selected with mouse-1. However, the
  2443. minibuffer will also be active, and you can simply enter the date as well.
  2444. When nil, only the minibuffer will be available."
  2445. :group 'org-time
  2446. :type 'boolean)
  2447. (if (fboundp 'defvaralias)
  2448. (defvaralias 'org-popup-calendar-for-date-prompt
  2449. 'org-read-date-popup-calendar))
  2450. (defcustom org-read-date-minibuffer-setup-hook nil
  2451. "Hook to be used to set up keys for the date/time interface.
  2452. Add key definitions to `minibuffer-local-map', which will be a temporary
  2453. copy."
  2454. :group 'org-time
  2455. :type 'hook)
  2456. (defcustom org-extend-today-until 0
  2457. "The hour when your day really ends. Must be an integer.
  2458. This has influence for the following applications:
  2459. - When switching the agenda to \"today\". It it is still earlier than
  2460. the time given here, the day recognized as TODAY is actually yesterday.
  2461. - When a date is read from the user and it is still before the time given
  2462. here, the current date and time will be assumed to be yesterday, 23:59.
  2463. Also, timestamps inserted in capture templates follow this rule.
  2464. IMPORTANT: This is a feature whose implementation is and likely will
  2465. remain incomplete. Really, it is only here because past midnight seems to
  2466. be the favorite working time of John Wiegley :-)"
  2467. :group 'org-time
  2468. :type 'integer)
  2469. (defcustom org-use-effective-time nil
  2470. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2471. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2472. \"effective time\" of any timestamps between midnight and 8am will be
  2473. 23:59 of the previous day."
  2474. :group 'org-time
  2475. :version "24.1"
  2476. :type 'boolean)
  2477. (defcustom org-use-last-clock-out-time-as-effective-time nil
  2478. "When non-nil, use the last clock out time for `org-todo'.
  2479. Note that this option has precedence over the combined use of
  2480. `org-use-effective-time' and `org-extend-today-until'."
  2481. :group 'org-time
  2482. ;; :version "24.3"
  2483. :type 'boolean)
  2484. (defcustom org-edit-timestamp-down-means-later nil
  2485. "Non-nil means S-down will increase the time in a time stamp.
  2486. When nil, S-up will increase."
  2487. :group 'org-time
  2488. :type 'boolean)
  2489. (defcustom org-calendar-follow-timestamp-change t
  2490. "Non-nil means make the calendar window follow timestamp changes.
  2491. When a timestamp is modified and the calendar window is visible, it will be
  2492. moved to the new date."
  2493. :group 'org-time
  2494. :type 'boolean)
  2495. (defgroup org-tags nil
  2496. "Options concerning tags in Org-mode."
  2497. :tag "Org Tags"
  2498. :group 'org)
  2499. (defcustom org-tag-alist nil
  2500. "List of tags allowed in Org-mode files.
  2501. When this list is nil, Org-mode will base TAG input on what is already in the
  2502. buffer.
  2503. The value of this variable is an alist, the car of each entry must be a
  2504. keyword as a string, the cdr may be a character that is used to select
  2505. that tag through the fast-tag-selection interface.
  2506. See the manual for details."
  2507. :group 'org-tags
  2508. :type '(repeat
  2509. (choice
  2510. (cons (string :tag "Tag name")
  2511. (character :tag "Access char"))
  2512. (list :tag "Start radio group"
  2513. (const :startgroup)
  2514. (option (string :tag "Group description")))
  2515. (list :tag "End radio group"
  2516. (const :endgroup)
  2517. (option (string :tag "Group description")))
  2518. (const :tag "New line" (:newline)))))
  2519. (defcustom org-tag-persistent-alist nil
  2520. "List of tags that will always appear in all Org-mode files.
  2521. This is in addition to any in buffer settings or customizations
  2522. of `org-tag-alist'.
  2523. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2524. The value of this variable is an alist, the car of each entry must be a
  2525. keyword as a string, the cdr may be a character that is used to select
  2526. that tag through the fast-tag-selection interface.
  2527. See the manual for details.
  2528. To disable these tags on a per-file basis, insert anywhere in the file:
  2529. #+STARTUP: noptag"
  2530. :group 'org-tags
  2531. :type '(repeat
  2532. (choice
  2533. (cons (string :tag "Tag name")
  2534. (character :tag "Access char"))
  2535. (const :tag "Start radio group" (:startgroup))
  2536. (const :tag "End radio group" (:endgroup))
  2537. (const :tag "New line" (:newline)))))
  2538. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2539. "If non-nil, always offer completion for all tags of all agenda files.
  2540. Instead of customizing this variable directly, you might want to
  2541. set it locally for capture buffers, because there no list of
  2542. tags in that file can be created dynamically (there are none).
  2543. (add-hook 'org-capture-mode-hook
  2544. (lambda ()
  2545. (set (make-local-variable
  2546. 'org-complete-tags-always-offer-all-agenda-tags)
  2547. t)))"
  2548. :group 'org-tags
  2549. :version "24.1"
  2550. :type 'boolean)
  2551. (defvar org-file-tags nil
  2552. "List of tags that can be inherited by all entries in the file.
  2553. The tags will be inherited if the variable `org-use-tag-inheritance'
  2554. says they should be.
  2555. This variable is populated from #+FILETAGS lines.")
  2556. (defcustom org-use-fast-tag-selection 'auto
  2557. "Non-nil means use fast tag selection scheme.
  2558. This is a special interface to select and deselect tags with single keys.
  2559. When nil, fast selection is never used.
  2560. When the symbol `auto', fast selection is used if and only if selection
  2561. characters for tags have been configured, either through the variable
  2562. `org-tag-alist' or through a #+TAGS line in the buffer.
  2563. When t, fast selection is always used and selection keys are assigned
  2564. automatically if necessary."
  2565. :group 'org-tags
  2566. :type '(choice
  2567. (const :tag "Always" t)
  2568. (const :tag "Never" nil)
  2569. (const :tag "When selection characters are configured" 'auto)))
  2570. (defcustom org-fast-tag-selection-single-key nil
  2571. "Non-nil means fast tag selection exits after first change.
  2572. When nil, you have to press RET to exit it.
  2573. During fast tag selection, you can toggle this flag with `C-c'.
  2574. This variable can also have the value `expert'. In this case, the window
  2575. displaying the tags menu is not even shown, until you press C-c again."
  2576. :group 'org-tags
  2577. :type '(choice
  2578. (const :tag "No" nil)
  2579. (const :tag "Yes" t)
  2580. (const :tag "Expert" expert)))
  2581. (defvar org-fast-tag-selection-include-todo nil
  2582. "Non-nil means fast tags selection interface will also offer TODO states.
  2583. This is an undocumented feature, you should not rely on it.")
  2584. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2585. "The column to which tags should be indented in a headline.
  2586. If this number is positive, it specifies the column. If it is negative,
  2587. it means that the tags should be flushright to that column. For example,
  2588. -80 works well for a normal 80 character screen.
  2589. When 0, place tags directly after headline text, with only one space in
  2590. between."
  2591. :group 'org-tags
  2592. :type 'integer)
  2593. (defcustom org-auto-align-tags t
  2594. "Non-nil keeps tags aligned when modifying headlines.
  2595. Some operations (i.e. demoting) change the length of a headline and
  2596. therefore shift the tags around. With this option turned on, after
  2597. each such operation the tags are again aligned to `org-tags-column'."
  2598. :group 'org-tags
  2599. :type 'boolean)
  2600. (defcustom org-use-tag-inheritance t
  2601. "Non-nil means tags in levels apply also for sublevels.
  2602. When nil, only the tags directly given in a specific line apply there.
  2603. This may also be a list of tags that should be inherited, or a regexp that
  2604. matches tags that should be inherited. Additional control is possible
  2605. with the variable `org-tags-exclude-from-inheritance' which gives an
  2606. explicit list of tags to be excluded from inheritance., even if the value of
  2607. `org-use-tag-inheritance' would select it for inheritance.
  2608. If this option is t, a match early-on in a tree can lead to a large
  2609. number of matches in the subtree when constructing the agenda or creating
  2610. a sparse tree. If you only want to see the first match in a tree during
  2611. a search, check out the variable `org-tags-match-list-sublevels'."
  2612. :group 'org-tags
  2613. :type '(choice
  2614. (const :tag "Not" nil)
  2615. (const :tag "Always" t)
  2616. (repeat :tag "Specific tags" (string :tag "Tag"))
  2617. (regexp :tag "Tags matched by regexp")))
  2618. (defcustom org-tags-exclude-from-inheritance nil
  2619. "List of tags that should never be inherited.
  2620. This is a way to exclude a few tags from inheritance. For way to do
  2621. the opposite, to actively allow inheritance for selected tags,
  2622. see the variable `org-use-tag-inheritance'."
  2623. :group 'org-tags
  2624. :type '(repeat (string :tag "Tag")))
  2625. (defun org-tag-inherit-p (tag)
  2626. "Check if TAG is one that should be inherited."
  2627. (cond
  2628. ((member tag org-tags-exclude-from-inheritance) nil)
  2629. ((eq org-use-tag-inheritance t) t)
  2630. ((not org-use-tag-inheritance) nil)
  2631. ((stringp org-use-tag-inheritance)
  2632. (string-match org-use-tag-inheritance tag))
  2633. ((listp org-use-tag-inheritance)
  2634. (member tag org-use-tag-inheritance))
  2635. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2636. (defcustom org-tags-match-list-sublevels t
  2637. "Non-nil means list also sublevels of headlines matching a search.
  2638. This variable applies to tags/property searches, and also to stuck
  2639. projects because this search is based on a tags match as well.
  2640. When set to the symbol `indented', sublevels are indented with
  2641. leading dots.
  2642. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2643. the sublevels of a headline matching a tag search often also match
  2644. the same search. Listing all of them can create very long lists.
  2645. Setting this variable to nil causes subtrees of a match to be skipped.
  2646. This variable is semi-obsolete and probably should always be true. It
  2647. is better to limit inheritance to certain tags using the variables
  2648. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2649. :group 'org-tags
  2650. :type '(choice
  2651. (const :tag "No, don't list them" nil)
  2652. (const :tag "Yes, do list them" t)
  2653. (const :tag "List them, indented with leading dots" indented)))
  2654. (defcustom org-tags-sort-function nil
  2655. "When set, tags are sorted using this function as a comparator."
  2656. :group 'org-tags
  2657. :type '(choice
  2658. (const :tag "No sorting" nil)
  2659. (const :tag "Alphabetical" string<)
  2660. (const :tag "Reverse alphabetical" string>)
  2661. (function :tag "Custom function" nil)))
  2662. (defvar org-tags-history nil
  2663. "History of minibuffer reads for tags.")
  2664. (defvar org-last-tags-completion-table nil
  2665. "The last used completion table for tags.")
  2666. (defvar org-after-tags-change-hook nil
  2667. "Hook that is run after the tags in a line have changed.")
  2668. (defgroup org-properties nil
  2669. "Options concerning properties in Org-mode."
  2670. :tag "Org Properties"
  2671. :group 'org)
  2672. (defcustom org-property-format "%-10s %s"
  2673. "How property key/value pairs should be formatted by `indent-line'.
  2674. When `indent-line' hits a property definition, it will format the line
  2675. according to this format, mainly to make sure that the values are
  2676. lined-up with respect to each other."
  2677. :group 'org-properties
  2678. :type 'string)
  2679. (defcustom org-properties-postprocess-alist nil
  2680. "Alist of properties and functions to adjust inserted values.
  2681. Elements of this alist must be of the form
  2682. ([string] [function])
  2683. where [string] must be a property name and [function] must be a
  2684. lambda expression: this lambda expression must take one argument,
  2685. the value to adjust, and return the new value as a string.
  2686. For example, this element will allow the property \"Remaining\"
  2687. to be updated wrt the relation between the \"Effort\" property
  2688. and the clock summary:
  2689. ((\"Remaining\" (lambda(value)
  2690. (let ((clocksum (org-clock-sum-current-item))
  2691. (effort (org-duration-string-to-minutes
  2692. (org-entry-get (point) \"Effort\"))))
  2693. (org-minutes-to-hh:mm-string (- effort clocksum))))))"
  2694. :group 'org-properties
  2695. :version "24.1"
  2696. :type '(alist :key-type (string :tag "Property")
  2697. :value-type (function :tag "Function")))
  2698. (defcustom org-use-property-inheritance nil
  2699. "Non-nil means properties apply also for sublevels.
  2700. This setting is chiefly used during property searches. Turning it on can
  2701. cause significant overhead when doing a search, which is why it is not
  2702. on by default.
  2703. When nil, only the properties directly given in the current entry count.
  2704. When t, every property is inherited. The value may also be a list of
  2705. properties that should have inheritance, or a regular expression matching
  2706. properties that should be inherited.
  2707. However, note that some special properties use inheritance under special
  2708. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2709. and the properties ending in \"_ALL\" when they are used as descriptor
  2710. for valid values of a property.
  2711. Note for programmers:
  2712. When querying an entry with `org-entry-get', you can control if inheritance
  2713. should be used. By default, `org-entry-get' looks only at the local
  2714. properties. You can request inheritance by setting the inherit argument
  2715. to t (to force inheritance) or to `selective' (to respect the setting
  2716. in this variable)."
  2717. :group 'org-properties
  2718. :type '(choice
  2719. (const :tag "Not" nil)
  2720. (const :tag "Always" t)
  2721. (repeat :tag "Specific properties" (string :tag "Property"))
  2722. (regexp :tag "Properties matched by regexp")))
  2723. (defun org-property-inherit-p (property)
  2724. "Check if PROPERTY is one that should be inherited."
  2725. (cond
  2726. ((eq org-use-property-inheritance t) t)
  2727. ((not org-use-property-inheritance) nil)
  2728. ((stringp org-use-property-inheritance)
  2729. (string-match org-use-property-inheritance property))
  2730. ((listp org-use-property-inheritance)
  2731. (member property org-use-property-inheritance))
  2732. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2733. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2734. "The default column format, if no other format has been defined.
  2735. This variable can be set on the per-file basis by inserting a line
  2736. #+COLUMNS: %25ITEM ....."
  2737. :group 'org-properties
  2738. :type 'string)
  2739. (defcustom org-columns-ellipses ".."
  2740. "The ellipses to be used when a field in column view is truncated.
  2741. When this is the empty string, as many characters as possible are shown,
  2742. but then there will be no visual indication that the field has been truncated.
  2743. When this is a string of length N, the last N characters of a truncated
  2744. field are replaced by this string. If the column is narrower than the
  2745. ellipses string, only part of the ellipses string will be shown."
  2746. :group 'org-properties
  2747. :type 'string)
  2748. (defcustom org-columns-modify-value-for-display-function nil
  2749. "Function that modifies values for display in column view.
  2750. For example, it can be used to cut out a certain part from a time stamp.
  2751. The function must take 2 arguments:
  2752. column-title The title of the column (*not* the property name)
  2753. value The value that should be modified.
  2754. The function should return the value that should be displayed,
  2755. or nil if the normal value should be used."
  2756. :group 'org-properties
  2757. :type 'function)
  2758. (defcustom org-effort-property "Effort"
  2759. "The property that is being used to keep track of effort estimates.
  2760. Effort estimates given in this property need to have the format H:MM."
  2761. :group 'org-properties
  2762. :group 'org-progress
  2763. :type '(string :tag "Property"))
  2764. (defconst org-global-properties-fixed
  2765. '(("VISIBILITY_ALL" . "folded children content all")
  2766. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2767. "List of property/value pairs that can be inherited by any entry.
  2768. These are fixed values, for the preset properties. The user variable
  2769. that can be used to add to this list is `org-global-properties'.
  2770. The entries in this list are cons cells where the car is a property
  2771. name and cdr is a string with the value. If the value represents
  2772. multiple items like an \"_ALL\" property, separate the items by
  2773. spaces.")
  2774. (defcustom org-global-properties nil
  2775. "List of property/value pairs that can be inherited by any entry.
  2776. This list will be combined with the constant `org-global-properties-fixed'.
  2777. The entries in this list are cons cells where the car is a property
  2778. name and cdr is a string with the value.
  2779. You can set buffer-local values for the same purpose in the variable
  2780. `org-file-properties' this by adding lines like
  2781. #+PROPERTY: NAME VALUE"
  2782. :group 'org-properties
  2783. :type '(repeat
  2784. (cons (string :tag "Property")
  2785. (string :tag "Value"))))
  2786. (defvar org-file-properties nil
  2787. "List of property/value pairs that can be inherited by any entry.
  2788. Valid for the current buffer.
  2789. This variable is populated from #+PROPERTY lines.")
  2790. (make-variable-buffer-local 'org-file-properties)
  2791. (defgroup org-agenda nil
  2792. "Options concerning agenda views in Org-mode."
  2793. :tag "Org Agenda"
  2794. :group 'org)
  2795. (defvar org-category nil
  2796. "Variable used by org files to set a category for agenda display.
  2797. Such files should use a file variable to set it, for example
  2798. # -*- mode: org; org-category: \"ELisp\"
  2799. or contain a special line
  2800. #+CATEGORY: ELisp
  2801. If the file does not specify a category, then file's base name
  2802. is used instead.")
  2803. (make-variable-buffer-local 'org-category)
  2804. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  2805. (defcustom org-agenda-files nil
  2806. "The files to be used for agenda display.
  2807. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2808. \\[org-remove-file]. You can also use customize to edit the list.
  2809. If an entry is a directory, all files in that directory that are matched by
  2810. `org-agenda-file-regexp' will be part of the file list.
  2811. If the value of the variable is not a list but a single file name, then
  2812. the list of agenda files is actually stored and maintained in that file, one
  2813. agenda file per line. In this file paths can be given relative to
  2814. `org-directory'. Tilde expansion and environment variable substitution
  2815. are also made."
  2816. :group 'org-agenda
  2817. :type '(choice
  2818. (repeat :tag "List of files and directories" file)
  2819. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2820. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2821. "Regular expression to match files for `org-agenda-files'.
  2822. If any element in the list in that variable contains a directory instead
  2823. of a normal file, all files in that directory that are matched by this
  2824. regular expression will be included."
  2825. :group 'org-agenda
  2826. :type 'regexp)
  2827. (defcustom org-agenda-text-search-extra-files nil
  2828. "List of extra files to be searched by text search commands.
  2829. These files will be search in addition to the agenda files by the
  2830. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2831. Note that these files will only be searched for text search commands,
  2832. not for the other agenda views like todo lists, tag searches or the weekly
  2833. agenda. This variable is intended to list notes and possibly archive files
  2834. that should also be searched by these two commands.
  2835. In fact, if the first element in the list is the symbol `agenda-archives',
  2836. than all archive files of all agenda files will be added to the search
  2837. scope."
  2838. :group 'org-agenda
  2839. :type '(set :greedy t
  2840. (const :tag "Agenda Archives" agenda-archives)
  2841. (repeat :inline t (file))))
  2842. (if (fboundp 'defvaralias)
  2843. (defvaralias 'org-agenda-multi-occur-extra-files
  2844. 'org-agenda-text-search-extra-files))
  2845. (defcustom org-agenda-skip-unavailable-files nil
  2846. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2847. A nil value means to remove them, after a query, from the list."
  2848. :group 'org-agenda
  2849. :type 'boolean)
  2850. (defcustom org-calendar-to-agenda-key [?c]
  2851. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2852. The command `org-calendar-goto-agenda' will be bound to this key. The
  2853. default is the character `c' because then `c' can be used to switch back and
  2854. forth between agenda and calendar."
  2855. :group 'org-agenda
  2856. :type 'sexp)
  2857. (defcustom org-calendar-insert-diary-entry-key [?i]
  2858. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2859. This option is irrelevant until `org-agenda-diary-file' has been configured
  2860. to point to an Org-mode file. When that is the case, the command
  2861. `org-agenda-diary-entry' will be bound to the key given here, by default
  2862. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2863. if you want to continue doing this, you need to change this to a different
  2864. key."
  2865. :group 'org-agenda
  2866. :type 'sexp)
  2867. (defcustom org-agenda-diary-file 'diary-file
  2868. "File to which to add new entries with the `i' key in agenda and calendar.
  2869. When this is the symbol `diary-file', the functionality in the Emacs
  2870. calendar will be used to add entries to the `diary-file'. But when this
  2871. points to a file, `org-agenda-diary-entry' will be used instead."
  2872. :group 'org-agenda
  2873. :type '(choice
  2874. (const :tag "The standard Emacs diary file" diary-file)
  2875. (file :tag "Special Org file diary entries")))
  2876. (eval-after-load "calendar"
  2877. '(progn
  2878. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2879. 'org-calendar-goto-agenda)
  2880. (add-hook 'calendar-mode-hook
  2881. (lambda ()
  2882. (unless (eq org-agenda-diary-file 'diary-file)
  2883. (define-key calendar-mode-map
  2884. org-calendar-insert-diary-entry-key
  2885. 'org-agenda-diary-entry))))))
  2886. (defgroup org-latex nil
  2887. "Options for embedding LaTeX code into Org-mode."
  2888. :tag "Org LaTeX"
  2889. :group 'org)
  2890. (defcustom org-format-latex-options
  2891. '(:foreground default :background default :scale 1.0
  2892. :html-foreground "Black" :html-background "Transparent"
  2893. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2894. "Options for creating images from LaTeX fragments.
  2895. This is a property list with the following properties:
  2896. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2897. `default' means use the foreground of the default face.
  2898. `auto' means use the foreground from the text face.
  2899. :background the background color, or \"Transparent\".
  2900. `default' means use the background of the default face.
  2901. `auto' means use the background from the text face.
  2902. :scale a scaling factor for the size of the images, to get more pixels
  2903. :html-foreground, :html-background, :html-scale
  2904. the same numbers for HTML export.
  2905. :matchers a list indicating which matchers should be used to
  2906. find LaTeX fragments. Valid members of this list are:
  2907. \"begin\" find environments
  2908. \"$1\" find single characters surrounded by $.$
  2909. \"$\" find math expressions surrounded by $...$
  2910. \"$$\" find math expressions surrounded by $$....$$
  2911. \"\\(\" find math expressions surrounded by \\(...\\)
  2912. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2913. :group 'org-latex
  2914. :type 'plist)
  2915. (defcustom org-format-latex-signal-error t
  2916. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2917. When nil, just push out a message."
  2918. :group 'org-latex
  2919. :version "24.1"
  2920. :type 'boolean)
  2921. (defcustom org-latex-to-mathml-jar-file nil
  2922. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  2923. Use this to specify additional executable file say a jar file.
  2924. When using MathToWeb as the converter, specify the full-path to
  2925. your mathtoweb.jar file."
  2926. :group 'org-latex
  2927. :version "24.1"
  2928. :type '(choice
  2929. (const :tag "None" nil)
  2930. (file :tag "JAR file" :must-match t)))
  2931. (defcustom org-latex-to-mathml-convert-command nil
  2932. "Command to convert LaTeX fragments to MathML.
  2933. Replace format-specifiers in the command as noted below and use
  2934. `shell-command' to convert LaTeX to MathML.
  2935. %j: Executable file in fully expanded form as specified by
  2936. `org-latex-to-mathml-jar-file'.
  2937. %I: Input LaTeX file in fully expanded form
  2938. %o: Output MathML file
  2939. This command is used by `org-create-math-formula'.
  2940. When using MathToWeb as the converter, set this to
  2941. \"java -jar %j -unicode -force -df %o %I\"."
  2942. :group 'org-latex
  2943. :version "24.1"
  2944. :type '(choice
  2945. (const :tag "None" nil)
  2946. (string :tag "\nShell command")))
  2947. (defcustom org-latex-create-formula-image-program 'dvipng
  2948. "Program to convert LaTeX fragments with.
  2949. dvipng Process the LaTeX fragments to dvi file, then convert
  2950. dvi files to png files using dvipng.
  2951. This will also include processing of non-math environments.
  2952. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  2953. to convert pdf files to png files"
  2954. :group 'org-latex
  2955. :version "24.1"
  2956. :type '(choice
  2957. (const :tag "dvipng" dvipng)
  2958. (const :tag "imagemagick" imagemagick)))
  2959. (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
  2960. "Path to store latex preview images. A relative path here creates many
  2961. directories relative to the processed org files paths. An absolute path
  2962. puts all preview images at the same place."
  2963. :group 'org-latex
  2964. :version "24.3"
  2965. :type 'string)
  2966. (defun org-format-latex-mathml-available-p ()
  2967. "Return t if `org-latex-to-mathml-convert-command' is usable."
  2968. (save-match-data
  2969. (when (and (boundp 'org-latex-to-mathml-convert-command)
  2970. org-latex-to-mathml-convert-command)
  2971. (let ((executable (car (split-string
  2972. org-latex-to-mathml-convert-command))))
  2973. (when (executable-find executable)
  2974. (if (string-match
  2975. "%j" org-latex-to-mathml-convert-command)
  2976. (file-readable-p org-latex-to-mathml-jar-file)
  2977. t))))))
  2978. (defcustom org-format-latex-header "\\documentclass{article}
  2979. \\usepackage[usenames]{color}
  2980. \\usepackage{amsmath}
  2981. \\usepackage[mathscr]{eucal}
  2982. \\pagestyle{empty} % do not remove
  2983. \[PACKAGES]
  2984. \[DEFAULT-PACKAGES]
  2985. % The settings below are copied from fullpage.sty
  2986. \\setlength{\\textwidth}{\\paperwidth}
  2987. \\addtolength{\\textwidth}{-3cm}
  2988. \\setlength{\\oddsidemargin}{1.5cm}
  2989. \\addtolength{\\oddsidemargin}{-2.54cm}
  2990. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2991. \\setlength{\\textheight}{\\paperheight}
  2992. \\addtolength{\\textheight}{-\\headheight}
  2993. \\addtolength{\\textheight}{-\\headsep}
  2994. \\addtolength{\\textheight}{-\\footskip}
  2995. \\addtolength{\\textheight}{-3cm}
  2996. \\setlength{\\topmargin}{1.5cm}
  2997. \\addtolength{\\topmargin}{-2.54cm}"
  2998. "The document header used for processing LaTeX fragments.
  2999. It is imperative that this header make sure that no page number
  3000. appears on the page. The package defined in the variables
  3001. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  3002. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  3003. will be appended."
  3004. :group 'org-latex
  3005. :type 'string)
  3006. (defvar org-format-latex-header-extra nil)
  3007. (defun org-set-packages-alist (var val)
  3008. "Set the packages alist and make sure it has 3 elements per entry."
  3009. (set var (mapcar (lambda (x)
  3010. (if (and (consp x) (= (length x) 2))
  3011. (list (car x) (nth 1 x) t)
  3012. x))
  3013. val)))
  3014. (defun org-get-packages-alist (var)
  3015. "Get the packages alist and make sure it has 3 elements per entry."
  3016. (mapcar (lambda (x)
  3017. (if (and (consp x) (= (length x) 2))
  3018. (list (car x) (nth 1 x) t)
  3019. x))
  3020. (default-value var)))
  3021. ;; The following variables are defined here because is it also used
  3022. ;; when formatting latex fragments. Originally it was part of the
  3023. ;; LaTeX exporter, which is why the name includes "export".
  3024. (defcustom org-export-latex-default-packages-alist
  3025. '(("AUTO" "inputenc" t)
  3026. ("T1" "fontenc" t)
  3027. ("" "fixltx2e" nil)
  3028. ("" "graphicx" t)
  3029. ("" "longtable" nil)
  3030. ("" "float" nil)
  3031. ("" "wrapfig" nil)
  3032. ("" "soul" t)
  3033. ("" "textcomp" t)
  3034. ("" "marvosym" t)
  3035. ("" "wasysym" t)
  3036. ("" "latexsym" t)
  3037. ("" "amssymb" t)
  3038. ("" "hyperref" nil)
  3039. "\\tolerance=1000"
  3040. )
  3041. "Alist of default packages to be inserted in the header.
  3042. Change this only if one of the packages here causes an incompatibility
  3043. with another package you are using.
  3044. The packages in this list are needed by one part or another of Org-mode
  3045. to function properly.
  3046. - inputenc, fontenc: for basic font and character selection
  3047. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  3048. for interpreting the entities in `org-entities'. You can skip some of these
  3049. packages if you don't use any of the symbols in it.
  3050. - graphicx: for including images
  3051. - float, wrapfig: for figure placement
  3052. - longtable: for long tables
  3053. - hyperref: for cross references
  3054. Therefore you should not modify this variable unless you know what you
  3055. are doing. The one reason to change it anyway is that you might be loading
  3056. some other package that conflicts with one of the default packages.
  3057. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  3058. If SNIPPET-FLAG is t, the package also needs to be included when
  3059. compiling LaTeX snippets into images for inclusion into HTML."
  3060. :group 'org-export-latex
  3061. :set 'org-set-packages-alist
  3062. :get 'org-get-packages-alist
  3063. :version "24.1"
  3064. :type '(repeat
  3065. (choice
  3066. (list :tag "options/package pair"
  3067. (string :tag "options")
  3068. (string :tag "package")
  3069. (boolean :tag "Snippet"))
  3070. (string :tag "A line of LaTeX"))))
  3071. (defcustom org-export-latex-packages-alist nil
  3072. "Alist of packages to be inserted in every LaTeX header.
  3073. These will be inserted after `org-export-latex-default-packages-alist'.
  3074. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  3075. SNIPPET-FLAG, when t, indicates that this package is also needed when
  3076. turning LaTeX snippets into images for inclusion into HTML.
  3077. Make sure that you only list packages here which:
  3078. - you want in every file
  3079. - do not conflict with the default packages in
  3080. `org-export-latex-default-packages-alist'
  3081. - do not conflict with the setup in `org-format-latex-header'."
  3082. :group 'org-export-latex
  3083. :set 'org-set-packages-alist
  3084. :get 'org-get-packages-alist
  3085. :type '(repeat
  3086. (choice
  3087. (list :tag "options/package pair"
  3088. (string :tag "options")
  3089. (string :tag "package")
  3090. (boolean :tag "Snippet"))
  3091. (string :tag "A line of LaTeX"))))
  3092. (defgroup org-appearance nil
  3093. "Settings for Org-mode appearance."
  3094. :tag "Org Appearance"
  3095. :group 'org)
  3096. (defcustom org-level-color-stars-only nil
  3097. "Non-nil means fontify only the stars in each headline.
  3098. When nil, the entire headline is fontified.
  3099. Changing it requires restart of `font-lock-mode' to become effective
  3100. also in regions already fontified."
  3101. :group 'org-appearance
  3102. :type 'boolean)
  3103. (defcustom org-hide-leading-stars nil
  3104. "Non-nil means hide the first N-1 stars in a headline.
  3105. This works by using the face `org-hide' for these stars. This
  3106. face is white for a light background, and black for a dark
  3107. background. You may have to customize the face `org-hide' to
  3108. make this work.
  3109. Changing it requires restart of `font-lock-mode' to become effective
  3110. also in regions already fontified.
  3111. You may also set this on a per-file basis by adding one of the following
  3112. lines to the buffer:
  3113. #+STARTUP: hidestars
  3114. #+STARTUP: showstars"
  3115. :group 'org-appearance
  3116. :type 'boolean)
  3117. (defcustom org-hidden-keywords nil
  3118. "List of symbols corresponding to keywords to be hidden the org buffer.
  3119. For example, a value '(title) for this list will make the document's title
  3120. appear in the buffer without the initial #+TITLE: keyword."
  3121. :group 'org-appearance
  3122. :version "24.1"
  3123. :type '(set (const :tag "#+AUTHOR" author)
  3124. (const :tag "#+DATE" date)
  3125. (const :tag "#+EMAIL" email)
  3126. (const :tag "#+TITLE" title)))
  3127. (defcustom org-custom-properties nil
  3128. "List of properties (as strings) with a special meaning.
  3129. The default use of these custom properties is to let the user
  3130. hide them with `org-toggle-custom-properties-visibility'."
  3131. :group 'org-properties
  3132. :group 'org-appearance
  3133. :version "24.3"
  3134. :type '(repeat (string :tag "Property Name")))
  3135. (defcustom org-fontify-done-headline nil
  3136. "Non-nil means change the face of a headline if it is marked DONE.
  3137. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3138. When this is non-nil, the headline after the keyword is set to the
  3139. `org-headline-done' as an additional indication."
  3140. :group 'org-appearance
  3141. :type 'boolean)
  3142. (defcustom org-fontify-emphasized-text t
  3143. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3144. Changing this variable requires a restart of Emacs to take effect."
  3145. :group 'org-appearance
  3146. :type 'boolean)
  3147. (defcustom org-fontify-whole-heading-line nil
  3148. "Non-nil means fontify the whole line for headings.
  3149. This is useful when setting a background color for the
  3150. org-level-* faces."
  3151. :group 'org-appearance
  3152. :type 'boolean)
  3153. (defcustom org-highlight-latex-fragments-and-specials nil
  3154. "Non-nil means fontify what is treated specially by the exporters."
  3155. :group 'org-appearance
  3156. :type 'boolean)
  3157. (defcustom org-hide-emphasis-markers nil
  3158. "Non-nil mean font-lock should hide the emphasis marker characters."
  3159. :group 'org-appearance
  3160. :type 'boolean)
  3161. (defcustom org-pretty-entities nil
  3162. "Non-nil means show entities as UTF8 characters.
  3163. When nil, the \\name form remains in the buffer."
  3164. :group 'org-appearance
  3165. :version "24.1"
  3166. :type 'boolean)
  3167. (defcustom org-pretty-entities-include-sub-superscripts t
  3168. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3169. :group 'org-appearance
  3170. :version "24.1"
  3171. :type 'boolean)
  3172. (defvar org-emph-re nil
  3173. "Regular expression for matching emphasis.
  3174. After a match, the match groups contain these elements:
  3175. 0 The match of the full regular expression, including the characters
  3176. before and after the proper match
  3177. 1 The character before the proper match, or empty at beginning of line
  3178. 2 The proper match, including the leading and trailing markers
  3179. 3 The leading marker like * or /, indicating the type of highlighting
  3180. 4 The text between the emphasis markers, not including the markers
  3181. 5 The character after the match, empty at the end of a line")
  3182. (defvar org-verbatim-re nil
  3183. "Regular expression for matching verbatim text.")
  3184. (defvar org-emphasis-regexp-components) ; defined just below
  3185. (defvar org-emphasis-alist) ; defined just below
  3186. (defun org-set-emph-re (var val)
  3187. "Set variable and compute the emphasis regular expression."
  3188. (set var val)
  3189. (when (and (boundp 'org-emphasis-alist)
  3190. (boundp 'org-emphasis-regexp-components)
  3191. org-emphasis-alist org-emphasis-regexp-components)
  3192. (let* ((e org-emphasis-regexp-components)
  3193. (pre (car e))
  3194. (post (nth 1 e))
  3195. (border (nth 2 e))
  3196. (body (nth 3 e))
  3197. (nl (nth 4 e))
  3198. (body1 (concat body "*?"))
  3199. (markers (mapconcat 'car org-emphasis-alist ""))
  3200. (vmarkers (mapconcat
  3201. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  3202. org-emphasis-alist "")))
  3203. ;; make sure special characters appear at the right position in the class
  3204. (if (string-match "\\^" markers)
  3205. (setq markers (concat (replace-match "" t t markers) "^")))
  3206. (if (string-match "-" markers)
  3207. (setq markers (concat (replace-match "" t t markers) "-")))
  3208. (if (string-match "\\^" vmarkers)
  3209. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3210. (if (string-match "-" vmarkers)
  3211. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3212. (if (> nl 0)
  3213. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3214. (int-to-string nl) "\\}")))
  3215. ;; Make the regexp
  3216. (setq org-emph-re
  3217. (concat "\\([" pre "]\\|^\\)"
  3218. "\\("
  3219. "\\([" markers "]\\)"
  3220. "\\("
  3221. "[^" border "]\\|"
  3222. "[^" border "]"
  3223. body1
  3224. "[^" border "]"
  3225. "\\)"
  3226. "\\3\\)"
  3227. "\\([" post "]\\|$\\)"))
  3228. (setq org-verbatim-re
  3229. (concat "\\([" pre "]\\|^\\)"
  3230. "\\("
  3231. "\\([" vmarkers "]\\)"
  3232. "\\("
  3233. "[^" border "]\\|"
  3234. "[^" border "]"
  3235. body1
  3236. "[^" border "]"
  3237. "\\)"
  3238. "\\3\\)"
  3239. "\\([" post "]\\|$\\)")))))
  3240. (defcustom org-emphasis-regexp-components
  3241. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3242. "Components used to build the regular expression for emphasis.
  3243. This is a list with five entries. Terminology: In an emphasis string
  3244. like \" *strong word* \", we call the initial space PREMATCH, the final
  3245. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3246. and \"trong wor\" is the body. The different components in this variable
  3247. specify what is allowed/forbidden in each part:
  3248. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3249. post Chars allowed as postmatch. End of line will be allowed too.
  3250. border The chars *forbidden* as border characters.
  3251. body-regexp A regexp like \".\" to match a body character. Don't use
  3252. non-shy groups here, and don't allow newline here.
  3253. newline The maximum number of newlines allowed in an emphasis exp.
  3254. Use customize to modify this, or restart Emacs after changing it."
  3255. :group 'org-appearance
  3256. :set 'org-set-emph-re
  3257. :type '(list
  3258. (sexp :tag "Allowed chars in pre ")
  3259. (sexp :tag "Allowed chars in post ")
  3260. (sexp :tag "Forbidden chars in border ")
  3261. (sexp :tag "Regexp for body ")
  3262. (integer :tag "number of newlines allowed")
  3263. (option (boolean :tag "Please ignore this button"))))
  3264. (defcustom org-emphasis-alist
  3265. `(("*" bold "<b>" "</b>")
  3266. ("/" italic "<i>" "</i>")
  3267. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  3268. ("=" org-code "<code>" "</code>" verbatim)
  3269. ("~" org-verbatim "<code>" "</code>" verbatim)
  3270. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  3271. "<del>" "</del>")
  3272. )
  3273. "Special syntax for emphasized text.
  3274. Text starting and ending with a special character will be emphasized, for
  3275. example *bold*, _underlined_ and /italic/. This variable sets the marker
  3276. characters, the face to be used by font-lock for highlighting in Org-mode
  3277. Emacs buffers, and the HTML tags to be used for this.
  3278. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  3279. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  3280. Use customize to modify this, or restart Emacs after changing it."
  3281. :group 'org-appearance
  3282. :set 'org-set-emph-re
  3283. :type '(repeat
  3284. (list
  3285. (string :tag "Marker character")
  3286. (choice
  3287. (face :tag "Font-lock-face")
  3288. (plist :tag "Face property list"))
  3289. (string :tag "HTML start tag")
  3290. (string :tag "HTML end tag")
  3291. (option (const verbatim)))))
  3292. (defvar org-protecting-blocks
  3293. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  3294. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3295. This is needed for font-lock setup.")
  3296. ;;; Miscellaneous options
  3297. (defgroup org-completion nil
  3298. "Completion in Org-mode."
  3299. :tag "Org Completion"
  3300. :group 'org)
  3301. (defcustom org-completion-use-ido nil
  3302. "Non-nil means use ido completion wherever possible.
  3303. Note that `ido-mode' must be active for this variable to be relevant.
  3304. If you decide to turn this variable on, you might well want to turn off
  3305. `org-outline-path-complete-in-steps'.
  3306. See also `org-completion-use-iswitchb'."
  3307. :group 'org-completion
  3308. :type 'boolean)
  3309. (defcustom org-completion-use-iswitchb nil
  3310. "Non-nil means use iswitchb completion wherever possible.
  3311. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3312. If you decide to turn this variable on, you might well want to turn off
  3313. `org-outline-path-complete-in-steps'.
  3314. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3315. :group 'org-completion
  3316. :type 'boolean)
  3317. (defcustom org-completion-fallback-command 'hippie-expand
  3318. "The expansion command called by \\[pcomplete] in normal context.
  3319. Normal means, no org-mode-specific context."
  3320. :group 'org-completion
  3321. :type 'function)
  3322. ;;; Functions and variables from their packages
  3323. ;; Declared here to avoid compiler warnings
  3324. ;; XEmacs only
  3325. (defvar outline-mode-menu-heading)
  3326. (defvar outline-mode-menu-show)
  3327. (defvar outline-mode-menu-hide)
  3328. (defvar zmacs-regions) ; XEmacs regions
  3329. ;; Emacs only
  3330. (defvar mark-active)
  3331. ;; Various packages
  3332. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3333. (declare-function calendar-forward-day "cal-move" (arg))
  3334. (declare-function calendar-goto-date "cal-move" (date))
  3335. (declare-function calendar-goto-today "cal-move" ())
  3336. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3337. (defvar calc-embedded-close-formula)
  3338. (defvar calc-embedded-open-formula)
  3339. (declare-function cdlatex-tab "ext:cdlatex" ())
  3340. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3341. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3342. (defvar font-lock-unfontify-region-function)
  3343. (declare-function iswitchb-read-buffer "iswitchb"
  3344. (prompt &optional default require-match start matches-set))
  3345. (defvar iswitchb-temp-buflist)
  3346. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3347. (defvar org-agenda-tags-todo-honor-ignore-options)
  3348. (declare-function org-agenda-skip "org-agenda" ())
  3349. (declare-function
  3350. org-agenda-format-item "org-agenda"
  3351. (extra txt &optional level category tags dotime noprefix remove-re habitp))
  3352. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3353. (declare-function org-agenda-change-all-lines "org-agenda"
  3354. (newhead hdmarker &optional fixface just-this))
  3355. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3356. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3357. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3358. (beg end))
  3359. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3360. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3361. "org-agenda" (&optional end))
  3362. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3363. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3364. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3365. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3366. (declare-function org-indent-mode "org-indent" (&optional arg))
  3367. (declare-function parse-time-string "parse-time" (string))
  3368. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3369. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3370. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3371. (defvar remember-data-file)
  3372. (defvar texmathp-why)
  3373. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3374. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3375. (defvar w3m-current-url)
  3376. (defvar w3m-current-title)
  3377. (defvar org-latex-regexps)
  3378. ;;; Autoload and prepare some org modules
  3379. ;; Some table stuff that needs to be defined here, because it is used
  3380. ;; by the functions setting up org-mode or checking for table context.
  3381. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3382. "Detect an org-type or table-type table.")
  3383. (defconst org-table-line-regexp "^[ \t]*|"
  3384. "Detect an org-type table line.")
  3385. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3386. "Detect an org-type table line.")
  3387. (defconst org-table-hline-regexp "^[ \t]*|-"
  3388. "Detect an org-type table hline.")
  3389. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3390. "Detect a table-type table hline.")
  3391. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3392. "Detect the first line outside a table when searching from within it.
  3393. This works for both table types.")
  3394. ;; Autoload the functions in org-table.el that are needed by functions here.
  3395. (eval-and-compile
  3396. (org-autoload "org-table"
  3397. '(org-table-begin org-table-blank-field org-table-end)))
  3398. ;;;###autoload
  3399. (defun turn-on-orgtbl ()
  3400. "Unconditionally turn on `orgtbl-mode'."
  3401. (require 'org-table)
  3402. (orgtbl-mode 1))
  3403. (defun org-at-table-p (&optional table-type)
  3404. "Return t if the cursor is inside an org-type table.
  3405. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3406. (if org-enable-table-editor
  3407. (save-excursion
  3408. (beginning-of-line 1)
  3409. (looking-at (if table-type org-table-any-line-regexp
  3410. org-table-line-regexp)))
  3411. nil))
  3412. (defsubst org-table-p () (org-at-table-p))
  3413. (defun org-at-table.el-p ()
  3414. "Return t if and only if we are at a table.el table."
  3415. (and (org-at-table-p 'any)
  3416. (save-excursion
  3417. (goto-char (org-table-begin 'any))
  3418. (looking-at org-table1-hline-regexp))))
  3419. (defun org-table-recognize-table.el ()
  3420. "If there is a table.el table nearby, recognize it and move into it."
  3421. (if org-table-tab-recognizes-table.el
  3422. (if (org-at-table.el-p)
  3423. (progn
  3424. (beginning-of-line 1)
  3425. (if (looking-at org-table-dataline-regexp)
  3426. nil
  3427. (if (looking-at org-table1-hline-regexp)
  3428. (progn
  3429. (beginning-of-line 2)
  3430. (if (looking-at org-table-any-border-regexp)
  3431. (beginning-of-line -1)))))
  3432. (if (re-search-forward "|" (org-table-end t) t)
  3433. (progn
  3434. (require 'table)
  3435. (if (table--at-cell-p (point))
  3436. t
  3437. (message "recognizing table.el table...")
  3438. (table-recognize-table)
  3439. (message "recognizing table.el table...done")))
  3440. (error "This should not happen"))
  3441. t)
  3442. nil)
  3443. nil))
  3444. (defun org-at-table-hline-p ()
  3445. "Return t if the cursor is inside a hline in a table."
  3446. (if org-enable-table-editor
  3447. (save-excursion
  3448. (beginning-of-line 1)
  3449. (looking-at org-table-hline-regexp))
  3450. nil))
  3451. (defvar org-table-clean-did-remove-column nil)
  3452. (defun org-table-map-tables (function &optional quietly)
  3453. "Apply FUNCTION to the start of all tables in the buffer."
  3454. (save-excursion
  3455. (save-restriction
  3456. (widen)
  3457. (goto-char (point-min))
  3458. (while (re-search-forward org-table-any-line-regexp nil t)
  3459. (unless quietly
  3460. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3461. (beginning-of-line 1)
  3462. (when (and (looking-at org-table-line-regexp)
  3463. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3464. (not (org-in-block-p '("src" "example"))))
  3465. (save-excursion (funcall function))
  3466. (or (looking-at org-table-line-regexp)
  3467. (forward-char 1)))
  3468. (re-search-forward org-table-any-border-regexp nil 1))))
  3469. (unless quietly (message "Mapping tables: done")))
  3470. ;; Declare and autoload functions from org-exp.el & Co
  3471. (declare-function org-default-export-plist "org-exp")
  3472. (declare-function org-infile-export-plist "org-exp")
  3473. (declare-function org-get-current-options "org-exp")
  3474. ;; Declare and autoload functions from org-agenda.el
  3475. (eval-and-compile
  3476. (org-autoload "org-agenda"
  3477. '(org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3478. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
  3479. (declare-function org-clock-update-mode-line "org-clock" ())
  3480. (declare-function org-resolve-clocks "org-clock"
  3481. (&optional also-non-dangling-p prompt last-valid))
  3482. (defvar org-clock-start-time)
  3483. (defvar org-clock-marker (make-marker)
  3484. "Marker recording the last clock-in.")
  3485. (defvar org-clock-hd-marker (make-marker)
  3486. "Marker recording the last clock-in, but the headline position.")
  3487. (defvar org-clock-heading ""
  3488. "The heading of the current clock entry.")
  3489. (defun org-clock-is-active ()
  3490. "Return non-nil if clock is currently running.
  3491. The return value is actually the clock marker."
  3492. (marker-buffer org-clock-marker))
  3493. (eval-and-compile
  3494. (org-autoload "org-clock" '(org-clock-remove-overlays
  3495. org-clock-update-time-maybe
  3496. org-clocktable-shift)))
  3497. (defun org-check-running-clock ()
  3498. "Check if the current buffer contains the running clock.
  3499. If yes, offer to stop it and to save the buffer with the changes."
  3500. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3501. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3502. (buffer-name))))
  3503. (org-clock-out)
  3504. (when (y-or-n-p "Save changed buffer?")
  3505. (save-buffer))))
  3506. (defun org-clocktable-try-shift (dir n)
  3507. "Check if this line starts a clock table, if yes, shift the time block."
  3508. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3509. (org-clocktable-shift dir n)))
  3510. ;;;###autoload
  3511. (defun org-clock-persistence-insinuate ()
  3512. "Set up hooks for clock persistence."
  3513. (require 'org-clock)
  3514. (add-hook 'org-mode-hook 'org-clock-load)
  3515. (add-hook 'kill-emacs-hook 'org-clock-save))
  3516. ;; Define the variable already here, to make sure we have it.
  3517. (defvar org-indent-mode nil
  3518. "Non-nil if Org-Indent mode is enabled.
  3519. Use the command `org-indent-mode' to change this variable.")
  3520. ;; Autoload archiving code
  3521. ;; The stuff that is needed for cycling and tags has to be defined here.
  3522. (defgroup org-archive nil
  3523. "Options concerning archiving in Org-mode."
  3524. :tag "Org Archive"
  3525. :group 'org-structure)
  3526. (defcustom org-archive-location "%s_archive::"
  3527. "The location where subtrees should be archived.
  3528. The value of this variable is a string, consisting of two parts,
  3529. separated by a double-colon. The first part is a filename and
  3530. the second part is a headline.
  3531. When the filename is omitted, archiving happens in the same file.
  3532. %s in the filename will be replaced by the current file
  3533. name (without the directory part). Archiving to a different file
  3534. is useful to keep archived entries from contributing to the
  3535. Org-mode Agenda.
  3536. The archived entries will be filed as subtrees of the specified
  3537. headline. When the headline is omitted, the subtrees are simply
  3538. filed away at the end of the file, as top-level entries. Also in
  3539. the heading you can use %s to represent the file name, this can be
  3540. useful when using the same archive for a number of different files.
  3541. Here are a few examples:
  3542. \"%s_archive::\"
  3543. If the current file is Projects.org, archive in file
  3544. Projects.org_archive, as top-level trees. This is the default.
  3545. \"::* Archived Tasks\"
  3546. Archive in the current file, under the top-level headline
  3547. \"* Archived Tasks\".
  3548. \"~/org/archive.org::\"
  3549. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3550. \"~/org/archive.org::* From %s\"
  3551. Archive in file ~/org/archive.org (absolute path), under headlines
  3552. \"From FILENAME\" where file name is the current file name.
  3553. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3554. The \"datetree/\" string is special, signifying to archive
  3555. items to the datetree. Items are placed in either the CLOSED
  3556. date of the item, or the current date if there is no CLOSED date.
  3557. The heading will be a subentry to the current date. There doesn't
  3558. need to be a heading, but there always needs to be a slash after
  3559. datetree. For example, to store archived items directly in the
  3560. datetree, use \"~/org/datetree.org::datetree/\".
  3561. \"basement::** Finished Tasks\"
  3562. Archive in file ./basement (relative path), as level 3 trees
  3563. below the level 2 heading \"** Finished Tasks\".
  3564. You may set this option on a per-file basis by adding to the buffer a
  3565. line like
  3566. #+ARCHIVE: basement::** Finished Tasks
  3567. You may also define it locally for a subtree by setting an ARCHIVE property
  3568. in the entry. If such a property is found in an entry, or anywhere up
  3569. the hierarchy, it will be used."
  3570. :group 'org-archive
  3571. :type 'string)
  3572. (defcustom org-archive-tag "ARCHIVE"
  3573. "The tag that marks a subtree as archived.
  3574. An archived subtree does not open during visibility cycling, and does
  3575. not contribute to the agenda listings.
  3576. After changing this, font-lock must be restarted in the relevant buffers to
  3577. get the proper fontification."
  3578. :group 'org-archive
  3579. :group 'org-keywords
  3580. :type 'string)
  3581. (defcustom org-agenda-skip-archived-trees t
  3582. "Non-nil means the agenda will skip any items located in archived trees.
  3583. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3584. variable is no longer recommended, you should leave it at the value t.
  3585. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3586. :group 'org-archive
  3587. :group 'org-agenda-skip
  3588. :type 'boolean)
  3589. (defcustom org-columns-skip-archived-trees t
  3590. "Non-nil means ignore archived trees when creating column view."
  3591. :group 'org-archive
  3592. :group 'org-properties
  3593. :type 'boolean)
  3594. (defcustom org-cycle-open-archived-trees nil
  3595. "Non-nil means `org-cycle' will open archived trees.
  3596. An archived tree is a tree marked with the tag ARCHIVE.
  3597. When nil, archived trees will stay folded. You can still open them with
  3598. normal outline commands like `show-all', but not with the cycling commands."
  3599. :group 'org-archive
  3600. :group 'org-cycle
  3601. :type 'boolean)
  3602. (defcustom org-sparse-tree-open-archived-trees nil
  3603. "Non-nil means sparse tree construction shows matches in archived trees.
  3604. When nil, matches in these trees are highlighted, but the trees are kept in
  3605. collapsed state."
  3606. :group 'org-archive
  3607. :group 'org-sparse-trees
  3608. :type 'boolean)
  3609. (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
  3610. "The default date type when building a sparse tree.
  3611. When this is nil, a date is a scheduled or a deadline timestamp.
  3612. Otherwise, these types are allowed:
  3613. all: all timestamps
  3614. active: only active timestamps (<...>)
  3615. inactive: only inactive timestamps (<...)
  3616. scheduled: only scheduled timestamps
  3617. deadline: only deadline timestamps"
  3618. :type '(choice (const :tag "Scheduled or deadline" 'scheduled-or-deadline)
  3619. (const :tag "All timestamps" all)
  3620. (const :tag "Only active timestamps" active)
  3621. (const :tag "Only inactive timestamps" inactive)
  3622. (const :tag "Only scheduled timestamps" scheduled)
  3623. (const :tag "Only deadline timestamps" deadline))
  3624. :version "24.3"
  3625. :group 'org-sparse-trees)
  3626. (defun org-cycle-hide-archived-subtrees (state)
  3627. "Re-hide all archived subtrees after a visibility state change."
  3628. (when (and (not org-cycle-open-archived-trees)
  3629. (not (memq state '(overview folded))))
  3630. (save-excursion
  3631. (let* ((globalp (memq state '(contents all)))
  3632. (beg (if globalp (point-min) (point)))
  3633. (end (if globalp (point-max) (org-end-of-subtree t))))
  3634. (org-hide-archived-subtrees beg end)
  3635. (goto-char beg)
  3636. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3637. (message "%s" (substitute-command-keys
  3638. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3639. (defun org-force-cycle-archived ()
  3640. "Cycle subtree even if it is archived."
  3641. (interactive)
  3642. (setq this-command 'org-cycle)
  3643. (let ((org-cycle-open-archived-trees t))
  3644. (call-interactively 'org-cycle)))
  3645. (defun org-hide-archived-subtrees (beg end)
  3646. "Re-hide all archived subtrees after a visibility state change."
  3647. (save-excursion
  3648. (let* ((re (concat ":" org-archive-tag ":")))
  3649. (goto-char beg)
  3650. (while (re-search-forward re end t)
  3651. (when (org-at-heading-p)
  3652. (org-flag-subtree t)
  3653. (org-end-of-subtree t))))))
  3654. (declare-function outline-end-of-heading "outline" ())
  3655. (declare-function outline-flag-region "outline" (from to flag))
  3656. (defun org-flag-subtree (flag)
  3657. (save-excursion
  3658. (org-back-to-heading t)
  3659. (outline-end-of-heading)
  3660. (outline-flag-region (point)
  3661. (progn (org-end-of-subtree t) (point))
  3662. flag)))
  3663. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3664. (eval-and-compile
  3665. (org-autoload "org-archive"
  3666. '(org-add-archive-files)))
  3667. ;; Autoload Column View Code
  3668. (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
  3669. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  3670. (declare-function org-columns-compute "org-colview" (property))
  3671. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3672. '(org-columns-number-to-string
  3673. org-columns-get-format-and-top-level
  3674. org-columns-compute
  3675. org-columns-remove-overlays))
  3676. ;; Autoload ID code
  3677. (declare-function org-id-store-link "org-id")
  3678. (declare-function org-id-locations-load "org-id")
  3679. (declare-function org-id-locations-save "org-id")
  3680. (defvar org-id-track-globally)
  3681. (org-autoload "org-id"
  3682. '(org-id-new
  3683. org-id-copy
  3684. org-id-get-with-outline-path-completion
  3685. org-id-get-with-outline-drilling))
  3686. ;;; Variables for pre-computed regular expressions, all buffer local
  3687. (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
  3688. "Matches first line of a hidden block.")
  3689. (make-variable-buffer-local 'org-drawer-regexp)
  3690. (defvar org-todo-regexp nil
  3691. "Matches any of the TODO state keywords.")
  3692. (make-variable-buffer-local 'org-todo-regexp)
  3693. (defvar org-not-done-regexp nil
  3694. "Matches any of the TODO state keywords except the last one.")
  3695. (make-variable-buffer-local 'org-not-done-regexp)
  3696. (defvar org-not-done-heading-regexp nil
  3697. "Matches a TODO headline that is not done.")
  3698. (make-variable-buffer-local 'org-not-done-regexp)
  3699. (defvar org-todo-line-regexp nil
  3700. "Matches a headline and puts TODO state into group 2 if present.")
  3701. (make-variable-buffer-local 'org-todo-line-regexp)
  3702. (defvar org-complex-heading-regexp nil
  3703. "Matches a headline and puts everything into groups:
  3704. group 1: the stars
  3705. group 2: The todo keyword, maybe
  3706. group 3: Priority cookie
  3707. group 4: True headline
  3708. group 5: Tags")
  3709. (make-variable-buffer-local 'org-complex-heading-regexp)
  3710. (defvar org-complex-heading-regexp-format nil
  3711. "Printf format to make regexp to match an exact headline.
  3712. This regexp will match the headline of any node which has the
  3713. exact headline text that is put into the format, but may have any
  3714. TODO state, priority and tags.")
  3715. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3716. (defvar org-todo-line-tags-regexp nil
  3717. "Matches a headline and puts TODO state into group 2 if present.
  3718. Also put tags into group 4 if tags are present.")
  3719. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3720. (defvar org-ds-keyword-length 12
  3721. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  3722. (make-variable-buffer-local 'org-ds-keyword-length)
  3723. (defvar org-deadline-regexp nil
  3724. "Matches the DEADLINE keyword.")
  3725. (make-variable-buffer-local 'org-deadline-regexp)
  3726. (defvar org-deadline-time-regexp nil
  3727. "Matches the DEADLINE keyword together with a time stamp.")
  3728. (make-variable-buffer-local 'org-deadline-time-regexp)
  3729. (defvar org-deadline-line-regexp nil
  3730. "Matches the DEADLINE keyword and the rest of the line.")
  3731. (make-variable-buffer-local 'org-deadline-line-regexp)
  3732. (defvar org-scheduled-regexp nil
  3733. "Matches the SCHEDULED keyword.")
  3734. (make-variable-buffer-local 'org-scheduled-regexp)
  3735. (defvar org-scheduled-time-regexp nil
  3736. "Matches the SCHEDULED keyword together with a time stamp.")
  3737. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3738. (defvar org-closed-time-regexp nil
  3739. "Matches the CLOSED keyword together with a time stamp.")
  3740. (make-variable-buffer-local 'org-closed-time-regexp)
  3741. (defvar org-keyword-time-regexp nil
  3742. "Matches any of the 4 keywords, together with the time stamp.")
  3743. (make-variable-buffer-local 'org-keyword-time-regexp)
  3744. (defvar org-keyword-time-not-clock-regexp nil
  3745. "Matches any of the 3 keywords, together with the time stamp.")
  3746. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3747. (defvar org-maybe-keyword-time-regexp nil
  3748. "Matches a timestamp, possibly preceded by a keyword.")
  3749. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3750. (defvar org-all-time-keywords nil
  3751. "List of time keywords.")
  3752. (make-variable-buffer-local 'org-all-time-keywords)
  3753. (defconst org-plain-time-of-day-regexp
  3754. (concat
  3755. "\\(\\<[012]?[0-9]"
  3756. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3757. "\\(--?"
  3758. "\\(\\<[012]?[0-9]"
  3759. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3760. "\\)?")
  3761. "Regular expression to match a plain time or time range.
  3762. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3763. groups carry important information:
  3764. 0 the full match
  3765. 1 the first time, range or not
  3766. 8 the second time, if it is a range.")
  3767. (defconst org-plain-time-extension-regexp
  3768. (concat
  3769. "\\(\\<[012]?[0-9]"
  3770. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3771. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3772. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3773. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3774. groups carry important information:
  3775. 0 the full match
  3776. 7 hours of duration
  3777. 9 minutes of duration")
  3778. (defconst org-stamp-time-of-day-regexp
  3779. (concat
  3780. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3781. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3782. "\\(--?"
  3783. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3784. "Regular expression to match a timestamp time or time range.
  3785. After a match, the following groups carry important information:
  3786. 0 the full match
  3787. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3788. 2 the first time, range or not
  3789. 4 the second time, if it is a range.")
  3790. (defconst org-startup-options
  3791. '(("fold" org-startup-folded t)
  3792. ("overview" org-startup-folded t)
  3793. ("nofold" org-startup-folded nil)
  3794. ("showall" org-startup-folded nil)
  3795. ("showeverything" org-startup-folded showeverything)
  3796. ("content" org-startup-folded content)
  3797. ("indent" org-startup-indented t)
  3798. ("noindent" org-startup-indented nil)
  3799. ("hidestars" org-hide-leading-stars t)
  3800. ("showstars" org-hide-leading-stars nil)
  3801. ("odd" org-odd-levels-only t)
  3802. ("oddeven" org-odd-levels-only nil)
  3803. ("align" org-startup-align-all-tables t)
  3804. ("noalign" org-startup-align-all-tables nil)
  3805. ("inlineimages" org-startup-with-inline-images t)
  3806. ("noinlineimages" org-startup-with-inline-images nil)
  3807. ("customtime" org-display-custom-times t)
  3808. ("logdone" org-log-done time)
  3809. ("lognotedone" org-log-done note)
  3810. ("nologdone" org-log-done nil)
  3811. ("lognoteclock-out" org-log-note-clock-out t)
  3812. ("nolognoteclock-out" org-log-note-clock-out nil)
  3813. ("logrepeat" org-log-repeat state)
  3814. ("lognoterepeat" org-log-repeat note)
  3815. ("nologrepeat" org-log-repeat nil)
  3816. ("logreschedule" org-log-reschedule time)
  3817. ("lognotereschedule" org-log-reschedule note)
  3818. ("nologreschedule" org-log-reschedule nil)
  3819. ("logredeadline" org-log-redeadline time)
  3820. ("lognoteredeadline" org-log-redeadline note)
  3821. ("nologredeadline" org-log-redeadline nil)
  3822. ("logrefile" org-log-refile time)
  3823. ("lognoterefile" org-log-refile note)
  3824. ("nologrefile" org-log-refile nil)
  3825. ("fninline" org-footnote-define-inline t)
  3826. ("nofninline" org-footnote-define-inline nil)
  3827. ("fnlocal" org-footnote-section nil)
  3828. ("fnauto" org-footnote-auto-label t)
  3829. ("fnprompt" org-footnote-auto-label nil)
  3830. ("fnconfirm" org-footnote-auto-label confirm)
  3831. ("fnplain" org-footnote-auto-label plain)
  3832. ("fnadjust" org-footnote-auto-adjust t)
  3833. ("nofnadjust" org-footnote-auto-adjust nil)
  3834. ("constcgs" constants-unit-system cgs)
  3835. ("constSI" constants-unit-system SI)
  3836. ("noptag" org-tag-persistent-alist nil)
  3837. ("hideblocks" org-hide-block-startup t)
  3838. ("nohideblocks" org-hide-block-startup nil)
  3839. ("beamer" org-startup-with-beamer-mode t)
  3840. ("entitiespretty" org-pretty-entities t)
  3841. ("entitiesplain" org-pretty-entities nil))
  3842. "Variable associated with STARTUP options for org-mode.
  3843. Each element is a list of three items: the startup options (as written
  3844. in the #+STARTUP line), the corresponding variable, and the value to set
  3845. this variable to if the option is found. An optional forth element PUSH
  3846. means to push this value onto the list in the variable.")
  3847. (defun org-update-property-plist (key val props)
  3848. "Update PROPS with KEY and VAL."
  3849. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  3850. (key (if appending (substring key 0 (- (length key) 1)) key))
  3851. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  3852. (previous (cdr (assoc key props))))
  3853. (if appending
  3854. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  3855. (cons (cons key val) remainder))))
  3856. (defconst org-block-regexp
  3857. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  3858. "Regular expression for hiding blocks.")
  3859. (defconst org-heading-keyword-regexp-format
  3860. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  3861. "Printf format for a regexp matching an headline with some keyword.
  3862. This regexp will match the headline of any node which has the
  3863. exact keyword that is put into the format. The keyword isn't in
  3864. any group by default, but the stars and the body are.")
  3865. (defconst org-heading-keyword-maybe-regexp-format
  3866. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  3867. "Printf format for a regexp matching an headline, possibly with some keyword.
  3868. This regexp can match any headline with the specified keyword, or
  3869. without a keyword. The keyword isn't in any group by default,
  3870. but the stars and the body are.")
  3871. (defun org-set-regexps-and-options ()
  3872. "Precompute regular expressions for current buffer."
  3873. (when (derived-mode-p 'org-mode)
  3874. (org-set-local 'org-todo-kwd-alist nil)
  3875. (org-set-local 'org-todo-key-alist nil)
  3876. (org-set-local 'org-todo-key-trigger nil)
  3877. (org-set-local 'org-todo-keywords-1 nil)
  3878. (org-set-local 'org-done-keywords nil)
  3879. (org-set-local 'org-todo-heads nil)
  3880. (org-set-local 'org-todo-sets nil)
  3881. (org-set-local 'org-todo-log-states nil)
  3882. (org-set-local 'org-file-properties nil)
  3883. (org-set-local 'org-file-tags nil)
  3884. (let ((re (org-make-options-regexp
  3885. '("CATEGORY" "TODO" "COLUMNS"
  3886. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  3887. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  3888. "OPTIONS")
  3889. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  3890. (splitre "[ \t]+")
  3891. (scripts org-use-sub-superscripts)
  3892. kwds kws0 kwsa key log value cat arch tags const links hw dws
  3893. tail sep kws1 prio props ftags drawers beamer-p
  3894. ext-setup-or-nil setup-contents (start 0))
  3895. (save-excursion
  3896. (save-restriction
  3897. (widen)
  3898. (goto-char (point-min))
  3899. (while (or (and ext-setup-or-nil
  3900. (string-match re ext-setup-or-nil start)
  3901. (setq start (match-end 0)))
  3902. (and (setq ext-setup-or-nil nil start 0)
  3903. (re-search-forward re nil t)))
  3904. (setq key (upcase (match-string 1 ext-setup-or-nil))
  3905. value (org-match-string-no-properties 2 ext-setup-or-nil))
  3906. (if (stringp value) (setq value (org-trim value)))
  3907. (cond
  3908. ((equal key "CATEGORY")
  3909. (setq cat value))
  3910. ((member key '("SEQ_TODO" "TODO"))
  3911. (push (cons 'sequence (org-split-string value splitre)) kwds))
  3912. ((equal key "TYP_TODO")
  3913. (push (cons 'type (org-split-string value splitre)) kwds))
  3914. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  3915. ;; general TODO-like setup
  3916. (push (cons (intern (downcase (match-string 1 key)))
  3917. (org-split-string value splitre)) kwds))
  3918. ((equal key "TAGS")
  3919. (setq tags (append tags (if tags '("\\n") nil)
  3920. (org-split-string value splitre))))
  3921. ((equal key "COLUMNS")
  3922. (org-set-local 'org-columns-default-format value))
  3923. ((equal key "LINK")
  3924. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  3925. (push (cons (match-string 1 value)
  3926. (org-trim (match-string 2 value)))
  3927. links)))
  3928. ((equal key "PRIORITIES")
  3929. (setq prio (org-split-string value " +")))
  3930. ((equal key "PROPERTY")
  3931. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  3932. (setq props (org-update-property-plist (match-string 1 value)
  3933. (match-string 2 value)
  3934. props))))
  3935. ((equal key "FILETAGS")
  3936. (when (string-match "\\S-" value)
  3937. (setq ftags
  3938. (append
  3939. ftags
  3940. (apply 'append
  3941. (mapcar (lambda (x) (org-split-string x ":"))
  3942. (org-split-string value)))))))
  3943. ((equal key "DRAWERS")
  3944. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  3945. ((equal key "CONSTANTS")
  3946. (setq const (append const (org-split-string value splitre))))
  3947. ((equal key "STARTUP")
  3948. (let ((opts (org-split-string value splitre))
  3949. l var val)
  3950. (while (setq l (pop opts))
  3951. (when (setq l (assoc l org-startup-options))
  3952. (setq var (nth 1 l) val (nth 2 l))
  3953. (if (not (nth 3 l))
  3954. (set (make-local-variable var) val)
  3955. (if (not (listp (symbol-value var)))
  3956. (set (make-local-variable var) nil))
  3957. (set (make-local-variable var) (symbol-value var))
  3958. (add-to-list var val))))))
  3959. ((equal key "ARCHIVE")
  3960. (setq arch value)
  3961. (remove-text-properties 0 (length arch)
  3962. '(face t fontified t) arch))
  3963. ((equal key "LATEX_CLASS")
  3964. (setq beamer-p (equal value "beamer")))
  3965. ((equal key "OPTIONS")
  3966. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  3967. (setq scripts (read (match-string 2 value)))))
  3968. ((equal key "SETUPFILE")
  3969. (setq setup-contents (org-file-contents
  3970. (expand-file-name
  3971. (org-remove-double-quotes value))
  3972. 'noerror))
  3973. (if (not ext-setup-or-nil)
  3974. (setq ext-setup-or-nil setup-contents start 0)
  3975. (setq ext-setup-or-nil
  3976. (concat (substring ext-setup-or-nil 0 start)
  3977. "\n" setup-contents "\n"
  3978. (substring ext-setup-or-nil start)))))))
  3979. ;; search for property blocks
  3980. (goto-char (point-min))
  3981. (while (re-search-forward org-block-regexp nil t)
  3982. (when (equal "PROPERTY" (upcase (match-string 1)))
  3983. (setq value (replace-regexp-in-string
  3984. "[\n\r]" " " (match-string 4)))
  3985. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  3986. (setq props (org-update-property-plist (match-string 1 value)
  3987. (match-string 2 value)
  3988. props)))))))
  3989. (org-set-local 'org-use-sub-superscripts scripts)
  3990. (when cat
  3991. (org-set-local 'org-category (intern cat))
  3992. (push (cons "CATEGORY" cat) props))
  3993. (when prio
  3994. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  3995. (setq prio (mapcar 'string-to-char prio))
  3996. (org-set-local 'org-highest-priority (nth 0 prio))
  3997. (org-set-local 'org-lowest-priority (nth 1 prio))
  3998. (org-set-local 'org-default-priority (nth 2 prio)))
  3999. (and props (org-set-local 'org-file-properties (nreverse props)))
  4000. (and ftags (org-set-local 'org-file-tags
  4001. (mapcar 'org-add-prop-inherited ftags)))
  4002. (and drawers (org-set-local 'org-drawers drawers))
  4003. (and arch (org-set-local 'org-archive-location arch))
  4004. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4005. ;; Process the TODO keywords
  4006. (unless kwds
  4007. ;; Use the global values as if they had been given locally.
  4008. (setq kwds (default-value 'org-todo-keywords))
  4009. (if (stringp (car kwds))
  4010. (setq kwds (list (cons org-todo-interpretation
  4011. (default-value 'org-todo-keywords)))))
  4012. (setq kwds (reverse kwds)))
  4013. (setq kwds (nreverse kwds))
  4014. (let (inter kws kw)
  4015. (while (setq kws (pop kwds))
  4016. (let ((kws (or
  4017. (run-hook-with-args-until-success
  4018. 'org-todo-setup-filter-hook kws)
  4019. kws)))
  4020. (setq inter (pop kws) sep (member "|" kws)
  4021. kws0 (delete "|" (copy-sequence kws))
  4022. kwsa nil
  4023. kws1 (mapcar
  4024. (lambda (x)
  4025. ;; 1 2
  4026. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4027. (progn
  4028. (setq kw (match-string 1 x)
  4029. key (and (match-end 2) (match-string 2 x))
  4030. log (org-extract-log-state-settings x))
  4031. (push (cons kw (and key (string-to-char key))) kwsa)
  4032. (and log (push log org-todo-log-states))
  4033. kw)
  4034. (error "Invalid TODO keyword %s" x)))
  4035. kws0)
  4036. kwsa (if kwsa (append '((:startgroup))
  4037. (nreverse kwsa)
  4038. '((:endgroup))))
  4039. hw (car kws1)
  4040. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4041. tail (list inter hw (car dws) (org-last dws))))
  4042. (add-to-list 'org-todo-heads hw 'append)
  4043. (push kws1 org-todo-sets)
  4044. (setq org-done-keywords (append org-done-keywords dws nil))
  4045. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4046. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4047. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4048. (setq org-todo-sets (nreverse org-todo-sets)
  4049. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4050. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4051. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4052. ;; Process the constants
  4053. (when const
  4054. (let (e cst)
  4055. (while (setq e (pop const))
  4056. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  4057. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  4058. (setq org-table-formula-constants-local cst)))
  4059. ;; Process the tags.
  4060. (when tags
  4061. (let (e tgs)
  4062. (while (setq e (pop tags))
  4063. (cond
  4064. ((equal e "{") (push '(:startgroup) tgs))
  4065. ((equal e "}") (push '(:endgroup) tgs))
  4066. ((equal e "\\n") (push '(:newline) tgs))
  4067. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4068. (push (cons (match-string 1 e)
  4069. (string-to-char (match-string 2 e)))
  4070. tgs))
  4071. (t (push (list e) tgs))))
  4072. (org-set-local 'org-tag-alist nil)
  4073. (while (setq e (pop tgs))
  4074. (or (and (stringp (car e))
  4075. (assoc (car e) org-tag-alist))
  4076. (push e org-tag-alist)))))
  4077. ;; Compute the regular expressions and other local variables.
  4078. ;; Using `org-outline-regexp-bol' would complicate them much,
  4079. ;; because of the fixed white space at the end of that string.
  4080. (if (not org-done-keywords)
  4081. (setq org-done-keywords (and org-todo-keywords-1
  4082. (list (org-last org-todo-keywords-1)))))
  4083. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4084. (length org-scheduled-string)
  4085. (length org-clock-string)
  4086. (length org-closed-string)))
  4087. org-drawer-regexp
  4088. (concat "^[ \t]*:\\("
  4089. (mapconcat 'regexp-quote org-drawers "\\|")
  4090. "\\):[ \t]*$")
  4091. org-not-done-keywords
  4092. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4093. org-todo-regexp
  4094. (concat "\\("
  4095. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4096. "\\)")
  4097. org-not-done-regexp
  4098. (concat "\\("
  4099. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4100. "\\)")
  4101. org-not-done-heading-regexp
  4102. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4103. org-todo-line-regexp
  4104. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4105. org-complex-heading-regexp
  4106. (concat "^\\(\\*+\\)"
  4107. "\\(?: +" org-todo-regexp "\\)?"
  4108. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4109. "\\(?: +\\(.*?\\)\\)??"
  4110. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4111. "[ \t]*$")
  4112. org-complex-heading-regexp-format
  4113. (concat "^\\(\\*+\\)"
  4114. "\\(?: +" org-todo-regexp "\\)?"
  4115. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4116. "\\(?: +"
  4117. ;; Stats cookies can be stuck to body.
  4118. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4119. "\\(%s\\)"
  4120. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4121. "\\)"
  4122. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4123. "[ \t]*$")
  4124. org-todo-line-tags-regexp
  4125. (concat "^\\(\\*+\\)"
  4126. "\\(?: +" org-todo-regexp "\\)?"
  4127. "\\(?: +\\(.*?\\)\\)??"
  4128. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4129. "[ \t]*$")
  4130. org-deadline-regexp (concat "\\<" org-deadline-string)
  4131. org-deadline-time-regexp
  4132. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4133. org-deadline-line-regexp
  4134. (concat "\\<\\(" org-deadline-string "\\).*")
  4135. org-scheduled-regexp
  4136. (concat "\\<" org-scheduled-string)
  4137. org-scheduled-time-regexp
  4138. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4139. org-closed-time-regexp
  4140. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4141. org-keyword-time-regexp
  4142. (concat "\\<\\(" org-scheduled-string
  4143. "\\|" org-deadline-string
  4144. "\\|" org-closed-string
  4145. "\\|" org-clock-string "\\)"
  4146. " *[[<]\\([^]>]+\\)[]>]")
  4147. org-keyword-time-not-clock-regexp
  4148. (concat "\\<\\(" org-scheduled-string
  4149. "\\|" org-deadline-string
  4150. "\\|" org-closed-string
  4151. "\\)"
  4152. " *[[<]\\([^]>]+\\)[]>]")
  4153. org-maybe-keyword-time-regexp
  4154. (concat "\\(\\<\\(" org-scheduled-string
  4155. "\\|" org-deadline-string
  4156. "\\|" org-closed-string
  4157. "\\|" org-clock-string "\\)\\)?"
  4158. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4159. org-all-time-keywords
  4160. (mapcar (lambda (w) (substring w 0 -1))
  4161. (list org-scheduled-string org-deadline-string
  4162. org-clock-string org-closed-string))
  4163. )
  4164. (org-compute-latex-and-specials-regexp)
  4165. (org-set-font-lock-defaults))))
  4166. (defun org-file-contents (file &optional noerror)
  4167. "Return the contents of FILE, as a string."
  4168. (if (or (not file)
  4169. (not (file-readable-p file)))
  4170. (if noerror
  4171. (progn
  4172. (message "Cannot read file \"%s\"" file)
  4173. (ding) (sit-for 2)
  4174. "")
  4175. (error "Cannot read file \"%s\"" file))
  4176. (with-temp-buffer
  4177. (insert-file-contents file)
  4178. (buffer-string))))
  4179. (defun org-extract-log-state-settings (x)
  4180. "Extract the log state setting from a TODO keyword string.
  4181. This will extract info from a string like \"WAIT(w@/!)\"."
  4182. (let (kw key log1 log2)
  4183. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4184. (setq kw (match-string 1 x)
  4185. key (and (match-end 2) (match-string 2 x))
  4186. log1 (and (match-end 3) (match-string 3 x))
  4187. log2 (and (match-end 4) (match-string 4 x)))
  4188. (and (or log1 log2)
  4189. (list kw
  4190. (and log1 (if (equal log1 "!") 'time 'note))
  4191. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4192. (defun org-remove-keyword-keys (list)
  4193. "Remove a pair of parenthesis at the end of each string in LIST."
  4194. (mapcar (lambda (x)
  4195. (if (string-match "(.*)$" x)
  4196. (substring x 0 (match-beginning 0))
  4197. x))
  4198. list))
  4199. (defun org-assign-fast-keys (alist)
  4200. "Assign fast keys to a keyword-key alist.
  4201. Respect keys that are already there."
  4202. (let (new e (alt ?0))
  4203. (while (setq e (pop alist))
  4204. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  4205. (cdr e)) ;; Key already assigned.
  4206. (push e new)
  4207. (let ((clist (string-to-list (downcase (car e))))
  4208. (used (append new alist)))
  4209. (when (= (car clist) ?@)
  4210. (pop clist))
  4211. (while (and clist (rassoc (car clist) used))
  4212. (pop clist))
  4213. (unless clist
  4214. (while (rassoc alt used)
  4215. (incf alt)))
  4216. (push (cons (car e) (or (car clist) alt)) new))))
  4217. (nreverse new)))
  4218. ;;; Some variables used in various places
  4219. (defvar org-window-configuration nil
  4220. "Used in various places to store a window configuration.")
  4221. (defvar org-selected-window nil
  4222. "Used in various places to store a window configuration.")
  4223. (defvar org-finish-function nil
  4224. "Function to be called when `C-c C-c' is used.
  4225. This is for getting out of special buffers like capture.")
  4226. ;; FIXME: Occasionally check by commenting these, to make sure
  4227. ;; no other functions uses these, forgetting to let-bind them.
  4228. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4229. (defvar org-last-state)
  4230. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4231. ;; Defined somewhere in this file, but used before definition.
  4232. (defvar org-entities) ;; defined in org-entities.el
  4233. (defvar org-struct-menu)
  4234. (defvar org-org-menu)
  4235. (defvar org-tbl-menu)
  4236. ;;;; Define the Org-mode
  4237. ;; We use a before-change function to check if a table might need
  4238. ;; an update.
  4239. (defvar org-table-may-need-update t
  4240. "Indicates that a table might need an update.
  4241. This variable is set by `org-before-change-function'.
  4242. `org-table-align' sets it back to nil.")
  4243. (defun org-before-change-function (beg end)
  4244. "Every change indicates that a table might need an update."
  4245. (setq org-table-may-need-update t))
  4246. (defvar org-mode-map)
  4247. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4248. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4249. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4250. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4251. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4252. (defvar org-table-buffer-is-an nil)
  4253. (defvar bidi-paragraph-direction)
  4254. (defvar buffer-face-mode-face)
  4255. (require 'outline)
  4256. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4257. (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"))
  4258. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  4259. ;; Other stuff we need.
  4260. (require 'time-date)
  4261. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4262. (require 'easymenu)
  4263. (require 'overlay)
  4264. (require 'org-macs)
  4265. (require 'org-entities)
  4266. ;; (require 'org-compat) moved higher up in the file before it is first used
  4267. (require 'org-faces)
  4268. (require 'org-list)
  4269. (require 'org-pcomplete)
  4270. (require 'org-src)
  4271. (require 'org-footnote)
  4272. ;; babel
  4273. (require 'ob)
  4274. (require 'ob-table)
  4275. (require 'ob-lob)
  4276. (require 'ob-ref)
  4277. (require 'ob-tangle)
  4278. (require 'ob-comint)
  4279. (require 'ob-keys)
  4280. ;;;###autoload
  4281. (define-derived-mode org-mode outline-mode "Org"
  4282. "Outline-based notes management and organizer, alias
  4283. \"Carsten's outline-mode for keeping track of everything.\"
  4284. Org-mode develops organizational tasks around a NOTES file which
  4285. contains information about projects as plain text. Org-mode is
  4286. implemented on top of outline-mode, which is ideal to keep the content
  4287. of large files well structured. It supports ToDo items, deadlines and
  4288. time stamps, which magically appear in the diary listing of the Emacs
  4289. calendar. Tables are easily created with a built-in table editor.
  4290. Plain text URL-like links connect to websites, emails (VM), Usenet
  4291. messages (Gnus), BBDB entries, and any files related to the project.
  4292. For printing and sharing of notes, an Org-mode file (or a part of it)
  4293. can be exported as a structured ASCII or HTML file.
  4294. The following commands are available:
  4295. \\{org-mode-map}"
  4296. ;; Get rid of Outline menus, they are not needed
  4297. ;; Need to do this here because define-derived-mode sets up
  4298. ;; the keymap so late. Still, it is a waste to call this each time
  4299. ;; we switch another buffer into org-mode.
  4300. (if (featurep 'xemacs)
  4301. (when (boundp 'outline-mode-menu-heading)
  4302. ;; Assume this is Greg's port, it uses easymenu
  4303. (easy-menu-remove outline-mode-menu-heading)
  4304. (easy-menu-remove outline-mode-menu-show)
  4305. (easy-menu-remove outline-mode-menu-hide))
  4306. (define-key org-mode-map [menu-bar headings] 'undefined)
  4307. (define-key org-mode-map [menu-bar hide] 'undefined)
  4308. (define-key org-mode-map [menu-bar show] 'undefined))
  4309. (org-load-modules-maybe)
  4310. (easy-menu-add org-org-menu)
  4311. (easy-menu-add org-tbl-menu)
  4312. (org-install-agenda-files-menu)
  4313. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4314. (add-to-invisibility-spec '(org-cwidth))
  4315. (add-to-invisibility-spec '(org-hide-block . t))
  4316. (when (featurep 'xemacs)
  4317. (org-set-local 'line-move-ignore-invisible t))
  4318. (org-set-local 'outline-regexp org-outline-regexp)
  4319. (org-set-local 'outline-level 'org-outline-level)
  4320. (setq bidi-paragraph-direction 'left-to-right)
  4321. (when (and org-ellipsis
  4322. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4323. (fboundp 'make-glyph-code))
  4324. (unless org-display-table
  4325. (setq org-display-table (make-display-table)))
  4326. (set-display-table-slot
  4327. org-display-table 4
  4328. (vconcat (mapcar
  4329. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4330. org-ellipsis)))
  4331. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4332. (setq buffer-display-table org-display-table))
  4333. (org-set-regexps-and-options)
  4334. (when (and org-tag-faces (not org-tags-special-faces-re))
  4335. ;; tag faces set outside customize.... force initialization.
  4336. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4337. ;; Calc embedded
  4338. (org-set-local 'calc-embedded-open-mode "# ")
  4339. (modify-syntax-entry ?@ "w")
  4340. (modify-syntax-entry ?\" "\"")
  4341. (if org-startup-truncated (setq truncate-lines t))
  4342. (org-set-local 'font-lock-unfontify-region-function
  4343. 'org-unfontify-region)
  4344. ;; Activate before-change-function
  4345. (org-set-local 'org-table-may-need-update t)
  4346. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4347. 'local)
  4348. ;; Check for running clock before killing a buffer
  4349. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4350. ;; Initialize macros templates.
  4351. (org-macro-initialize-templates)
  4352. ;; Initialize radio targets.
  4353. (org-update-radio-target-regexp)
  4354. ;; Indentation.
  4355. (org-set-local 'indent-line-function 'org-indent-line)
  4356. (org-set-local 'indent-region-function 'org-indent-region)
  4357. ;; Filling and auto-filling.
  4358. (org-setup-filling)
  4359. ;; Comments.
  4360. (org-setup-comments-handling)
  4361. ;; Beginning/end of defun
  4362. (org-set-local 'beginning-of-defun-function 'org-back-to-heading)
  4363. (org-set-local 'end-of-defun-function (lambda () (interactive) (org-end-of-subtree nil t)))
  4364. ;; Next error for sparse trees
  4365. (org-set-local 'next-error-function 'org-occur-next-match)
  4366. ;; Make sure dependence stuff works reliably, even for users who set it
  4367. ;; too late :-(
  4368. (if org-enforce-todo-dependencies
  4369. (add-hook 'org-blocker-hook
  4370. 'org-block-todo-from-children-or-siblings-or-parent)
  4371. (remove-hook 'org-blocker-hook
  4372. 'org-block-todo-from-children-or-siblings-or-parent))
  4373. (if org-enforce-todo-checkbox-dependencies
  4374. (add-hook 'org-blocker-hook
  4375. 'org-block-todo-from-checkboxes)
  4376. (remove-hook 'org-blocker-hook
  4377. 'org-block-todo-from-checkboxes))
  4378. ;; Align options lines
  4379. (org-set-local
  4380. 'align-mode-rules-list
  4381. '((org-in-buffer-settings
  4382. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4383. (modes . '(org-mode)))))
  4384. ;; Imenu
  4385. (org-set-local 'imenu-create-index-function
  4386. 'org-imenu-get-tree)
  4387. ;; Make isearch reveal context
  4388. (if (or (featurep 'xemacs)
  4389. (not (boundp 'outline-isearch-open-invisible-function)))
  4390. ;; Emacs 21 and XEmacs make use of the hook
  4391. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4392. ;; Emacs 22 deals with this through a special variable
  4393. (org-set-local 'outline-isearch-open-invisible-function
  4394. (lambda (&rest ignore) (org-show-context 'isearch))))
  4395. ;; Turn on org-beamer-mode?
  4396. (and org-startup-with-beamer-mode (org-beamer-mode))
  4397. ;; Setup the pcomplete hooks
  4398. (set (make-local-variable 'pcomplete-command-completion-function)
  4399. 'org-pcomplete-initial)
  4400. (set (make-local-variable 'pcomplete-command-name-function)
  4401. 'org-command-at-point)
  4402. (set (make-local-variable 'pcomplete-default-completion-function)
  4403. 'ignore)
  4404. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4405. 'org-parse-arguments)
  4406. (set (make-local-variable 'pcomplete-termination-string) "")
  4407. (when (>= emacs-major-version 23)
  4408. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4409. ;; If empty file that did not turn on org-mode automatically, make it to.
  4410. (if (and org-insert-mode-line-in-empty-file
  4411. (org-called-interactively-p 'any)
  4412. (= (point-min) (point-max)))
  4413. (insert "# -*- mode: org -*-\n\n"))
  4414. (unless org-inhibit-startup
  4415. (when org-startup-align-all-tables
  4416. (let ((bmp (buffer-modified-p)))
  4417. (org-table-map-tables 'org-table-align 'quietly)
  4418. (set-buffer-modified-p bmp)))
  4419. (when org-startup-with-inline-images
  4420. (org-display-inline-images))
  4421. (when org-startup-indented
  4422. (require 'org-indent)
  4423. (org-indent-mode 1))
  4424. (unless org-inhibit-startup-visibility-stuff
  4425. (org-set-startup-visibility)))
  4426. ;; Try to set org-hide correctly
  4427. (set-face-foreground 'org-hide (org-find-invisible-foreground)))
  4428. (when (fboundp 'abbrev-table-put)
  4429. (abbrev-table-put org-mode-abbrev-table
  4430. :parents (list text-mode-abbrev-table)))
  4431. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4432. (defun org-find-invisible-foreground ()
  4433. (let ((candidates (remove
  4434. "unspecified-bg"
  4435. (list
  4436. (face-background 'default)
  4437. (face-background 'org-default)
  4438. (cdr (assoc 'background-color default-frame-alist))
  4439. (cdr (assoc 'background-color initial-frame-alist))
  4440. (cdr (assoc 'background-color window-system-default-frame-alist))
  4441. (face-foreground 'org-hide)))))
  4442. (car (remove nil candidates))))
  4443. (defun org-current-time ()
  4444. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4445. (if (> (car org-time-stamp-rounding-minutes) 1)
  4446. (let ((r (car org-time-stamp-rounding-minutes))
  4447. (time (decode-time)))
  4448. (apply 'encode-time
  4449. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4450. (nthcdr 2 time))))
  4451. (current-time)))
  4452. (defun org-today ()
  4453. "Return today date, considering `org-extend-today-until'."
  4454. (time-to-days
  4455. (time-subtract (current-time)
  4456. (list 0 (* 3600 org-extend-today-until) 0))))
  4457. ;;;; Font-Lock stuff, including the activators
  4458. (defvar org-mouse-map (make-sparse-keymap))
  4459. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4460. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4461. (when org-mouse-1-follows-link
  4462. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4463. (when org-tab-follows-link
  4464. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4465. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4466. (require 'font-lock)
  4467. (defconst org-non-link-chars "]\t\n\r<>")
  4468. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4469. "shell" "elisp" "doi" "message"))
  4470. (defvar org-link-types-re nil
  4471. "Matches a link that has a url-like prefix like \"http:\"")
  4472. (defvar org-link-re-with-space nil
  4473. "Matches a link with spaces, optional angular brackets around it.")
  4474. (defvar org-link-re-with-space2 nil
  4475. "Matches a link with spaces, optional angular brackets around it.")
  4476. (defvar org-link-re-with-space3 nil
  4477. "Matches a link with spaces, only for internal part in bracket links.")
  4478. (defvar org-angle-link-re nil
  4479. "Matches link with angular brackets, spaces are allowed.")
  4480. (defvar org-plain-link-re nil
  4481. "Matches plain link, without spaces.")
  4482. (defvar org-bracket-link-regexp nil
  4483. "Matches a link in double brackets.")
  4484. (defvar org-bracket-link-analytic-regexp nil
  4485. "Regular expression used to analyze links.
  4486. Here is what the match groups contain after a match:
  4487. 1: http:
  4488. 2: http
  4489. 3: path
  4490. 4: [desc]
  4491. 5: desc")
  4492. (defvar org-bracket-link-analytic-regexp++ nil
  4493. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4494. (defvar org-any-link-re nil
  4495. "Regular expression matching any link.")
  4496. (defcustom org-match-sexp-depth 3
  4497. "Number of stacked braces for sub/superscript matching.
  4498. This has to be set before loading org.el to be effective."
  4499. :group 'org-export-translation ; ??????????????????????????/
  4500. :type 'integer)
  4501. (defun org-create-multibrace-regexp (left right n)
  4502. "Create a regular expression which will match a balanced sexp.
  4503. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4504. as single character strings.
  4505. The regexp returned will match the entire expression including the
  4506. delimiters. It will also define a single group which contains the
  4507. match except for the outermost delimiters. The maximum depth of
  4508. stacked delimiters is N. Escaping delimiters is not possible."
  4509. (let* ((nothing (concat "[^" left right "]*?"))
  4510. (or "\\|")
  4511. (re nothing)
  4512. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4513. (while (> n 1)
  4514. (setq n (1- n)
  4515. re (concat re or next)
  4516. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4517. (concat left "\\(" re "\\)" right)))
  4518. (defvar org-match-substring-regexp
  4519. (concat
  4520. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4521. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4522. "\\|"
  4523. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4524. "\\|"
  4525. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4526. "The regular expression matching a sub- or superscript.")
  4527. (defvar org-match-substring-with-braces-regexp
  4528. (concat
  4529. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4530. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4531. "\\)")
  4532. "The regular expression matching a sub- or superscript, forcing braces.")
  4533. (defun org-make-link-regexps ()
  4534. "Update the link regular expressions.
  4535. This should be called after the variable `org-link-types' has changed."
  4536. (setq org-link-types-re
  4537. (concat
  4538. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4539. org-link-re-with-space
  4540. (concat
  4541. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4542. "\\([^" org-non-link-chars " ]"
  4543. "[^" org-non-link-chars "]*"
  4544. "[^" org-non-link-chars " ]\\)>?")
  4545. org-link-re-with-space2
  4546. (concat
  4547. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4548. "\\([^" org-non-link-chars " ]"
  4549. "[^\t\n\r]*"
  4550. "[^" org-non-link-chars " ]\\)>?")
  4551. org-link-re-with-space3
  4552. (concat
  4553. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4554. "\\([^" org-non-link-chars " ]"
  4555. "[^\t\n\r]*\\)")
  4556. org-angle-link-re
  4557. (concat
  4558. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4559. "\\([^" org-non-link-chars " ]"
  4560. "[^" org-non-link-chars "]*"
  4561. "\\)>")
  4562. org-plain-link-re
  4563. (concat
  4564. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4565. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4566. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4567. org-bracket-link-regexp
  4568. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4569. org-bracket-link-analytic-regexp
  4570. (concat
  4571. "\\[\\["
  4572. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4573. "\\([^]]+\\)"
  4574. "\\]"
  4575. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4576. "\\]")
  4577. org-bracket-link-analytic-regexp++
  4578. (concat
  4579. "\\[\\["
  4580. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4581. "\\([^]]+\\)"
  4582. "\\]"
  4583. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4584. "\\]")
  4585. org-any-link-re
  4586. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4587. org-angle-link-re "\\)\\|\\("
  4588. org-plain-link-re "\\)")))
  4589. (org-make-link-regexps)
  4590. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  4591. "Regular expression for fast time stamp matching.")
  4592. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  4593. "Regular expression for fast time stamp matching.")
  4594. (defconst org-ts-regexp0
  4595. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4596. "Regular expression matching time strings for analysis.
  4597. This one does not require the space after the date, so it can be used
  4598. on a string that terminates immediately after the date.")
  4599. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4600. "Regular expression matching time strings for analysis.")
  4601. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4602. "Regular expression matching time stamps, with groups.")
  4603. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4604. "Regular expression matching time stamps (also [..]), with groups.")
  4605. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4606. "Regular expression matching a time stamp range.")
  4607. (defconst org-tr-regexp-both
  4608. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4609. "Regular expression matching a time stamp range.")
  4610. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4611. org-ts-regexp "\\)?")
  4612. "Regular expression matching a time stamp or time stamp range.")
  4613. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4614. org-ts-regexp-both "\\)?")
  4615. "Regular expression matching a time stamp or time stamp range.
  4616. The time stamps may be either active or inactive.")
  4617. (defvar org-emph-face nil)
  4618. (defun org-do-emphasis-faces (limit)
  4619. "Run through the buffer and add overlays to emphasized strings."
  4620. (let (rtn a)
  4621. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4622. (if (not (= (char-after (match-beginning 3))
  4623. (char-after (match-beginning 4))))
  4624. (progn
  4625. (setq rtn t)
  4626. (setq a (assoc (match-string 3) org-emphasis-alist))
  4627. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4628. 'face
  4629. (nth 1 a))
  4630. (and (nth 4 a)
  4631. (org-remove-flyspell-overlays-in
  4632. (match-beginning 0) (match-end 0)))
  4633. (add-text-properties (match-beginning 2) (match-end 2)
  4634. '(font-lock-multiline t org-emphasis t))
  4635. (when org-hide-emphasis-markers
  4636. (add-text-properties (match-end 4) (match-beginning 5)
  4637. '(invisible org-link))
  4638. (add-text-properties (match-beginning 3) (match-end 3)
  4639. '(invisible org-link)))))
  4640. (backward-char 1))
  4641. rtn))
  4642. (defun org-emphasize (&optional char)
  4643. "Insert or change an emphasis, i.e. a font like bold or italic.
  4644. If there is an active region, change that region to a new emphasis.
  4645. If there is no region, just insert the marker characters and position
  4646. the cursor between them.
  4647. CHAR should be either the marker character, or the first character of the
  4648. HTML tag associated with that emphasis. If CHAR is a space, the means
  4649. to remove the emphasis of the selected region.
  4650. If char is not given (for example in an interactive call) it
  4651. will be prompted for."
  4652. (interactive)
  4653. (let ((eal org-emphasis-alist) e det
  4654. (erc org-emphasis-regexp-components)
  4655. (prompt "")
  4656. (string "") beg end move tag c s)
  4657. (if (org-region-active-p)
  4658. (setq beg (region-beginning) end (region-end)
  4659. string (buffer-substring beg end))
  4660. (setq move t))
  4661. (while (setq e (pop eal))
  4662. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4663. c (aref tag 0))
  4664. (push (cons c (string-to-char (car e))) det)
  4665. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4666. (substring tag 1)))))
  4667. (setq det (nreverse det))
  4668. (unless char
  4669. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4670. (setq char (read-char-exclusive)))
  4671. (setq char (or (cdr (assoc char det)) char))
  4672. (if (equal char ?\ )
  4673. (setq s "" move nil)
  4674. (unless (assoc (char-to-string char) org-emphasis-alist)
  4675. (error "No such emphasis marker: \"%c\"" char))
  4676. (setq s (char-to-string char)))
  4677. (while (and (> (length string) 1)
  4678. (equal (substring string 0 1) (substring string -1))
  4679. (assoc (substring string 0 1) org-emphasis-alist))
  4680. (setq string (substring string 1 -1)))
  4681. (setq string (concat s string s))
  4682. (if beg (delete-region beg end))
  4683. (unless (or (bolp)
  4684. (string-match (concat "[" (nth 0 erc) "\n]")
  4685. (char-to-string (char-before (point)))))
  4686. (insert " "))
  4687. (unless (or (eobp)
  4688. (string-match (concat "[" (nth 1 erc) "\n]")
  4689. (char-to-string (char-after (point)))))
  4690. (insert " ") (backward-char 1))
  4691. (insert string)
  4692. (and move (backward-char 1))))
  4693. (defconst org-nonsticky-props
  4694. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4695. (defsubst org-rear-nonsticky-at (pos)
  4696. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4697. (defun org-activate-plain-links (limit)
  4698. "Run through the buffer and add overlays to links."
  4699. (catch 'exit
  4700. (let (f hl)
  4701. (when (re-search-forward (concat org-plain-link-re) limit t)
  4702. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4703. (setq f (get-text-property (match-beginning 0) 'face))
  4704. (setq hl (org-match-string-no-properties 0))
  4705. (if (or (eq f 'org-tag)
  4706. (and (listp f) (memq 'org-tag f)))
  4707. nil
  4708. (add-text-properties (match-beginning 0) (match-end 0)
  4709. (list 'mouse-face 'highlight
  4710. 'face 'org-link
  4711. 'htmlize-link `(:uri ,hl)
  4712. 'keymap org-mouse-map))
  4713. (org-rear-nonsticky-at (match-end 0)))
  4714. t))))
  4715. (defun org-activate-code (limit)
  4716. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  4717. (progn
  4718. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4719. (remove-text-properties (match-beginning 0) (match-end 0)
  4720. '(display t invisible t intangible t))
  4721. t)))
  4722. (defcustom org-src-fontify-natively nil
  4723. "When non-nil, fontify code in code blocks."
  4724. :type 'boolean
  4725. :version "24.1"
  4726. :group 'org-appearance
  4727. :group 'org-babel)
  4728. (defcustom org-allow-promoting-top-level-subtree nil
  4729. "When non-nil, allow promoting a top level subtree.
  4730. The leading star of the top level headline will be replaced
  4731. by a #."
  4732. :type 'boolean
  4733. :version "24.1"
  4734. :group 'org-appearance)
  4735. (defun org-fontify-meta-lines-and-blocks (limit)
  4736. (condition-case nil
  4737. (org-fontify-meta-lines-and-blocks-1 limit)
  4738. (error (message "org-mode fontification error"))))
  4739. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  4740. "Fontify #+ lines and blocks, in the correct ways."
  4741. (let ((case-fold-search t))
  4742. (if (re-search-forward
  4743. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  4744. limit t)
  4745. (let ((beg (match-beginning 0))
  4746. (block-start (match-end 0))
  4747. (block-end nil)
  4748. (lang (match-string 7))
  4749. (beg1 (line-beginning-position 2))
  4750. (dc1 (downcase (match-string 2)))
  4751. (dc3 (downcase (match-string 3)))
  4752. end end1 quoting block-type ovl)
  4753. (cond
  4754. ((member dc1 '("+html:" "+ascii:" "+latex:" "+docbook:"))
  4755. ;; a single line of backend-specific content
  4756. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4757. (remove-text-properties (match-beginning 0) (match-end 0)
  4758. '(display t invisible t intangible t))
  4759. (add-text-properties (match-beginning 1) (match-end 3)
  4760. '(font-lock-fontified t face org-meta-line))
  4761. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  4762. '(font-lock-fontified t face org-block))
  4763. ; for backend-specific code
  4764. t)
  4765. ((and (match-end 4) (equal dc3 "+begin"))
  4766. ;; Truly a block
  4767. (setq block-type (downcase (match-string 5))
  4768. quoting (member block-type org-protecting-blocks))
  4769. (when (re-search-forward
  4770. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4771. nil t) ;; on purpose, we look further than LIMIT
  4772. (setq end (min (point-max) (match-end 0))
  4773. end1 (min (point-max) (1- (match-beginning 0))))
  4774. (setq block-end (match-beginning 0))
  4775. (when quoting
  4776. (remove-text-properties beg end
  4777. '(display t invisible t intangible t)))
  4778. (add-text-properties
  4779. beg end
  4780. '(font-lock-fontified t font-lock-multiline t))
  4781. (add-text-properties beg beg1 '(face org-meta-line))
  4782. (add-text-properties end1 (min (point-max) (1+ end))
  4783. '(face org-meta-line)) ; for end_src
  4784. (cond
  4785. ((and lang (not (string= lang "")) org-src-fontify-natively)
  4786. (org-src-font-lock-fontify-block lang block-start block-end)
  4787. ;; remove old background overlays
  4788. (mapc (lambda (ov)
  4789. (if (eq (overlay-get ov 'face) 'org-block-background)
  4790. (delete-overlay ov)))
  4791. (overlays-at (/ (+ beg1 block-end) 2)))
  4792. ;; add a background overlay
  4793. (setq ovl (make-overlay beg1 block-end))
  4794. (overlay-put ovl 'face 'org-block-background)
  4795. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  4796. (quoting
  4797. (add-text-properties beg1 (min (point-max) (1+ end1))
  4798. '(face org-block))) ; end of source block
  4799. ((not org-fontify-quote-and-verse-blocks))
  4800. ((string= block-type "quote")
  4801. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  4802. ((string= block-type "verse")
  4803. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  4804. (add-text-properties beg beg1 '(face org-block-begin-line))
  4805. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  4806. '(face org-block-end-line))
  4807. t))
  4808. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  4809. (add-text-properties
  4810. beg (match-end 3)
  4811. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4812. '(font-lock-fontified t invisible t)
  4813. '(font-lock-fontified t face org-document-info-keyword)))
  4814. (add-text-properties
  4815. (match-beginning 6) (match-end 6)
  4816. (if (string-equal dc1 "+title:")
  4817. '(font-lock-fontified t face org-document-title)
  4818. '(font-lock-fontified t face org-document-info))))
  4819. ((or (equal dc1 "+results")
  4820. (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
  4821. "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
  4822. "+call:" "+header:" "+headers:" "+name:"))
  4823. (and (match-end 4) (equal dc3 "+attr")))
  4824. (add-text-properties
  4825. beg (match-end 0)
  4826. '(font-lock-fontified t face org-meta-line))
  4827. t)
  4828. ((member dc3 '(" " ""))
  4829. (add-text-properties
  4830. beg (match-end 0)
  4831. '(font-lock-fontified t face font-lock-comment-face)))
  4832. ((not (member (char-after beg) '(?\ ?\t)))
  4833. ;; just any other in-buffer setting, but not indented
  4834. (add-text-properties
  4835. beg (match-end 0)
  4836. '(font-lock-fontified t face org-meta-line))
  4837. t)
  4838. (t nil))))))
  4839. (defun org-activate-angle-links (limit)
  4840. "Run through the buffer and add overlays to links."
  4841. (if (re-search-forward org-angle-link-re limit t)
  4842. (progn
  4843. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4844. (add-text-properties (match-beginning 0) (match-end 0)
  4845. (list 'mouse-face 'highlight
  4846. 'keymap org-mouse-map))
  4847. (org-rear-nonsticky-at (match-end 0))
  4848. t)))
  4849. (defun org-activate-footnote-links (limit)
  4850. "Run through the buffer and add overlays to footnotes."
  4851. (let ((fn (org-footnote-next-reference-or-definition limit)))
  4852. (when fn
  4853. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  4854. (org-remove-flyspell-overlays-in beg end)
  4855. (add-text-properties beg end
  4856. (list 'mouse-face 'highlight
  4857. 'keymap org-mouse-map
  4858. 'help-echo
  4859. (if (= (point-at-bol) beg)
  4860. "Footnote definition"
  4861. "Footnote reference")
  4862. 'font-lock-fontified t
  4863. 'font-lock-multiline t
  4864. 'face 'org-footnote))))))
  4865. (defun org-activate-bracket-links (limit)
  4866. "Run through the buffer and add overlays to bracketed links."
  4867. (if (re-search-forward org-bracket-link-regexp limit t)
  4868. (let* ((hl (org-match-string-no-properties 1))
  4869. (help (concat "LINK: " hl))
  4870. ;; FIXME: Above we should remove the escapes. But that
  4871. ;; requires another match, protecting match data, a lot
  4872. ;; of overhead for font-lock.
  4873. (ip (org-maybe-intangible
  4874. (list 'invisible 'org-link
  4875. 'keymap org-mouse-map 'mouse-face 'highlight
  4876. 'font-lock-multiline t 'help-echo help
  4877. 'htmlize-link `(:uri ,hl))))
  4878. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  4879. 'font-lock-multiline t 'help-echo help
  4880. 'htmlize-link `(:uri ,hl))))
  4881. ;; We need to remove the invisible property here. Table narrowing
  4882. ;; may have made some of this invisible.
  4883. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4884. (remove-text-properties (match-beginning 0) (match-end 0)
  4885. '(invisible nil))
  4886. (if (match-end 3)
  4887. (progn
  4888. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  4889. (org-rear-nonsticky-at (match-beginning 3))
  4890. (add-text-properties (match-beginning 3) (match-end 3) vp)
  4891. (org-rear-nonsticky-at (match-end 3))
  4892. (add-text-properties (match-end 3) (match-end 0) ip)
  4893. (org-rear-nonsticky-at (match-end 0)))
  4894. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  4895. (org-rear-nonsticky-at (match-beginning 1))
  4896. (add-text-properties (match-beginning 1) (match-end 1) vp)
  4897. (org-rear-nonsticky-at (match-end 1))
  4898. (add-text-properties (match-end 1) (match-end 0) ip)
  4899. (org-rear-nonsticky-at (match-end 0)))
  4900. t)))
  4901. (defun org-activate-dates (limit)
  4902. "Run through the buffer and add overlays to dates."
  4903. (if (re-search-forward org-tsr-regexp-both limit t)
  4904. (progn
  4905. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4906. (add-text-properties (match-beginning 0) (match-end 0)
  4907. (list 'mouse-face 'highlight
  4908. 'keymap org-mouse-map))
  4909. (org-rear-nonsticky-at (match-end 0))
  4910. (when org-display-custom-times
  4911. (if (match-end 3)
  4912. (org-display-custom-time (match-beginning 3) (match-end 3)))
  4913. (org-display-custom-time (match-beginning 1) (match-end 1)))
  4914. t)))
  4915. (defvar org-target-link-regexp nil
  4916. "Regular expression matching radio targets in plain text.")
  4917. (make-variable-buffer-local 'org-target-link-regexp)
  4918. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  4919. "Regular expression matching a link target.")
  4920. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  4921. "Regular expression matching a radio target.")
  4922. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  4923. "Regular expression matching any target.")
  4924. (defun org-activate-target-links (limit)
  4925. "Run through the buffer and add overlays to target matches."
  4926. (when org-target-link-regexp
  4927. (let ((case-fold-search t))
  4928. (if (re-search-forward org-target-link-regexp limit t)
  4929. (progn
  4930. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4931. (add-text-properties (match-beginning 0) (match-end 0)
  4932. (list 'mouse-face 'highlight
  4933. 'keymap org-mouse-map
  4934. 'help-echo "Radio target link"
  4935. 'org-linked-text t))
  4936. (org-rear-nonsticky-at (match-end 0))
  4937. t)))))
  4938. (defun org-update-radio-target-regexp ()
  4939. "Find all radio targets in this file and update the regular expression."
  4940. (interactive)
  4941. (when (memq 'radio org-activate-links)
  4942. (setq org-target-link-regexp
  4943. (org-make-target-link-regexp (org-all-targets 'radio)))
  4944. (org-restart-font-lock)))
  4945. (defun org-hide-wide-columns (limit)
  4946. (let (s e)
  4947. (setq s (text-property-any (point) (or limit (point-max))
  4948. 'org-cwidth t))
  4949. (when s
  4950. (setq e (next-single-property-change s 'org-cwidth))
  4951. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  4952. (goto-char e)
  4953. t)))
  4954. (defvar org-latex-and-specials-regexp nil
  4955. "Regular expression for highlighting export special stuff.")
  4956. (defvar org-match-substring-regexp)
  4957. (defvar org-match-substring-with-braces-regexp)
  4958. ;; This should be with the exporter code, but we also use if for font-locking
  4959. (defconst org-export-html-special-string-regexps
  4960. '(("\\\\-" . "&shy;")
  4961. ("---\\([^-]\\)" . "&mdash;\\1")
  4962. ("--\\([^-]\\)" . "&ndash;\\1")
  4963. ("\\.\\.\\." . "&hellip;"))
  4964. "Regular expressions for special string conversion.")
  4965. (defun org-compute-latex-and-specials-regexp ()
  4966. "Compute regular expression for stuff treated specially by exporters."
  4967. (if (not org-highlight-latex-fragments-and-specials)
  4968. (org-set-local 'org-latex-and-specials-regexp nil)
  4969. (require 'org-exp)
  4970. (let*
  4971. ((matchers (plist-get org-format-latex-options :matchers))
  4972. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  4973. org-latex-regexps)))
  4974. (org-export-allow-BIND nil)
  4975. (options (org-combine-plists (org-default-export-plist)
  4976. (org-infile-export-plist)))
  4977. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  4978. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  4979. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  4980. (org-export-html-expand (plist-get options :expand-quoted-html))
  4981. (org-export-with-special-strings (plist-get options :special-strings))
  4982. (re-sub
  4983. (cond
  4984. ((equal org-export-with-sub-superscripts '{})
  4985. (list org-match-substring-with-braces-regexp))
  4986. (org-export-with-sub-superscripts
  4987. (list org-match-substring-regexp))))
  4988. (re-latex
  4989. (if org-export-with-LaTeX-fragments
  4990. (mapcar (lambda (x) (nth 1 x)) latexs)))
  4991. (re-macros
  4992. (if org-export-with-TeX-macros
  4993. (list (concat "\\\\"
  4994. (regexp-opt
  4995. (append
  4996. (delq nil
  4997. (mapcar 'car-safe
  4998. (append org-entities-user
  4999. org-entities)))
  5000. (if (boundp 'org-latex-entities)
  5001. (mapcar (lambda (x)
  5002. (or (car-safe x) x))
  5003. org-latex-entities)
  5004. nil))
  5005. 'words))) ; FIXME
  5006. ))
  5007. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  5008. (re-special (if org-export-with-special-strings
  5009. (mapcar (lambda (x) (car x))
  5010. org-export-html-special-string-regexps)))
  5011. (re-rest
  5012. (delq nil
  5013. (list
  5014. (if org-export-html-expand "@<[^>\n]+>")
  5015. ))))
  5016. (org-set-local
  5017. 'org-latex-and-specials-regexp
  5018. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  5019. re-rest) "\\|")))))
  5020. (defun org-do-latex-and-special-faces (limit)
  5021. "Run through the buffer and add overlays to links."
  5022. (when org-latex-and-specials-regexp
  5023. (let (rtn d)
  5024. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  5025. limit t))
  5026. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5027. 'face))
  5028. '(org-code org-verbatim underline)))
  5029. (progn
  5030. (setq rtn t
  5031. d (cond ((member (char-after (1+ (match-beginning 0)))
  5032. '(?_ ?^)) 1)
  5033. (t 0)))
  5034. (font-lock-prepend-text-property
  5035. (+ d (match-beginning 0)) (match-end 0)
  5036. 'face 'org-latex-and-export-specials)
  5037. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  5038. '(font-lock-multiline t)))))
  5039. rtn)))
  5040. (defun org-restart-font-lock ()
  5041. "Restart `font-lock-mode', to force refontification."
  5042. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5043. (font-lock-mode -1)
  5044. (font-lock-mode 1)))
  5045. (defun org-all-targets (&optional radio)
  5046. "Return a list of all targets in this file.
  5047. With optional argument RADIO, only find radio targets."
  5048. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  5049. rtn)
  5050. (save-excursion
  5051. (goto-char (point-min))
  5052. (while (re-search-forward re nil t)
  5053. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  5054. rtn)))
  5055. (defun org-make-target-link-regexp (targets)
  5056. "Make regular expression matching all strings in TARGETS.
  5057. The regular expression finds the targets also if there is a line break
  5058. between words."
  5059. (and targets
  5060. (concat
  5061. "\\<\\("
  5062. (mapconcat
  5063. (lambda (x)
  5064. (setq x (regexp-quote x))
  5065. (while (string-match " +" x)
  5066. (setq x (replace-match "\\s-+" t t x)))
  5067. x)
  5068. targets
  5069. "\\|")
  5070. "\\)\\>")))
  5071. (defun org-activate-tags (limit)
  5072. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5073. (progn
  5074. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5075. (add-text-properties (match-beginning 1) (match-end 1)
  5076. (list 'mouse-face 'highlight
  5077. 'keymap org-mouse-map))
  5078. (org-rear-nonsticky-at (match-end 1))
  5079. t)))
  5080. (defun org-outline-level ()
  5081. "Compute the outline level of the heading at point.
  5082. If this is called at a normal headline, the level is the number of stars.
  5083. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5084. (save-excursion
  5085. (if (not (condition-case nil
  5086. (org-back-to-heading t)
  5087. (error nil)))
  5088. 0
  5089. (looking-at org-outline-regexp)
  5090. (1- (- (match-end 0) (match-beginning 0))))))
  5091. (defvar org-font-lock-keywords nil)
  5092. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  5093. "Regular expression matching a property line.")
  5094. (defvar org-font-lock-hook nil
  5095. "Functions to be called for special font lock stuff.")
  5096. (defvar org-font-lock-set-keywords-hook nil
  5097. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5098. This is called after `org-font-lock-extra-keywords' is defined, but before
  5099. it is installed to be used by font lock. This can be useful if something
  5100. needs to be inserted at a specific position in the font-lock sequence.")
  5101. (defun org-font-lock-hook (limit)
  5102. "Run `org-font-lock-hook' within LIMIT."
  5103. (run-hook-with-args 'org-font-lock-hook limit))
  5104. (defun org-set-font-lock-defaults ()
  5105. "Set font lock defaults for the current buffer."
  5106. (let* ((em org-fontify-emphasized-text)
  5107. (lk org-activate-links)
  5108. (org-font-lock-extra-keywords
  5109. (list
  5110. ;; Call the hook
  5111. '(org-font-lock-hook)
  5112. ;; Headlines
  5113. `(,(if org-fontify-whole-heading-line
  5114. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5115. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5116. (1 (org-get-level-face 1))
  5117. (2 (org-get-level-face 2))
  5118. (3 (org-get-level-face 3)))
  5119. ;; Table lines
  5120. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5121. (1 'org-table t))
  5122. ;; Table internals
  5123. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5124. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5125. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5126. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5127. ;; Drawers
  5128. (list org-drawer-regexp '(0 'org-special-keyword t))
  5129. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5130. ;; Properties
  5131. (list org-property-re
  5132. '(1 'org-special-keyword t)
  5133. '(3 'org-property-value t))
  5134. ;; Links
  5135. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5136. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5137. (if (memq 'plain lk) '(org-activate-plain-links))
  5138. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5139. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5140. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5141. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5142. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5143. '(org-hide-wide-columns (0 nil append))
  5144. ;; TODO keyword
  5145. (list (format org-heading-keyword-regexp-format
  5146. org-todo-regexp)
  5147. '(2 (org-get-todo-face 2) t))
  5148. ;; DONE
  5149. (if org-fontify-done-headline
  5150. (list (format org-heading-keyword-regexp-format
  5151. (concat
  5152. "\\(?:"
  5153. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5154. "\\)"))
  5155. '(2 'org-headline-done t))
  5156. nil)
  5157. ;; Priorities
  5158. '(org-font-lock-add-priority-faces)
  5159. ;; Tags
  5160. '(org-font-lock-add-tag-faces)
  5161. ;; Special keywords
  5162. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5163. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5164. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5165. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5166. ;; Emphasis
  5167. (if em
  5168. (if (featurep 'xemacs)
  5169. '(org-do-emphasis-faces (0 nil append))
  5170. '(org-do-emphasis-faces)))
  5171. ;; Checkboxes
  5172. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5173. 1 'org-checkbox prepend)
  5174. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5175. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5176. (0 (org-get-checkbox-statistics-face) t)))
  5177. ;; Description list items
  5178. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5179. 1 'org-list-dt prepend)
  5180. ;; ARCHIVEd headings
  5181. (list (concat
  5182. org-outline-regexp-bol
  5183. "\\(.*:" org-archive-tag ":.*\\)")
  5184. '(1 'org-archived prepend))
  5185. ;; Specials
  5186. '(org-do-latex-and-special-faces)
  5187. '(org-fontify-entities)
  5188. '(org-raise-scripts)
  5189. ;; Code
  5190. '(org-activate-code (1 'org-code t))
  5191. ;; COMMENT
  5192. (list (format org-heading-keyword-regexp-format
  5193. (concat "\\("
  5194. org-comment-string "\\|" org-quote-string
  5195. "\\)"))
  5196. '(2 'org-special-keyword t))
  5197. ;; Blocks and meta lines
  5198. '(org-fontify-meta-lines-and-blocks)
  5199. )))
  5200. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5201. (run-hooks 'org-font-lock-set-keywords-hook)
  5202. ;; Now set the full font-lock-keywords
  5203. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5204. (org-set-local 'font-lock-defaults
  5205. '(org-font-lock-keywords t nil nil backward-paragraph))
  5206. (kill-local-variable 'font-lock-keywords) nil))
  5207. (defun org-toggle-pretty-entities ()
  5208. "Toggle the composition display of entities as UTF8 characters."
  5209. (interactive)
  5210. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5211. (org-restart-font-lock)
  5212. (if org-pretty-entities
  5213. (message "Entities are displayed as UTF8 characters")
  5214. (save-restriction
  5215. (widen)
  5216. (org-decompose-region (point-min) (point-max))
  5217. (message "Entities are displayed plain"))))
  5218. (defvar org-custom-properties-overlays nil
  5219. "List of overlays used for custom properties.")
  5220. (make-variable-buffer-local 'org-custom-properties-overlays)
  5221. (defun org-toggle-custom-properties-visibility ()
  5222. "Display or hide properties in `org-custom-properties'."
  5223. (interactive)
  5224. (if org-custom-properties-overlays
  5225. (progn (mapc 'delete-overlay org-custom-properties-overlays)
  5226. (setq org-custom-properties-overlays nil))
  5227. (unless (not org-custom-properties)
  5228. (save-excursion
  5229. (save-restriction
  5230. (widen)
  5231. (goto-char (point-min))
  5232. (while (re-search-forward org-property-re nil t)
  5233. (mapc (lambda(p)
  5234. (when (equal p (substring (match-string 1) 1 -1))
  5235. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5236. (overlay-put o 'invisible t)
  5237. (overlay-put o 'org-custom-property t)
  5238. (push o org-custom-properties-overlays))))
  5239. org-custom-properties)))))))
  5240. (defun org-fontify-entities (limit)
  5241. "Find an entity to fontify."
  5242. (let (ee)
  5243. (when org-pretty-entities
  5244. (catch 'match
  5245. (while (re-search-forward
  5246. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5247. limit t)
  5248. (if (and (not (org-in-indented-comment-line))
  5249. (setq ee (org-entity-get (match-string 1)))
  5250. (= (length (nth 6 ee)) 1))
  5251. (let*
  5252. ((end (if (equal (match-string 2) "{}")
  5253. (match-end 2)
  5254. (match-end 1))))
  5255. (add-text-properties
  5256. (match-beginning 0) end
  5257. (list 'font-lock-fontified t))
  5258. (compose-region (match-beginning 0) end
  5259. (nth 6 ee) nil)
  5260. (backward-char 1)
  5261. (throw 'match t))))
  5262. nil))))
  5263. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5264. "Fontify string S like in Org-mode."
  5265. (with-temp-buffer
  5266. (insert s)
  5267. (let ((org-odd-levels-only odd-levels))
  5268. (org-mode)
  5269. (font-lock-fontify-buffer)
  5270. (buffer-string))))
  5271. (defvar org-m nil)
  5272. (defvar org-l nil)
  5273. (defvar org-f nil)
  5274. (defun org-get-level-face (n)
  5275. "Get the right face for match N in font-lock matching of headlines."
  5276. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5277. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5278. (if org-cycle-level-faces
  5279. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5280. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5281. (cond
  5282. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5283. ((eq n 2) org-f)
  5284. (t (if org-level-color-stars-only nil org-f))))
  5285. (defun org-get-todo-face (kwd)
  5286. "Get the right face for a TODO keyword KWD.
  5287. If KWD is a number, get the corresponding match group."
  5288. (if (numberp kwd) (setq kwd (match-string kwd)))
  5289. (or (org-face-from-face-or-color
  5290. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5291. (and (member kwd org-done-keywords) 'org-done)
  5292. 'org-todo))
  5293. (defun org-face-from-face-or-color (context inherit face-or-color)
  5294. "Create a face list that inherits INHERIT, but sets the foreground color.
  5295. When FACE-OR-COLOR is not a string, just return it."
  5296. (if (stringp face-or-color)
  5297. (list :inherit inherit
  5298. (cdr (assoc context org-faces-easy-properties))
  5299. face-or-color)
  5300. face-or-color))
  5301. (defun org-font-lock-add-tag-faces (limit)
  5302. "Add the special tag faces."
  5303. (when (and org-tag-faces org-tags-special-faces-re)
  5304. (while (re-search-forward org-tags-special-faces-re limit t)
  5305. (add-text-properties (match-beginning 1) (match-end 1)
  5306. (list 'face (org-get-tag-face 1)
  5307. 'font-lock-fontified t))
  5308. (backward-char 1))))
  5309. (defun org-font-lock-add-priority-faces (limit)
  5310. "Add the special priority faces."
  5311. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5312. (when (save-match-data (org-at-heading-p))
  5313. (add-text-properties
  5314. (match-beginning 0) (match-end 0)
  5315. (list 'face (or (org-face-from-face-or-color
  5316. 'priority 'org-special-keyword
  5317. (cdr (assoc (char-after (match-beginning 1))
  5318. org-priority-faces)))
  5319. 'org-special-keyword)
  5320. 'font-lock-fontified t)))))
  5321. (defun org-get-tag-face (kwd)
  5322. "Get the right face for a TODO keyword KWD.
  5323. If KWD is a number, get the corresponding match group."
  5324. (if (numberp kwd) (setq kwd (match-string kwd)))
  5325. (or (org-face-from-face-or-color
  5326. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5327. 'org-tag))
  5328. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5329. "Remove fontification and activation overlays from links."
  5330. (font-lock-default-unfontify-region beg end)
  5331. (let* ((buffer-undo-list t)
  5332. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5333. (inhibit-modification-hooks t)
  5334. deactivate-mark buffer-file-name buffer-file-truename)
  5335. (org-decompose-region beg end)
  5336. (remove-text-properties beg end
  5337. '(mouse-face t keymap t org-linked-text t
  5338. invisible t intangible t
  5339. org-no-flyspell t org-emphasis t))
  5340. (org-remove-font-lock-display-properties beg end)))
  5341. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5342. ((raise 0.3) (height 0.7))
  5343. ((raise -0.5))
  5344. ((raise 0.5)))
  5345. "Display properties for showing superscripts and subscripts.")
  5346. (defun org-remove-font-lock-display-properties (beg end)
  5347. "Remove specific display properties that have been added by font lock.
  5348. The will remove the raise properties that are used to show superscripts
  5349. and subscripts."
  5350. (let (next prop)
  5351. (while (< beg end)
  5352. (setq next (next-single-property-change beg 'display nil end)
  5353. prop (get-text-property beg 'display))
  5354. (if (member prop org-script-display)
  5355. (put-text-property beg next 'display nil))
  5356. (setq beg next))))
  5357. (defun org-raise-scripts (limit)
  5358. "Add raise properties to sub/superscripts."
  5359. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5360. (if (re-search-forward
  5361. (if (eq org-use-sub-superscripts t)
  5362. org-match-substring-regexp
  5363. org-match-substring-with-braces-regexp)
  5364. limit t)
  5365. (let* ((pos (point)) table-p comment-p
  5366. (mpos (match-beginning 3))
  5367. (emph-p (get-text-property mpos 'org-emphasis))
  5368. (link-p (get-text-property mpos 'mouse-face))
  5369. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5370. (goto-char (point-at-bol))
  5371. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5372. comment-p (org-looking-at-p "[ \t]*#"))
  5373. (goto-char pos)
  5374. ;; FIXME: Should we go back one character here, for a_b^c
  5375. ;; (goto-char (1- pos)) ;????????????????????
  5376. (if (or comment-p emph-p link-p keyw-p)
  5377. t
  5378. (put-text-property (match-beginning 3) (match-end 0)
  5379. 'display
  5380. (if (equal (char-after (match-beginning 2)) ?^)
  5381. (nth (if table-p 3 1) org-script-display)
  5382. (nth (if table-p 2 0) org-script-display)))
  5383. (add-text-properties (match-beginning 2) (match-end 2)
  5384. (list 'invisible t
  5385. 'org-dwidth t 'org-dwidth-n 1))
  5386. (if (and (eq (char-after (match-beginning 3)) ?{)
  5387. (eq (char-before (match-end 3)) ?}))
  5388. (progn
  5389. (add-text-properties
  5390. (match-beginning 3) (1+ (match-beginning 3))
  5391. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5392. (add-text-properties
  5393. (1- (match-end 3)) (match-end 3)
  5394. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5395. t)))))
  5396. ;;;; Visibility cycling, including org-goto and indirect buffer
  5397. ;;; Cycling
  5398. (defvar org-cycle-global-status nil)
  5399. (make-variable-buffer-local 'org-cycle-global-status)
  5400. (defvar org-cycle-subtree-status nil)
  5401. (make-variable-buffer-local 'org-cycle-subtree-status)
  5402. (defvar org-inlinetask-min-level)
  5403. ;;;###autoload
  5404. (defun org-cycle (&optional arg)
  5405. "TAB-action and visibility cycling for Org-mode.
  5406. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5407. is outline visibility cycling, but it also invokes other actions
  5408. in special contexts.
  5409. - When this function is called with a prefix argument, rotate the entire
  5410. buffer through 3 states (global cycling)
  5411. 1. OVERVIEW: Show only top-level headlines.
  5412. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5413. 3. SHOW ALL: Show everything.
  5414. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5415. determined by the variable `org-startup-folded', and by any VISIBILITY
  5416. properties in the buffer.
  5417. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5418. including any drawers.
  5419. - When inside a table, re-align the table and move to the next field.
  5420. - When point is at the beginning of a headline, rotate the subtree started
  5421. by this line through 3 different states (local cycling)
  5422. 1. FOLDED: Only the main headline is shown.
  5423. 2. CHILDREN: The main headline and the direct children are shown.
  5424. From this state, you can move to one of the children
  5425. and zoom in further.
  5426. 3. SUBTREE: Show the entire subtree, including body text.
  5427. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5428. - When point is at the beginning of an empty headline and the variable
  5429. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5430. of the headline by demoting and promoting it to likely levels. This
  5431. speeds up creation document structure by pressing TAB once or several
  5432. times right after creating a new headline.
  5433. - When there is a numeric prefix, go up to a heading with level ARG, do
  5434. a `show-subtree' and return to the previous cursor position. If ARG
  5435. is negative, go up that many levels.
  5436. - When point is not at the beginning of a headline, execute the global
  5437. binding for TAB, which is re-indenting the line. See the option
  5438. `org-cycle-emulate-tab' for details.
  5439. - Special case: if point is at the beginning of the buffer and there is
  5440. no headline in line 1, this function will act as if called with prefix arg
  5441. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5442. But only if also the variable `org-cycle-global-at-bob' is t."
  5443. (interactive "P")
  5444. (org-load-modules-maybe)
  5445. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5446. (and org-cycle-level-after-item/entry-creation
  5447. (or (org-cycle-level)
  5448. (org-cycle-item-indentation))))
  5449. (let* ((limit-level
  5450. (or org-cycle-max-level
  5451. (and (boundp 'org-inlinetask-min-level)
  5452. org-inlinetask-min-level
  5453. (1- org-inlinetask-min-level))))
  5454. (nstars (and limit-level
  5455. (if org-odd-levels-only
  5456. (and limit-level (1- (* limit-level 2)))
  5457. limit-level)))
  5458. (org-outline-regexp
  5459. (if (not (derived-mode-p 'org-mode))
  5460. outline-regexp
  5461. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5462. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5463. (not (looking-at org-outline-regexp))))
  5464. (org-cycle-hook
  5465. (if bob-special
  5466. (delq 'org-optimize-window-after-visibility-change
  5467. (copy-sequence org-cycle-hook))
  5468. org-cycle-hook))
  5469. (pos (point)))
  5470. (if (or bob-special (equal arg '(4)))
  5471. ;; special case: use global cycling
  5472. (setq arg t))
  5473. (cond
  5474. ((equal arg '(16))
  5475. (setq last-command 'dummy)
  5476. (org-set-startup-visibility)
  5477. (message "Startup visibility, plus VISIBILITY properties"))
  5478. ((equal arg '(64))
  5479. (show-all)
  5480. (message "Entire buffer visible, including drawers"))
  5481. ;; Table: enter it or move to the next field.
  5482. ((org-at-table-p 'any)
  5483. (if (org-at-table.el-p)
  5484. (message "Use C-c ' to edit table.el tables")
  5485. (if arg (org-table-edit-field t)
  5486. (org-table-justify-field-maybe)
  5487. (call-interactively 'org-table-next-field))))
  5488. ((run-hook-with-args-until-success
  5489. 'org-tab-after-check-for-table-hook))
  5490. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5491. ((eq arg t) (org-cycle-internal-global))
  5492. ;; Drawers: delegate to `org-flag-drawer'.
  5493. ((and org-drawers org-drawer-regexp
  5494. (save-excursion
  5495. (beginning-of-line 1)
  5496. (looking-at org-drawer-regexp)))
  5497. (org-flag-drawer ; toggle block visibility
  5498. (not (get-char-property (match-end 0) 'invisible))))
  5499. ;; Show-subtree, ARG levels up from here.
  5500. ((integerp arg)
  5501. (save-excursion
  5502. (org-back-to-heading)
  5503. (outline-up-heading (if (< arg 0) (- arg)
  5504. (- (funcall outline-level) arg)))
  5505. (org-show-subtree)))
  5506. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5507. ((and (featurep 'org-inlinetask)
  5508. (org-inlinetask-at-task-p)
  5509. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5510. (org-inlinetask-toggle-visibility))
  5511. ((org-try-cdlatex-tab))
  5512. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5513. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5514. (save-excursion (beginning-of-line 1)
  5515. (looking-at org-outline-regexp)))
  5516. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5517. (org-cycle-internal-local))
  5518. ;; From there: TAB emulation and template completion.
  5519. (buffer-read-only (org-back-to-heading))
  5520. ((run-hook-with-args-until-success
  5521. 'org-tab-after-check-for-cycling-hook))
  5522. ((org-try-structure-completion))
  5523. ((run-hook-with-args-until-success
  5524. 'org-tab-before-tab-emulation-hook))
  5525. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5526. (or (not (bolp))
  5527. (not (looking-at org-outline-regexp))))
  5528. (call-interactively (global-key-binding "\t")))
  5529. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5530. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5531. (or (and (eq org-cycle-emulate-tab 'white)
  5532. (= (match-end 0) (point-at-eol)))
  5533. (and (eq org-cycle-emulate-tab 'whitestart)
  5534. (>= (match-end 0) pos))))
  5535. t
  5536. (eq org-cycle-emulate-tab t))
  5537. (call-interactively (global-key-binding "\t")))
  5538. (t (save-excursion
  5539. (org-back-to-heading)
  5540. (org-cycle)))))))
  5541. (defun org-cycle-internal-global ()
  5542. "Do the global cycling action."
  5543. ;; Hack to avoid display of messages for .org attachments in Gnus
  5544. (let ((ga (string-match "\\*fontification" (buffer-name))))
  5545. (cond
  5546. ((and (eq last-command this-command)
  5547. (eq org-cycle-global-status 'overview))
  5548. ;; We just created the overview - now do table of contents
  5549. ;; This can be slow in very large buffers, so indicate action
  5550. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5551. (unless ga (message "CONTENTS..."))
  5552. (org-content)
  5553. (unless ga (message "CONTENTS...done"))
  5554. (setq org-cycle-global-status 'contents)
  5555. (run-hook-with-args 'org-cycle-hook 'contents))
  5556. ((and (eq last-command this-command)
  5557. (eq org-cycle-global-status 'contents))
  5558. ;; We just showed the table of contents - now show everything
  5559. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5560. (show-all)
  5561. (unless ga (message "SHOW ALL"))
  5562. (setq org-cycle-global-status 'all)
  5563. (run-hook-with-args 'org-cycle-hook 'all))
  5564. (t
  5565. ;; Default action: go to overview
  5566. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5567. (org-overview)
  5568. (unless ga (message "OVERVIEW"))
  5569. (setq org-cycle-global-status 'overview)
  5570. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5571. (defun org-cycle-internal-local ()
  5572. "Do the local cycling action."
  5573. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5574. ;; First, determine end of headline (EOH), end of subtree or item
  5575. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5576. (save-excursion
  5577. (if (org-at-item-p)
  5578. (progn
  5579. (beginning-of-line)
  5580. (setq struct (org-list-struct))
  5581. (setq eoh (point-at-eol))
  5582. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5583. (setq has-children (org-list-has-child-p (point) struct)))
  5584. (org-back-to-heading)
  5585. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5586. (setq eos (save-excursion
  5587. (org-end-of-subtree t)
  5588. (unless (eobp)
  5589. (skip-chars-forward " \t\n"))
  5590. (if (eobp) (point) (1- (point)))))
  5591. (setq has-children
  5592. (or (save-excursion
  5593. (let ((level (funcall outline-level)))
  5594. (outline-next-heading)
  5595. (and (org-at-heading-p t)
  5596. (> (funcall outline-level) level))))
  5597. (save-excursion
  5598. (org-list-search-forward (org-item-beginning-re) eos t)))))
  5599. ;; Determine end invisible part of buffer (EOL)
  5600. (beginning-of-line 2)
  5601. ;; XEmacs doesn't have `next-single-char-property-change'
  5602. (if (featurep 'xemacs)
  5603. (while (and (not (eobp)) ;; this is like `next-line'
  5604. (get-char-property (1- (point)) 'invisible))
  5605. (beginning-of-line 2))
  5606. (while (and (not (eobp)) ;; this is like `next-line'
  5607. (get-char-property (1- (point)) 'invisible))
  5608. (goto-char (next-single-char-property-change (point) 'invisible))
  5609. (and (eolp) (beginning-of-line 2))))
  5610. (setq eol (point)))
  5611. ;; Find out what to do next and set `this-command'
  5612. (cond
  5613. ((= eos eoh)
  5614. ;; Nothing is hidden behind this heading
  5615. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5616. (message "EMPTY ENTRY")
  5617. (setq org-cycle-subtree-status nil)
  5618. (save-excursion
  5619. (goto-char eos)
  5620. (outline-next-heading)
  5621. (if (outline-invisible-p) (org-flag-heading nil))))
  5622. ((and (or (>= eol eos)
  5623. (not (string-match "\\S-" (buffer-substring eol eos))))
  5624. (or has-children
  5625. (not (setq children-skipped
  5626. org-cycle-skip-children-state-if-no-children))))
  5627. ;; Entire subtree is hidden in one line: children view
  5628. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5629. (if (org-at-item-p)
  5630. (org-list-set-item-visibility (point-at-bol) struct 'children)
  5631. (org-show-entry)
  5632. (org-with-limited-levels (show-children))
  5633. ;; FIXME: This slows down the func way too much.
  5634. ;; How keep drawers hidden in subtree anyway?
  5635. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  5636. ;; (org-cycle-hide-drawers 'subtree))
  5637. ;; Fold every list in subtree to top-level items.
  5638. (when (eq org-cycle-include-plain-lists 'integrate)
  5639. (save-excursion
  5640. (org-back-to-heading)
  5641. (while (org-list-search-forward (org-item-beginning-re) eos t)
  5642. (beginning-of-line 1)
  5643. (let* ((struct (org-list-struct))
  5644. (prevs (org-list-prevs-alist struct))
  5645. (end (org-list-get-bottom-point struct)))
  5646. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  5647. (org-list-get-all-items (point) struct prevs))
  5648. (goto-char end))))))
  5649. (message "CHILDREN")
  5650. (save-excursion
  5651. (goto-char eos)
  5652. (outline-next-heading)
  5653. (if (outline-invisible-p) (org-flag-heading nil)))
  5654. (setq org-cycle-subtree-status 'children)
  5655. (run-hook-with-args 'org-cycle-hook 'children))
  5656. ((or children-skipped
  5657. (and (eq last-command this-command)
  5658. (eq org-cycle-subtree-status 'children)))
  5659. ;; We just showed the children, or no children are there,
  5660. ;; now show everything.
  5661. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5662. (outline-flag-region eoh eos nil)
  5663. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5664. (setq org-cycle-subtree-status 'subtree)
  5665. (run-hook-with-args 'org-cycle-hook 'subtree))
  5666. (t
  5667. ;; Default action: hide the subtree.
  5668. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5669. (outline-flag-region eoh eos t)
  5670. (message "FOLDED")
  5671. (setq org-cycle-subtree-status 'folded)
  5672. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5673. ;;;###autoload
  5674. (defun org-global-cycle (&optional arg)
  5675. "Cycle the global visibility. For details see `org-cycle'.
  5676. With \\[universal-argument] prefix arg, switch to startup visibility.
  5677. With a numeric prefix, show all headlines up to that level."
  5678. (interactive "P")
  5679. (let ((org-cycle-include-plain-lists
  5680. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  5681. (cond
  5682. ((integerp arg)
  5683. (show-all)
  5684. (hide-sublevels arg)
  5685. (setq org-cycle-global-status 'contents))
  5686. ((equal arg '(4))
  5687. (org-set-startup-visibility)
  5688. (message "Startup visibility, plus VISIBILITY properties."))
  5689. (t
  5690. (org-cycle '(4))))))
  5691. (defun org-set-startup-visibility ()
  5692. "Set the visibility required by startup options and properties."
  5693. (cond
  5694. ((eq org-startup-folded t)
  5695. (org-cycle '(4)))
  5696. ((eq org-startup-folded 'content)
  5697. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5698. (org-cycle '(4)) (org-cycle '(4)))))
  5699. (unless (eq org-startup-folded 'showeverything)
  5700. (if org-hide-block-startup (org-hide-block-all))
  5701. (org-set-visibility-according-to-property 'no-cleanup)
  5702. (org-cycle-hide-archived-subtrees 'all)
  5703. (org-cycle-hide-drawers 'all)
  5704. (org-cycle-show-empty-lines t)))
  5705. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5706. "Switch subtree visibilities according to :VISIBILITY: property."
  5707. (interactive)
  5708. (let (org-show-entry-below state)
  5709. (save-excursion
  5710. (goto-char (point-min))
  5711. (while (re-search-forward
  5712. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5713. nil t)
  5714. (setq state (match-string 1))
  5715. (save-excursion
  5716. (org-back-to-heading t)
  5717. (hide-subtree)
  5718. (org-reveal)
  5719. (cond
  5720. ((equal state '("fold" "folded"))
  5721. (hide-subtree))
  5722. ((equal state "children")
  5723. (org-show-hidden-entry)
  5724. (show-children))
  5725. ((equal state "content")
  5726. (save-excursion
  5727. (save-restriction
  5728. (org-narrow-to-subtree)
  5729. (org-content))))
  5730. ((member state '("all" "showall"))
  5731. (show-subtree)))))
  5732. (unless no-cleanup
  5733. (org-cycle-hide-archived-subtrees 'all)
  5734. (org-cycle-hide-drawers 'all)
  5735. (org-cycle-show-empty-lines 'all)))))
  5736. ;; This function uses outline-regexp instead of the more fundamental
  5737. ;; org-outline-regexp so that org-cycle-global works outside of Org
  5738. ;; buffers, where outline-regexp is needed.
  5739. (defun org-overview ()
  5740. "Switch to overview mode, showing only top-level headlines.
  5741. Really, this shows all headlines with level equal or greater than the level
  5742. of the first headline in the buffer. This is important, because if the
  5743. first headline is not level one, then (hide-sublevels 1) gives confusing
  5744. results."
  5745. (interactive)
  5746. (let ((level (save-excursion
  5747. (goto-char (point-min))
  5748. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5749. (progn
  5750. (goto-char (match-beginning 0))
  5751. (funcall outline-level))))))
  5752. (and level (hide-sublevels level))))
  5753. (defun org-content (&optional arg)
  5754. "Show all headlines in the buffer, like a table of contents.
  5755. With numerical argument N, show content up to level N."
  5756. (interactive "P")
  5757. (save-excursion
  5758. ;; Visit all headings and show their offspring
  5759. (and (integerp arg) (org-overview))
  5760. (goto-char (point-max))
  5761. (catch 'exit
  5762. (while (and (progn (condition-case nil
  5763. (outline-previous-visible-heading 1)
  5764. (error (goto-char (point-min))))
  5765. t)
  5766. (looking-at org-outline-regexp))
  5767. (if (integerp arg)
  5768. (show-children (1- arg))
  5769. (show-branches))
  5770. (if (bobp) (throw 'exit nil))))))
  5771. (defun org-optimize-window-after-visibility-change (state)
  5772. "Adjust the window after a change in outline visibility.
  5773. This function is the default value of the hook `org-cycle-hook'."
  5774. (when (get-buffer-window (current-buffer))
  5775. (cond
  5776. ((eq state 'content) nil)
  5777. ((eq state 'all) nil)
  5778. ((eq state 'folded) nil)
  5779. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5780. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5781. (defun org-remove-empty-overlays-at (pos)
  5782. "Remove outline overlays that do not contain non-white stuff."
  5783. (mapc
  5784. (lambda (o)
  5785. (and (eq 'outline (overlay-get o 'invisible))
  5786. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5787. (overlay-end o))))
  5788. (delete-overlay o)))
  5789. (overlays-at pos)))
  5790. (defun org-clean-visibility-after-subtree-move ()
  5791. "Fix visibility issues after moving a subtree."
  5792. ;; First, find a reasonable region to look at:
  5793. ;; Start two siblings above, end three below
  5794. (let* ((beg (save-excursion
  5795. (and (org-get-last-sibling)
  5796. (org-get-last-sibling))
  5797. (point)))
  5798. (end (save-excursion
  5799. (and (org-get-next-sibling)
  5800. (org-get-next-sibling)
  5801. (org-get-next-sibling))
  5802. (if (org-at-heading-p)
  5803. (point-at-eol)
  5804. (point))))
  5805. (level (looking-at "\\*+"))
  5806. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5807. (save-excursion
  5808. (save-restriction
  5809. (narrow-to-region beg end)
  5810. (when re
  5811. ;; Properly fold already folded siblings
  5812. (goto-char (point-min))
  5813. (while (re-search-forward re nil t)
  5814. (if (and (not (outline-invisible-p))
  5815. (save-excursion
  5816. (goto-char (point-at-eol)) (outline-invisible-p)))
  5817. (hide-entry))))
  5818. (org-cycle-show-empty-lines 'overview)
  5819. (org-cycle-hide-drawers 'overview)))))
  5820. (defun org-cycle-show-empty-lines (state)
  5821. "Show empty lines above all visible headlines.
  5822. The region to be covered depends on STATE when called through
  5823. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5824. entire buffer covered. Note that an empty line is only shown if there
  5825. are at least `org-cycle-separator-lines' empty lines before the headline."
  5826. (when (not (= org-cycle-separator-lines 0))
  5827. (save-excursion
  5828. (let* ((n (abs org-cycle-separator-lines))
  5829. (re (cond
  5830. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5831. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5832. (t (let ((ns (number-to-string (- n 2))))
  5833. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5834. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5835. beg end b e)
  5836. (cond
  5837. ((memq state '(overview contents t))
  5838. (setq beg (point-min) end (point-max)))
  5839. ((memq state '(children folded))
  5840. (setq beg (point) end (progn (org-end-of-subtree t t)
  5841. (beginning-of-line 2)
  5842. (point)))))
  5843. (when beg
  5844. (goto-char beg)
  5845. (while (re-search-forward re end t)
  5846. (unless (get-char-property (match-end 1) 'invisible)
  5847. (setq e (match-end 1))
  5848. (if (< org-cycle-separator-lines 0)
  5849. (setq b (save-excursion
  5850. (goto-char (match-beginning 0))
  5851. (org-back-over-empty-lines)
  5852. (if (save-excursion
  5853. (goto-char (max (point-min) (1- (point))))
  5854. (org-at-heading-p))
  5855. (1- (point))
  5856. (point))))
  5857. (setq b (match-beginning 1)))
  5858. (outline-flag-region b e nil)))))))
  5859. ;; Never hide empty lines at the end of the file.
  5860. (save-excursion
  5861. (goto-char (point-max))
  5862. (outline-previous-heading)
  5863. (outline-end-of-heading)
  5864. (if (and (looking-at "[ \t\n]+")
  5865. (= (match-end 0) (point-max)))
  5866. (outline-flag-region (point) (match-end 0) nil))))
  5867. (defun org-show-empty-lines-in-parent ()
  5868. "Move to the parent and re-show empty lines before visible headlines."
  5869. (save-excursion
  5870. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  5871. (org-cycle-show-empty-lines context))))
  5872. (defun org-files-list ()
  5873. "Return `org-agenda-files' list, plus all open org-mode files.
  5874. This is useful for operations that need to scan all of a user's
  5875. open and agenda-wise Org files."
  5876. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  5877. (dolist (buf (buffer-list))
  5878. (with-current-buffer buf
  5879. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  5880. (let ((file (expand-file-name (buffer-file-name))))
  5881. (unless (member file files)
  5882. (push file files))))))
  5883. files))
  5884. (defsubst org-entry-beginning-position ()
  5885. "Return the beginning position of the current entry."
  5886. (save-excursion (outline-back-to-heading t) (point)))
  5887. (defsubst org-entry-end-position ()
  5888. "Return the end position of the current entry."
  5889. (save-excursion (outline-next-heading) (point)))
  5890. (defun org-cycle-hide-drawers (state)
  5891. "Re-hide all drawers after a visibility state change."
  5892. (when (and (derived-mode-p 'org-mode)
  5893. (not (memq state '(overview folded contents))))
  5894. (save-excursion
  5895. (let* ((globalp (memq state '(contents all)))
  5896. (beg (if globalp (point-min) (point)))
  5897. (end (if globalp (point-max)
  5898. (if (eq state 'children)
  5899. (save-excursion (outline-next-heading) (point))
  5900. (org-end-of-subtree t)))))
  5901. (goto-char beg)
  5902. (while (re-search-forward org-drawer-regexp end t)
  5903. (org-flag-drawer t))))))
  5904. (defun org-cycle-hide-inline-tasks (state)
  5905. "Re-hide inline task when switching to 'contents visibility state."
  5906. (when (and (eq state 'contents)
  5907. (boundp 'org-inlinetask-min-level)
  5908. org-inlinetask-min-level)
  5909. (hide-sublevels (1- org-inlinetask-min-level))))
  5910. (defun org-flag-drawer (flag)
  5911. "When FLAG is non-nil, hide the drawer we are within.
  5912. Otherwise make it visible."
  5913. (save-excursion
  5914. (beginning-of-line 1)
  5915. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  5916. (let ((b (match-end 0)))
  5917. (if (re-search-forward
  5918. "^[ \t]*:END:"
  5919. (save-excursion (outline-next-heading) (point)) t)
  5920. (outline-flag-region b (point-at-eol) flag)
  5921. (error ":END: line missing at position %s" b))))))
  5922. (defun org-subtree-end-visible-p ()
  5923. "Is the end of the current subtree visible?"
  5924. (pos-visible-in-window-p
  5925. (save-excursion (org-end-of-subtree t) (point))))
  5926. (defun org-first-headline-recenter (&optional N)
  5927. "Move cursor to the first headline and recenter the headline.
  5928. Optional argument N means put the headline into the Nth line of the window."
  5929. (goto-char (point-min))
  5930. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  5931. (beginning-of-line)
  5932. (recenter (prefix-numeric-value N))))
  5933. ;;; Saving and restoring visibility
  5934. (defun org-outline-overlay-data (&optional use-markers)
  5935. "Return a list of the locations of all outline overlays.
  5936. These are overlays with the `invisible' property value `outline'.
  5937. The return value is a list of cons cells, with start and stop
  5938. positions for each overlay.
  5939. If USE-MARKERS is set, return the positions as markers."
  5940. (let (beg end)
  5941. (save-excursion
  5942. (save-restriction
  5943. (widen)
  5944. (delq nil
  5945. (mapcar (lambda (o)
  5946. (when (eq (overlay-get o 'invisible) 'outline)
  5947. (setq beg (overlay-start o)
  5948. end (overlay-end o))
  5949. (and beg end (> end beg)
  5950. (if use-markers
  5951. (cons (move-marker (make-marker) beg)
  5952. (move-marker (make-marker) end))
  5953. (cons beg end)))))
  5954. (overlays-in (point-min) (point-max))))))))
  5955. (defun org-set-outline-overlay-data (data)
  5956. "Create visibility overlays for all positions in DATA.
  5957. DATA should have been made by `org-outline-overlay-data'."
  5958. (let (o)
  5959. (save-excursion
  5960. (save-restriction
  5961. (widen)
  5962. (show-all)
  5963. (mapc (lambda (c)
  5964. (outline-flag-region (car c) (cdr c) t))
  5965. data)))))
  5966. ;;; Folding of blocks
  5967. (defvar org-hide-block-overlays nil
  5968. "Overlays hiding blocks.")
  5969. (make-variable-buffer-local 'org-hide-block-overlays)
  5970. (defun org-block-map (function &optional start end)
  5971. "Call FUNCTION at the head of all source blocks in the current buffer.
  5972. Optional arguments START and END can be used to limit the range."
  5973. (let ((start (or start (point-min)))
  5974. (end (or end (point-max))))
  5975. (save-excursion
  5976. (goto-char start)
  5977. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  5978. (save-excursion
  5979. (save-match-data
  5980. (goto-char (match-beginning 0))
  5981. (funcall function)))))))
  5982. (defun org-hide-block-toggle-all ()
  5983. "Toggle the visibility of all blocks in the current buffer."
  5984. (org-block-map #'org-hide-block-toggle))
  5985. (defun org-hide-block-all ()
  5986. "Fold all blocks in the current buffer."
  5987. (interactive)
  5988. (org-show-block-all)
  5989. (org-block-map #'org-hide-block-toggle-maybe))
  5990. (defun org-show-block-all ()
  5991. "Unfold all blocks in the current buffer."
  5992. (interactive)
  5993. (mapc 'delete-overlay org-hide-block-overlays)
  5994. (setq org-hide-block-overlays nil))
  5995. (defun org-hide-block-toggle-maybe ()
  5996. "Toggle visibility of block at point."
  5997. (interactive)
  5998. (let ((case-fold-search t))
  5999. (if (save-excursion
  6000. (beginning-of-line 1)
  6001. (looking-at org-block-regexp))
  6002. (progn (org-hide-block-toggle)
  6003. t) ;; to signal that we took action
  6004. nil))) ;; to signal that we did not
  6005. (defun org-hide-block-toggle (&optional force)
  6006. "Toggle the visibility of the current block."
  6007. (interactive)
  6008. (save-excursion
  6009. (beginning-of-line)
  6010. (if (re-search-forward org-block-regexp nil t)
  6011. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6012. (end (match-end 0)) ;; end of entire body
  6013. ov)
  6014. (if (memq t (mapcar (lambda (overlay)
  6015. (eq (overlay-get overlay 'invisible)
  6016. 'org-hide-block))
  6017. (overlays-at start)))
  6018. (if (or (not force) (eq force 'off))
  6019. (mapc (lambda (ov)
  6020. (when (member ov org-hide-block-overlays)
  6021. (setq org-hide-block-overlays
  6022. (delq ov org-hide-block-overlays)))
  6023. (when (eq (overlay-get ov 'invisible)
  6024. 'org-hide-block)
  6025. (delete-overlay ov)))
  6026. (overlays-at start)))
  6027. (setq ov (make-overlay start end))
  6028. (overlay-put ov 'invisible 'org-hide-block)
  6029. ;; make the block accessible to isearch
  6030. (overlay-put
  6031. ov 'isearch-open-invisible
  6032. (lambda (ov)
  6033. (when (member ov org-hide-block-overlays)
  6034. (setq org-hide-block-overlays
  6035. (delq ov org-hide-block-overlays)))
  6036. (when (eq (overlay-get ov 'invisible)
  6037. 'org-hide-block)
  6038. (delete-overlay ov))))
  6039. (push ov org-hide-block-overlays)))
  6040. (error "Not looking at a source block"))))
  6041. ;; org-tab-after-check-for-cycling-hook
  6042. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6043. ;; Remove overlays when changing major mode
  6044. (add-hook 'org-mode-hook
  6045. (lambda () (org-add-hook 'change-major-mode-hook
  6046. 'org-show-block-all 'append 'local)))
  6047. ;;; Org-goto
  6048. (defvar org-goto-window-configuration nil)
  6049. (defvar org-goto-marker nil)
  6050. (defvar org-goto-map
  6051. (let ((map (make-sparse-keymap)))
  6052. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  6053. (while (setq cmd (pop cmds))
  6054. (substitute-key-definition cmd cmd map global-map)))
  6055. (suppress-keymap map)
  6056. (org-defkey map "\C-m" 'org-goto-ret)
  6057. (org-defkey map [(return)] 'org-goto-ret)
  6058. (org-defkey map [(left)] 'org-goto-left)
  6059. (org-defkey map [(right)] 'org-goto-right)
  6060. (org-defkey map [(control ?g)] 'org-goto-quit)
  6061. (org-defkey map "\C-i" 'org-cycle)
  6062. (org-defkey map [(tab)] 'org-cycle)
  6063. (org-defkey map [(down)] 'outline-next-visible-heading)
  6064. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6065. (if org-goto-auto-isearch
  6066. (if (fboundp 'define-key-after)
  6067. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6068. nil)
  6069. (org-defkey map "q" 'org-goto-quit)
  6070. (org-defkey map "n" 'outline-next-visible-heading)
  6071. (org-defkey map "p" 'outline-previous-visible-heading)
  6072. (org-defkey map "f" 'outline-forward-same-level)
  6073. (org-defkey map "b" 'outline-backward-same-level)
  6074. (org-defkey map "u" 'outline-up-heading))
  6075. (org-defkey map "/" 'org-occur)
  6076. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6077. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6078. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6079. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6080. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6081. map))
  6082. (defconst org-goto-help
  6083. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  6084. RET=jump to location [Q]uit and return to previous location
  6085. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6086. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6087. ;; FIXME: Docstring does not mention both interfaces
  6088. (defun org-goto (&optional alternative-interface)
  6089. "Look up a different location in the current file, keeping current visibility.
  6090. When you want look-up or go to a different location in a
  6091. document, the fastest way is often to fold the entire buffer and
  6092. then dive into the tree. This method has the disadvantage, that
  6093. the previous location will be folded, which may not be what you
  6094. want.
  6095. This command works around this by showing a copy of the current
  6096. buffer in an indirect buffer, in overview mode. You can dive
  6097. into the tree in that copy, use org-occur and incremental search
  6098. to find a location. When pressing RET or `Q', the command
  6099. returns to the original buffer in which the visibility is still
  6100. unchanged. After RET it will also jump to the location selected
  6101. in the indirect buffer and expose the headline hierarchy above.
  6102. With a prefix argument, use the alternative interface: e.g. if
  6103. `org-goto-interface' is 'outline use 'outline-path-completion."
  6104. (interactive "P")
  6105. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6106. (org-refile-use-outline-path t)
  6107. (org-refile-target-verify-function nil)
  6108. (interface
  6109. (if (not alternative-interface)
  6110. org-goto-interface
  6111. (if (eq org-goto-interface 'outline)
  6112. 'outline-path-completion
  6113. 'outline)))
  6114. (org-goto-start-pos (point))
  6115. (selected-point
  6116. (if (eq interface 'outline)
  6117. (car (org-get-location (current-buffer) org-goto-help))
  6118. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6119. (org-refile-check-position pa)
  6120. (nth 3 pa)))))
  6121. (if selected-point
  6122. (progn
  6123. (org-mark-ring-push org-goto-start-pos)
  6124. (goto-char selected-point)
  6125. (if (or (outline-invisible-p) (org-invisible-p2))
  6126. (org-show-context 'org-goto)))
  6127. (message "Quit"))))
  6128. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6129. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6130. (defvar org-goto-local-auto-isearch-map) ; defined below
  6131. (defun org-get-location (buf help)
  6132. "Let the user select a location in the Org-mode buffer BUF.
  6133. This function uses a recursive edit. It returns the selected position
  6134. or nil."
  6135. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6136. (isearch-hide-immediately nil)
  6137. (isearch-search-fun-function
  6138. (lambda () 'org-goto-local-search-headings))
  6139. (org-goto-selected-point org-goto-exit-command)
  6140. (pop-up-frames nil)
  6141. (special-display-buffer-names nil)
  6142. (special-display-regexps nil)
  6143. (special-display-function nil))
  6144. (save-excursion
  6145. (save-window-excursion
  6146. (delete-other-windows)
  6147. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6148. (org-pop-to-buffer-same-window
  6149. (condition-case nil
  6150. (make-indirect-buffer (current-buffer) "*org-goto*")
  6151. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6152. (with-output-to-temp-buffer "*Help*"
  6153. (princ help))
  6154. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  6155. (setq buffer-read-only nil)
  6156. (let ((org-startup-truncated t)
  6157. (org-startup-folded nil)
  6158. (org-startup-align-all-tables nil))
  6159. (org-mode)
  6160. (org-overview))
  6161. (setq buffer-read-only t)
  6162. (if (and (boundp 'org-goto-start-pos)
  6163. (integer-or-marker-p org-goto-start-pos))
  6164. (let ((org-show-hierarchy-above t)
  6165. (org-show-siblings t)
  6166. (org-show-following-heading t))
  6167. (goto-char org-goto-start-pos)
  6168. (and (outline-invisible-p) (org-show-context)))
  6169. (goto-char (point-min)))
  6170. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6171. (message "Select location and press RET")
  6172. (use-local-map org-goto-map)
  6173. (recursive-edit)
  6174. ))
  6175. (kill-buffer "*org-goto*")
  6176. (cons org-goto-selected-point org-goto-exit-command)))
  6177. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6178. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6179. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6180. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6181. (defun org-goto-local-search-headings (string bound noerror)
  6182. "Search and make sure that any matches are in headlines."
  6183. (catch 'return
  6184. (while (if isearch-forward
  6185. (search-forward string bound noerror)
  6186. (search-backward string bound noerror))
  6187. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6188. (and (member :headline context)
  6189. (not (member :tags context))))
  6190. (throw 'return (point))))))
  6191. (defun org-goto-local-auto-isearch ()
  6192. "Start isearch."
  6193. (interactive)
  6194. (goto-char (point-min))
  6195. (let ((keys (this-command-keys)))
  6196. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6197. (isearch-mode t)
  6198. (isearch-process-search-char (string-to-char keys)))))
  6199. (defun org-goto-ret (&optional arg)
  6200. "Finish `org-goto' by going to the new location."
  6201. (interactive "P")
  6202. (setq org-goto-selected-point (point)
  6203. org-goto-exit-command 'return)
  6204. (throw 'exit nil))
  6205. (defun org-goto-left ()
  6206. "Finish `org-goto' by going to the new location."
  6207. (interactive)
  6208. (if (org-at-heading-p)
  6209. (progn
  6210. (beginning-of-line 1)
  6211. (setq org-goto-selected-point (point)
  6212. org-goto-exit-command 'left)
  6213. (throw 'exit nil))
  6214. (error "Not on a heading")))
  6215. (defun org-goto-right ()
  6216. "Finish `org-goto' by going to the new location."
  6217. (interactive)
  6218. (if (org-at-heading-p)
  6219. (progn
  6220. (setq org-goto-selected-point (point)
  6221. org-goto-exit-command 'right)
  6222. (throw 'exit nil))
  6223. (error "Not on a heading")))
  6224. (defun org-goto-quit ()
  6225. "Finish `org-goto' without cursor motion."
  6226. (interactive)
  6227. (setq org-goto-selected-point nil)
  6228. (setq org-goto-exit-command 'quit)
  6229. (throw 'exit nil))
  6230. ;;; Indirect buffer display of subtrees
  6231. (defvar org-indirect-dedicated-frame nil
  6232. "This is the frame being used for indirect tree display.")
  6233. (defvar org-last-indirect-buffer nil)
  6234. (defun org-tree-to-indirect-buffer (&optional arg)
  6235. "Create indirect buffer and narrow it to current subtree.
  6236. With a numerical prefix ARG, go up to this level and then take that tree.
  6237. If ARG is negative, go up that many levels.
  6238. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6239. indirect buffer previously made with this command, to avoid proliferation of
  6240. indirect buffers. However, when you call the command with a \
  6241. \\[universal-argument] prefix, or
  6242. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6243. is kept so that you can work with several indirect buffers at the same time.
  6244. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6245. \\[universal-argument] prefix also
  6246. requests that a new frame be made for the new buffer, so that the dedicated
  6247. frame is not changed."
  6248. (interactive "P")
  6249. (let ((cbuf (current-buffer))
  6250. (cwin (selected-window))
  6251. (pos (point))
  6252. beg end level heading ibuf)
  6253. (save-excursion
  6254. (org-back-to-heading t)
  6255. (when (numberp arg)
  6256. (setq level (org-outline-level))
  6257. (if (< arg 0) (setq arg (+ level arg)))
  6258. (while (> (setq level (org-outline-level)) arg)
  6259. (org-up-heading-safe)))
  6260. (setq beg (point)
  6261. heading (org-get-heading))
  6262. (org-end-of-subtree t t)
  6263. (if (org-at-heading-p) (backward-char 1))
  6264. (setq end (point)))
  6265. (if (and (buffer-live-p org-last-indirect-buffer)
  6266. (not (eq org-indirect-buffer-display 'new-frame))
  6267. (not arg))
  6268. (kill-buffer org-last-indirect-buffer))
  6269. (setq ibuf (org-get-indirect-buffer cbuf)
  6270. org-last-indirect-buffer ibuf)
  6271. (cond
  6272. ((or (eq org-indirect-buffer-display 'new-frame)
  6273. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6274. (select-frame (make-frame))
  6275. (delete-other-windows)
  6276. (org-pop-to-buffer-same-window ibuf)
  6277. (org-set-frame-title heading))
  6278. ((eq org-indirect-buffer-display 'dedicated-frame)
  6279. (raise-frame
  6280. (select-frame (or (and org-indirect-dedicated-frame
  6281. (frame-live-p org-indirect-dedicated-frame)
  6282. org-indirect-dedicated-frame)
  6283. (setq org-indirect-dedicated-frame (make-frame)))))
  6284. (delete-other-windows)
  6285. (org-pop-to-buffer-same-window ibuf)
  6286. (org-set-frame-title (concat "Indirect: " heading)))
  6287. ((eq org-indirect-buffer-display 'current-window)
  6288. (org-pop-to-buffer-same-window ibuf))
  6289. ((eq org-indirect-buffer-display 'other-window)
  6290. (pop-to-buffer ibuf))
  6291. (t (error "Invalid value")))
  6292. (if (featurep 'xemacs)
  6293. (save-excursion (org-mode) (turn-on-font-lock)))
  6294. (narrow-to-region beg end)
  6295. (show-all)
  6296. (goto-char pos)
  6297. (run-hook-with-args 'org-cycle-hook 'all)
  6298. (and (window-live-p cwin) (select-window cwin))))
  6299. (defun org-get-indirect-buffer (&optional buffer)
  6300. (setq buffer (or buffer (current-buffer)))
  6301. (let ((n 1) (base (buffer-name buffer)) bname)
  6302. (while (buffer-live-p
  6303. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6304. (setq n (1+ n)))
  6305. (condition-case nil
  6306. (make-indirect-buffer buffer bname 'clone)
  6307. (error (make-indirect-buffer buffer bname)))))
  6308. (defun org-set-frame-title (title)
  6309. "Set the title of the current frame to the string TITLE."
  6310. ;; FIXME: how to name a single frame in XEmacs???
  6311. (unless (featurep 'xemacs)
  6312. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6313. ;;;; Structure editing
  6314. ;;; Inserting headlines
  6315. (defun org-previous-line-empty-p ()
  6316. (save-excursion
  6317. (and (not (bobp))
  6318. (or (beginning-of-line 0) t)
  6319. (save-match-data
  6320. (looking-at "[ \t]*$")))))
  6321. (defun org-insert-heading (&optional force-heading invisible-ok)
  6322. "Insert a new heading or item with same depth at point.
  6323. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  6324. If point is at the beginning of a headline, insert a sibling before the
  6325. current headline. If point is not at the beginning, split the line,
  6326. create the new headline with the text in the current line after point
  6327. \(but see also the variable `org-M-RET-may-split-line').
  6328. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6329. This is important for non-interactive uses of the command."
  6330. (interactive "P")
  6331. (if (or (= (buffer-size) 0)
  6332. (and (not (save-excursion
  6333. (and (ignore-errors (org-back-to-heading invisible-ok))
  6334. (org-at-heading-p))))
  6335. (or force-heading (not (org-in-item-p)))))
  6336. (progn
  6337. (insert "\n* ")
  6338. (run-hooks 'org-insert-heading-hook))
  6339. (when (or force-heading (not (org-insert-item)))
  6340. (let* ((empty-line-p nil)
  6341. (level nil)
  6342. (on-heading (org-at-heading-p))
  6343. (head (save-excursion
  6344. (condition-case nil
  6345. (progn
  6346. (org-back-to-heading invisible-ok)
  6347. (when (and (not on-heading)
  6348. (featurep 'org-inlinetask)
  6349. (integerp org-inlinetask-min-level)
  6350. (>= (length (match-string 0))
  6351. org-inlinetask-min-level))
  6352. ;; Find a heading level before the inline task
  6353. (while (and (setq level (org-up-heading-safe))
  6354. (>= level org-inlinetask-min-level)))
  6355. (if (org-at-heading-p)
  6356. (org-back-to-heading invisible-ok)
  6357. (error "This should not happen")))
  6358. (setq empty-line-p (org-previous-line-empty-p))
  6359. (match-string 0))
  6360. (error "*"))))
  6361. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6362. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6363. pos hide-previous previous-pos)
  6364. (cond
  6365. ((and (org-at-heading-p) (bolp)
  6366. (or (bobp)
  6367. (save-excursion (backward-char 1) (not (outline-invisible-p)))))
  6368. ;; insert before the current line
  6369. (open-line (if blank 2 1)))
  6370. ((and (bolp)
  6371. (not org-insert-heading-respect-content)
  6372. (or (bobp)
  6373. (save-excursion
  6374. (backward-char 1) (not (outline-invisible-p)))))
  6375. ;; insert right here
  6376. nil)
  6377. (t
  6378. ;; somewhere in the line
  6379. (save-excursion
  6380. (setq previous-pos (point-at-bol))
  6381. (end-of-line)
  6382. (setq hide-previous (outline-invisible-p)))
  6383. (and org-insert-heading-respect-content (org-show-subtree))
  6384. (let ((split
  6385. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  6386. (save-excursion
  6387. (let ((p (point)))
  6388. (goto-char (point-at-bol))
  6389. (and (looking-at org-complex-heading-regexp)
  6390. (match-beginning 4)
  6391. (> p (match-beginning 4)))))))
  6392. tags pos)
  6393. (cond
  6394. (org-insert-heading-respect-content
  6395. (org-end-of-subtree nil t)
  6396. (when (featurep 'org-inlinetask)
  6397. (while (and (not (eobp))
  6398. (looking-at "\\(\\*+\\)[ \t]+")
  6399. (>= (length (match-string 1))
  6400. org-inlinetask-min-level))
  6401. (org-end-of-subtree nil t)))
  6402. (or (bolp) (newline))
  6403. (or (org-previous-line-empty-p)
  6404. (and blank (newline)))
  6405. (open-line 1))
  6406. ((org-at-heading-p)
  6407. (when hide-previous
  6408. (show-children)
  6409. (org-show-entry))
  6410. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  6411. (setq tags (and (match-end 2) (match-string 2)))
  6412. (and (match-end 1)
  6413. (delete-region (match-beginning 1) (match-end 1)))
  6414. (setq pos (point-at-bol))
  6415. (or split (end-of-line 1))
  6416. (delete-horizontal-space)
  6417. (if (string-match "\\`\\*+\\'"
  6418. (buffer-substring (point-at-bol) (point)))
  6419. (insert " "))
  6420. (newline (if blank 2 1))
  6421. (when tags
  6422. (save-excursion
  6423. (goto-char pos)
  6424. (end-of-line 1)
  6425. (insert " " tags)
  6426. (org-set-tags nil 'align))))
  6427. (t
  6428. (or split (end-of-line 1))
  6429. (newline (if blank 2 1)))))))
  6430. (insert head) (just-one-space)
  6431. (setq pos (point))
  6432. (end-of-line 1)
  6433. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  6434. (when (and org-insert-heading-respect-content hide-previous)
  6435. (save-excursion
  6436. (goto-char previous-pos)
  6437. (hide-subtree)))
  6438. (run-hooks 'org-insert-heading-hook)))))
  6439. (defun org-get-heading (&optional no-tags no-todo)
  6440. "Return the heading of the current entry, without the stars.
  6441. When NO-TAGS is non-nil, don't include tags.
  6442. When NO-TODO is non-nil, don't include TODO keywords."
  6443. (save-excursion
  6444. (org-back-to-heading t)
  6445. (cond
  6446. ((and no-tags no-todo)
  6447. (looking-at org-complex-heading-regexp)
  6448. (match-string 4))
  6449. (no-tags
  6450. (looking-at (concat org-outline-regexp
  6451. "\\(.*?\\)"
  6452. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6453. (match-string 1))
  6454. (no-todo
  6455. (looking-at org-todo-line-regexp)
  6456. (match-string 3))
  6457. (t (looking-at org-heading-regexp)
  6458. (match-string 2)))))
  6459. (defun org-heading-components ()
  6460. "Return the components of the current heading.
  6461. This is a list with the following elements:
  6462. - the level as an integer
  6463. - the reduced level, different if `org-odd-levels-only' is set.
  6464. - the TODO keyword, or nil
  6465. - the priority character, like ?A, or nil if no priority is given
  6466. - the headline text itself, or the tags string if no headline text
  6467. - the tags string, or nil."
  6468. (save-excursion
  6469. (org-back-to-heading t)
  6470. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  6471. (list (length (match-string 1))
  6472. (org-reduced-level (length (match-string 1)))
  6473. (org-match-string-no-properties 2)
  6474. (and (match-end 3) (aref (match-string 3) 2))
  6475. (org-match-string-no-properties 4)
  6476. (org-match-string-no-properties 5)))))
  6477. (defun org-get-entry ()
  6478. "Get the entry text, after heading, entire subtree."
  6479. (save-excursion
  6480. (org-back-to-heading t)
  6481. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6482. (defun org-insert-heading-after-current ()
  6483. "Insert a new heading with same level as current, after current subtree."
  6484. (interactive)
  6485. (org-back-to-heading)
  6486. (org-insert-heading)
  6487. (org-move-subtree-down)
  6488. (end-of-line 1))
  6489. (defun org-insert-heading-respect-content ()
  6490. (interactive)
  6491. (let ((org-insert-heading-respect-content t))
  6492. (org-insert-heading t)))
  6493. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6494. (interactive "P")
  6495. (let ((org-insert-heading-respect-content t))
  6496. (org-insert-todo-heading force-state t)))
  6497. (defun org-insert-todo-heading (arg &optional force-heading)
  6498. "Insert a new heading with the same level and TODO state as current heading.
  6499. If the heading has no TODO state, or if the state is DONE, use the first
  6500. state (TODO by default). Also with prefix arg, force first state."
  6501. (interactive "P")
  6502. (when (or force-heading (not (org-insert-item 'checkbox)))
  6503. (org-insert-heading force-heading)
  6504. (save-excursion
  6505. (org-back-to-heading)
  6506. (outline-previous-heading)
  6507. (looking-at org-todo-line-regexp))
  6508. (let*
  6509. ((new-mark-x
  6510. (if (or arg
  6511. (not (match-beginning 2))
  6512. (member (match-string 2) org-done-keywords))
  6513. (car org-todo-keywords-1)
  6514. (match-string 2)))
  6515. (new-mark
  6516. (or
  6517. (run-hook-with-args-until-success
  6518. 'org-todo-get-default-hook new-mark-x nil)
  6519. new-mark-x)))
  6520. (beginning-of-line 1)
  6521. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6522. (if org-treat-insert-todo-heading-as-state-change
  6523. (org-todo new-mark)
  6524. (insert new-mark " "))))
  6525. (when org-provide-todo-statistics
  6526. (org-update-parent-todo-statistics))))
  6527. (defun org-insert-subheading (arg)
  6528. "Insert a new subheading and demote it.
  6529. Works for outline headings and for plain lists alike."
  6530. (interactive "P")
  6531. (org-insert-heading arg)
  6532. (cond
  6533. ((org-at-heading-p) (org-do-demote))
  6534. ((org-at-item-p) (org-indent-item))))
  6535. (defun org-insert-todo-subheading (arg)
  6536. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6537. Works for outline headings and for plain lists alike."
  6538. (interactive "P")
  6539. (org-insert-todo-heading arg)
  6540. (cond
  6541. ((org-at-heading-p) (org-do-demote))
  6542. ((org-at-item-p) (org-indent-item))))
  6543. ;;; Promotion and Demotion
  6544. (defvar org-after-demote-entry-hook nil
  6545. "Hook run after an entry has been demoted.
  6546. The cursor will be at the beginning of the entry.
  6547. When a subtree is being demoted, the hook will be called for each node.")
  6548. (defvar org-after-promote-entry-hook nil
  6549. "Hook run after an entry has been promoted.
  6550. The cursor will be at the beginning of the entry.
  6551. When a subtree is being promoted, the hook will be called for each node.")
  6552. (defun org-promote-subtree ()
  6553. "Promote the entire subtree.
  6554. See also `org-promote'."
  6555. (interactive)
  6556. (save-excursion
  6557. (org-with-limited-levels (org-map-tree 'org-promote)))
  6558. (org-fix-position-after-promote))
  6559. (defun org-demote-subtree ()
  6560. "Demote the entire subtree. See `org-demote'.
  6561. See also `org-promote'."
  6562. (interactive)
  6563. (save-excursion
  6564. (org-with-limited-levels (org-map-tree 'org-demote)))
  6565. (org-fix-position-after-promote))
  6566. (defun org-do-promote ()
  6567. "Promote the current heading higher up the tree.
  6568. If the region is active in `transient-mark-mode', promote all headings
  6569. in the region."
  6570. (interactive)
  6571. (save-excursion
  6572. (if (org-region-active-p)
  6573. (org-map-region 'org-promote (region-beginning) (region-end))
  6574. (org-promote)))
  6575. (org-fix-position-after-promote))
  6576. (defun org-do-demote ()
  6577. "Demote the current heading lower down the tree.
  6578. If the region is active in `transient-mark-mode', demote all headings
  6579. in the region."
  6580. (interactive)
  6581. (save-excursion
  6582. (if (org-region-active-p)
  6583. (org-map-region 'org-demote (region-beginning) (region-end))
  6584. (org-demote)))
  6585. (org-fix-position-after-promote))
  6586. (defun org-fix-position-after-promote ()
  6587. "Make sure that after pro/demotion cursor position is right."
  6588. (let ((pos (point)))
  6589. (when (save-excursion
  6590. (beginning-of-line 1)
  6591. (looking-at org-todo-line-regexp)
  6592. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6593. (cond ((eobp) (insert " "))
  6594. ((eolp) (insert " "))
  6595. ((equal (char-after) ?\ ) (forward-char 1))))))
  6596. (defun org-current-level ()
  6597. "Return the level of the current entry, or nil if before the first headline.
  6598. The level is the number of stars at the beginning of the headline."
  6599. (save-excursion
  6600. (org-with-limited-levels
  6601. (if (ignore-errors (org-back-to-heading t))
  6602. (funcall outline-level)))))
  6603. (defun org-get-previous-line-level ()
  6604. "Return the outline depth of the last headline before the current line.
  6605. Returns 0 for the first headline in the buffer, and nil if before the
  6606. first headline."
  6607. (let ((current-level (org-current-level))
  6608. (prev-level (when (> (line-number-at-pos) 1)
  6609. (save-excursion
  6610. (beginning-of-line 0)
  6611. (org-current-level)))))
  6612. (cond ((null current-level) nil) ; Before first headline
  6613. ((null prev-level) 0) ; At first headline
  6614. (prev-level))))
  6615. (defun org-reduced-level (l)
  6616. "Compute the effective level of a heading.
  6617. This takes into account the setting of `org-odd-levels-only'."
  6618. (cond
  6619. ((zerop l) 0)
  6620. (org-odd-levels-only (1+ (floor (/ l 2))))
  6621. (t l)))
  6622. (defun org-level-increment ()
  6623. "Return the number of stars that will be added or removed at a
  6624. time to headlines when structure editing, based on the value of
  6625. `org-odd-levels-only'."
  6626. (if org-odd-levels-only 2 1))
  6627. (defun org-get-valid-level (level &optional change)
  6628. "Rectify a level change under the influence of `org-odd-levels-only'
  6629. LEVEL is a current level, CHANGE is by how much the level should be
  6630. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6631. even level numbers will become the next higher odd number."
  6632. (if org-odd-levels-only
  6633. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6634. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6635. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6636. (max 1 (+ level (or change 0)))))
  6637. (if (boundp 'define-obsolete-function-alias)
  6638. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6639. (define-obsolete-function-alias 'org-get-legal-level
  6640. 'org-get-valid-level)
  6641. (define-obsolete-function-alias 'org-get-legal-level
  6642. 'org-get-valid-level "23.1")))
  6643. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  6644. ;; ̀org-with-limited-levels'
  6645. (defun org-promote ()
  6646. "Promote the current heading higher up the tree.
  6647. If the region is active in `transient-mark-mode', promote all headings
  6648. in the region."
  6649. (org-back-to-heading t)
  6650. (let* ((level (save-match-data (funcall outline-level)))
  6651. (after-change-functions (remove 'flyspell-after-change-function
  6652. after-change-functions))
  6653. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6654. (diff (abs (- level (length up-head) -1))))
  6655. (cond ((and (= level 1) org-called-with-limited-levels
  6656. org-allow-promoting-top-level-subtree)
  6657. (replace-match "# " nil t))
  6658. ((= level 1)
  6659. (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6660. (t (replace-match up-head nil t)))
  6661. ;; Fixup tag positioning
  6662. (unless (= level 1)
  6663. (and org-auto-align-tags (org-set-tags nil t))
  6664. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  6665. (run-hooks 'org-after-promote-entry-hook)))
  6666. (defun org-demote ()
  6667. "Demote the current heading lower down the tree.
  6668. If the region is active in `transient-mark-mode', demote all headings
  6669. in the region."
  6670. (org-back-to-heading t)
  6671. (let* ((level (save-match-data (funcall outline-level)))
  6672. (after-change-functions (remove 'flyspell-after-change-function
  6673. after-change-functions))
  6674. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6675. (diff (abs (- level (length down-head) -1))))
  6676. (replace-match down-head nil t)
  6677. ;; Fixup tag positioning
  6678. (and org-auto-align-tags (org-set-tags nil t))
  6679. (if org-adapt-indentation (org-fixup-indentation diff))
  6680. (run-hooks 'org-after-demote-entry-hook)))
  6681. (defun org-cycle-level ()
  6682. "Cycle the level of an empty headline through possible states.
  6683. This goes first to child, then to parent, level, then up the hierarchy.
  6684. After top level, it switches back to sibling level."
  6685. (interactive)
  6686. (let ((org-adapt-indentation nil))
  6687. (when (org-point-at-end-of-empty-headline)
  6688. (setq this-command 'org-cycle-level) ; Only needed for caching
  6689. (let ((cur-level (org-current-level))
  6690. (prev-level (org-get-previous-line-level)))
  6691. (cond
  6692. ;; If first headline in file, promote to top-level.
  6693. ((= prev-level 0)
  6694. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6695. do (org-do-promote)))
  6696. ;; If same level as prev, demote one.
  6697. ((= prev-level cur-level)
  6698. (org-do-demote))
  6699. ;; If parent is top-level, promote to top level if not already.
  6700. ((= prev-level 1)
  6701. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6702. do (org-do-promote)))
  6703. ;; If top-level, return to prev-level.
  6704. ((= cur-level 1)
  6705. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6706. do (org-do-demote)))
  6707. ;; If less than prev-level, promote one.
  6708. ((< cur-level prev-level)
  6709. (org-do-promote))
  6710. ;; If deeper than prev-level, promote until higher than
  6711. ;; prev-level.
  6712. ((> cur-level prev-level)
  6713. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6714. do (org-do-promote))))
  6715. t))))
  6716. (defun org-map-tree (fun)
  6717. "Call FUN for every heading underneath the current one."
  6718. (org-back-to-heading)
  6719. (let ((level (funcall outline-level)))
  6720. (save-excursion
  6721. (funcall fun)
  6722. (while (and (progn
  6723. (outline-next-heading)
  6724. (> (funcall outline-level) level))
  6725. (not (eobp)))
  6726. (funcall fun)))))
  6727. (defun org-map-region (fun beg end)
  6728. "Call FUN for every heading between BEG and END."
  6729. (let ((org-ignore-region t))
  6730. (save-excursion
  6731. (setq end (copy-marker end))
  6732. (goto-char beg)
  6733. (if (and (re-search-forward org-outline-regexp-bol nil t)
  6734. (< (point) end))
  6735. (funcall fun))
  6736. (while (and (progn
  6737. (outline-next-heading)
  6738. (< (point) end))
  6739. (not (eobp)))
  6740. (funcall fun)))))
  6741. (defvar org-property-end-re) ; silence byte-compiler
  6742. (defun org-fixup-indentation (diff)
  6743. "Change the indentation in the current entry by DIFF.
  6744. However, if any line in the current entry has no indentation, or if it
  6745. would end up with no indentation after the change, nothing at all is done."
  6746. (save-excursion
  6747. (let ((end (save-excursion (outline-next-heading)
  6748. (point-marker)))
  6749. (prohibit (if (> diff 0)
  6750. "^\\S-"
  6751. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6752. col)
  6753. (unless (save-excursion (end-of-line 1)
  6754. (re-search-forward prohibit end t))
  6755. (while (and (< (point) end)
  6756. (re-search-forward "^[ \t]+" end t))
  6757. (goto-char (match-end 0))
  6758. (setq col (current-column))
  6759. (if (< diff 0) (replace-match ""))
  6760. (org-indent-to-column (+ diff col))))
  6761. (move-marker end nil))))
  6762. (defun org-convert-to-odd-levels ()
  6763. "Convert an org-mode file with all levels allowed to one with odd levels.
  6764. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6765. level 5 etc."
  6766. (interactive)
  6767. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6768. (let ((outline-level 'org-outline-level)
  6769. (org-odd-levels-only nil) n)
  6770. (save-excursion
  6771. (goto-char (point-min))
  6772. (while (re-search-forward "^\\*\\*+ " nil t)
  6773. (setq n (- (length (match-string 0)) 2))
  6774. (while (>= (setq n (1- n)) 0)
  6775. (org-demote))
  6776. (end-of-line 1))))))
  6777. (defun org-convert-to-oddeven-levels ()
  6778. "Convert an org-mode file with only odd levels to one with odd/even levels.
  6779. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6780. file contains a section with an even level, conversion would
  6781. destroy the structure of the file. An error is signaled in this
  6782. case."
  6783. (interactive)
  6784. (goto-char (point-min))
  6785. ;; First check if there are no even levels
  6786. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6787. (org-show-context t)
  6788. (error "Not all levels are odd in this file. Conversion not possible"))
  6789. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6790. (let ((outline-regexp org-outline-regexp)
  6791. (outline-level 'org-outline-level)
  6792. (org-odd-levels-only nil) n)
  6793. (save-excursion
  6794. (goto-char (point-min))
  6795. (while (re-search-forward "^\\*\\*+ " nil t)
  6796. (setq n (/ (1- (length (match-string 0))) 2))
  6797. (while (>= (setq n (1- n)) 0)
  6798. (org-promote))
  6799. (end-of-line 1))))))
  6800. (defun org-tr-level (n)
  6801. "Make N odd if required."
  6802. (if org-odd-levels-only (1+ (/ n 2)) n))
  6803. ;;; Vertical tree motion, cutting and pasting of subtrees
  6804. (defun org-move-subtree-up (&optional arg)
  6805. "Move the current subtree up past ARG headlines of the same level."
  6806. (interactive "p")
  6807. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6808. (defun org-move-subtree-down (&optional arg)
  6809. "Move the current subtree down past ARG headlines of the same level."
  6810. (interactive "p")
  6811. (setq arg (prefix-numeric-value arg))
  6812. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6813. 'org-get-last-sibling))
  6814. (ins-point (make-marker))
  6815. (cnt (abs arg))
  6816. (col (current-column))
  6817. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6818. ;; Select the tree
  6819. (org-back-to-heading)
  6820. (setq beg0 (point))
  6821. (save-excursion
  6822. (setq ne-beg (org-back-over-empty-lines))
  6823. (setq beg (point)))
  6824. (save-match-data
  6825. (save-excursion (outline-end-of-heading)
  6826. (setq folded (outline-invisible-p)))
  6827. (outline-end-of-subtree))
  6828. (outline-next-heading)
  6829. (setq ne-end (org-back-over-empty-lines))
  6830. (setq end (point))
  6831. (goto-char beg0)
  6832. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6833. ;; include less whitespace
  6834. (save-excursion
  6835. (goto-char beg)
  6836. (forward-line (- ne-beg ne-end))
  6837. (setq beg (point))))
  6838. ;; Find insertion point, with error handling
  6839. (while (> cnt 0)
  6840. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  6841. (progn (goto-char beg0)
  6842. (error "Cannot move past superior level or buffer limit")))
  6843. (setq cnt (1- cnt)))
  6844. (if (> arg 0)
  6845. ;; Moving forward - still need to move over subtree
  6846. (progn (org-end-of-subtree t t)
  6847. (save-excursion
  6848. (org-back-over-empty-lines)
  6849. (or (bolp) (newline)))))
  6850. (setq ne-ins (org-back-over-empty-lines))
  6851. (move-marker ins-point (point))
  6852. (setq txt (buffer-substring beg end))
  6853. (org-save-markers-in-region beg end)
  6854. (delete-region beg end)
  6855. (org-remove-empty-overlays-at beg)
  6856. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6857. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6858. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6859. (let ((bbb (point)))
  6860. (insert-before-markers txt)
  6861. (org-reinstall-markers-in-region bbb)
  6862. (move-marker ins-point bbb))
  6863. (or (bolp) (insert "\n"))
  6864. (setq ins-end (point))
  6865. (goto-char ins-point)
  6866. (org-skip-whitespace)
  6867. (when (and (< arg 0)
  6868. (org-first-sibling-p)
  6869. (> ne-ins ne-beg))
  6870. ;; Move whitespace back to beginning
  6871. (save-excursion
  6872. (goto-char ins-end)
  6873. (let ((kill-whole-line t))
  6874. (kill-line (- ne-ins ne-beg)) (point)))
  6875. (insert (make-string (- ne-ins ne-beg) ?\n)))
  6876. (move-marker ins-point nil)
  6877. (if folded
  6878. (hide-subtree)
  6879. (org-show-entry)
  6880. (show-children)
  6881. (org-cycle-hide-drawers 'children))
  6882. (org-clean-visibility-after-subtree-move)
  6883. ;; move back to the initial column we were at
  6884. (move-to-column col)))
  6885. (defvar org-subtree-clip ""
  6886. "Clipboard for cut and paste of subtrees.
  6887. This is actually only a copy of the kill, because we use the normal kill
  6888. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  6889. (defvar org-subtree-clip-folded nil
  6890. "Was the last copied subtree folded?
  6891. This is used to fold the tree back after pasting.")
  6892. (defun org-cut-subtree (&optional n)
  6893. "Cut the current subtree into the clipboard.
  6894. With prefix arg N, cut this many sequential subtrees.
  6895. This is a short-hand for marking the subtree and then cutting it."
  6896. (interactive "p")
  6897. (org-copy-subtree n 'cut))
  6898. (defun org-copy-subtree (&optional n cut force-store-markers)
  6899. "Cut the current subtree into the clipboard.
  6900. With prefix arg N, cut this many sequential subtrees.
  6901. This is a short-hand for marking the subtree and then copying it.
  6902. If CUT is non-nil, actually cut the subtree.
  6903. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  6904. of some markers in the region, even if CUT is non-nil. This is
  6905. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  6906. (interactive "p")
  6907. (let (beg end folded (beg0 (point)))
  6908. (if (org-called-interactively-p 'any)
  6909. (org-back-to-heading nil) ; take what looks like a subtree
  6910. (org-back-to-heading t)) ; take what is really there
  6911. (org-back-over-empty-lines)
  6912. (setq beg (point))
  6913. (skip-chars-forward " \t\r\n")
  6914. (save-match-data
  6915. (save-excursion (outline-end-of-heading)
  6916. (setq folded (outline-invisible-p)))
  6917. (condition-case nil
  6918. (org-forward-heading-same-level (1- n) t)
  6919. (error nil))
  6920. (org-end-of-subtree t t))
  6921. (org-back-over-empty-lines)
  6922. (setq end (point))
  6923. (goto-char beg0)
  6924. (when (> end beg)
  6925. (setq org-subtree-clip-folded folded)
  6926. (when (or cut force-store-markers)
  6927. (org-save-markers-in-region beg end))
  6928. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  6929. (setq org-subtree-clip (current-kill 0))
  6930. (message "%s: Subtree(s) with %d characters"
  6931. (if cut "Cut" "Copied")
  6932. (length org-subtree-clip)))))
  6933. (defun org-paste-subtree (&optional level tree for-yank)
  6934. "Paste the clipboard as a subtree, with modification of headline level.
  6935. The entire subtree is promoted or demoted in order to match a new headline
  6936. level.
  6937. If the cursor is at the beginning of a headline, the same level as
  6938. that headline is used to paste the tree
  6939. If not, the new level is derived from the *visible* headings
  6940. before and after the insertion point, and taken to be the inferior headline
  6941. level of the two. So if the previous visible heading is level 3 and the
  6942. next is level 4 (or vice versa), level 4 will be used for insertion.
  6943. This makes sure that the subtree remains an independent subtree and does
  6944. not swallow low level entries.
  6945. You can also force a different level, either by using a numeric prefix
  6946. argument, or by inserting the heading marker by hand. For example, if the
  6947. cursor is after \"*****\", then the tree will be shifted to level 5.
  6948. If optional TREE is given, use this text instead of the kill ring.
  6949. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  6950. move back over whitespace before inserting, and move point to the end of
  6951. the inserted text when done."
  6952. (interactive "P")
  6953. (setq tree (or tree (and kill-ring (current-kill 0))))
  6954. (unless (org-kill-is-subtree-p tree)
  6955. (error "%s"
  6956. (substitute-command-keys
  6957. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  6958. (org-with-limited-levels
  6959. (let* ((visp (not (outline-invisible-p)))
  6960. (txt tree)
  6961. (^re_ "\\(\\*+\\)[ \t]*")
  6962. (old-level (if (string-match org-outline-regexp-bol txt)
  6963. (- (match-end 0) (match-beginning 0) 1)
  6964. -1))
  6965. (force-level (cond (level (prefix-numeric-value level))
  6966. ((and (looking-at "[ \t]*$")
  6967. (string-match
  6968. "^\\*+$" (buffer-substring
  6969. (point-at-bol) (point))))
  6970. (- (match-end 1) (match-beginning 1)))
  6971. ((and (bolp)
  6972. (looking-at org-outline-regexp))
  6973. (- (match-end 0) (point) 1))))
  6974. (previous-level (save-excursion
  6975. (condition-case nil
  6976. (progn
  6977. (outline-previous-visible-heading 1)
  6978. (if (looking-at ^re_)
  6979. (- (match-end 0) (match-beginning 0) 1)
  6980. 1))
  6981. (error 1))))
  6982. (next-level (save-excursion
  6983. (condition-case nil
  6984. (progn
  6985. (or (looking-at org-outline-regexp)
  6986. (outline-next-visible-heading 1))
  6987. (if (looking-at ^re_)
  6988. (- (match-end 0) (match-beginning 0) 1)
  6989. 1))
  6990. (error 1))))
  6991. (new-level (or force-level (max previous-level next-level)))
  6992. (shift (if (or (= old-level -1)
  6993. (= new-level -1)
  6994. (= old-level new-level))
  6995. 0
  6996. (- new-level old-level)))
  6997. (delta (if (> shift 0) -1 1))
  6998. (func (if (> shift 0) 'org-demote 'org-promote))
  6999. (org-odd-levels-only nil)
  7000. beg end newend)
  7001. ;; Remove the forced level indicator
  7002. (if force-level
  7003. (delete-region (point-at-bol) (point)))
  7004. ;; Paste
  7005. (beginning-of-line (if (bolp) 1 2))
  7006. (unless for-yank (org-back-over-empty-lines))
  7007. (setq beg (point))
  7008. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7009. (insert-before-markers txt)
  7010. (unless (string-match "\n\\'" txt) (insert "\n"))
  7011. (setq newend (point))
  7012. (org-reinstall-markers-in-region beg)
  7013. (setq end (point))
  7014. (goto-char beg)
  7015. (skip-chars-forward " \t\n\r")
  7016. (setq beg (point))
  7017. (if (and (outline-invisible-p) visp)
  7018. (save-excursion (outline-show-heading)))
  7019. ;; Shift if necessary
  7020. (unless (= shift 0)
  7021. (save-restriction
  7022. (narrow-to-region beg end)
  7023. (while (not (= shift 0))
  7024. (org-map-region func (point-min) (point-max))
  7025. (setq shift (+ delta shift)))
  7026. (goto-char (point-min))
  7027. (setq newend (point-max))))
  7028. (when (or (org-called-interactively-p 'interactive) for-yank)
  7029. (message "Clipboard pasted as level %d subtree" new-level))
  7030. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7031. kill-ring
  7032. (eq org-subtree-clip (current-kill 0))
  7033. org-subtree-clip-folded)
  7034. ;; The tree was folded before it was killed/copied
  7035. (hide-subtree))
  7036. (and for-yank (goto-char newend)))))
  7037. (defun org-kill-is-subtree-p (&optional txt)
  7038. "Check if the current kill is an outline subtree, or a set of trees.
  7039. Returns nil if kill does not start with a headline, or if the first
  7040. headline level is not the largest headline level in the tree.
  7041. So this will actually accept several entries of equal levels as well,
  7042. which is OK for `org-paste-subtree'.
  7043. If optional TXT is given, check this string instead of the current kill."
  7044. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7045. (re (org-get-limited-outline-regexp))
  7046. (^re (concat "^" re))
  7047. (start-level (and kill
  7048. (string-match
  7049. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7050. kill)
  7051. (- (match-end 2) (match-beginning 2) 1)))
  7052. (start (1+ (or (match-beginning 2) -1))))
  7053. (if (not start-level)
  7054. (progn
  7055. nil) ;; does not even start with a heading
  7056. (catch 'exit
  7057. (while (setq start (string-match ^re kill (1+ start)))
  7058. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7059. (throw 'exit nil)))
  7060. t))))
  7061. (defvar org-markers-to-move nil
  7062. "Markers that should be moved with a cut-and-paste operation.
  7063. Those markers are stored together with their positions relative to
  7064. the start of the region.")
  7065. (defun org-save-markers-in-region (beg end)
  7066. "Check markers in region.
  7067. If these markers are between BEG and END, record their position relative
  7068. to BEG, so that after moving the block of text, we can put the markers back
  7069. into place.
  7070. This function gets called just before an entry or tree gets cut from the
  7071. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7072. called immediately, to move the markers with the entries."
  7073. (setq org-markers-to-move nil)
  7074. (when (featurep 'org-clock)
  7075. (org-clock-save-markers-for-cut-and-paste beg end))
  7076. (when (featurep 'org-agenda)
  7077. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7078. (defun org-check-and-save-marker (marker beg end)
  7079. "Check if MARKER is between BEG and END.
  7080. If yes, remember the marker and the distance to BEG."
  7081. (when (and (marker-buffer marker)
  7082. (equal (marker-buffer marker) (current-buffer)))
  7083. (if (and (>= marker beg) (< marker end))
  7084. (push (cons marker (- marker beg)) org-markers-to-move))))
  7085. (defun org-reinstall-markers-in-region (beg)
  7086. "Move all remembered markers to their position relative to BEG."
  7087. (mapc (lambda (x)
  7088. (move-marker (car x) (+ beg (cdr x))))
  7089. org-markers-to-move)
  7090. (setq org-markers-to-move nil))
  7091. (defun org-narrow-to-subtree ()
  7092. "Narrow buffer to the current subtree."
  7093. (interactive)
  7094. (save-excursion
  7095. (save-match-data
  7096. (org-with-limited-levels
  7097. (narrow-to-region
  7098. (progn (org-back-to-heading t) (point))
  7099. (progn (org-end-of-subtree t t)
  7100. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7101. (point)))))))
  7102. (defun org-narrow-to-block ()
  7103. "Narrow buffer to the current block."
  7104. (interactive)
  7105. (let* ((case-fold-search t)
  7106. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7107. "^[ \t]*#\\+end_.*")))
  7108. (if blockp
  7109. (narrow-to-region (car blockp) (cdr blockp))
  7110. (error "Not in a block"))))
  7111. (eval-when-compile
  7112. (defvar org-property-drawer-re))
  7113. (defvar org-property-start-re) ;; defined below
  7114. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7115. "Clone the task (subtree) at point N times.
  7116. The clones will be inserted as siblings.
  7117. In interactive use, the user will be prompted for the number of
  7118. clones to be produced, and for a time SHIFT, which may be a
  7119. repeater as used in time stamps, for example `+3d'.
  7120. When a valid repeater is given and the entry contains any time
  7121. stamps, the clones will become a sequence in time, with time
  7122. stamps in the subtree shifted for each clone produced. If SHIFT
  7123. is nil or the empty string, time stamps will be left alone. The
  7124. ID property of the original subtree is removed.
  7125. If the original subtree did contain time stamps with a repeater,
  7126. the following will happen:
  7127. - the repeater will be removed in each clone
  7128. - an additional clone will be produced, with the current, unshifted
  7129. date(s) in the entry.
  7130. - the original entry will be placed *after* all the clones, with
  7131. repeater intact.
  7132. - the start days in the repeater in the original entry will be shifted
  7133. to past the last clone.
  7134. In this way you can spell out a number of instances of a repeating task,
  7135. and still retain the repeater to cover future instances of the task."
  7136. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  7137. (let (beg end template task idprop
  7138. shift-n shift-what doshift nmin nmax (n-no-remove -1)
  7139. (drawer-re org-drawer-regexp))
  7140. (if (not (and (integerp n) (> n 0)))
  7141. (error "Invalid number of replications %s" n))
  7142. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7143. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7144. shift)))
  7145. (error "Invalid shift specification %s" shift))
  7146. (when doshift
  7147. (setq shift-n (string-to-number (match-string 1 shift))
  7148. shift-what (cdr (assoc (match-string 2 shift)
  7149. '(("d" . day) ("w" . week)
  7150. ("m" . month) ("y" . year))))))
  7151. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7152. (setq nmin 1 nmax n)
  7153. (org-back-to-heading t)
  7154. (setq beg (point))
  7155. (setq idprop (org-entry-get nil "ID"))
  7156. (org-end-of-subtree t t)
  7157. (or (bolp) (insert "\n"))
  7158. (setq end (point))
  7159. (setq template (buffer-substring beg end))
  7160. (when (and doshift
  7161. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7162. (delete-region beg end)
  7163. (setq end beg)
  7164. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7165. (goto-char end)
  7166. (loop for n from nmin to nmax do
  7167. ;; prepare clone
  7168. (with-temp-buffer
  7169. (insert template)
  7170. (org-mode)
  7171. (goto-char (point-min))
  7172. (org-show-subtree)
  7173. (and idprop (if org-clone-delete-id
  7174. (org-entry-delete nil "ID")
  7175. (org-id-get-create t)))
  7176. (unless (= n 0)
  7177. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7178. (kill-whole-line))
  7179. (goto-char (point-min))
  7180. (while (re-search-forward drawer-re nil t)
  7181. (mapc (lambda (d)
  7182. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7183. (goto-char (point-min))
  7184. (when doshift
  7185. (while (re-search-forward org-ts-regexp-both nil t)
  7186. (org-timestamp-change (* n shift-n) shift-what))
  7187. (unless (= n n-no-remove)
  7188. (goto-char (point-min))
  7189. (while (re-search-forward org-ts-regexp nil t)
  7190. (save-excursion
  7191. (goto-char (match-beginning 0))
  7192. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7193. (delete-region (match-beginning 1) (match-end 1)))))))
  7194. (setq task (buffer-string)))
  7195. (insert task))
  7196. (goto-char beg)))
  7197. ;;; Outline Sorting
  7198. (defun org-sort (with-case)
  7199. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7200. Optional argument WITH-CASE means sort case-sensitively."
  7201. (interactive "P")
  7202. (cond
  7203. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7204. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7205. (t
  7206. (org-call-with-arg 'org-sort-entries with-case))))
  7207. (defun org-sort-remove-invisible (s)
  7208. (remove-text-properties 0 (length s) org-rm-props s)
  7209. (while (string-match org-bracket-link-regexp s)
  7210. (setq s (replace-match (if (match-end 2)
  7211. (match-string 3 s)
  7212. (match-string 1 s)) t t s)))
  7213. s)
  7214. (defvar org-priority-regexp) ; defined later in the file
  7215. (defvar org-after-sorting-entries-or-items-hook nil
  7216. "Hook that is run after a bunch of entries or items have been sorted.
  7217. When children are sorted, the cursor is in the parent line when this
  7218. hook gets called. When a region or a plain list is sorted, the cursor
  7219. will be in the first entry of the sorted region/list.")
  7220. (defun org-sort-entries
  7221. (&optional with-case sorting-type getkey-func compare-func property)
  7222. "Sort entries on a certain level of an outline tree.
  7223. If there is an active region, the entries in the region are sorted.
  7224. Else, if the cursor is before the first entry, sort the top-level items.
  7225. Else, the children of the entry at point are sorted.
  7226. Sorting can be alphabetically, numerically, by date/time as given by
  7227. a time stamp, by a property or by priority.
  7228. The command prompts for the sorting type unless it has been given to the
  7229. function through the SORTING-TYPE argument, which needs to be a character,
  7230. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  7231. precise meaning of each character:
  7232. n Numerically, by converting the beginning of the entry/item to a number.
  7233. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7234. t By date/time, either the first active time stamp in the entry, or, if
  7235. none exist, by the first inactive one.
  7236. s By the scheduled date/time.
  7237. d By deadline date/time.
  7238. c By creation time, which is assumed to be the first inactive time stamp
  7239. at the beginning of a line.
  7240. p By priority according to the cookie.
  7241. r By the value of a property.
  7242. Capital letters will reverse the sort order.
  7243. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7244. called with point at the beginning of the record. It must return either
  7245. a string or a number that should serve as the sorting key for that record.
  7246. Comparing entries ignores case by default. However, with an optional argument
  7247. WITH-CASE, the sorting considers case as well."
  7248. (interactive "P")
  7249. (let ((case-func (if with-case 'identity 'downcase))
  7250. start beg end stars re re2
  7251. txt what tmp)
  7252. ;; Find beginning and end of region to sort
  7253. (cond
  7254. ((org-region-active-p)
  7255. ;; we will sort the region
  7256. (setq end (region-end)
  7257. what "region")
  7258. (goto-char (region-beginning))
  7259. (if (not (org-at-heading-p)) (outline-next-heading))
  7260. (setq start (point)))
  7261. ((or (org-at-heading-p)
  7262. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7263. ;; we will sort the children of the current headline
  7264. (org-back-to-heading)
  7265. (setq start (point)
  7266. end (progn (org-end-of-subtree t t)
  7267. (or (bolp) (insert "\n"))
  7268. (org-back-over-empty-lines)
  7269. (point))
  7270. what "children")
  7271. (goto-char start)
  7272. (show-subtree)
  7273. (outline-next-heading))
  7274. (t
  7275. ;; we will sort the top-level entries in this file
  7276. (goto-char (point-min))
  7277. (or (org-at-heading-p) (outline-next-heading))
  7278. (setq start (point))
  7279. (goto-char (point-max))
  7280. (beginning-of-line 1)
  7281. (when (looking-at ".*?\\S-")
  7282. ;; File ends in a non-white line
  7283. (end-of-line 1)
  7284. (insert "\n"))
  7285. (setq end (point-max))
  7286. (setq what "top-level")
  7287. (goto-char start)
  7288. (show-all)))
  7289. (setq beg (point))
  7290. (if (>= beg end) (error "Nothing to sort"))
  7291. (looking-at "\\(\\*+\\)")
  7292. (setq stars (match-string 1)
  7293. re (concat "^" (regexp-quote stars) " +")
  7294. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7295. txt (buffer-substring beg end))
  7296. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7297. (if (and (not (equal stars "*")) (string-match re2 txt))
  7298. (error "Region to sort contains a level above the first entry"))
  7299. (unless sorting-type
  7300. (message
  7301. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7302. [t]ime [s]cheduled [d]eadline [c]reated
  7303. A/N/T/S/D/C/P/O/F means reversed:"
  7304. what)
  7305. (setq sorting-type (read-char-exclusive))
  7306. (and (= (downcase sorting-type) ?f)
  7307. (setq getkey-func
  7308. (org-icompleting-read "Sort using function: "
  7309. obarray 'fboundp t nil nil))
  7310. (setq getkey-func (intern getkey-func)))
  7311. (and (= (downcase sorting-type) ?r)
  7312. (setq property
  7313. (org-icompleting-read "Property: "
  7314. (mapcar 'list (org-buffer-property-keys t))
  7315. nil t))))
  7316. (message "Sorting entries...")
  7317. (save-restriction
  7318. (narrow-to-region start end)
  7319. (let ((dcst (downcase sorting-type))
  7320. (case-fold-search nil)
  7321. (now (current-time)))
  7322. (sort-subr
  7323. (/= dcst sorting-type)
  7324. ;; This function moves to the beginning character of the "record" to
  7325. ;; be sorted.
  7326. (lambda nil
  7327. (if (re-search-forward re nil t)
  7328. (goto-char (match-beginning 0))
  7329. (goto-char (point-max))))
  7330. ;; This function moves to the last character of the "record" being
  7331. ;; sorted.
  7332. (lambda nil
  7333. (save-match-data
  7334. (condition-case nil
  7335. (outline-forward-same-level 1)
  7336. (error
  7337. (goto-char (point-max))))))
  7338. ;; This function returns the value that gets sorted against.
  7339. (lambda nil
  7340. (cond
  7341. ((= dcst ?n)
  7342. (if (looking-at org-complex-heading-regexp)
  7343. (string-to-number (match-string 4))
  7344. nil))
  7345. ((= dcst ?a)
  7346. (if (looking-at org-complex-heading-regexp)
  7347. (funcall case-func (match-string 4))
  7348. nil))
  7349. ((= dcst ?t)
  7350. (let ((end (save-excursion (outline-next-heading) (point))))
  7351. (if (or (re-search-forward org-ts-regexp end t)
  7352. (re-search-forward org-ts-regexp-both end t))
  7353. (org-time-string-to-seconds (match-string 0))
  7354. (org-float-time now))))
  7355. ((= dcst ?c)
  7356. (let ((end (save-excursion (outline-next-heading) (point))))
  7357. (if (re-search-forward
  7358. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7359. end t)
  7360. (org-time-string-to-seconds (match-string 0))
  7361. (org-float-time now))))
  7362. ((= dcst ?s)
  7363. (let ((end (save-excursion (outline-next-heading) (point))))
  7364. (if (re-search-forward org-scheduled-time-regexp end t)
  7365. (org-time-string-to-seconds (match-string 1))
  7366. (org-float-time now))))
  7367. ((= dcst ?d)
  7368. (let ((end (save-excursion (outline-next-heading) (point))))
  7369. (if (re-search-forward org-deadline-time-regexp end t)
  7370. (org-time-string-to-seconds (match-string 1))
  7371. (org-float-time now))))
  7372. ((= dcst ?p)
  7373. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7374. (string-to-char (match-string 2))
  7375. org-default-priority))
  7376. ((= dcst ?r)
  7377. (or (org-entry-get nil property) ""))
  7378. ((= dcst ?o)
  7379. (if (looking-at org-complex-heading-regexp)
  7380. (- 9999 (length (member (match-string 2)
  7381. org-todo-keywords-1)))))
  7382. ((= dcst ?f)
  7383. (if getkey-func
  7384. (progn
  7385. (setq tmp (funcall getkey-func))
  7386. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7387. tmp)
  7388. (error "Invalid key function `%s'" getkey-func)))
  7389. (t (error "Invalid sorting type `%c'" sorting-type))))
  7390. nil
  7391. (cond
  7392. ((= dcst ?a) 'string<)
  7393. ((= dcst ?f) compare-func)
  7394. ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
  7395. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7396. (message "Sorting entries...done")))
  7397. (defun org-do-sort (table what &optional with-case sorting-type)
  7398. "Sort TABLE of WHAT according to SORTING-TYPE.
  7399. The user will be prompted for the SORTING-TYPE if the call to this
  7400. function does not specify it. WHAT is only for the prompt, to indicate
  7401. what is being sorted. The sorting key will be extracted from
  7402. the car of the elements of the table.
  7403. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7404. (unless sorting-type
  7405. (message
  7406. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  7407. what)
  7408. (setq sorting-type (read-char-exclusive)))
  7409. (let ((dcst (downcase sorting-type))
  7410. extractfun comparefun)
  7411. ;; Define the appropriate functions
  7412. (cond
  7413. ((= dcst ?n)
  7414. (setq extractfun 'string-to-number
  7415. comparefun (if (= dcst sorting-type) '< '>)))
  7416. ((= dcst ?a)
  7417. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7418. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7419. comparefun (if (= dcst sorting-type)
  7420. 'string<
  7421. (lambda (a b) (and (not (string< a b))
  7422. (not (string= a b)))))))
  7423. ((= dcst ?t)
  7424. (setq extractfun
  7425. (lambda (x)
  7426. (if (or (string-match org-ts-regexp x)
  7427. (string-match org-ts-regexp-both x))
  7428. (org-float-time
  7429. (org-time-string-to-time (match-string 0 x)))
  7430. 0))
  7431. comparefun (if (= dcst sorting-type) '< '>)))
  7432. (t (error "Invalid sorting type `%c'" sorting-type)))
  7433. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7434. table)
  7435. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7436. ;;; The orgstruct minor mode
  7437. ;; Define a minor mode which can be used in other modes in order to
  7438. ;; integrate the org-mode structure editing commands.
  7439. ;; This is really a hack, because the org-mode structure commands use
  7440. ;; keys which normally belong to the major mode. Here is how it
  7441. ;; works: The minor mode defines all the keys necessary to operate the
  7442. ;; structure commands, but wraps the commands into a function which
  7443. ;; tests if the cursor is currently at a headline or a plain list
  7444. ;; item. If that is the case, the structure command is used,
  7445. ;; temporarily setting many Org-mode variables like regular
  7446. ;; expressions for filling etc. However, when any of those keys is
  7447. ;; used at a different location, function uses `key-binding' to look
  7448. ;; up if the key has an associated command in another currently active
  7449. ;; keymap (minor modes, major mode, global), and executes that
  7450. ;; command. There might be problems if any of the keys is otherwise
  7451. ;; used as a prefix key.
  7452. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  7453. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  7454. ;; addresses this by checking explicitly for both bindings.
  7455. (defvar orgstruct-mode-map (make-sparse-keymap)
  7456. "Keymap for the minor `orgstruct-mode'.")
  7457. (defvar org-local-vars nil
  7458. "List of local variables, for use by `orgstruct-mode'.")
  7459. ;;;###autoload
  7460. (define-minor-mode orgstruct-mode
  7461. "Toggle the minor mode `orgstruct-mode'.
  7462. This mode is for using Org-mode structure commands in other
  7463. modes. The following keys behave as if Org-mode were active, if
  7464. the cursor is on a headline, or on a plain list item (both as
  7465. defined by Org-mode).
  7466. M-up Move entry/item up
  7467. M-down Move entry/item down
  7468. M-left Promote
  7469. M-right Demote
  7470. M-S-up Move entry/item up
  7471. M-S-down Move entry/item down
  7472. M-S-left Promote subtree
  7473. M-S-right Demote subtree
  7474. M-q Fill paragraph and items like in Org-mode
  7475. C-c ^ Sort entries
  7476. C-c - Cycle list bullet
  7477. TAB Cycle item visibility
  7478. M-RET Insert new heading/item
  7479. S-M-RET Insert new TODO heading / Checkbox item
  7480. C-c C-c Set tags / toggle checkbox"
  7481. nil " OrgStruct" nil
  7482. (org-load-modules-maybe)
  7483. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7484. ;;;###autoload
  7485. (defun turn-on-orgstruct ()
  7486. "Unconditionally turn on `orgstruct-mode'."
  7487. (orgstruct-mode 1))
  7488. (defvar org-fb-vars nil)
  7489. (make-variable-buffer-local 'org-fb-vars)
  7490. (defun orgstruct++-mode (&optional arg)
  7491. "Toggle `orgstruct-mode', the enhanced version of it.
  7492. In addition to setting orgstruct-mode, this also exports all
  7493. indentation and autofilling variables from org-mode into the
  7494. buffer. It will also recognize item context in multiline items."
  7495. (interactive "P")
  7496. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7497. (if (< arg 1)
  7498. (progn (orgstruct-mode -1)
  7499. (mapc (lambda(v)
  7500. (org-set-local (car v)
  7501. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  7502. org-fb-vars))
  7503. (orgstruct-mode 1)
  7504. (setq org-fb-vars nil)
  7505. (let (var val)
  7506. (mapc
  7507. (lambda (x)
  7508. (when (string-match
  7509. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
  7510. (symbol-name (car x)))
  7511. (setq var (car x) val (nth 1 x))
  7512. (push (list var `(quote ,(eval var))) org-fb-vars)
  7513. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7514. org-local-vars)
  7515. (org-set-local 'orgstruct-is-++ t))))
  7516. (defvar orgstruct-is-++ nil
  7517. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  7518. (make-variable-buffer-local 'orgstruct-is-++)
  7519. ;;;###autoload
  7520. (defun turn-on-orgstruct++ ()
  7521. "Unconditionally turn on `orgstruct++-mode'."
  7522. (orgstruct++-mode 1))
  7523. (defun orgstruct-error ()
  7524. "Error when there is no default binding for a structure key."
  7525. (interactive)
  7526. (error "This key has no function outside structure elements"))
  7527. (defun orgstruct-setup ()
  7528. "Setup orgstruct keymaps."
  7529. (let ((nfunc 0)
  7530. (bindings
  7531. (list
  7532. '([(meta up)] org-metaup)
  7533. '([(meta down)] org-metadown)
  7534. '([(meta left)] org-metaleft)
  7535. '([(meta right)] org-metaright)
  7536. '([(meta shift up)] org-shiftmetaup)
  7537. '([(meta shift down)] org-shiftmetadown)
  7538. '([(meta shift left)] org-shiftmetaleft)
  7539. '([(meta shift right)] org-shiftmetaright)
  7540. '([?\e (up)] org-metaup)
  7541. '([?\e (down)] org-metadown)
  7542. '([?\e (left)] org-metaleft)
  7543. '([?\e (right)] org-metaright)
  7544. '([?\e (shift up)] org-shiftmetaup)
  7545. '([?\e (shift down)] org-shiftmetadown)
  7546. '([?\e (shift left)] org-shiftmetaleft)
  7547. '([?\e (shift right)] org-shiftmetaright)
  7548. '([(shift up)] org-shiftup)
  7549. '([(shift down)] org-shiftdown)
  7550. '([(shift left)] org-shiftleft)
  7551. '([(shift right)] org-shiftright)
  7552. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7553. '("\M-q" fill-paragraph)
  7554. '("\C-c^" org-sort)
  7555. '("\C-c-" org-cycle-list-bullet)))
  7556. elt key fun cmd)
  7557. (while (setq elt (pop bindings))
  7558. (setq nfunc (1+ nfunc))
  7559. (setq key (org-key (car elt))
  7560. fun (nth 1 elt)
  7561. cmd (orgstruct-make-binding fun nfunc key))
  7562. (org-defkey orgstruct-mode-map key cmd))
  7563. ;; Prevent an error for users who forgot to make autoloads
  7564. (require 'org-element)
  7565. ;; Special treatment needed for TAB and RET
  7566. (org-defkey orgstruct-mode-map [(tab)]
  7567. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7568. (org-defkey orgstruct-mode-map "\C-i"
  7569. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7570. (org-defkey orgstruct-mode-map "\M-\C-m"
  7571. (orgstruct-make-binding 'org-insert-heading 105
  7572. "\M-\C-m" [(meta return)]))
  7573. (org-defkey orgstruct-mode-map [(meta return)]
  7574. (orgstruct-make-binding 'org-insert-heading 106
  7575. [(meta return)] "\M-\C-m"))
  7576. (org-defkey orgstruct-mode-map [(shift meta return)]
  7577. (orgstruct-make-binding 'org-insert-todo-heading 107
  7578. [(meta return)] "\M-\C-m"))
  7579. (org-defkey orgstruct-mode-map "\e\C-m"
  7580. (orgstruct-make-binding 'org-insert-heading 108
  7581. "\e\C-m" [?\e (return)]))
  7582. (org-defkey orgstruct-mode-map [?\e (return)]
  7583. (orgstruct-make-binding 'org-insert-heading 109
  7584. [?\e (return)] "\e\C-m"))
  7585. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7586. (orgstruct-make-binding 'org-insert-todo-heading 110
  7587. [?\e (return)] "\e\C-m"))
  7588. (unless org-local-vars
  7589. (setq org-local-vars (org-get-local-variables)))
  7590. t))
  7591. (defun orgstruct-make-binding (fun n &rest keys)
  7592. "Create a function for binding in the structure minor mode.
  7593. FUN is the command to call inside a table. N is used to create a unique
  7594. command name. KEYS are keys that should be checked in for a command
  7595. to execute outside of tables."
  7596. (eval
  7597. (list 'defun
  7598. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7599. '(arg)
  7600. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7601. "Outside of structure, run the binding of `"
  7602. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7603. "'.")
  7604. '(interactive "p")
  7605. (list 'if
  7606. `(org-context-p 'headline 'item
  7607. (and orgstruct-is-++
  7608. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7609. 'item-body))
  7610. (list 'org-run-like-in-org-mode (list 'quote fun))
  7611. (list 'let '(orgstruct-mode)
  7612. (list 'call-interactively
  7613. (append '(or)
  7614. (mapcar (lambda (k)
  7615. (list 'key-binding k))
  7616. keys)
  7617. '('orgstruct-error))))))))
  7618. (defun org-contextualize-keys (alist contexts)
  7619. "Return valid elements in ALIST depending on CONTEXTS.
  7620. `org-agenda-custom-commands' or `org-capture-templates' are the
  7621. values used for ALIST, and `org-agenda-custom-commands-contexts'
  7622. or `org-capture-templates-contexts' are the associated contexts
  7623. definitions."
  7624. (let ((contexts
  7625. ;; normalize contexts
  7626. (mapcar
  7627. (lambda(c) (cond ((listp (cadr c))
  7628. (list (car c) (car c) (cadr c)))
  7629. ((string= "" (cadr c))
  7630. (list (car c) (car c) (caddr c)))
  7631. (t c))) contexts))
  7632. (a alist) c r s)
  7633. ;; loop over all commands or templates
  7634. (while (setq c (pop a))
  7635. (let (vrules repl)
  7636. (cond
  7637. ((not (assoc (car c) contexts))
  7638. (push c r))
  7639. ((and (assoc (car c) contexts)
  7640. (setq vrules (org-contextualize-validate-key
  7641. (car c) contexts)))
  7642. (mapc (lambda (vr)
  7643. (when (not (equal (car vr) (cadr vr)))
  7644. (setq repl vr))) vrules)
  7645. (if (not repl) (push c r)
  7646. (push (cadr repl) s)
  7647. (push
  7648. (cons (car c)
  7649. (cdr (or (assoc (cadr repl) alist)
  7650. (error "Undefined key `%s' as contextual replacement for `%s'"
  7651. (cadr repl) (car c)))))
  7652. r))))))
  7653. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  7654. (delq
  7655. nil
  7656. (delete-dups
  7657. (mapcar (lambda (x)
  7658. (let ((tpl (car x)))
  7659. (when (not (delq
  7660. nil
  7661. (mapcar (lambda(y)
  7662. (equal y tpl)) s))) x)))
  7663. (reverse r))))))
  7664. (defun org-contextualize-validate-key (key contexts)
  7665. "Check CONTEXTS for agenda or capture KEY."
  7666. (let (r rr res)
  7667. (while (setq r (pop contexts))
  7668. (mapc
  7669. (lambda (rr)
  7670. (when
  7671. (and (equal key (car r))
  7672. (if (functionp rr) (funcall rr)
  7673. (or (and (eq (car rr) 'in-file)
  7674. (buffer-file-name)
  7675. (string-match (cdr rr) (buffer-file-name)))
  7676. (and (eq (car rr) 'in-mode)
  7677. (string-match (cdr rr) (symbol-name major-mode)))
  7678. (when (and (eq (car rr) 'not-in-file)
  7679. (buffer-file-name))
  7680. (not (string-match (cdr rr) (buffer-file-name))))
  7681. (when (eq (car rr) 'not-in-mode)
  7682. (not (string-match (cdr rr) (symbol-name major-mode)))))))
  7683. (push r res)))
  7684. (car (last r))))
  7685. (delete-dups (delq nil res))))
  7686. (defun org-context-p (&rest contexts)
  7687. "Check if local context is any of CONTEXTS.
  7688. Possible values in the list of contexts are `table', `headline', and `item'."
  7689. (let ((pos (point)))
  7690. (goto-char (point-at-bol))
  7691. (prog1 (or (and (memq 'table contexts)
  7692. (looking-at "[ \t]*|"))
  7693. (and (memq 'headline contexts)
  7694. (looking-at org-outline-regexp))
  7695. (and (memq 'item contexts)
  7696. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7697. (and (memq 'item-body contexts)
  7698. (org-in-item-p)))
  7699. (goto-char pos))))
  7700. (defun org-get-local-variables ()
  7701. "Return a list of all local variables in an Org mode buffer."
  7702. (let (varlist)
  7703. (with-current-buffer (get-buffer-create "*Org tmp*")
  7704. (erase-buffer)
  7705. (org-mode)
  7706. (setq varlist (buffer-local-variables)))
  7707. (kill-buffer "*Org tmp*")
  7708. (delq nil
  7709. (mapcar
  7710. (lambda (x)
  7711. (setq x
  7712. (if (symbolp x)
  7713. (list x)
  7714. (list (car x) (list 'quote (cdr x)))))
  7715. (if (string-match
  7716. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  7717. (symbol-name (car x)))
  7718. x nil))
  7719. varlist))))
  7720. (defun org-clone-local-variables (from-buffer &optional regexp)
  7721. "Clone local variables from FROM-BUFFER.
  7722. Optional argument REGEXP selects variables to clone."
  7723. (mapc
  7724. (lambda (pair)
  7725. (and (symbolp (car pair))
  7726. (or (null regexp)
  7727. (string-match regexp (symbol-name (car pair))))
  7728. (set (make-local-variable (car pair))
  7729. (cdr pair))))
  7730. (buffer-local-variables from-buffer)))
  7731. ;;;###autoload
  7732. (defun org-run-like-in-org-mode (cmd)
  7733. "Run a command, pretending that the current buffer is in Org-mode.
  7734. This will temporarily bind local variables that are typically bound in
  7735. Org-mode to the values they have in Org-mode, and then interactively
  7736. call CMD."
  7737. (org-load-modules-maybe)
  7738. (unless org-local-vars
  7739. (setq org-local-vars (org-get-local-variables)))
  7740. (eval (list 'let org-local-vars
  7741. (list 'call-interactively (list 'quote cmd)))))
  7742. ;;;; Archiving
  7743. (defun org-get-category (&optional pos force-refresh)
  7744. "Get the category applying to position POS."
  7745. (save-match-data
  7746. (if force-refresh (org-refresh-category-properties))
  7747. (let ((pos (or pos (point))))
  7748. (or (get-text-property pos 'org-category)
  7749. (progn (org-refresh-category-properties)
  7750. (get-text-property pos 'org-category))))))
  7751. (defun org-refresh-category-properties ()
  7752. "Refresh category text properties in the buffer."
  7753. (let ((case-fold-search t)
  7754. (inhibit-read-only t)
  7755. (def-cat (cond
  7756. ((null org-category)
  7757. (if buffer-file-name
  7758. (file-name-sans-extension
  7759. (file-name-nondirectory buffer-file-name))
  7760. "???"))
  7761. ((symbolp org-category) (symbol-name org-category))
  7762. (t org-category)))
  7763. beg end cat pos optionp)
  7764. (org-unmodified
  7765. (save-excursion
  7766. (save-restriction
  7767. (widen)
  7768. (goto-char (point-min))
  7769. (put-text-property (point) (point-max) 'org-category def-cat)
  7770. (while (re-search-forward
  7771. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7772. (setq pos (match-end 0)
  7773. optionp (equal (char-after (match-beginning 0)) ?#)
  7774. cat (org-trim (match-string 2)))
  7775. (if optionp
  7776. (setq beg (point-at-bol) end (point-max))
  7777. (org-back-to-heading t)
  7778. (setq beg (point) end (org-end-of-subtree t t)))
  7779. (put-text-property beg end 'org-category cat)
  7780. (put-text-property beg end 'org-category-position beg)
  7781. (goto-char pos)))))))
  7782. ;;;; Link Stuff
  7783. ;;; Link abbreviations
  7784. (defun org-link-expand-abbrev (link)
  7785. "Apply replacements as defined in `org-link-abbrev-alist'."
  7786. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  7787. (let* ((key (match-string 1 link))
  7788. (as (or (assoc key org-link-abbrev-alist-local)
  7789. (assoc key org-link-abbrev-alist)))
  7790. (tag (and (match-end 2) (match-string 3 link)))
  7791. rpl)
  7792. (if (not as)
  7793. link
  7794. (setq rpl (cdr as))
  7795. (cond
  7796. ((symbolp rpl) (funcall rpl tag))
  7797. ((string-match "%(\\([^)]+\\))" rpl)
  7798. (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
  7799. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7800. ((string-match "%h" rpl)
  7801. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7802. (t (concat rpl tag)))))
  7803. link))
  7804. ;;; Storing and inserting links
  7805. (defvar org-insert-link-history nil
  7806. "Minibuffer history for links inserted with `org-insert-link'.")
  7807. (defvar org-stored-links nil
  7808. "Contains the links stored with `org-store-link'.")
  7809. (defvar org-store-link-plist nil
  7810. "Plist with info about the most recently link created with `org-store-link'.")
  7811. (defvar org-link-protocols nil
  7812. "Link protocols added to Org-mode using `org-add-link-type'.")
  7813. (defvar org-store-link-functions nil
  7814. "List of functions that are called to create and store a link.
  7815. Each function will be called in turn until one returns a non-nil
  7816. value. Each function should check if it is responsible for creating
  7817. this link (for example by looking at the major mode).
  7818. If not, it must exit and return nil.
  7819. If yes, it should return a non-nil value after a calling
  7820. `org-store-link-props' with a list of properties and values.
  7821. Special properties are:
  7822. :type The link prefix, like \"http\". This must be given.
  7823. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7824. This is obligatory as well.
  7825. :description Optional default description for the second pair
  7826. of brackets in an Org-mode link. The user can still change
  7827. this when inserting this link into an Org-mode buffer.
  7828. In addition to these, any additional properties can be specified
  7829. and then used in capture templates.")
  7830. (defun org-add-link-type (type &optional follow export)
  7831. "Add TYPE to the list of `org-link-types'.
  7832. Re-compute all regular expressions depending on `org-link-types'
  7833. FOLLOW and EXPORT are two functions.
  7834. FOLLOW should take the link path as the single argument and do whatever
  7835. is necessary to follow the link, for example find a file or display
  7836. a mail message.
  7837. EXPORT should format the link path for export to one of the export formats.
  7838. It should be a function accepting three arguments:
  7839. path the path of the link, the text after the prefix (like \"http:\")
  7840. desc the description of the link, if any, or a description added by
  7841. org-export-normalize-links if there is none
  7842. format the export format, a symbol like `html' or `latex' or `ascii'..
  7843. The function may use the FORMAT information to return different values
  7844. depending on the format. The return value will be put literally into
  7845. the exported file. If the return value is nil, this means Org should
  7846. do what it normally does with links which do not have EXPORT defined.
  7847. Org-mode has a built-in default for exporting links. If you are happy with
  7848. this default, there is no need to define an export function for the link
  7849. type. For a simple example of an export function, see `org-bbdb.el'."
  7850. (add-to-list 'org-link-types type t)
  7851. (org-make-link-regexps)
  7852. (if (assoc type org-link-protocols)
  7853. (setcdr (assoc type org-link-protocols) (list follow export))
  7854. (push (list type follow export) org-link-protocols)))
  7855. (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
  7856. (defvar org-link-to-org-use-id) ; Defined in org-id.el
  7857. ;;;###autoload
  7858. (defun org-store-link (arg)
  7859. "\\<org-mode-map>Store an org-link to the current location.
  7860. This link is added to `org-stored-links' and can later be inserted
  7861. into an org-buffer with \\[org-insert-link].
  7862. For some link types, a prefix arg is interpreted:
  7863. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  7864. For file links, arg negates `org-context-in-file-links'."
  7865. (interactive "P")
  7866. (org-load-modules-maybe)
  7867. (setq org-store-link-plist nil) ; reset
  7868. (org-with-limited-levels
  7869. (let (link cpltxt desc description search txt custom-id agenda-link)
  7870. (cond
  7871. ((run-hook-with-args-until-success 'org-store-link-functions)
  7872. (setq link (plist-get org-store-link-plist :link)
  7873. desc (or (plist-get org-store-link-plist :description) link)))
  7874. ((org-src-edit-buffer-p)
  7875. (let (label gc)
  7876. (while (or (not label)
  7877. (save-excursion
  7878. (save-restriction
  7879. (widen)
  7880. (goto-char (point-min))
  7881. (re-search-forward
  7882. (regexp-quote (format org-coderef-label-format label))
  7883. nil t))))
  7884. (when label (message "Label exists already") (sit-for 2))
  7885. (setq label (read-string "Code line label: " label)))
  7886. (end-of-line 1)
  7887. (setq link (format org-coderef-label-format label))
  7888. (setq gc (- 79 (length link)))
  7889. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  7890. (insert link)
  7891. (setq link (concat "(" label ")") desc nil)))
  7892. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  7893. ;; We are in the agenda, link to referenced location
  7894. (let ((m (or (get-text-property (point) 'org-hd-marker)
  7895. (get-text-property (point) 'org-marker))))
  7896. (when m
  7897. (org-with-point-at m
  7898. (setq agenda-link
  7899. (if (org-called-interactively-p 'any)
  7900. (call-interactively 'org-store-link)
  7901. (org-store-link nil)))))))
  7902. ((eq major-mode 'calendar-mode)
  7903. (let ((cd (calendar-cursor-to-date)))
  7904. (setq link
  7905. (format-time-string
  7906. (car org-time-stamp-formats)
  7907. (apply 'encode-time
  7908. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  7909. nil nil nil))))
  7910. (org-store-link-props :type "calendar" :date cd)))
  7911. ((eq major-mode 'help-mode)
  7912. (setq link (concat "help:" (save-excursion
  7913. (goto-char (point-min))
  7914. (looking-at "^[^ ]+")
  7915. (match-string 0))))
  7916. (org-store-link-props :type "help"))
  7917. ((eq major-mode 'w3-mode)
  7918. (setq cpltxt (if (and (buffer-name)
  7919. (not (string-match "Untitled" (buffer-name))))
  7920. (buffer-name)
  7921. (url-view-url t))
  7922. link (url-view-url t))
  7923. (org-store-link-props :type "w3" :url (url-view-url t)))
  7924. ((eq major-mode 'w3m-mode)
  7925. (setq cpltxt (or w3m-current-title w3m-current-url)
  7926. link w3m-current-url)
  7927. (org-store-link-props :type "w3m" :url (url-view-url t)))
  7928. ((setq search (run-hook-with-args-until-success
  7929. 'org-create-file-search-functions))
  7930. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  7931. "::" search))
  7932. (setq cpltxt (or description link)))
  7933. ((eq major-mode 'image-mode)
  7934. (setq cpltxt (concat "file:"
  7935. (abbreviate-file-name buffer-file-name))
  7936. link cpltxt)
  7937. (org-store-link-props :type "image" :file buffer-file-name))
  7938. ((eq major-mode 'dired-mode)
  7939. ;; link to the file in the current line
  7940. (let ((file (dired-get-filename nil t)))
  7941. (setq file (if file
  7942. (abbreviate-file-name
  7943. (expand-file-name (dired-get-filename nil t)))
  7944. ;; otherwise, no file so use current directory.
  7945. default-directory))
  7946. (setq cpltxt (concat "file:" file)
  7947. link cpltxt)))
  7948. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  7949. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  7950. (cond
  7951. ((org-in-regexp "<<\\(.*?\\)>>")
  7952. (setq cpltxt
  7953. (concat "file:"
  7954. (abbreviate-file-name
  7955. (buffer-file-name (buffer-base-buffer)))
  7956. "::" (match-string 1))
  7957. link cpltxt))
  7958. ((and (featurep 'org-id)
  7959. (or (eq org-link-to-org-use-id t)
  7960. (and (org-called-interactively-p 'any)
  7961. (or (eq org-link-to-org-use-id 'create-if-interactive)
  7962. (and (eq org-link-to-org-use-id
  7963. 'create-if-interactive-and-no-custom-id)
  7964. (not custom-id))))
  7965. (and org-link-to-org-use-id (org-entry-get nil "ID"))))
  7966. ;; We can make a link using the ID.
  7967. (setq link (condition-case nil
  7968. (prog1 (org-id-store-link)
  7969. (setq desc (plist-get org-store-link-plist :description)))
  7970. (error
  7971. ;; probably before first headline, link to file only
  7972. (concat "file:"
  7973. (abbreviate-file-name
  7974. (buffer-file-name (buffer-base-buffer))))))))
  7975. (t
  7976. ;; Just link to current headline
  7977. (setq cpltxt (concat "file:"
  7978. (abbreviate-file-name
  7979. (buffer-file-name (buffer-base-buffer)))))
  7980. ;; Add a context search string
  7981. (when (org-xor org-context-in-file-links arg)
  7982. (setq txt (cond
  7983. ((org-at-heading-p) nil)
  7984. ((org-region-active-p)
  7985. (buffer-substring (region-beginning) (region-end)))))
  7986. (when (or (null txt) (string-match "\\S-" txt))
  7987. (setq cpltxt
  7988. (concat cpltxt "::"
  7989. (condition-case nil
  7990. (org-make-org-heading-search-string txt)
  7991. (error "")))
  7992. desc (or (nth 4 (ignore-errors
  7993. (org-heading-components))) "NONE"))))
  7994. (if (string-match "::\\'" cpltxt)
  7995. (setq cpltxt (substring cpltxt 0 -2)))
  7996. (setq link cpltxt))))
  7997. ((buffer-file-name (buffer-base-buffer))
  7998. ;; Just link to this file here.
  7999. (setq cpltxt (concat "file:"
  8000. (abbreviate-file-name
  8001. (buffer-file-name (buffer-base-buffer)))))
  8002. ;; Add a context string
  8003. (when (org-xor org-context-in-file-links arg)
  8004. (setq txt (if (org-region-active-p)
  8005. (buffer-substring (region-beginning) (region-end))
  8006. (buffer-substring (point-at-bol) (point-at-eol))))
  8007. ;; Only use search option if there is some text.
  8008. (when (string-match "\\S-" txt)
  8009. (setq cpltxt
  8010. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8011. desc "NONE")))
  8012. (setq link cpltxt))
  8013. ((org-called-interactively-p 'interactive)
  8014. (error "Cannot link to a buffer which is not visiting a file"))
  8015. (t (setq link nil)))
  8016. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8017. (setq link (or link cpltxt)
  8018. desc (or desc cpltxt))
  8019. (if (equal desc "NONE") (setq desc nil))
  8020. (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
  8021. (progn
  8022. (setq org-stored-links
  8023. (cons (list link desc) org-stored-links))
  8024. (message "Stored: %s" (or desc link))
  8025. (when custom-id
  8026. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  8027. "::#" custom-id))
  8028. (setq org-stored-links
  8029. (cons (list link desc) org-stored-links))))
  8030. (or agenda-link (and link (org-make-link-string link desc)))))))
  8031. (defun org-store-link-props (&rest plist)
  8032. "Store link properties, extract names and addresses."
  8033. (let (x adr)
  8034. (when (setq x (plist-get plist :from))
  8035. (setq adr (mail-extract-address-components x))
  8036. (setq plist (plist-put plist :fromname (car adr)))
  8037. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8038. (when (setq x (plist-get plist :to))
  8039. (setq adr (mail-extract-address-components x))
  8040. (setq plist (plist-put plist :toname (car adr)))
  8041. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8042. (let ((from (plist-get plist :from))
  8043. (to (plist-get plist :to)))
  8044. (when (and from to org-from-is-user-regexp)
  8045. (setq plist
  8046. (plist-put plist :fromto
  8047. (if (string-match org-from-is-user-regexp from)
  8048. (concat "to %t")
  8049. (concat "from %f"))))))
  8050. (setq org-store-link-plist plist))
  8051. (defun org-add-link-props (&rest plist)
  8052. "Add these properties to the link property list."
  8053. (let (key value)
  8054. (while plist
  8055. (setq key (pop plist) value (pop plist))
  8056. (setq org-store-link-plist
  8057. (plist-put org-store-link-plist key value)))))
  8058. (defun org-email-link-description (&optional fmt)
  8059. "Return the description part of an email link.
  8060. This takes information from `org-store-link-plist' and formats it
  8061. according to FMT (default from `org-email-link-description-format')."
  8062. (setq fmt (or fmt org-email-link-description-format))
  8063. (let* ((p org-store-link-plist)
  8064. (to (plist-get p :toaddress))
  8065. (from (plist-get p :fromaddress))
  8066. (table
  8067. (list
  8068. (cons "%c" (plist-get p :fromto))
  8069. (cons "%F" (plist-get p :from))
  8070. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8071. (cons "%T" (plist-get p :to))
  8072. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8073. (cons "%s" (plist-get p :subject))
  8074. (cons "%d" (plist-get p :date))
  8075. (cons "%m" (plist-get p :message-id)))))
  8076. (when (string-match "%c" fmt)
  8077. ;; Check if the user wrote this message
  8078. (if (and org-from-is-user-regexp from to
  8079. (save-match-data (string-match org-from-is-user-regexp from)))
  8080. (setq fmt (replace-match "to %t" t t fmt))
  8081. (setq fmt (replace-match "from %f" t t fmt))))
  8082. (org-replace-escapes fmt table)))
  8083. (defun org-make-org-heading-search-string (&optional string heading)
  8084. "Make search string for STRING or current headline."
  8085. (interactive)
  8086. (let ((s (or string (org-get-heading)))
  8087. (lines org-context-in-file-links))
  8088. (unless (and string (not heading))
  8089. ;; We are using a headline, clean up garbage in there.
  8090. (if (string-match org-todo-regexp s)
  8091. (setq s (replace-match "" t t s)))
  8092. (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
  8093. (setq s (replace-match "" t t s)))
  8094. (setq s (org-trim s))
  8095. (if (string-match (concat "^\\(" org-quote-string "\\|"
  8096. org-comment-string "\\)") s)
  8097. (setq s (replace-match "" t t s)))
  8098. (while (string-match org-ts-regexp s)
  8099. (setq s (replace-match "" t t s))))
  8100. (or string (setq s (concat "*" s))) ; Add * for headlines
  8101. (when (and string (integerp lines) (> lines 0))
  8102. (let ((slines (org-split-string s "\n")))
  8103. (when (< lines (length slines))
  8104. (setq s (mapconcat
  8105. 'identity
  8106. (reverse (nthcdr (- (length slines) lines)
  8107. (reverse slines))) "\n")))))
  8108. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8109. (defun org-make-link-string (link &optional description)
  8110. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8111. (unless (string-match "\\S-" link)
  8112. (error "Empty link"))
  8113. (when (and description
  8114. (stringp description)
  8115. (not (string-match "\\S-" description)))
  8116. (setq description nil))
  8117. (when (stringp description)
  8118. ;; Remove brackets from the description, they are fatal.
  8119. (while (string-match "\\[" description)
  8120. (setq description (replace-match "{" t t description)))
  8121. (while (string-match "\\]" description)
  8122. (setq description (replace-match "}" t t description))))
  8123. (when (equal link description)
  8124. ;; No description needed, it is identical
  8125. (setq description nil))
  8126. (when (and (not description)
  8127. (not (string-match (org-image-file-name-regexp) link))
  8128. (not (equal link (org-link-escape link))))
  8129. (setq description (org-extract-attributes link)))
  8130. (setq link
  8131. (cond ((string-match (org-image-file-name-regexp) link) link)
  8132. ((string-match org-link-types-re link)
  8133. (concat (match-string 1 link)
  8134. (org-link-escape (substring link (match-end 1)))))
  8135. (t (org-link-escape link))))
  8136. (concat "[[" link "]"
  8137. (if description (concat "[" description "]") "")
  8138. "]"))
  8139. (defconst org-link-escape-chars
  8140. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  8141. "List of characters that should be escaped in link.
  8142. This is the list that is used for internal purposes.")
  8143. (defconst org-link-escape-chars-browser
  8144. '(?\ )
  8145. "List of escapes for characters that are problematic in links.
  8146. This is the list that is used before handing over to the browser.")
  8147. (defun org-link-escape (text &optional table merge)
  8148. "Return percent escaped representation of TEXT.
  8149. TEXT is a string with the text to escape.
  8150. Optional argument TABLE is a list with characters that should be
  8151. escaped. When nil, `org-link-escape-chars' is used.
  8152. If optional argument MERGE is set, merge TABLE into
  8153. `org-link-escape-chars'."
  8154. (cond
  8155. ((and table merge)
  8156. (mapc (lambda (defchr)
  8157. (unless (member defchr table)
  8158. (setq table (cons defchr table)))) org-link-escape-chars))
  8159. ((null table)
  8160. (setq table org-link-escape-chars)))
  8161. (mapconcat
  8162. (lambda (char)
  8163. (if (or (member char table)
  8164. (and (or (< char 32) (= char 37) (> char 126))
  8165. org-url-hexify-p))
  8166. (mapconcat (lambda (sequence-element)
  8167. (format "%%%.2X" sequence-element))
  8168. (or (encode-coding-char char 'utf-8)
  8169. (error "Unable to percent escape character: %s"
  8170. (char-to-string char))) "")
  8171. (char-to-string char))) text ""))
  8172. (defun org-link-unescape (str)
  8173. "Unhex hexified Unicode strings as returned from the JavaScript function
  8174. encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
  8175. (unless (and (null str) (string= "" str))
  8176. (let ((pos 0) (case-fold-search t) unhexed)
  8177. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8178. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8179. (setq str (replace-match unhexed t t str))
  8180. (setq pos (+ pos (length unhexed))))))
  8181. str)
  8182. (defun org-link-unescape-compound (hex)
  8183. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
  8184. Note: this function also decodes single byte encodings like
  8185. `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
  8186. (save-match-data
  8187. (let* ((bytes (cdr (split-string hex "%")))
  8188. (ret "")
  8189. (eat 0)
  8190. (sum 0))
  8191. (while bytes
  8192. (let* ((val (string-to-number (pop bytes) 16))
  8193. (shift-xor
  8194. (if (= 0 eat)
  8195. (cond
  8196. ((>= val 252) (cons 6 252))
  8197. ((>= val 248) (cons 5 248))
  8198. ((>= val 240) (cons 4 240))
  8199. ((>= val 224) (cons 3 224))
  8200. ((>= val 192) (cons 2 192))
  8201. (t (cons 0 0)))
  8202. (cons 6 128))))
  8203. (if (>= val 192) (setq eat (car shift-xor)))
  8204. (setq val (logxor val (cdr shift-xor)))
  8205. (setq sum (+ (lsh sum (car shift-xor)) val))
  8206. (if (> eat 0) (setq eat (- eat 1)))
  8207. (cond
  8208. ((= 0 eat) ;multi byte
  8209. (setq ret (concat ret (org-char-to-string sum)))
  8210. (setq sum 0))
  8211. ((not bytes) ; single byte(s)
  8212. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8213. )) ;; end (while bytes
  8214. ret )))
  8215. (defun org-link-unescape-single-byte-sequence (hex)
  8216. "Unhexify hex-encoded single byte character sequences."
  8217. (mapconcat (lambda (byte)
  8218. (char-to-string (string-to-number byte 16)))
  8219. (cdr (split-string hex "%")) ""))
  8220. (defun org-xor (a b)
  8221. "Exclusive or."
  8222. (if a (not b) b))
  8223. (defun org-fixup-message-id-for-http (s)
  8224. "Replace special characters in a message id, so it can be used in an http query."
  8225. (when (string-match "%" s)
  8226. (setq s (mapconcat (lambda (c)
  8227. (if (eq c ?%)
  8228. "%25"
  8229. (char-to-string c)))
  8230. s "")))
  8231. (while (string-match "<" s)
  8232. (setq s (replace-match "%3C" t t s)))
  8233. (while (string-match ">" s)
  8234. (setq s (replace-match "%3E" t t s)))
  8235. (while (string-match "@" s)
  8236. (setq s (replace-match "%40" t t s)))
  8237. s)
  8238. (defun org-link-prettify (link)
  8239. "Return a human-readable representation of LINK.
  8240. The car of LINK must be a raw link the cdr of LINK must be either
  8241. a link description or nil."
  8242. (let ((desc (or (cadr link) "<no description>")))
  8243. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8244. "<" (car link) ">")))
  8245. ;;;###autoload
  8246. (defun org-insert-link-global ()
  8247. "Insert a link like Org-mode does.
  8248. This command can be called in any mode to insert a link in Org-mode syntax."
  8249. (interactive)
  8250. (org-load-modules-maybe)
  8251. (org-run-like-in-org-mode 'org-insert-link))
  8252. (defun org-insert-all-links (&optional keep)
  8253. "Insert all links in `org-stored-links'."
  8254. (interactive "P")
  8255. (let ((links (copy-sequence org-stored-links)) l)
  8256. (while (setq l (if keep (pop links) (pop org-stored-links)))
  8257. (insert "- ")
  8258. (org-insert-link nil (car l) (cadr l))
  8259. (insert "\n"))))
  8260. (defun org-link-fontify-links-to-this-file ()
  8261. "Fontify links to the current file in `org-stored-links'."
  8262. (let ((f (buffer-file-name)) a b)
  8263. (setq a (mapcar (lambda(l)
  8264. (let ((ll (car l)))
  8265. (when (and (string-match "^file:\\(.+\\)::" ll)
  8266. (equal f (expand-file-name (match-string 1 ll))))
  8267. ll)))
  8268. org-stored-links))
  8269. (when (featurep 'org-id)
  8270. (setq b (mapcar (lambda(l)
  8271. (let ((ll (car l)))
  8272. (when (and (string-match "^id:\\(.+\\)$" ll)
  8273. (equal f (expand-file-name
  8274. (or (org-id-find-id-file
  8275. (match-string 1 ll)) ""))))
  8276. ll)))
  8277. org-stored-links)))
  8278. (mapcar (lambda(l)
  8279. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  8280. (delq nil (append a b)))))
  8281. (defvar org-link-links-in-this-file nil)
  8282. (defun org-insert-link (&optional complete-file link-location default-description)
  8283. "Insert a link. At the prompt, enter the link.
  8284. Completion can be used to insert any of the link protocol prefixes like
  8285. http or ftp in use.
  8286. The history can be used to select a link previously stored with
  8287. `org-store-link'. When the empty string is entered (i.e. if you just
  8288. press RET at the prompt), the link defaults to the most recently
  8289. stored link. As SPC triggers completion in the minibuffer, you need to
  8290. use M-SPC or C-q SPC to force the insertion of a space character.
  8291. You will also be prompted for a description, and if one is given, it will
  8292. be displayed in the buffer instead of the link.
  8293. If there is already a link at point, this command will allow you to edit link
  8294. and description parts.
  8295. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8296. be selected using completion. The path to the file will be relative to the
  8297. current directory if the file is in the current directory or a subdirectory.
  8298. Otherwise, the link will be the absolute path as completed in the minibuffer
  8299. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8300. option `org-link-file-path-type'.
  8301. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8302. the current directory or below.
  8303. With three \\[universal-argument] prefixes, negate the meaning of
  8304. `org-keep-stored-link-after-insertion'.
  8305. If `org-make-link-description-function' is non-nil, this function will be
  8306. called with the link target, and the result will be the default
  8307. link description.
  8308. If the LINK-LOCATION parameter is non-nil, this value will be
  8309. used as the link location instead of reading one interactively.
  8310. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8311. be used as the default description."
  8312. (interactive "P")
  8313. (let* ((wcf (current-window-configuration))
  8314. (origbuf (current-buffer))
  8315. (region (if (org-region-active-p)
  8316. (buffer-substring (region-beginning) (region-end))))
  8317. (remove (and region (list (region-beginning) (region-end))))
  8318. (desc region)
  8319. tmphist ; byte-compile incorrectly complains about this
  8320. (link link-location)
  8321. (abbrevs org-link-abbrev-alist-local)
  8322. entry file all-prefixes auto-desc)
  8323. (cond
  8324. (link-location) ; specified by arg, just use it.
  8325. ((org-in-regexp org-bracket-link-regexp 1)
  8326. ;; We do have a link at point, and we are going to edit it.
  8327. (setq remove (list (match-beginning 0) (match-end 0)))
  8328. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8329. (setq link (read-string "Link: "
  8330. (org-link-unescape
  8331. (org-match-string-no-properties 1)))))
  8332. ((or (org-in-regexp org-angle-link-re)
  8333. (org-in-regexp org-plain-link-re))
  8334. ;; Convert to bracket link
  8335. (setq remove (list (match-beginning 0) (match-end 0))
  8336. link (read-string "Link: "
  8337. (org-remove-angle-brackets (match-string 0)))))
  8338. ((member complete-file '((4) (16)))
  8339. ;; Completing read for file names.
  8340. (setq link (org-file-complete-link complete-file)))
  8341. (t
  8342. ;; Read link, with completion for stored links.
  8343. (org-link-fontify-links-to-this-file)
  8344. (org-switch-to-buffer-other-window "*Org Links*")
  8345. (with-current-buffer "*Org Links*"
  8346. (erase-buffer)
  8347. (insert "Insert a link.
  8348. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  8349. (when org-stored-links
  8350. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  8351. (insert (mapconcat 'org-link-prettify
  8352. (reverse org-stored-links) "\n")))
  8353. (goto-char (point-min)))
  8354. (let ((cw (selected-window)))
  8355. (select-window (get-buffer-window "*Org Links*" 'visible))
  8356. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  8357. (unless (pos-visible-in-window-p (point-max))
  8358. (org-fit-window-to-buffer))
  8359. (and (window-live-p cw) (select-window cw)))
  8360. ;; Fake a link history, containing the stored links.
  8361. (setq tmphist (append (mapcar 'car org-stored-links)
  8362. org-insert-link-history))
  8363. (setq all-prefixes (append (mapcar 'car abbrevs)
  8364. (mapcar 'car org-link-abbrev-alist)
  8365. org-link-types))
  8366. (unwind-protect
  8367. (progn
  8368. (setq link
  8369. (let ((org-completion-use-ido nil)
  8370. (org-completion-use-iswitchb nil))
  8371. (org-completing-read
  8372. "Link: "
  8373. (append
  8374. (mapcar (lambda (x) (list (concat x ":")))
  8375. all-prefixes)
  8376. (mapcar 'car org-stored-links)
  8377. (mapcar 'cadr org-stored-links))
  8378. nil nil nil
  8379. 'tmphist
  8380. (caar org-stored-links))))
  8381. (if (not (string-match "\\S-" link))
  8382. (error "No link selected"))
  8383. (mapc (lambda(l)
  8384. (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
  8385. org-stored-links)
  8386. (if (or (member link all-prefixes)
  8387. (and (equal ":" (substring link -1))
  8388. (member (substring link 0 -1) all-prefixes)
  8389. (setq link (substring link 0 -1))))
  8390. (setq link (with-current-buffer origbuf
  8391. (org-link-try-special-completion link)))))
  8392. (set-window-configuration wcf)
  8393. (kill-buffer "*Org Links*"))
  8394. (setq entry (assoc link org-stored-links))
  8395. (or entry (push link org-insert-link-history))
  8396. (setq desc (or desc (nth 1 entry)))))
  8397. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  8398. (not org-keep-stored-link-after-insertion))
  8399. (setq org-stored-links (delq (assoc link org-stored-links)
  8400. org-stored-links)))
  8401. (if (string-match org-plain-link-re link)
  8402. ;; URL-like link, normalize the use of angular brackets.
  8403. (setq link (org-remove-angle-brackets link)))
  8404. ;; Check if we are linking to the current file with a search option
  8405. ;; If yes, simplify the link by using only the search option.
  8406. (when (and buffer-file-name
  8407. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  8408. (let* ((path (match-string 1 link))
  8409. (case-fold-search nil)
  8410. (search (match-string 2 link)))
  8411. (save-match-data
  8412. (if (equal (file-truename buffer-file-name) (file-truename path))
  8413. ;; We are linking to this same file, with a search option
  8414. (setq link search)))))
  8415. ;; Check if we can/should use a relative path. If yes, simplify the link
  8416. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  8417. (let* ((type (match-string 1 link))
  8418. (path (match-string 2 link))
  8419. (origpath path)
  8420. (case-fold-search nil))
  8421. (cond
  8422. ((or (eq org-link-file-path-type 'absolute)
  8423. (equal complete-file '(16)))
  8424. (setq path (abbreviate-file-name (expand-file-name path))))
  8425. ((eq org-link-file-path-type 'noabbrev)
  8426. (setq path (expand-file-name path)))
  8427. ((eq org-link-file-path-type 'relative)
  8428. (setq path (file-relative-name path)))
  8429. (t
  8430. (save-match-data
  8431. (if (string-match (concat "^" (regexp-quote
  8432. (expand-file-name
  8433. (file-name-as-directory
  8434. default-directory))))
  8435. (expand-file-name path))
  8436. ;; We are linking a file with relative path name.
  8437. (setq path (substring (expand-file-name path)
  8438. (match-end 0)))
  8439. (setq path (abbreviate-file-name (expand-file-name path)))))))
  8440. (setq link (concat type path))
  8441. (if (equal desc origpath)
  8442. (setq desc path))))
  8443. (if org-make-link-description-function
  8444. (setq desc
  8445. (or (condition-case nil
  8446. (funcall org-make-link-description-function link desc)
  8447. (error (progn (message "Can't get link description from `%s'"
  8448. (symbol-name org-make-link-description-function))
  8449. (sit-for 2) nil)))
  8450. (read-string "Description: " default-description)))
  8451. (if default-description (setq desc default-description)
  8452. (setq desc (or (and auto-desc desc)
  8453. (read-string "Description: " desc)))))
  8454. (unless (string-match "\\S-" desc) (setq desc nil))
  8455. (if remove (apply 'delete-region remove))
  8456. (insert (org-make-link-string link desc))))
  8457. (defun org-link-try-special-completion (type)
  8458. "If there is completion support for link type TYPE, offer it."
  8459. (let ((fun (intern (concat "org-" type "-complete-link"))))
  8460. (if (functionp fun)
  8461. (funcall fun)
  8462. (read-string "Link (no completion support): " (concat type ":")))))
  8463. (defun org-file-complete-link (&optional arg)
  8464. "Create a file link using completion."
  8465. (let (file link)
  8466. (setq file (read-file-name "File: "))
  8467. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  8468. (pwd1 (file-name-as-directory (abbreviate-file-name
  8469. (expand-file-name ".")))))
  8470. (cond
  8471. ((equal arg '(16))
  8472. (setq link (concat
  8473. "file:"
  8474. (abbreviate-file-name (expand-file-name file)))))
  8475. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  8476. (setq link (concat "file:" (match-string 1 file))))
  8477. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  8478. (expand-file-name file))
  8479. (setq link (concat
  8480. "file:" (match-string 1 (expand-file-name file)))))
  8481. (t (setq link (concat "file:" file)))))
  8482. link))
  8483. (defun org-completing-read (&rest args)
  8484. "Completing-read with SPACE being a normal character."
  8485. (let ((enable-recursive-minibuffers t)
  8486. (minibuffer-local-completion-map
  8487. (copy-keymap minibuffer-local-completion-map)))
  8488. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  8489. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  8490. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  8491. (apply 'org-icompleting-read args)))
  8492. (defun org-completing-read-no-i (&rest args)
  8493. (let (org-completion-use-ido org-completion-use-iswitchb)
  8494. (apply 'org-completing-read args)))
  8495. (defun org-iswitchb-completing-read (prompt choices &rest args)
  8496. "Use iswitch as a completing-read replacement to choose from choices.
  8497. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  8498. from."
  8499. (let* ((iswitchb-use-virtual-buffers nil)
  8500. (iswitchb-make-buflist-hook
  8501. (lambda ()
  8502. (setq iswitchb-temp-buflist choices))))
  8503. (iswitchb-read-buffer prompt)))
  8504. (defun org-icompleting-read (&rest args)
  8505. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  8506. (org-without-partial-completion
  8507. (if (and org-completion-use-ido
  8508. (fboundp 'ido-completing-read)
  8509. (boundp 'ido-mode) ido-mode
  8510. (listp (second args)))
  8511. (let ((ido-enter-matching-directory nil))
  8512. (apply 'ido-completing-read (concat (car args))
  8513. (if (consp (car (nth 1 args)))
  8514. (mapcar 'car (nth 1 args))
  8515. (nth 1 args))
  8516. (cddr args)))
  8517. (if (and org-completion-use-iswitchb
  8518. (boundp 'iswitchb-mode) iswitchb-mode
  8519. (listp (second args)))
  8520. (apply 'org-iswitchb-completing-read (concat (car args))
  8521. (if (consp (car (nth 1 args)))
  8522. (mapcar 'car (nth 1 args))
  8523. (nth 1 args))
  8524. (cddr args))
  8525. (apply 'completing-read args)))))
  8526. (defun org-extract-attributes (s)
  8527. "Extract the attributes cookie from a string and set as text property."
  8528. (let (a attr (start 0) key value)
  8529. (save-match-data
  8530. (when (string-match "{{\\([^}]+\\)}}$" s)
  8531. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  8532. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  8533. (setq key (match-string 1 a) value (match-string 2 a)
  8534. start (match-end 0)
  8535. attr (plist-put attr (intern key) value))))
  8536. (org-add-props s nil 'org-attr attr))
  8537. s))
  8538. (defun org-extract-attributes-from-string (tag)
  8539. (let (key value attr)
  8540. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  8541. (setq key (match-string 1 tag) value (match-string 2 tag)
  8542. tag (replace-match "" t t tag)
  8543. attr (plist-put attr (intern key) value)))
  8544. (cons tag attr)))
  8545. (defun org-attributes-to-string (plist)
  8546. "Format a property list into an HTML attribute list."
  8547. (let ((s "") key value)
  8548. (while plist
  8549. (setq key (pop plist) value (pop plist))
  8550. (and value
  8551. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  8552. s))
  8553. ;;; Opening/following a link
  8554. (defvar org-link-search-failed nil)
  8555. (defvar org-open-link-functions nil
  8556. "Hook for functions finding a plain text link.
  8557. These functions must take a single argument, the link content.
  8558. They will be called for links that look like [[link text][description]]
  8559. when LINK TEXT does not have a protocol like \"http:\" and does not look
  8560. like a filename (e.g. \"./blue.png\").
  8561. These functions will be called *before* Org attempts to resolve the
  8562. link by doing text searches in the current buffer - so if you want a
  8563. link \"[[target]]\" to still find \"<<target>>\", your function should
  8564. handle this as a special case.
  8565. When the function does handle the link, it must return a non-nil value.
  8566. If it decides that it is not responsible for this link, it must return
  8567. nil to indicate that that Org-mode can continue with other options
  8568. like exact and fuzzy text search.")
  8569. (defun org-next-link ()
  8570. "Move forward to the next link.
  8571. If the link is in hidden text, expose it."
  8572. (interactive)
  8573. (when (and org-link-search-failed (eq this-command last-command))
  8574. (goto-char (point-min))
  8575. (message "Link search wrapped back to beginning of buffer"))
  8576. (setq org-link-search-failed nil)
  8577. (let* ((pos (point))
  8578. (ct (org-context))
  8579. (a (assoc :link ct)))
  8580. (if a (goto-char (nth 2 a)))
  8581. (if (re-search-forward org-any-link-re nil t)
  8582. (progn
  8583. (goto-char (match-beginning 0))
  8584. (if (outline-invisible-p) (org-show-context)))
  8585. (goto-char pos)
  8586. (setq org-link-search-failed t)
  8587. (error "No further link found"))))
  8588. (defun org-previous-link ()
  8589. "Move backward to the previous link.
  8590. If the link is in hidden text, expose it."
  8591. (interactive)
  8592. (when (and org-link-search-failed (eq this-command last-command))
  8593. (goto-char (point-max))
  8594. (message "Link search wrapped back to end of buffer"))
  8595. (setq org-link-search-failed nil)
  8596. (let* ((pos (point))
  8597. (ct (org-context))
  8598. (a (assoc :link ct)))
  8599. (if a (goto-char (nth 1 a)))
  8600. (if (re-search-backward org-any-link-re nil t)
  8601. (progn
  8602. (goto-char (match-beginning 0))
  8603. (if (outline-invisible-p) (org-show-context)))
  8604. (goto-char pos)
  8605. (setq org-link-search-failed t)
  8606. (error "No further link found"))))
  8607. (defun org-translate-link (s)
  8608. "Translate a link string if a translation function has been defined."
  8609. (if (and org-link-translation-function
  8610. (fboundp org-link-translation-function)
  8611. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  8612. (progn
  8613. (setq s (funcall org-link-translation-function
  8614. (match-string 1 s) (match-string 2 s)))
  8615. (concat (car s) ":" (cdr s)))
  8616. s))
  8617. (defun org-translate-link-from-planner (type path)
  8618. "Translate a link from Emacs Planner syntax so that Org can follow it.
  8619. This is still an experimental function, your mileage may vary."
  8620. (cond
  8621. ((member type '("http" "https" "news" "ftp"))
  8622. ;; standard Internet links are the same.
  8623. nil)
  8624. ((and (equal type "irc") (string-match "^//" path))
  8625. ;; Planner has two / at the beginning of an irc link, we have 1.
  8626. ;; We should have zero, actually....
  8627. (setq path (substring path 1)))
  8628. ((and (equal type "lisp") (string-match "^/" path))
  8629. ;; Planner has a slash, we do not.
  8630. (setq type "elisp" path (substring path 1)))
  8631. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  8632. ;; A typical message link. Planner has the id after the final slash,
  8633. ;; we separate it with a hash mark
  8634. (setq path (concat (match-string 1 path) "#"
  8635. (org-remove-angle-brackets (match-string 2 path)))))
  8636. )
  8637. (cons type path))
  8638. (defun org-find-file-at-mouse (ev)
  8639. "Open file link or URL at mouse."
  8640. (interactive "e")
  8641. (mouse-set-point ev)
  8642. (org-open-at-point 'in-emacs))
  8643. (defun org-open-at-mouse (ev)
  8644. "Open file link or URL at mouse.
  8645. See the docstring of `org-open-file' for details."
  8646. (interactive "e")
  8647. (mouse-set-point ev)
  8648. (if (eq major-mode 'org-agenda-mode)
  8649. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  8650. (org-open-at-point))
  8651. (defvar org-window-config-before-follow-link nil
  8652. "The window configuration before following a link.
  8653. This is saved in case the need arises to restore it.")
  8654. (defvar org-open-link-marker (make-marker)
  8655. "Marker pointing to the location where `org-open-at-point; was called.")
  8656. ;;;###autoload
  8657. (defun org-open-at-point-global ()
  8658. "Follow a link like Org-mode does.
  8659. This command can be called in any mode to follow a link that has
  8660. Org-mode syntax."
  8661. (interactive)
  8662. (org-run-like-in-org-mode 'org-open-at-point))
  8663. ;;;###autoload
  8664. (defun org-open-link-from-string (s &optional arg reference-buffer)
  8665. "Open a link in the string S, as if it was in Org-mode."
  8666. (interactive "sLink: \nP")
  8667. (let ((reference-buffer (or reference-buffer (current-buffer))))
  8668. (with-temp-buffer
  8669. (let ((org-inhibit-startup (not reference-buffer)))
  8670. (org-mode)
  8671. (insert s)
  8672. (goto-char (point-min))
  8673. (when reference-buffer
  8674. (setq org-link-abbrev-alist-local
  8675. (with-current-buffer reference-buffer
  8676. org-link-abbrev-alist-local)))
  8677. (org-open-at-point arg reference-buffer)))))
  8678. (defvar org-open-at-point-functions nil
  8679. "Hook that is run when following a link at point.
  8680. Functions in this hook must return t if they identify and follow
  8681. a link at point. If they don't find anything interesting at point,
  8682. they must return nil.")
  8683. (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
  8684. (defun org-open-at-point (&optional arg reference-buffer)
  8685. "Open link at or after point.
  8686. If there is no link at point, this function will search forward up to
  8687. the end of the current line.
  8688. Normally, files will be opened by an appropriate application. If the
  8689. optional prefix argument ARG is non-nil, Emacs will visit the file.
  8690. With a double prefix argument, try to open outside of Emacs, in the
  8691. application the system uses for this file type."
  8692. (interactive "P")
  8693. ;; if in a code block, then open the block's results
  8694. (unless (call-interactively #'org-babel-open-src-block-result)
  8695. (org-load-modules-maybe)
  8696. (move-marker org-open-link-marker (point))
  8697. (setq org-window-config-before-follow-link (current-window-configuration))
  8698. (org-remove-occur-highlights nil nil t)
  8699. (cond
  8700. ((and (org-at-heading-p)
  8701. (not (org-at-timestamp-p t))
  8702. (not (org-in-regexp
  8703. (concat org-plain-link-re "\\|"
  8704. org-bracket-link-regexp "\\|"
  8705. org-angle-link-re "\\|"
  8706. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8707. (not (get-text-property (point) 'org-linked-text)))
  8708. (or (org-offer-links-in-entry arg)
  8709. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8710. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  8711. ((and (org-at-timestamp-p t)
  8712. (not (org-in-regexp org-bracket-link-regexp)))
  8713. (org-follow-timestamp-link))
  8714. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8715. (not (org-in-regexp org-bracket-link-regexp)))
  8716. (org-footnote-action))
  8717. (t
  8718. (let (type path link line search (pos (point)))
  8719. (catch 'match
  8720. (save-excursion
  8721. (skip-chars-forward "^]\n\r")
  8722. (when (org-in-regexp org-bracket-link-regexp 1)
  8723. (setq link (org-extract-attributes
  8724. (org-link-unescape (org-match-string-no-properties 1))))
  8725. (while (string-match " *\n *" link)
  8726. (setq link (replace-match " " t t link)))
  8727. (setq link (org-link-expand-abbrev link))
  8728. (cond
  8729. ((or (file-name-absolute-p link)
  8730. (string-match "^\\.\\.?/" link))
  8731. (setq type "file" path link))
  8732. ((string-match org-link-re-with-space3 link)
  8733. (setq type (match-string 1 link) path (match-string 2 link)))
  8734. ((string-match "^help:+\\(.+\\)" link)
  8735. (setq type "help" path (match-string 1 link)))
  8736. (t (setq type "thisfile" path link)))
  8737. (throw 'match t)))
  8738. (when (get-text-property (point) 'org-linked-text)
  8739. (setq type "thisfile"
  8740. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8741. (1+ (point)) (point))
  8742. path (buffer-substring
  8743. (or (previous-single-property-change pos 'org-linked-text)
  8744. (point-min))
  8745. (or (next-single-property-change pos 'org-linked-text)
  8746. (point-max))))
  8747. (throw 'match t))
  8748. (save-excursion
  8749. (when (or (org-in-regexp org-angle-link-re)
  8750. (and (goto-char (car (org-in-regexp org-plain-link-re)))
  8751. (save-match-data (not (looking-back "\\[\\[")))))
  8752. (setq type (match-string 1)
  8753. path (org-link-unescape (match-string 2)))
  8754. (throw 'match t)))
  8755. (save-excursion
  8756. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  8757. (setq type "tags"
  8758. path (match-string 1))
  8759. (while (string-match ":" path)
  8760. (setq path (replace-match "+" t t path)))
  8761. (throw 'match t)))
  8762. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8763. (setq type "tree-match"
  8764. path (match-string 1))
  8765. (throw 'match t)))
  8766. (unless path
  8767. (error "No link found"))
  8768. ;; switch back to reference buffer
  8769. ;; needed when if called in a temporary buffer through
  8770. ;; org-open-link-from-string
  8771. (with-current-buffer (or reference-buffer (current-buffer))
  8772. ;; Remove any trailing spaces in path
  8773. (if (string-match " +\\'" path)
  8774. (setq path (replace-match "" t t path)))
  8775. (if (and org-link-translation-function
  8776. (fboundp org-link-translation-function))
  8777. ;; Check if we need to translate the link
  8778. (let ((tmp (funcall org-link-translation-function type path)))
  8779. (setq type (car tmp) path (cdr tmp))))
  8780. (cond
  8781. ((assoc type org-link-protocols)
  8782. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8783. ((equal type "help")
  8784. (let ((f-or-v (intern path)))
  8785. (cond ((fboundp f-or-v)
  8786. (describe-function f-or-v))
  8787. ((boundp f-or-v)
  8788. (describe-variable f-or-v))
  8789. (t (error "Not a known function or variable")))))
  8790. ((equal type "mailto")
  8791. (let ((cmd (car org-link-mailto-program))
  8792. (args (cdr org-link-mailto-program)) args1
  8793. (address path) (subject "") a)
  8794. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8795. (setq address (match-string 1 path)
  8796. subject (org-link-escape (match-string 2 path))))
  8797. (while args
  8798. (cond
  8799. ((not (stringp (car args))) (push (pop args) args1))
  8800. (t (setq a (pop args))
  8801. (if (string-match "%a" a)
  8802. (setq a (replace-match address t t a)))
  8803. (if (string-match "%s" a)
  8804. (setq a (replace-match subject t t a)))
  8805. (push a args1))))
  8806. (apply cmd (nreverse args1))))
  8807. ((member type '("http" "https" "ftp" "news"))
  8808. (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
  8809. (org-link-escape
  8810. path org-link-escape-chars-browser)
  8811. path))))
  8812. ((string= type "doi")
  8813. (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
  8814. (org-link-escape
  8815. path org-link-escape-chars-browser)
  8816. path))))
  8817. ((member type '("message"))
  8818. (browse-url (concat type ":" path)))
  8819. ((string= type "tags")
  8820. (org-tags-view arg path))
  8821. ((string= type "tree-match")
  8822. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8823. ((string= type "file")
  8824. (if (string-match "::\\([0-9]+\\)\\'" path)
  8825. (setq line (string-to-number (match-string 1 path))
  8826. path (substring path 0 (match-beginning 0)))
  8827. (if (string-match "::\\(.+\\)\\'" path)
  8828. (setq search (match-string 1 path)
  8829. path (substring path 0 (match-beginning 0)))))
  8830. (if (string-match "[*?{]" (file-name-nondirectory path))
  8831. (dired path)
  8832. (org-open-file path arg line search)))
  8833. ((string= type "shell")
  8834. (let ((buf (generate-new-buffer "*Org Shell Output"))
  8835. (cmd path))
  8836. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  8837. (string-match org-confirm-shell-link-not-regexp cmd))
  8838. (not org-confirm-shell-link-function)
  8839. (funcall org-confirm-shell-link-function
  8840. (format "Execute \"%s\" in shell? "
  8841. (org-add-props cmd nil
  8842. 'face 'org-warning))))
  8843. (progn
  8844. (message "Executing %s" cmd)
  8845. (shell-command cmd buf)
  8846. (if (featurep 'midnight)
  8847. (setq clean-buffer-list-kill-buffer-names
  8848. (cons buf clean-buffer-list-kill-buffer-names))))
  8849. (error "Abort"))))
  8850. ((string= type "elisp")
  8851. (let ((cmd path))
  8852. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  8853. (string-match org-confirm-elisp-link-not-regexp cmd))
  8854. (not org-confirm-elisp-link-function)
  8855. (funcall org-confirm-elisp-link-function
  8856. (format "Execute \"%s\" as elisp? "
  8857. (org-add-props cmd nil
  8858. 'face 'org-warning))))
  8859. (message "%s => %s" cmd
  8860. (if (equal (string-to-char cmd) ?\()
  8861. (eval (read cmd))
  8862. (call-interactively (read cmd))))
  8863. (error "Abort"))))
  8864. ((and (string= type "thisfile")
  8865. (run-hook-with-args-until-success
  8866. 'org-open-link-functions path)))
  8867. ((string= type "thisfile")
  8868. (if arg
  8869. (switch-to-buffer-other-window
  8870. (org-get-buffer-for-internal-link (current-buffer)))
  8871. (org-mark-ring-push))
  8872. (let ((cmd `(org-link-search
  8873. ,path
  8874. ,(cond ((equal arg '(4)) ''occur)
  8875. ((equal arg '(16)) ''org-occur))
  8876. ,pos)))
  8877. (condition-case nil (let ((org-link-search-inhibit-query t))
  8878. (eval cmd))
  8879. (error (progn (widen) (eval cmd))))))
  8880. (t (browse-url-at-point)))))))
  8881. (move-marker org-open-link-marker nil)
  8882. (run-hook-with-args 'org-follow-link-hook)))
  8883. (defun org-offer-links-in-entry (&optional nth zero)
  8884. "Offer links in the current entry and follow the selected link.
  8885. If there is only one link, follow it immediately as well.
  8886. If NTH is an integer, immediately pick the NTH link found.
  8887. If ZERO is a string, check also this string for a link, and if
  8888. there is one, offer it as link number zero."
  8889. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  8890. "\\(" org-angle-link-re "\\)\\|"
  8891. "\\(" org-plain-link-re "\\)"))
  8892. (cnt ?0)
  8893. (in-emacs (if (integerp nth) nil nth))
  8894. have-zero end links link c)
  8895. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  8896. (push (match-string 0 zero) links)
  8897. (setq cnt (1- cnt) have-zero t))
  8898. (save-excursion
  8899. (org-back-to-heading t)
  8900. (setq end (save-excursion (outline-next-heading) (point)))
  8901. (while (re-search-forward re end t)
  8902. (push (match-string 0) links))
  8903. (setq links (org-uniquify (reverse links))))
  8904. (cond
  8905. ((null links)
  8906. (message "No links"))
  8907. ((equal (length links) 1)
  8908. (setq link (list (car links))))
  8909. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  8910. (setq link (list (nth (if have-zero nth (1- nth)) links))))
  8911. (t ; we have to select a link
  8912. (save-excursion
  8913. (save-window-excursion
  8914. (delete-other-windows)
  8915. (with-output-to-temp-buffer "*Select Link*"
  8916. (mapc (lambda (l)
  8917. (if (not (string-match org-bracket-link-regexp l))
  8918. (princ (format "[%c] %s\n" (incf cnt)
  8919. (org-remove-angle-brackets l)))
  8920. (if (match-end 3)
  8921. (princ (format "[%c] %s (%s)\n" (incf cnt)
  8922. (match-string 3 l) (match-string 1 l)))
  8923. (princ (format "[%c] %s\n" (incf cnt)
  8924. (match-string 1 l))))))
  8925. links))
  8926. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  8927. (message "Select link to open, RET to open all:")
  8928. (setq c (read-char-exclusive))
  8929. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  8930. (when (equal c ?q) (error "Abort"))
  8931. (if (equal c ?\C-m)
  8932. (setq link links)
  8933. (setq nth (- c ?0))
  8934. (if have-zero (setq nth (1+ nth)))
  8935. (unless (and (integerp nth) (>= (length links) nth))
  8936. (error "Invalid link selection"))
  8937. (setq link (list (nth (1- nth) links))))))
  8938. (if link
  8939. (let ((buf (current-buffer)))
  8940. (dolist (l link)
  8941. (org-open-link-from-string l in-emacs buf))
  8942. t)
  8943. nil)))
  8944. ;; Add special file links that specify the way of opening
  8945. (org-add-link-type "file+sys" 'org-open-file-with-system)
  8946. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  8947. (defun org-open-file-with-system (path)
  8948. "Open file at PATH using the system way of opening it."
  8949. (org-open-file path 'system))
  8950. (defun org-open-file-with-emacs (path)
  8951. "Open file at PATH in Emacs."
  8952. (org-open-file path 'emacs))
  8953. (defun org-remove-file-link-modifiers ()
  8954. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  8955. (goto-char (point-min))
  8956. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  8957. (org-if-unprotected
  8958. (replace-match "file:" t t))))
  8959. (eval-after-load "org-exp"
  8960. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  8961. 'org-remove-file-link-modifiers))
  8962. ;;;; Time estimates
  8963. (defun org-get-effort (&optional pom)
  8964. "Get the effort estimate for the current entry."
  8965. (org-entry-get pom org-effort-property))
  8966. ;;; File search
  8967. (defvar org-create-file-search-functions nil
  8968. "List of functions to construct the right search string for a file link.
  8969. These functions are called in turn with point at the location to
  8970. which the link should point.
  8971. A function in the hook should first test if it would like to
  8972. handle this file type, for example by checking the `major-mode'
  8973. or the file extension. If it decides not to handle this file, it
  8974. should just return nil to give other functions a chance. If it
  8975. does handle the file, it must return the search string to be used
  8976. when following the link. The search string will be part of the
  8977. file link, given after a double colon, and `org-open-at-point'
  8978. will automatically search for it. If special measures must be
  8979. taken to make the search successful, another function should be
  8980. added to the companion hook `org-execute-file-search-functions',
  8981. which see.
  8982. A function in this hook may also use `setq' to set the variable
  8983. `description' to provide a suggestion for the descriptive text to
  8984. be used for this link when it gets inserted into an Org-mode
  8985. buffer with \\[org-insert-link].")
  8986. (defvar org-execute-file-search-functions nil
  8987. "List of functions to execute a file search triggered by a link.
  8988. Functions added to this hook must accept a single argument, the
  8989. search string that was part of the file link, the part after the
  8990. double colon. The function must first check if it would like to
  8991. handle this search, for example by checking the `major-mode' or
  8992. the file extension. If it decides not to handle this search, it
  8993. should just return nil to give other functions a chance. If it
  8994. does handle the search, it must return a non-nil value to keep
  8995. other functions from trying.
  8996. Each function can access the current prefix argument through the
  8997. variable `current-prefix-argument'. Note that a single prefix is
  8998. used to force opening a link in Emacs, so it may be good to only
  8999. use a numeric or double prefix to guide the search function.
  9000. In case this is needed, a function in this hook can also restore
  9001. the window configuration before `org-open-at-point' was called using:
  9002. (set-window-configuration org-window-config-before-follow-link)")
  9003. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  9004. (defun org-link-search (s &optional type avoid-pos stealth)
  9005. "Search for a link search option.
  9006. If S is surrounded by forward slashes, it is interpreted as a
  9007. regular expression. In org-mode files, this will create an `org-occur'
  9008. sparse tree. In ordinary files, `occur' will be used to list matches.
  9009. If the current buffer is in `dired-mode', grep will be used to search
  9010. in all files. If AVOID-POS is given, ignore matches near that position.
  9011. When optional argument STEALTH is non-nil, do not modify
  9012. visibility around point, thus ignoring
  9013. `org-show-hierarchy-above', `org-show-following-heading' and
  9014. `org-show-siblings' variables."
  9015. (let ((case-fold-search t)
  9016. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  9017. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  9018. (append '(("") (" ") ("\t") ("\n"))
  9019. org-emphasis-alist)
  9020. "\\|") "\\)"))
  9021. (pos (point))
  9022. (pre nil) (post nil)
  9023. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  9024. (cond
  9025. ;; First check if there are any special search functions
  9026. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9027. ;; Now try the builtin stuff
  9028. ((and (equal (string-to-char s0) ?#)
  9029. (> (length s0) 1)
  9030. (save-excursion
  9031. (goto-char (point-min))
  9032. (and
  9033. (re-search-forward
  9034. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  9035. (setq type 'dedicated
  9036. pos (match-beginning 0))))
  9037. ;; There is an exact target for this
  9038. (goto-char pos)
  9039. (org-back-to-heading t)))
  9040. ((save-excursion
  9041. (goto-char (point-min))
  9042. (and
  9043. (re-search-forward
  9044. (concat "<<" (regexp-quote s0) ">>") nil t)
  9045. (setq type 'dedicated
  9046. pos (match-beginning 0))))
  9047. ;; There is an exact target for this
  9048. (goto-char pos))
  9049. ((save-excursion
  9050. (goto-char (point-min))
  9051. (and
  9052. (re-search-forward
  9053. (format "^[ \t]*#\\+TARGET: %s" (regexp-quote s0)) nil t)
  9054. (setq type 'dedicated pos (match-beginning 0))))
  9055. ;; Found an invisible target.
  9056. (goto-char pos))
  9057. ((save-excursion
  9058. (goto-char (point-min))
  9059. (and
  9060. (re-search-forward
  9061. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9062. (setq type 'dedicated pos (match-beginning 0))))
  9063. ;; Found an element with a matching #+name affiliated keyword.
  9064. (goto-char pos))
  9065. ((and (string-match "^(\\(.*\\))$" s0)
  9066. (save-excursion
  9067. (goto-char (point-min))
  9068. (and
  9069. (re-search-forward
  9070. (concat "[^[]" (regexp-quote
  9071. (format org-coderef-label-format
  9072. (match-string 1 s0))))
  9073. nil t)
  9074. (setq type 'dedicated
  9075. pos (1+ (match-beginning 0))))))
  9076. ;; There is a coderef target for this
  9077. (goto-char pos))
  9078. ((string-match "^/\\(.*\\)/$" s)
  9079. ;; A regular expression
  9080. (cond
  9081. ((derived-mode-p 'org-mode)
  9082. (org-occur (match-string 1 s)))
  9083. ;;((eq major-mode 'dired-mode)
  9084. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  9085. (t (org-do-occur (match-string 1 s)))))
  9086. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9087. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9088. (goto-char (point-min))
  9089. (cond
  9090. ((let (case-fold-search)
  9091. (re-search-forward (format org-complex-heading-regexp-format
  9092. (regexp-quote s))
  9093. nil t))
  9094. ;; OK, found a match
  9095. (setq type 'dedicated)
  9096. (goto-char (match-beginning 0)))
  9097. ((and (not org-link-search-inhibit-query)
  9098. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9099. (y-or-n-p "No match - create this as a new heading? "))
  9100. (goto-char (point-max))
  9101. (or (bolp) (newline))
  9102. (insert "* " s "\n")
  9103. (beginning-of-line 0))
  9104. (t
  9105. (goto-char pos)
  9106. (error "No match"))))
  9107. (t
  9108. ;; A normal search string
  9109. (when (equal (string-to-char s) ?*)
  9110. ;; Anchor on headlines, post may include tags.
  9111. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9112. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9113. s (substring s 1)))
  9114. (remove-text-properties
  9115. 0 (length s)
  9116. '(face nil mouse-face nil keymap nil fontified nil) s)
  9117. ;; Make a series of regular expressions to find a match
  9118. (setq words (org-split-string s "[ \n\r\t]+")
  9119. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9120. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9121. "\\)" markers)
  9122. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  9123. re2a (concat "[ \t\r\n]" re2a_)
  9124. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9125. re4 (concat "[^a-zA-Z_]" re4_)
  9126. re1 (concat pre re2 post)
  9127. re3 (concat pre (if pre re4_ re4) post)
  9128. re5 (concat pre ".*" re4)
  9129. re2 (concat pre re2)
  9130. re2a (concat pre (if pre re2a_ re2a))
  9131. re4 (concat pre (if pre re4_ re4))
  9132. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9133. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9134. re5 "\\)"
  9135. ))
  9136. (cond
  9137. ((eq type 'org-occur) (org-occur reall))
  9138. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9139. (t (goto-char (point-min))
  9140. (setq type 'fuzzy)
  9141. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  9142. (org-search-not-self 1 re1 nil t)
  9143. (org-search-not-self 1 re2 nil t)
  9144. (org-search-not-self 1 re2a nil t)
  9145. (org-search-not-self 1 re3 nil t)
  9146. (org-search-not-self 1 re4 nil t)
  9147. (org-search-not-self 1 re5 nil t)
  9148. )
  9149. (goto-char (match-beginning 1))
  9150. (goto-char pos)
  9151. (error "No match"))))))
  9152. (and (derived-mode-p 'org-mode)
  9153. (not stealth)
  9154. (org-show-context 'link-search))
  9155. type))
  9156. (defun org-search-not-self (group &rest args)
  9157. "Execute `re-search-forward', but only accept matches that do not
  9158. enclose the position of `org-open-link-marker'."
  9159. (let ((m org-open-link-marker))
  9160. (catch 'exit
  9161. (while (apply 're-search-forward args)
  9162. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9163. (goto-char (match-end group))
  9164. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9165. (> (match-beginning 0) (marker-position m))
  9166. (< (match-end 0) (marker-position m)))
  9167. (save-match-data
  9168. (or (not (org-in-regexp
  9169. org-bracket-link-analytic-regexp 1))
  9170. (not (match-end 4)) ; no description
  9171. (and (<= (match-beginning 4) (point))
  9172. (>= (match-end 4) (point))))))
  9173. (throw 'exit (point))))))))
  9174. (defun org-get-buffer-for-internal-link (buffer)
  9175. "Return a buffer to be used for displaying the link target of internal links."
  9176. (cond
  9177. ((not org-display-internal-link-with-indirect-buffer)
  9178. buffer)
  9179. ((string-match "(Clone)$" (buffer-name buffer))
  9180. (message "Buffer is already a clone, not making another one")
  9181. ;; we also do not modify visibility in this case
  9182. buffer)
  9183. (t ; make a new indirect buffer for displaying the link
  9184. (let* ((bn (buffer-name buffer))
  9185. (ibn (concat bn "(Clone)"))
  9186. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9187. (with-current-buffer ib (org-overview))
  9188. ib))))
  9189. (defun org-do-occur (regexp &optional cleanup)
  9190. "Call the Emacs command `occur'.
  9191. If CLEANUP is non-nil, remove the printout of the regular expression
  9192. in the *Occur* buffer. This is useful if the regex is long and not useful
  9193. to read."
  9194. (occur regexp)
  9195. (when cleanup
  9196. (let ((cwin (selected-window)) win beg end)
  9197. (when (setq win (get-buffer-window "*Occur*"))
  9198. (select-window win))
  9199. (goto-char (point-min))
  9200. (when (re-search-forward "match[a-z]+" nil t)
  9201. (setq beg (match-end 0))
  9202. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9203. (setq end (1- (match-beginning 0)))))
  9204. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9205. (goto-char (point-min))
  9206. (select-window cwin))))
  9207. ;;; The mark ring for links jumps
  9208. (defvar org-mark-ring nil
  9209. "Mark ring for positions before jumps in Org-mode.")
  9210. (defvar org-mark-ring-last-goto nil
  9211. "Last position in the mark ring used to go back.")
  9212. ;; Fill and close the ring
  9213. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9214. (loop for i from 1 to org-mark-ring-length do
  9215. (push (make-marker) org-mark-ring))
  9216. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9217. org-mark-ring)
  9218. (defun org-mark-ring-push (&optional pos buffer)
  9219. "Put the current position or POS into the mark ring and rotate it."
  9220. (interactive)
  9221. (setq pos (or pos (point)))
  9222. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9223. (move-marker (car org-mark-ring)
  9224. (or pos (point))
  9225. (or buffer (current-buffer)))
  9226. (message "%s"
  9227. (substitute-command-keys
  9228. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9229. (defun org-mark-ring-goto (&optional n)
  9230. "Jump to the previous position in the mark ring.
  9231. With prefix arg N, jump back that many stored positions. When
  9232. called several times in succession, walk through the entire ring.
  9233. Org-mode commands jumping to a different position in the current file,
  9234. or to another Org-mode file, automatically push the old position
  9235. onto the ring."
  9236. (interactive "p")
  9237. (let (p m)
  9238. (if (eq last-command this-command)
  9239. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9240. (setq p org-mark-ring))
  9241. (setq org-mark-ring-last-goto p)
  9242. (setq m (car p))
  9243. (org-pop-to-buffer-same-window (marker-buffer m))
  9244. (goto-char m)
  9245. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9246. (defun org-remove-angle-brackets (s)
  9247. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9248. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9249. s)
  9250. (defun org-add-angle-brackets (s)
  9251. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9252. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9253. s)
  9254. (defun org-remove-double-quotes (s)
  9255. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9256. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9257. s)
  9258. ;;; Following specific links
  9259. (defun org-follow-timestamp-link ()
  9260. "Open an agenda view for the time-stamp date/range at point."
  9261. (cond
  9262. ((org-at-date-range-p t)
  9263. (let ((org-agenda-start-on-weekday)
  9264. (t1 (match-string 1))
  9265. (t2 (match-string 2)) tt1 tt2)
  9266. (setq tt1 (time-to-days (org-time-string-to-time t1))
  9267. tt2 (time-to-days (org-time-string-to-time t2)))
  9268. (let ((org-agenda-buffer-tmp-name
  9269. (format "*Org Agenda(a:%s)"
  9270. (concat (substring t1 0 10) "--" (substring t2 0 10)))))
  9271. (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
  9272. ((org-at-timestamp-p t)
  9273. (let ((org-agenda-buffer-tmp-name
  9274. (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
  9275. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9276. (substring (match-string 1) 0 10)))
  9277. 1)))
  9278. (t (error "This should not happen"))))
  9279. ;;; Following file links
  9280. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9281. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9282. (declare-function mailcap-mime-info
  9283. "mailcap" (string &optional request no-decode))
  9284. (defvar org-wait nil)
  9285. (defun org-open-file (path &optional in-emacs line search)
  9286. "Open the file at PATH.
  9287. First, this expands any special file name abbreviations. Then the
  9288. configuration variable `org-file-apps' is checked if it contains an
  9289. entry for this file type, and if yes, the corresponding command is launched.
  9290. If no application is found, Emacs simply visits the file.
  9291. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9292. With a double \\[universal-argument] \\[universal-argument] \
  9293. prefix arg, Org tries to avoid opening in Emacs
  9294. and to use an external application to visit the file.
  9295. Optional LINE specifies a line to go to, optional SEARCH a string
  9296. to search for. If LINE or SEARCH is given, the file will be
  9297. opened in Emacs, unless an entry from org-file-apps that makes
  9298. use of groups in a regexp matches.
  9299. If you want to change the way frames are used when following a
  9300. link, please customize `org-link-frame-setup'.
  9301. If the file does not exist, an error is thrown."
  9302. (let* ((file (if (equal path "")
  9303. buffer-file-name
  9304. (substitute-in-file-name (expand-file-name path))))
  9305. (file-apps (append org-file-apps (org-default-apps)))
  9306. (apps (org-remove-if
  9307. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9308. (apps-dlink (org-remove-if-not
  9309. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9310. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9311. (dirp (if remp nil (file-directory-p file)))
  9312. (file (if (and dirp org-open-directory-means-index-dot-org)
  9313. (concat (file-name-as-directory file) "index.org")
  9314. file))
  9315. (a-m-a-p (assq 'auto-mode apps))
  9316. (dfile (downcase file))
  9317. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9318. (link (cond ((and (eq line nil)
  9319. (eq search nil))
  9320. file)
  9321. (line
  9322. (concat file "::" (number-to-string line)))
  9323. (search
  9324. (concat file "::" search))))
  9325. (dlink (downcase link))
  9326. (old-buffer (current-buffer))
  9327. (old-pos (point))
  9328. (old-mode major-mode)
  9329. ext cmd link-match-data)
  9330. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9331. (setq ext (match-string 1 dfile))
  9332. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9333. (setq ext (match-string 1 dfile))))
  9334. (cond
  9335. ((member in-emacs '((16) system))
  9336. (setq cmd (cdr (assoc 'system apps))))
  9337. (in-emacs (setq cmd 'emacs))
  9338. (t
  9339. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9340. (and dirp (cdr (assoc 'directory apps)))
  9341. ; first, try matching against apps-dlink
  9342. ; if we get a match here, store the match data for later
  9343. (let ((match (assoc-default dlink apps-dlink
  9344. 'string-match)))
  9345. (if match
  9346. (progn (setq link-match-data (match-data))
  9347. match)
  9348. (progn (setq in-emacs (or in-emacs line search))
  9349. nil))) ; if we have no match in apps-dlink,
  9350. ; always open the file in emacs if line or search
  9351. ; is given (for backwards compatibility)
  9352. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9353. 'string-match)
  9354. (cdr (assoc ext apps))
  9355. (cdr (assoc t apps))))))
  9356. (when (eq cmd 'system)
  9357. (setq cmd (cdr (assoc 'system apps))))
  9358. (when (eq cmd 'default)
  9359. (setq cmd (cdr (assoc t apps))))
  9360. (when (eq cmd 'mailcap)
  9361. (require 'mailcap)
  9362. (mailcap-parse-mailcaps)
  9363. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9364. (command (mailcap-mime-info mime-type)))
  9365. (if (stringp command)
  9366. (setq cmd command)
  9367. (setq cmd 'emacs))))
  9368. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  9369. (not (file-exists-p file))
  9370. (not org-open-non-existing-files))
  9371. (error "No such file: %s" file))
  9372. (cond
  9373. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  9374. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  9375. (while (string-match "['\"]%s['\"]" cmd)
  9376. (setq cmd (replace-match "%s" t t cmd)))
  9377. (while (string-match "%s" cmd)
  9378. (setq cmd (replace-match
  9379. (save-match-data
  9380. (shell-quote-argument
  9381. (convert-standard-filename file)))
  9382. t t cmd)))
  9383. ;; Replace "%1", "%2" etc. in command with group matches from regex
  9384. (save-match-data
  9385. (let ((match-index 1)
  9386. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  9387. (set-match-data link-match-data)
  9388. (while (<= match-index number-of-groups)
  9389. (let ((regex (concat "%" (number-to-string match-index)))
  9390. (replace-with (match-string match-index dlink)))
  9391. (while (string-match regex cmd)
  9392. (setq cmd (replace-match replace-with t t cmd))))
  9393. (setq match-index (+ match-index 1)))))
  9394. (save-window-excursion
  9395. (message "Running %s...done" cmd)
  9396. (start-process-shell-command cmd nil cmd)
  9397. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  9398. ((or (stringp cmd)
  9399. (eq cmd 'emacs))
  9400. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  9401. (widen)
  9402. (if line (org-goto-line line)
  9403. (if search (org-link-search search))))
  9404. ((consp cmd)
  9405. (let ((file (convert-standard-filename file)))
  9406. (save-match-data
  9407. (set-match-data link-match-data)
  9408. (eval cmd))))
  9409. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  9410. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  9411. (or (not (equal old-buffer (current-buffer)))
  9412. (not (equal old-pos (point))))
  9413. (org-mark-ring-push old-pos old-buffer))))
  9414. (defun org-file-apps-entry-match-against-dlink-p (entry)
  9415. "This function returns non-nil if `entry' uses a regular
  9416. expression which should be matched against the whole link by
  9417. org-open-file.
  9418. It assumes that is the case when the entry uses a regular
  9419. expression which has at least one grouping construct and the
  9420. action is either a lisp form or a command string containing
  9421. '%1', i.e. using at least one subexpression match as a
  9422. parameter."
  9423. (let ((selector (car entry))
  9424. (action (cdr entry)))
  9425. (if (stringp selector)
  9426. (and (> (regexp-opt-depth selector) 0)
  9427. (or (and (stringp action)
  9428. (string-match "%[0-9]" action))
  9429. (consp action)))
  9430. nil)))
  9431. (defun org-default-apps ()
  9432. "Return the default applications for this operating system."
  9433. (cond
  9434. ((eq system-type 'darwin)
  9435. org-file-apps-defaults-macosx)
  9436. ((eq system-type 'windows-nt)
  9437. org-file-apps-defaults-windowsnt)
  9438. (t org-file-apps-defaults-gnu)))
  9439. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  9440. "Convert extensions to regular expressions in the cars of LIST.
  9441. Also, weed out any non-string entries, because the return value is used
  9442. only for regexp matching.
  9443. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  9444. point to the symbol `emacs', indicating that the file should
  9445. be opened in Emacs."
  9446. (append
  9447. (delq nil
  9448. (mapcar (lambda (x)
  9449. (if (not (stringp (car x)))
  9450. nil
  9451. (if (string-match "\\W" (car x))
  9452. x
  9453. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  9454. list))
  9455. (if add-auto-mode
  9456. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  9457. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  9458. (defun org-file-remote-p (file)
  9459. "Test whether FILE specifies a location on a remote system.
  9460. Return non-nil if the location is indeed remote.
  9461. For example, the filename \"/user@host:/foo\" specifies a location
  9462. on the system \"/user@host:\"."
  9463. (cond ((fboundp 'file-remote-p)
  9464. (file-remote-p file))
  9465. ((fboundp 'tramp-handle-file-remote-p)
  9466. (tramp-handle-file-remote-p file))
  9467. ((and (boundp 'ange-ftp-name-format)
  9468. (string-match (car ange-ftp-name-format) file))
  9469. t)))
  9470. ;;;; Refiling
  9471. (defun org-get-org-file ()
  9472. "Read a filename, with default directory `org-directory'."
  9473. (let ((default (or org-default-notes-file remember-data-file)))
  9474. (read-file-name (format "File name [%s]: " default)
  9475. (file-name-as-directory org-directory)
  9476. default)))
  9477. (defun org-notes-order-reversed-p ()
  9478. "Check if the current file should receive notes in reversed order."
  9479. (cond
  9480. ((not org-reverse-note-order) nil)
  9481. ((eq t org-reverse-note-order) t)
  9482. ((not (listp org-reverse-note-order)) nil)
  9483. (t (catch 'exit
  9484. (let ((all org-reverse-note-order)
  9485. entry)
  9486. (while (setq entry (pop all))
  9487. (if (string-match (car entry) buffer-file-name)
  9488. (throw 'exit (cdr entry))))
  9489. nil)))))
  9490. (defvar org-refile-target-table nil
  9491. "The list of refile targets, created by `org-refile'.")
  9492. (defvar org-agenda-new-buffers nil
  9493. "Buffers created to visit agenda files.")
  9494. (defvar org-refile-cache nil
  9495. "Cache for refile targets.")
  9496. (defvar org-refile-markers nil
  9497. "All the markers used for caching refile locations.")
  9498. (defun org-refile-marker (pos)
  9499. "Get a new refile marker, but only if caching is in use."
  9500. (if (not org-refile-use-cache)
  9501. pos
  9502. (let ((m (make-marker)))
  9503. (move-marker m pos)
  9504. (push m org-refile-markers)
  9505. m)))
  9506. (defun org-refile-cache-clear ()
  9507. "Clear the refile cache and disable all the markers."
  9508. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  9509. (setq org-refile-markers nil)
  9510. (setq org-refile-cache nil)
  9511. (message "Refile cache has been cleared"))
  9512. (defun org-refile-cache-check-set (set)
  9513. "Check if all the markers in the cache still have live buffers."
  9514. (let (marker)
  9515. (catch 'exit
  9516. (while (and set (setq marker (nth 3 (pop set))))
  9517. ;; if org-refile-use-outline-path is 'file, marker may be nil
  9518. (when (and marker (null (marker-buffer marker)))
  9519. (message "not found") (sit-for 3)
  9520. (throw 'exit nil)))
  9521. t)))
  9522. (defun org-refile-cache-put (set &rest identifiers)
  9523. "Push the refile targets SET into the cache, under IDENTIFIERS."
  9524. (let* ((key (sha1 (prin1-to-string identifiers)))
  9525. (entry (assoc key org-refile-cache)))
  9526. (if entry
  9527. (setcdr entry set)
  9528. (push (cons key set) org-refile-cache))))
  9529. (defun org-refile-cache-get (&rest identifiers)
  9530. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  9531. (cond
  9532. ((not org-refile-cache) nil)
  9533. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  9534. (t
  9535. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  9536. org-refile-cache))))
  9537. (and set (org-refile-cache-check-set set) set)))))
  9538. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  9539. "Produce a table with refile targets."
  9540. (let ((case-fold-search nil)
  9541. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  9542. (entries (or org-refile-targets '((nil . (:level . 1)))))
  9543. targets tgs txt re files f desc descre fast-path-p level pos0)
  9544. (message "Getting targets...")
  9545. (with-current-buffer (or default-buffer (current-buffer))
  9546. (while (setq entry (pop entries))
  9547. (setq files (car entry) desc (cdr entry))
  9548. (setq fast-path-p nil)
  9549. (cond
  9550. ((null files) (setq files (list (current-buffer))))
  9551. ((eq files 'org-agenda-files)
  9552. (setq files (org-agenda-files 'unrestricted)))
  9553. ((and (symbolp files) (fboundp files))
  9554. (setq files (funcall files)))
  9555. ((and (symbolp files) (boundp files))
  9556. (setq files (symbol-value files))))
  9557. (if (stringp files) (setq files (list files)))
  9558. (cond
  9559. ((eq (car desc) :tag)
  9560. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  9561. ((eq (car desc) :todo)
  9562. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  9563. ((eq (car desc) :regexp)
  9564. (setq descre (cdr desc)))
  9565. ((eq (car desc) :level)
  9566. (setq descre (concat "^\\*\\{" (number-to-string
  9567. (if org-odd-levels-only
  9568. (1- (* 2 (cdr desc)))
  9569. (cdr desc)))
  9570. "\\}[ \t]")))
  9571. ((eq (car desc) :maxlevel)
  9572. (setq fast-path-p t)
  9573. (setq descre (concat "^\\*\\{1," (number-to-string
  9574. (if org-odd-levels-only
  9575. (1- (* 2 (cdr desc)))
  9576. (cdr desc)))
  9577. "\\}[ \t]")))
  9578. (t (error "Bad refiling target description %s" desc)))
  9579. (while (setq f (pop files))
  9580. (with-current-buffer
  9581. (if (bufferp f) f (org-get-agenda-file-buffer f))
  9582. (or
  9583. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  9584. (progn
  9585. (if (bufferp f) (setq f (buffer-file-name
  9586. (buffer-base-buffer f))))
  9587. (setq f (and f (expand-file-name f)))
  9588. (if (eq org-refile-use-outline-path 'file)
  9589. (push (list (file-name-nondirectory f) f nil nil) tgs))
  9590. (save-excursion
  9591. (save-restriction
  9592. (widen)
  9593. (goto-char (point-min))
  9594. (while (re-search-forward descre nil t)
  9595. (goto-char (setq pos0 (point-at-bol)))
  9596. (catch 'next
  9597. (when org-refile-target-verify-function
  9598. (save-match-data
  9599. (or (funcall org-refile-target-verify-function)
  9600. (throw 'next t))))
  9601. (when (and (looking-at org-complex-heading-regexp)
  9602. (not (member (match-string 4) excluded-entries))
  9603. (match-string 4))
  9604. (setq level (org-reduced-level
  9605. (- (match-end 1) (match-beginning 1)))
  9606. txt (org-link-display-format (match-string 4))
  9607. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  9608. re (format org-complex-heading-regexp-format
  9609. (regexp-quote (match-string 4))))
  9610. (when org-refile-use-outline-path
  9611. (setq txt (mapconcat
  9612. 'org-protect-slash
  9613. (append
  9614. (if (eq org-refile-use-outline-path
  9615. 'file)
  9616. (list (file-name-nondirectory
  9617. (buffer-file-name
  9618. (buffer-base-buffer))))
  9619. (if (eq org-refile-use-outline-path
  9620. 'full-file-path)
  9621. (list (buffer-file-name
  9622. (buffer-base-buffer)))))
  9623. (org-get-outline-path fast-path-p
  9624. level txt)
  9625. (list txt))
  9626. "/")))
  9627. (push (list txt f re (org-refile-marker (point)))
  9628. tgs)))
  9629. (when (= (point) pos0)
  9630. ;; verification function has not moved point
  9631. (goto-char (point-at-eol))))))))
  9632. (when org-refile-use-cache
  9633. (org-refile-cache-put tgs (buffer-file-name) descre))
  9634. (setq targets (append tgs targets))
  9635. ))))
  9636. (message "Getting targets...done")
  9637. (nreverse targets)))
  9638. (defun org-protect-slash (s)
  9639. (while (string-match "/" s)
  9640. (setq s (replace-match "\\" t t s)))
  9641. s)
  9642. (defvar org-olpa (make-vector 20 nil))
  9643. (defun org-get-outline-path (&optional fastp level heading)
  9644. "Return the outline path to the current entry, as a list.
  9645. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  9646. routine which makes outline path derivations for an entire file,
  9647. avoiding backtracing. Refile target collection makes use of that."
  9648. (if fastp
  9649. (progn
  9650. (if (> level 19)
  9651. (error "Outline path failure, more than 19 levels"))
  9652. (loop for i from level upto 19 do
  9653. (aset org-olpa i nil))
  9654. (prog1
  9655. (delq nil (append org-olpa nil))
  9656. (aset org-olpa level heading)))
  9657. (let (rtn case-fold-search)
  9658. (save-excursion
  9659. (save-restriction
  9660. (widen)
  9661. (while (org-up-heading-safe)
  9662. (when (looking-at org-complex-heading-regexp)
  9663. (push (org-match-string-no-properties 4) rtn)))
  9664. rtn)))))
  9665. (defun org-format-outline-path (path &optional width prefix separator)
  9666. "Format the outline path PATH for display.
  9667. WIDTH is the maximum number of characters that is available.
  9668. PREFIX is a prefix to be included in the returned string,
  9669. such as the file name.
  9670. SEPARATOR is inserted between the different parts of the path,
  9671. the default is \"/\"."
  9672. (setq width (or width 79))
  9673. (if prefix (setq width (- width (length prefix))))
  9674. (if (not path)
  9675. (or prefix "")
  9676. (let* ((nsteps (length path))
  9677. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  9678. (maxwidth (if (<= total-width width)
  9679. 10000 ;; everything fits
  9680. ;; we need to shorten the level headings
  9681. (/ (- width nsteps) nsteps)))
  9682. (org-odd-levels-only nil)
  9683. (n 0)
  9684. (total (1+ (length prefix))))
  9685. (setq maxwidth (max maxwidth 10))
  9686. (concat prefix
  9687. (if prefix (or separator "/"))
  9688. (mapconcat
  9689. (lambda (h)
  9690. (setq n (1+ n))
  9691. (if (and (= n nsteps) (< maxwidth 10000))
  9692. (setq maxwidth (- total-width total)))
  9693. (if (< (length h) maxwidth)
  9694. (progn (setq total (+ total (length h) 1)) h)
  9695. (setq h (substring h 0 (- maxwidth 2))
  9696. total (+ total maxwidth 1))
  9697. (if (string-match "[ \t]+\\'" h)
  9698. (setq h (substring h 0 (match-beginning 0))))
  9699. (setq h (concat h "..")))
  9700. (org-add-props h nil 'face
  9701. (nth (% (1- n) org-n-level-faces)
  9702. org-level-faces))
  9703. h)
  9704. path (or separator "/"))))))
  9705. (defun org-display-outline-path (&optional file current separator just-return-string)
  9706. "Display the current outline path in the echo area.
  9707. If FILE is non-nil, prepend the output with the file name.
  9708. If CURRENT is non-nil, append the current heading to the output.
  9709. SEPARATOR is passed through to `org-format-outline-path'. It separates
  9710. the different parts of the path and defaults to \"/\".
  9711. If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
  9712. (interactive "P")
  9713. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  9714. (case-fold-search nil)
  9715. (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
  9716. res)
  9717. (if current (setq path (append path
  9718. (save-excursion
  9719. (org-back-to-heading t)
  9720. (if (looking-at org-complex-heading-regexp)
  9721. (list (match-string 4)))))))
  9722. (setq res
  9723. (org-format-outline-path
  9724. path
  9725. (1- (frame-width))
  9726. (and file bfn (concat (file-name-nondirectory bfn) separator))
  9727. separator))
  9728. (if just-return-string
  9729. (org-no-properties res)
  9730. (message "%s" res))))
  9731. (defvar org-refile-history nil
  9732. "History for refiling operations.")
  9733. (defvar org-after-refile-insert-hook nil
  9734. "Hook run after `org-refile' has inserted its stuff at the new location.
  9735. Note that this is still *before* the stuff will be removed from
  9736. the *old* location.")
  9737. (defvar org-capture-last-stored-marker)
  9738. (defvar org-refile-keep nil
  9739. "Non-nil means `org-refile' will copy instead of refile.")
  9740. (defun org-copy ()
  9741. "Like `org-refile', but copy."
  9742. (interactive)
  9743. (let ((org-refile-keep t))
  9744. (funcall 'org-refile nil nil nil "Copy")))
  9745. (defun org-refile (&optional goto default-buffer rfloc msg)
  9746. "Move the entry or entries at point to another heading.
  9747. The list of target headings is compiled using the information in
  9748. `org-refile-targets', which see.
  9749. At the target location, the entry is filed as a subitem of the target
  9750. heading. Depending on `org-reverse-note-order', the new subitem will
  9751. either be the first or the last subitem.
  9752. If there is an active region, all entries in that region will be moved.
  9753. However, the region must fulfill the requirement that the first heading
  9754. is the first one sets the top-level of the moved text - at most siblings
  9755. below it are allowed.
  9756. With prefix arg GOTO, the command will only visit the target location
  9757. and not actually move anything.
  9758. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  9759. go to the location where the last refiling operation has put the subtree.
  9760. With a prefix argument of `2', refile to the running clock.
  9761. RFLOC can be a refile location obtained in a different way.
  9762. MSG is a string to replace \"Refile\" in the default prompt with
  9763. another verb. E.g. `org-copy' sets this parameter to \"Copy\".
  9764. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  9765. If you are using target caching (see `org-refile-use-cache'),
  9766. you have to clear the target cache in order to find new targets.
  9767. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  9768. prefix argument (`C-u C-u C-u C-c C-w')."
  9769. (interactive "P")
  9770. (if (member goto '(0 (64)))
  9771. (org-refile-cache-clear)
  9772. (let* ((actionmsg (or msg "Refile"))
  9773. (cbuf (current-buffer))
  9774. (regionp (org-region-active-p))
  9775. (region-start (and regionp (region-beginning)))
  9776. (region-end (and regionp (region-end)))
  9777. (region-length (and regionp (- region-end region-start)))
  9778. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9779. pos it nbuf file re level reversed)
  9780. (setq last-command nil)
  9781. (when regionp
  9782. (goto-char region-start)
  9783. (or (bolp) (goto-char (point-at-bol)))
  9784. (setq region-start (point))
  9785. (unless (or (org-kill-is-subtree-p
  9786. (buffer-substring region-start region-end))
  9787. (prog1 org-refile-active-region-within-subtree
  9788. (org-toggle-heading)))
  9789. (error "The region is not a (sequence of) subtree(s)")))
  9790. (if (equal goto '(16))
  9791. (org-refile-goto-last-stored)
  9792. (when (or
  9793. (and (equal goto 2)
  9794. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9795. (prog1
  9796. (setq it (list (or org-clock-heading "running clock")
  9797. (buffer-file-name
  9798. (marker-buffer org-clock-hd-marker))
  9799. ""
  9800. (marker-position org-clock-hd-marker)))
  9801. (setq goto nil)))
  9802. (setq it (or rfloc
  9803. (let (heading-text)
  9804. (save-excursion
  9805. (unless goto
  9806. (org-back-to-heading t)
  9807. (setq heading-text
  9808. (nth 4 (org-heading-components))))
  9809. (org-refile-get-location
  9810. (cond (goto "Goto")
  9811. (regionp (concat actionmsg " region to"))
  9812. (t (concat actionmsg " subtree \""
  9813. heading-text "\" to")))
  9814. default-buffer
  9815. (and (not (equal '(4) goto))
  9816. org-refile-allow-creating-parent-nodes)
  9817. goto))))))
  9818. (setq file (nth 1 it)
  9819. re (nth 2 it)
  9820. pos (nth 3 it))
  9821. (if (and (not goto)
  9822. pos
  9823. (equal (buffer-file-name) file)
  9824. (if regionp
  9825. (and (>= pos region-start)
  9826. (<= pos region-end))
  9827. (and (>= pos (point))
  9828. (< pos (save-excursion
  9829. (org-end-of-subtree t t))))))
  9830. (error "Cannot refile to position inside the tree or region"))
  9831. (setq nbuf (or (find-buffer-visiting file)
  9832. (find-file-noselect file)))
  9833. (if goto
  9834. (progn
  9835. (org-pop-to-buffer-same-window nbuf)
  9836. (goto-char pos)
  9837. (org-show-context 'org-goto))
  9838. (if regionp
  9839. (progn
  9840. (org-kill-new (buffer-substring region-start region-end))
  9841. (org-save-markers-in-region region-start region-end))
  9842. (org-copy-subtree 1 nil t))
  9843. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9844. (find-file-noselect file)))
  9845. (setq reversed (org-notes-order-reversed-p))
  9846. (save-excursion
  9847. (save-restriction
  9848. (widen)
  9849. (if pos
  9850. (progn
  9851. (goto-char pos)
  9852. (looking-at org-outline-regexp)
  9853. (setq level (org-get-valid-level (funcall outline-level) 1))
  9854. (goto-char
  9855. (if reversed
  9856. (or (outline-next-heading) (point-max))
  9857. (or (save-excursion (org-get-next-sibling))
  9858. (org-end-of-subtree t t)
  9859. (point-max)))))
  9860. (setq level 1)
  9861. (if (not reversed)
  9862. (goto-char (point-max))
  9863. (goto-char (point-min))
  9864. (or (outline-next-heading) (goto-char (point-max)))))
  9865. (if (not (bolp)) (newline))
  9866. (org-paste-subtree level)
  9867. (when org-log-refile
  9868. (org-add-log-setup 'refile nil nil 'findpos
  9869. org-log-refile)
  9870. (unless (eq org-log-refile 'note)
  9871. (save-excursion (org-add-log-note))))
  9872. (and org-auto-align-tags
  9873. (let ((org-loop-over-headlines-in-active-region nil))
  9874. (org-set-tags nil t)))
  9875. (bookmark-set "org-refile-last-stored")
  9876. ;; If we are refiling for capture, make sure that the
  9877. ;; last-capture pointers point here
  9878. (when (org-bound-and-true-p org-refile-for-capture)
  9879. (bookmark-set "org-capture-last-stored-marker")
  9880. (move-marker org-capture-last-stored-marker (point)))
  9881. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9882. (run-hooks 'org-after-refile-insert-hook))))
  9883. (unless org-refile-keep
  9884. (if regionp
  9885. (delete-region (point) (+ (point) region-length))
  9886. (org-cut-subtree)))
  9887. (when (featurep 'org-inlinetask)
  9888. (org-inlinetask-remove-END-maybe))
  9889. (setq org-markers-to-move nil)
  9890. (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
  9891. (defun org-refile-goto-last-stored ()
  9892. "Go to the location where the last refile was stored."
  9893. (interactive)
  9894. (bookmark-jump "org-refile-last-stored")
  9895. (message "This is the location of the last refile"))
  9896. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  9897. no-exclude)
  9898. "Prompt the user for a refile location, using PROMPT.
  9899. PROMPT should not be suffixed with a colon and a space, because
  9900. this function appends the default value from
  9901. `org-refile-history' automatically, if that is not empty.
  9902. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  9903. this is used for the GOTO interface."
  9904. (let ((org-refile-targets org-refile-targets)
  9905. (org-refile-use-outline-path org-refile-use-outline-path)
  9906. excluded-entries)
  9907. (when (and (derived-mode-p 'org-mode)
  9908. (not org-refile-use-cache)
  9909. (not no-exclude))
  9910. (org-map-tree
  9911. (lambda()
  9912. (setq excluded-entries
  9913. (append excluded-entries (list (org-get-heading t t)))))))
  9914. (setq org-refile-target-table
  9915. (org-refile-get-targets default-buffer excluded-entries)))
  9916. (unless org-refile-target-table
  9917. (error "No refile targets"))
  9918. (let* ((cbuf (current-buffer))
  9919. (partial-completion-mode nil)
  9920. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  9921. (cfunc (if (and org-refile-use-outline-path
  9922. org-outline-path-complete-in-steps)
  9923. 'org-olpath-completing-read
  9924. 'org-icompleting-read))
  9925. (extra (if org-refile-use-outline-path "/" ""))
  9926. (cbnex (concat (buffer-name) extra))
  9927. (filename (and cfn (expand-file-name cfn)))
  9928. (tbl (mapcar
  9929. (lambda (x)
  9930. (if (and (not (member org-refile-use-outline-path
  9931. '(file full-file-path)))
  9932. (not (equal filename (nth 1 x))))
  9933. (cons (concat (car x) extra " ("
  9934. (file-name-nondirectory (nth 1 x)) ")")
  9935. (cdr x))
  9936. (cons (concat (car x) extra) (cdr x))))
  9937. org-refile-target-table))
  9938. (completion-ignore-case t)
  9939. cdef
  9940. (prompt (concat prompt
  9941. (or (and (car org-refile-history)
  9942. (concat " (default " (car org-refile-history) ")"))
  9943. (and (assoc cbnex tbl) (setq cdef cbnex)
  9944. (concat " (default " cbnex ")"))) ": "))
  9945. pa answ parent-target child parent old-hist)
  9946. (setq old-hist org-refile-history)
  9947. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  9948. nil 'org-refile-history (or cdef (car org-refile-history))))
  9949. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  9950. (org-refile-check-position pa)
  9951. (if pa
  9952. (progn
  9953. (when (or (not org-refile-history)
  9954. (not (eq old-hist org-refile-history))
  9955. (not (equal (car pa) (car org-refile-history))))
  9956. (setq org-refile-history
  9957. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  9958. org-refile-history
  9959. (cdr org-refile-history))))
  9960. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  9961. (pop org-refile-history)))
  9962. pa)
  9963. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  9964. (progn
  9965. (setq parent (match-string 1 answ)
  9966. child (match-string 2 answ))
  9967. (setq parent-target (or (assoc parent tbl)
  9968. (assoc (concat parent "/") tbl)))
  9969. (when (and parent-target
  9970. (or (eq new-nodes t)
  9971. (and (eq new-nodes 'confirm)
  9972. (y-or-n-p (format "Create new node \"%s\"? "
  9973. child)))))
  9974. (org-refile-new-child parent-target child)))
  9975. (error "Invalid target location")))))
  9976. (declare-function org-string-nw-p "org-macs.el" (s))
  9977. (defun org-refile-check-position (refile-pointer)
  9978. "Check if the refile pointer matches the readline to which it points."
  9979. (let* ((file (nth 1 refile-pointer))
  9980. (re (nth 2 refile-pointer))
  9981. (pos (nth 3 refile-pointer))
  9982. buffer)
  9983. (when (org-string-nw-p re)
  9984. (setq buffer (if (markerp pos)
  9985. (marker-buffer pos)
  9986. (or (find-buffer-visiting file)
  9987. (find-file-noselect file))))
  9988. (with-current-buffer buffer
  9989. (save-excursion
  9990. (save-restriction
  9991. (widen)
  9992. (goto-char pos)
  9993. (beginning-of-line 1)
  9994. (unless (org-looking-at-p re)
  9995. (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  9996. (defun org-refile-new-child (parent-target child)
  9997. "Use refile target PARENT-TARGET to add new CHILD below it."
  9998. (unless parent-target
  9999. (error "Cannot find parent for new node"))
  10000. (let ((file (nth 1 parent-target))
  10001. (pos (nth 3 parent-target))
  10002. level)
  10003. (with-current-buffer (or (find-buffer-visiting file)
  10004. (find-file-noselect file))
  10005. (save-excursion
  10006. (save-restriction
  10007. (widen)
  10008. (if pos
  10009. (goto-char pos)
  10010. (goto-char (point-max))
  10011. (if (not (bolp)) (newline)))
  10012. (when (looking-at org-outline-regexp)
  10013. (setq level (funcall outline-level))
  10014. (org-end-of-subtree t t))
  10015. (org-back-over-empty-lines)
  10016. (insert "\n" (make-string
  10017. (if pos (org-get-valid-level level 1) 1) ?*)
  10018. " " child "\n")
  10019. (beginning-of-line 0)
  10020. (list (concat (car parent-target) "/" child) file "" (point)))))))
  10021. (defun org-olpath-completing-read (prompt collection &rest args)
  10022. "Read an outline path like a file name."
  10023. (let ((thetable collection)
  10024. (org-completion-use-ido nil) ; does not work with ido.
  10025. (org-completion-use-iswitchb nil)) ; or iswitchb
  10026. (apply
  10027. 'org-icompleting-read prompt
  10028. (lambda (string predicate &optional flag)
  10029. (let (rtn r f (l (length string)))
  10030. (cond
  10031. ((eq flag nil)
  10032. ;; try completion
  10033. (try-completion string thetable))
  10034. ((eq flag t)
  10035. ;; all-completions
  10036. (setq rtn (all-completions string thetable predicate))
  10037. (mapcar
  10038. (lambda (x)
  10039. (setq r (substring x l))
  10040. (if (string-match " ([^)]*)$" x)
  10041. (setq f (match-string 0 x))
  10042. (setq f ""))
  10043. (if (string-match "/" r)
  10044. (concat string (substring r 0 (match-end 0)) f)
  10045. x))
  10046. rtn))
  10047. ((eq flag 'lambda)
  10048. ;; exact match?
  10049. (assoc string thetable)))))
  10050. args)))
  10051. ;;;; Dynamic blocks
  10052. (defun org-find-dblock (name)
  10053. "Find the first dynamic block with name NAME in the buffer.
  10054. If not found, stay at current position and return nil."
  10055. (let ((case-fold-search t) pos)
  10056. (save-excursion
  10057. (goto-char (point-min))
  10058. (setq pos (and (re-search-forward
  10059. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10060. (match-beginning 0))))
  10061. (if pos (goto-char pos))
  10062. pos))
  10063. (defconst org-dblock-start-re
  10064. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  10065. "Matches the start line of a dynamic block, with parameters.")
  10066. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  10067. "Matches the end of a dynamic block.")
  10068. (defun org-create-dblock (plist)
  10069. "Create a dynamic block section, with parameters taken from PLIST.
  10070. PLIST must contain a :name entry which is used as name of the block."
  10071. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10072. (end-of-line 1)
  10073. (newline))
  10074. (let ((col (current-column))
  10075. (name (plist-get plist :name)))
  10076. (insert "#+BEGIN: " name)
  10077. (while plist
  10078. (if (eq (car plist) :name)
  10079. (setq plist (cddr plist))
  10080. (insert " " (prin1-to-string (pop plist)))))
  10081. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10082. (beginning-of-line -2)))
  10083. (defun org-prepare-dblock ()
  10084. "Prepare dynamic block for refresh.
  10085. This empties the block, puts the cursor at the insert position and returns
  10086. the property list including an extra property :name with the block name."
  10087. (unless (looking-at org-dblock-start-re)
  10088. (error "Not at a dynamic block"))
  10089. (let* ((begdel (1+ (match-end 0)))
  10090. (name (org-no-properties (match-string 1)))
  10091. (params (append (list :name name)
  10092. (read (concat "(" (match-string 3) ")")))))
  10093. (save-excursion
  10094. (beginning-of-line 1)
  10095. (skip-chars-forward " \t")
  10096. (setq params (plist-put params :indentation-column (current-column))))
  10097. (unless (re-search-forward org-dblock-end-re nil t)
  10098. (error "Dynamic block not terminated"))
  10099. (setq params
  10100. (append params
  10101. (list :content (buffer-substring
  10102. begdel (match-beginning 0)))))
  10103. (delete-region begdel (match-beginning 0))
  10104. (goto-char begdel)
  10105. (open-line 1)
  10106. params))
  10107. (defun org-map-dblocks (&optional command)
  10108. "Apply COMMAND to all dynamic blocks in the current buffer.
  10109. If COMMAND is not given, use `org-update-dblock'."
  10110. (let ((cmd (or command 'org-update-dblock)))
  10111. (save-excursion
  10112. (goto-char (point-min))
  10113. (while (re-search-forward org-dblock-start-re nil t)
  10114. (goto-char (match-beginning 0))
  10115. (save-excursion
  10116. (condition-case nil
  10117. (funcall cmd)
  10118. (error (message "Error during update of dynamic block"))))
  10119. (unless (re-search-forward org-dblock-end-re nil t)
  10120. (error "Dynamic block not terminated"))))))
  10121. (defun org-dblock-update (&optional arg)
  10122. "User command for updating dynamic blocks.
  10123. Update the dynamic block at point. With prefix ARG, update all dynamic
  10124. blocks in the buffer."
  10125. (interactive "P")
  10126. (if arg
  10127. (org-update-all-dblocks)
  10128. (or (looking-at org-dblock-start-re)
  10129. (org-beginning-of-dblock))
  10130. (org-update-dblock)))
  10131. (defun org-update-dblock ()
  10132. "Update the dynamic block at point.
  10133. This means to empty the block, parse for parameters and then call
  10134. the correct writing function."
  10135. (interactive)
  10136. (save-window-excursion
  10137. (let* ((pos (point))
  10138. (line (org-current-line))
  10139. (params (org-prepare-dblock))
  10140. (name (plist-get params :name))
  10141. (indent (plist-get params :indentation-column))
  10142. (cmd (intern (concat "org-dblock-write:" name))))
  10143. (message "Updating dynamic block `%s' at line %d..." name line)
  10144. (funcall cmd params)
  10145. (message "Updating dynamic block `%s' at line %d...done" name line)
  10146. (goto-char pos)
  10147. (when (and indent (> indent 0))
  10148. (setq indent (make-string indent ?\ ))
  10149. (save-excursion
  10150. (org-beginning-of-dblock)
  10151. (forward-line 1)
  10152. (while (not (looking-at org-dblock-end-re))
  10153. (insert indent)
  10154. (beginning-of-line 2))
  10155. (when (looking-at org-dblock-end-re)
  10156. (and (looking-at "[ \t]+")
  10157. (replace-match ""))
  10158. (insert indent)))))))
  10159. (defun org-beginning-of-dblock ()
  10160. "Find the beginning of the dynamic block at point.
  10161. Error if there is no such block at point."
  10162. (let ((pos (point))
  10163. beg)
  10164. (end-of-line 1)
  10165. (if (and (re-search-backward org-dblock-start-re nil t)
  10166. (setq beg (match-beginning 0))
  10167. (re-search-forward org-dblock-end-re nil t)
  10168. (> (match-end 0) pos))
  10169. (goto-char beg)
  10170. (goto-char pos)
  10171. (error "Not in a dynamic block"))))
  10172. (defun org-update-all-dblocks ()
  10173. "Update all dynamic blocks in the buffer.
  10174. This function can be used in a hook."
  10175. (interactive)
  10176. (when (derived-mode-p 'org-mode)
  10177. (org-map-dblocks 'org-update-dblock)))
  10178. ;;;; Completion
  10179. (defconst org-additional-option-like-keywords
  10180. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
  10181. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
  10182. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  10183. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
  10184. "BEGIN:" "END:"
  10185. "ORGTBL" "TBLFM:" "TBLNAME:"
  10186. "BEGIN_EXAMPLE" "END_EXAMPLE"
  10187. "BEGIN_VERBATIM" "END_VERBATIM"
  10188. "BEGIN_QUOTE" "END_QUOTE"
  10189. "BEGIN_VERSE" "END_VERSE"
  10190. "BEGIN_CENTER" "END_CENTER"
  10191. "BEGIN_SRC" "END_SRC"
  10192. "BEGIN_RESULT" "END_RESULT"
  10193. "BEGIN_lstlisting" "END_lstlisting"
  10194. "NAME:" "RESULTS:"
  10195. "HEADER:" "HEADERS:"
  10196. "COLUMNS:" "PROPERTY:"
  10197. "CAPTION:" "LABEL:"
  10198. "SETUPFILE:"
  10199. "INCLUDE:"
  10200. "BIND:"
  10201. "MACRO:"))
  10202. (defconst org-options-keywords
  10203. '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
  10204. "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
  10205. "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
  10206. "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
  10207. "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
  10208. "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:" "STYLE:"
  10209. "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
  10210. (defconst org-additional-option-like-keywords-for-flyspell
  10211. (delete-dups
  10212. (split-string
  10213. (mapconcat (lambda(k)
  10214. (replace-regexp-in-string
  10215. "_\\|:" " "
  10216. (concat k " " (downcase k) " " (upcase k))))
  10217. (append org-options-keywords org-additional-option-like-keywords)
  10218. " ")
  10219. " +" t)))
  10220. (defcustom org-structure-template-alist
  10221. '(
  10222. ("s" "#+BEGIN_SRC ?\n\n#+END_SRC"
  10223. "<src lang=\"?\">\n\n</src>")
  10224. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE"
  10225. "<example>\n?\n</example>")
  10226. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE"
  10227. "<quote>\n?\n</quote>")
  10228. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE"
  10229. "<verse>\n?\n</verse>")
  10230. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER"
  10231. "<center>\n?\n</center>")
  10232. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10233. "<literal style=\"latex\">\n?\n</literal>")
  10234. ("L" "#+LaTeX: "
  10235. "<literal style=\"latex\">?</literal>")
  10236. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10237. "<literal style=\"html\">\n?\n</literal>")
  10238. ("H" "#+HTML: "
  10239. "<literal style=\"html\">?</literal>")
  10240. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
  10241. ("A" "#+ASCII: ")
  10242. ("i" "#+INDEX: ?"
  10243. "#+INDEX: ?")
  10244. ("I" "#+INCLUDE: %file ?"
  10245. "<include file=%file markup=\"?\">")
  10246. )
  10247. "Structure completion elements.
  10248. This is a list of abbreviation keys and values. The value gets inserted
  10249. if you type `<' followed by the key and then press the completion key,
  10250. usually `M-TAB'. %file will be replaced by a file name after prompting
  10251. for the file using completion. The cursor will be placed at the position
  10252. of the `?` in the template.
  10253. There are two templates for each key, the first uses the original Org syntax,
  10254. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10255. the default when the /org-mtags.el/ module has been loaded. See also the
  10256. variable `org-mtags-prefer-muse-templates'."
  10257. :group 'org-completion
  10258. :type '(repeat
  10259. (string :tag "Key")
  10260. (string :tag "Template")
  10261. (string :tag "Muse Template")))
  10262. (defun org-try-structure-completion ()
  10263. "Try to complete a structure template before point.
  10264. This looks for strings like \"<e\" on an otherwise empty line and
  10265. expands them."
  10266. (let ((l (buffer-substring (point-at-bol) (point)))
  10267. a)
  10268. (when (and (looking-at "[ \t]*$")
  10269. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10270. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10271. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10272. (match-beginning 1)) a)
  10273. t)))
  10274. (defun org-complete-expand-structure-template (start cell)
  10275. "Expand a structure template."
  10276. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10277. (rpl (nth (if musep 2 1) cell))
  10278. (ind ""))
  10279. (delete-region start (point))
  10280. (when (string-match "\\`#\\+" rpl)
  10281. (cond
  10282. ((bolp))
  10283. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10284. (setq ind (buffer-substring (point-at-bol) (point))))
  10285. (t (newline))))
  10286. (setq start (point))
  10287. (if (string-match "%file" rpl)
  10288. (setq rpl (replace-match
  10289. (concat
  10290. "\""
  10291. (save-match-data
  10292. (abbreviate-file-name (read-file-name "Include file: ")))
  10293. "\"")
  10294. t t rpl)))
  10295. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10296. (concat "\n" ind)))
  10297. (insert rpl)
  10298. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10299. ;;;; TODO, DEADLINE, Comments
  10300. (defun org-toggle-comment ()
  10301. "Change the COMMENT state of an entry."
  10302. (interactive)
  10303. (save-excursion
  10304. (org-back-to-heading)
  10305. (let (case-fold-search)
  10306. (cond
  10307. ((looking-at (format org-heading-keyword-regexp-format
  10308. org-comment-string))
  10309. (goto-char (match-end 1))
  10310. (looking-at (concat " +" org-comment-string))
  10311. (replace-match "" t t)
  10312. (when (eolp) (insert " ")))
  10313. ((looking-at org-outline-regexp)
  10314. (goto-char (match-end 0))
  10315. (insert org-comment-string " "))))))
  10316. (defvar org-last-todo-state-is-todo nil
  10317. "This is non-nil when the last TODO state change led to a TODO state.
  10318. If the last change removed the TODO tag or switched to DONE, then
  10319. this is nil.")
  10320. (defvar org-setting-tags nil) ; dynamically skipped
  10321. (defvar org-todo-setup-filter-hook nil
  10322. "Hook for functions that pre-filter todo specs.
  10323. Each function takes a todo spec and returns either nil or the spec
  10324. transformed into canonical form." )
  10325. (defvar org-todo-get-default-hook nil
  10326. "Hook for functions that get a default item for todo.
  10327. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10328. nil or a string to be used for the todo mark." )
  10329. (defvar org-agenda-headline-snapshot-before-repeat)
  10330. (defun org-current-effective-time ()
  10331. "Return current time adjusted for `org-extend-today-until' variable."
  10332. (let* ((ct (org-current-time))
  10333. (dct (decode-time ct))
  10334. (ct1
  10335. (cond
  10336. (org-use-last-clock-out-time-as-effective-time
  10337. (or (org-clock-get-last-clock-out-time) ct))
  10338. ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
  10339. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
  10340. (t ct))))
  10341. ct1))
  10342. (defun org-todo-yesterday (&optional arg)
  10343. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10344. (interactive "P")
  10345. (if (eq major-mode 'org-agenda-mode)
  10346. (apply 'org-agenda-todo-yesterday arg)
  10347. (let* ((hour (third (decode-time
  10348. (org-current-time))))
  10349. (org-extend-today-until (1+ hour)))
  10350. (org-todo arg))))
  10351. (defun org-todo (&optional arg)
  10352. "Change the TODO state of an item.
  10353. The state of an item is given by a keyword at the start of the heading,
  10354. like
  10355. *** TODO Write paper
  10356. *** DONE Call mom
  10357. The different keywords are specified in the variable `org-todo-keywords'.
  10358. By default the available states are \"TODO\" and \"DONE\".
  10359. So for this example: when the item starts with TODO, it is changed to DONE.
  10360. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10361. DONE are present, add TODO at the beginning of the heading.
  10362. With \\[universal-argument] prefix arg, use completion to determine the new \
  10363. state.
  10364. With numeric prefix arg, switch to that state.
  10365. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10366. keywords (nextset).
  10367. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10368. With a numeric prefix arg of 0, inhibit note taking for the change.
  10369. For calling through lisp, arg is also interpreted in the following way:
  10370. 'none -> empty state
  10371. \"\"(empty string) -> switch to empty state
  10372. 'done -> switch to DONE
  10373. 'nextset -> switch to the next set of keywords
  10374. 'previousset -> switch to the previous set of keywords
  10375. \"WAITING\" -> switch to the specified keyword, but only if it
  10376. really is a member of `org-todo-keywords'."
  10377. (interactive "P")
  10378. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10379. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10380. 'region-start-level 'region))
  10381. org-loop-over-headlines-in-active-region)
  10382. (org-map-entries
  10383. `(org-todo ,arg)
  10384. org-loop-over-headlines-in-active-region
  10385. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  10386. (if (equal arg '(16)) (setq arg 'nextset))
  10387. (let ((org-blocker-hook org-blocker-hook)
  10388. (case-fold-search nil))
  10389. (when (equal arg '(64))
  10390. (setq arg nil org-blocker-hook nil))
  10391. (when (and org-blocker-hook
  10392. (or org-inhibit-blocking
  10393. (org-entry-get nil "NOBLOCKING")))
  10394. (setq org-blocker-hook nil))
  10395. (save-excursion
  10396. (catch 'exit
  10397. (org-back-to-heading t)
  10398. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  10399. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  10400. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  10401. (let* ((match-data (match-data))
  10402. (startpos (point-at-bol))
  10403. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  10404. (org-log-done org-log-done)
  10405. (org-log-repeat org-log-repeat)
  10406. (org-todo-log-states org-todo-log-states)
  10407. (org-inhibit-logging
  10408. (if (equal arg 0)
  10409. (progn (setq arg nil) 'note) org-inhibit-logging))
  10410. (this (match-string 1))
  10411. (hl-pos (match-beginning 0))
  10412. (head (org-get-todo-sequence-head this))
  10413. (ass (assoc head org-todo-kwd-alist))
  10414. (interpret (nth 1 ass))
  10415. (done-word (nth 3 ass))
  10416. (final-done-word (nth 4 ass))
  10417. (org-last-state (or this ""))
  10418. (completion-ignore-case t)
  10419. (member (member this org-todo-keywords-1))
  10420. (tail (cdr member))
  10421. (org-state (cond
  10422. ((and org-todo-key-trigger
  10423. (or (and (equal arg '(4))
  10424. (eq org-use-fast-todo-selection 'prefix))
  10425. (and (not arg) org-use-fast-todo-selection
  10426. (not (eq org-use-fast-todo-selection
  10427. 'prefix)))))
  10428. ;; Use fast selection
  10429. (org-fast-todo-selection))
  10430. ((and (equal arg '(4))
  10431. (or (not org-use-fast-todo-selection)
  10432. (not org-todo-key-trigger)))
  10433. ;; Read a state with completion
  10434. (org-icompleting-read
  10435. "State: " (mapcar (lambda(x) (list x))
  10436. org-todo-keywords-1)
  10437. nil t))
  10438. ((eq arg 'right)
  10439. (if this
  10440. (if tail (car tail) nil)
  10441. (car org-todo-keywords-1)))
  10442. ((eq arg 'left)
  10443. (if (equal member org-todo-keywords-1)
  10444. nil
  10445. (if this
  10446. (nth (- (length org-todo-keywords-1)
  10447. (length tail) 2)
  10448. org-todo-keywords-1)
  10449. (org-last org-todo-keywords-1))))
  10450. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  10451. (setq arg nil))) ; hack to fall back to cycling
  10452. (arg
  10453. ;; user or caller requests a specific state
  10454. (cond
  10455. ((equal arg "") nil)
  10456. ((eq arg 'none) nil)
  10457. ((eq arg 'done) (or done-word (car org-done-keywords)))
  10458. ((eq arg 'nextset)
  10459. (or (car (cdr (member head org-todo-heads)))
  10460. (car org-todo-heads)))
  10461. ((eq arg 'previousset)
  10462. (let ((org-todo-heads (reverse org-todo-heads)))
  10463. (or (car (cdr (member head org-todo-heads)))
  10464. (car org-todo-heads))))
  10465. ((car (member arg org-todo-keywords-1)))
  10466. ((stringp arg)
  10467. (error "State `%s' not valid in this file" arg))
  10468. ((nth (1- (prefix-numeric-value arg))
  10469. org-todo-keywords-1))))
  10470. ((null member) (or head (car org-todo-keywords-1)))
  10471. ((equal this final-done-word) nil) ;; -> make empty
  10472. ((null tail) nil) ;; -> first entry
  10473. ((memq interpret '(type priority))
  10474. (if (eq this-command last-command)
  10475. (car tail)
  10476. (if (> (length tail) 0)
  10477. (or done-word (car org-done-keywords))
  10478. nil)))
  10479. (t
  10480. (car tail))))
  10481. (org-state (or
  10482. (run-hook-with-args-until-success
  10483. 'org-todo-get-default-hook org-state org-last-state)
  10484. org-state))
  10485. (next (if org-state (concat " " org-state " ") " "))
  10486. (change-plist (list :type 'todo-state-change :from this :to org-state
  10487. :position startpos))
  10488. dolog now-done-p)
  10489. (when org-blocker-hook
  10490. (setq org-last-todo-state-is-todo
  10491. (not (member this org-done-keywords)))
  10492. (unless (save-excursion
  10493. (save-match-data
  10494. (org-with-wide-buffer
  10495. (run-hook-with-args-until-failure
  10496. 'org-blocker-hook change-plist))))
  10497. (if (org-called-interactively-p 'interactive)
  10498. (error "TODO state change from %s to %s blocked" this org-state)
  10499. ;; fail silently
  10500. (message "TODO state change from %s to %s blocked" this org-state)
  10501. (throw 'exit nil))))
  10502. (store-match-data match-data)
  10503. (replace-match next t t)
  10504. (unless (pos-visible-in-window-p hl-pos)
  10505. (message "TODO state changed to %s" (org-trim next)))
  10506. (unless head
  10507. (setq head (org-get-todo-sequence-head org-state)
  10508. ass (assoc head org-todo-kwd-alist)
  10509. interpret (nth 1 ass)
  10510. done-word (nth 3 ass)
  10511. final-done-word (nth 4 ass)))
  10512. (when (memq arg '(nextset previousset))
  10513. (message "Keyword-Set %d/%d: %s"
  10514. (- (length org-todo-sets) -1
  10515. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  10516. (length org-todo-sets)
  10517. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  10518. (setq org-last-todo-state-is-todo
  10519. (not (member org-state org-done-keywords)))
  10520. (setq now-done-p (and (member org-state org-done-keywords)
  10521. (not (member this org-done-keywords))))
  10522. (and logging (org-local-logging logging))
  10523. (when (and (or org-todo-log-states org-log-done)
  10524. (not (eq org-inhibit-logging t))
  10525. (not (memq arg '(nextset previousset))))
  10526. ;; we need to look at recording a time and note
  10527. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  10528. (nth 2 (assoc this org-todo-log-states))))
  10529. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  10530. (setq dolog 'time))
  10531. (when (and org-state
  10532. (member org-state org-not-done-keywords)
  10533. (not (member this org-not-done-keywords)))
  10534. ;; This is now a todo state and was not one before
  10535. ;; If there was a CLOSED time stamp, get rid of it.
  10536. (org-add-planning-info nil nil 'closed))
  10537. (when (and now-done-p org-log-done)
  10538. ;; It is now done, and it was not done before
  10539. (org-add-planning-info 'closed (org-current-effective-time))
  10540. (if (and (not dolog) (eq 'note org-log-done))
  10541. (org-add-log-setup 'done org-state this 'findpos 'note)))
  10542. (when (and org-state dolog)
  10543. ;; This is a non-nil state, and we need to log it
  10544. (org-add-log-setup 'state org-state this 'findpos dolog)))
  10545. ;; Fixup tag positioning
  10546. (org-todo-trigger-tag-changes org-state)
  10547. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  10548. (when org-provide-todo-statistics
  10549. (org-update-parent-todo-statistics))
  10550. (run-hooks 'org-after-todo-state-change-hook)
  10551. (if (and arg (not (member org-state org-done-keywords)))
  10552. (setq head (org-get-todo-sequence-head org-state)))
  10553. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  10554. ;; Do we need to trigger a repeat?
  10555. (when now-done-p
  10556. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  10557. ;; This is for the agenda, take a snapshot of the headline.
  10558. (save-match-data
  10559. (setq org-agenda-headline-snapshot-before-repeat
  10560. (org-get-heading))))
  10561. (org-auto-repeat-maybe org-state))
  10562. ;; Fixup cursor location if close to the keyword
  10563. (if (and (outline-on-heading-p)
  10564. (not (bolp))
  10565. (save-excursion (beginning-of-line 1)
  10566. (looking-at org-todo-line-regexp))
  10567. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  10568. (progn
  10569. (goto-char (or (match-end 2) (match-end 1)))
  10570. (and (looking-at " ") (just-one-space))))
  10571. (when org-trigger-hook
  10572. (save-excursion
  10573. (run-hook-with-args 'org-trigger-hook change-plist)))))))))
  10574. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  10575. "Block turning an entry into a TODO, using the hierarchy.
  10576. This checks whether the current task should be blocked from state
  10577. changes. Such blocking occurs when:
  10578. 1. The task has children which are not all in a completed state.
  10579. 2. A task has a parent with the property :ORDERED:, and there
  10580. are siblings prior to the current task with incomplete
  10581. status.
  10582. 3. The parent of the task is blocked because it has siblings that should
  10583. be done first, or is child of a block grandparent TODO entry."
  10584. (if (not org-enforce-todo-dependencies)
  10585. t ; if locally turned off don't block
  10586. (catch 'dont-block
  10587. ;; If this is not a todo state change, or if this entry is already DONE,
  10588. ;; do not block
  10589. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10590. (member (plist-get change-plist :from)
  10591. (cons 'done org-done-keywords))
  10592. (member (plist-get change-plist :to)
  10593. (cons 'todo org-not-done-keywords))
  10594. (not (plist-get change-plist :to)))
  10595. (throw 'dont-block t))
  10596. ;; If this task has children, and any are undone, it's blocked
  10597. (save-excursion
  10598. (org-back-to-heading t)
  10599. (let ((this-level (funcall outline-level)))
  10600. (outline-next-heading)
  10601. (let ((child-level (funcall outline-level)))
  10602. (while (and (not (eobp))
  10603. (> child-level this-level))
  10604. ;; this todo has children, check whether they are all
  10605. ;; completed
  10606. (if (and (not (org-entry-is-done-p))
  10607. (org-entry-is-todo-p))
  10608. (throw 'dont-block nil))
  10609. (outline-next-heading)
  10610. (setq child-level (funcall outline-level))))))
  10611. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  10612. ;; any previous siblings are undone, it's blocked
  10613. (save-excursion
  10614. (org-back-to-heading t)
  10615. (let* ((pos (point))
  10616. (parent-pos (and (org-up-heading-safe) (point))))
  10617. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10618. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10619. (forward-line 1)
  10620. (re-search-forward org-not-done-heading-regexp pos t))
  10621. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  10622. ;; Search further up the hierarchy, to see if an ancestor is blocked
  10623. (while t
  10624. (goto-char parent-pos)
  10625. (if (not (looking-at org-not-done-heading-regexp))
  10626. (throw 'dont-block t)) ; do not block, parent is not a TODO
  10627. (setq pos (point))
  10628. (setq parent-pos (and (org-up-heading-safe) (point)))
  10629. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10630. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10631. (forward-line 1)
  10632. (re-search-forward org-not-done-heading-regexp pos t))
  10633. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  10634. (defcustom org-track-ordered-property-with-tag nil
  10635. "Should the ORDERED property also be shown as a tag?
  10636. The ORDERED property decides if an entry should require subtasks to be
  10637. completed in sequence. Since a property is not very visible, setting
  10638. this option means that toggling the ORDERED property with the command
  10639. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  10640. not relevant for the behavior, but it makes things more visible.
  10641. Note that toggling the tag with tags commands will not change the property
  10642. and therefore not influence behavior!
  10643. This can be t, meaning the tag ORDERED should be used, It can also be a
  10644. string to select a different tag for this task."
  10645. :group 'org-todo
  10646. :type '(choice
  10647. (const :tag "No tracking" nil)
  10648. (const :tag "Track with ORDERED tag" t)
  10649. (string :tag "Use other tag")))
  10650. (defun org-toggle-ordered-property ()
  10651. "Toggle the ORDERED property of the current entry.
  10652. For better visibility, you can track the value of this property with a tag.
  10653. See variable `org-track-ordered-property-with-tag'."
  10654. (interactive)
  10655. (let* ((t1 org-track-ordered-property-with-tag)
  10656. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  10657. (save-excursion
  10658. (org-back-to-heading)
  10659. (if (org-entry-get nil "ORDERED")
  10660. (progn
  10661. (org-delete-property "ORDERED")
  10662. (and tag (org-toggle-tag tag 'off))
  10663. (message "Subtasks can be completed in arbitrary order"))
  10664. (org-entry-put nil "ORDERED" "t")
  10665. (and tag (org-toggle-tag tag 'on))
  10666. (message "Subtasks must be completed in sequence")))))
  10667. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  10668. (defun org-block-todo-from-checkboxes (change-plist)
  10669. "Block turning an entry into a TODO, using checkboxes.
  10670. This checks whether the current task should be blocked from state
  10671. changes because there are unchecked boxes in this entry."
  10672. (if (not org-enforce-todo-checkbox-dependencies)
  10673. t ; if locally turned off don't block
  10674. (catch 'dont-block
  10675. ;; If this is not a todo state change, or if this entry is already DONE,
  10676. ;; do not block
  10677. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10678. (member (plist-get change-plist :from)
  10679. (cons 'done org-done-keywords))
  10680. (member (plist-get change-plist :to)
  10681. (cons 'todo org-not-done-keywords))
  10682. (not (plist-get change-plist :to)))
  10683. (throw 'dont-block t))
  10684. ;; If this task has checkboxes that are not checked, it's blocked
  10685. (save-excursion
  10686. (org-back-to-heading t)
  10687. (let ((beg (point)) end)
  10688. (outline-next-heading)
  10689. (setq end (point))
  10690. (goto-char beg)
  10691. (if (org-list-search-forward
  10692. (concat (org-item-beginning-re)
  10693. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  10694. "\\[[- ]\\]")
  10695. end t)
  10696. (progn
  10697. (if (boundp 'org-blocked-by-checkboxes)
  10698. (setq org-blocked-by-checkboxes t))
  10699. (throw 'dont-block nil)))))
  10700. t))) ; do not block
  10701. (defun org-entry-blocked-p ()
  10702. "Is the current entry blocked?"
  10703. (if (org-entry-get nil "NOBLOCKING")
  10704. nil ;; Never block this entry
  10705. (not
  10706. (run-hook-with-args-until-failure
  10707. 'org-blocker-hook
  10708. (list :type 'todo-state-change
  10709. :position (point)
  10710. :from 'todo
  10711. :to 'done)))))
  10712. (defun org-update-statistics-cookies (all)
  10713. "Update the statistics cookie, either from TODO or from checkboxes.
  10714. This should be called with the cursor in a line with a statistics cookie."
  10715. (interactive "P")
  10716. (if all
  10717. (progn
  10718. (org-update-checkbox-count 'all)
  10719. (org-map-entries 'org-update-parent-todo-statistics))
  10720. (if (not (org-at-heading-p))
  10721. (org-update-checkbox-count)
  10722. (let ((pos (move-marker (make-marker) (point)))
  10723. end l1 l2)
  10724. (ignore-errors (org-back-to-heading t))
  10725. (if (not (org-at-heading-p))
  10726. (org-update-checkbox-count)
  10727. (setq l1 (org-outline-level))
  10728. (setq end (save-excursion
  10729. (outline-next-heading)
  10730. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  10731. (point)))
  10732. (if (and (save-excursion
  10733. (re-search-forward
  10734. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  10735. (not (save-excursion (re-search-forward
  10736. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  10737. (org-update-checkbox-count)
  10738. (if (and l2 (> l2 l1))
  10739. (progn
  10740. (goto-char end)
  10741. (org-update-parent-todo-statistics))
  10742. (goto-char pos)
  10743. (beginning-of-line 1)
  10744. (while (re-search-forward
  10745. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  10746. (point-at-eol) t)
  10747. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  10748. (goto-char pos)
  10749. (move-marker pos nil)))))
  10750. (defvar org-entry-property-inherited-from) ;; defined below
  10751. (defun org-update-parent-todo-statistics ()
  10752. "Update any statistics cookie in the parent of the current headline.
  10753. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  10754. the entire subtree and this will travel up the hierarchy and update
  10755. statistics everywhere."
  10756. (let* ((prop (save-excursion (org-up-heading-safe)
  10757. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  10758. (recursive (or (not org-hierarchical-todo-statistics)
  10759. (and prop (string-match "\\<recursive\\>" prop))))
  10760. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  10761. 0))
  10762. (first t)
  10763. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10764. level ltoggle l1 new ndel
  10765. (cnt-all 0) (cnt-done 0) is-percent kwd
  10766. checkbox-beg ov ovs ove cookie-present)
  10767. (catch 'exit
  10768. (save-excursion
  10769. (beginning-of-line 1)
  10770. (setq ltoggle (funcall outline-level))
  10771. ;; Three situations are to consider:
  10772. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  10773. ;; to the top-level ancestor on the headline;
  10774. ;; 2. If parent has "recursive" property, repeat up to the
  10775. ;; headline setting that property, taking inheritance into
  10776. ;; account;
  10777. ;; 3. Else, move up to direct parent and proceed only once.
  10778. (while (and (setq level (org-up-heading-safe))
  10779. (or recursive first)
  10780. (>= (point) lim))
  10781. (setq first nil cookie-present nil)
  10782. (unless (and level
  10783. (not (string-match
  10784. "\\<checkbox\\>"
  10785. (downcase (or (org-entry-get nil "COOKIE_DATA")
  10786. "")))))
  10787. (throw 'exit nil))
  10788. (while (re-search-forward box-re (point-at-eol) t)
  10789. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10790. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  10791. (save-match-data
  10792. (unless (outline-next-heading) (throw 'exit nil))
  10793. (while (and (looking-at org-complex-heading-regexp)
  10794. (> (setq l1 (length (match-string 1))) level))
  10795. (setq kwd (and (or recursive (= l1 ltoggle))
  10796. (match-string 2)))
  10797. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10798. (and (listp org-provide-todo-statistics)
  10799. (or (member kwd org-provide-todo-statistics)
  10800. (member kwd org-done-keywords))))
  10801. (setq cnt-all (1+ cnt-all))
  10802. (if (eq org-provide-todo-statistics t)
  10803. (and kwd (setq cnt-all (1+ cnt-all)))))
  10804. (and (member kwd org-done-keywords)
  10805. (setq cnt-done (1+ cnt-done)))
  10806. (outline-next-heading)))
  10807. (setq new
  10808. (if is-percent
  10809. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10810. (format "[%d/%d]" cnt-done cnt-all))
  10811. ndel (- (match-end 0) checkbox-beg))
  10812. ;; handle overlays when updating cookie from column view
  10813. (when (setq ov (car (overlays-at checkbox-beg)))
  10814. (setq ovs (overlay-start ov) ove (overlay-end ov))
  10815. (delete-overlay ov))
  10816. (goto-char checkbox-beg)
  10817. (insert new)
  10818. (delete-region (point) (+ (point) ndel))
  10819. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  10820. (when ov (move-overlay ov ovs ove)))
  10821. (when cookie-present
  10822. (run-hook-with-args 'org-after-todo-statistics-hook
  10823. cnt-done (- cnt-all cnt-done))))))
  10824. (run-hooks 'org-todo-statistics-hook)))
  10825. (defvar org-after-todo-statistics-hook nil
  10826. "Hook that is called after a TODO statistics cookie has been updated.
  10827. Each function is called with two arguments: the number of not-done entries
  10828. and the number of done entries.
  10829. For example, the following function, when added to this hook, will switch
  10830. an entry to DONE when all children are done, and back to TODO when new
  10831. entries are set to a TODO status. Note that this hook is only called
  10832. when there is a statistics cookie in the headline!
  10833. (defun org-summary-todo (n-done n-not-done)
  10834. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10835. (let (org-log-done org-log-states) ; turn off logging
  10836. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10837. ")
  10838. (defvar org-todo-statistics-hook nil
  10839. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10840. This hook runs even if there is no statistics cookie present, in which case
  10841. `org-after-todo-statistics-hook' would not run.")
  10842. (defun org-todo-trigger-tag-changes (state)
  10843. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10844. (let ((l org-todo-state-tags-triggers)
  10845. changes)
  10846. (when (or (not state) (equal state ""))
  10847. (setq changes (append changes (cdr (assoc "" l)))))
  10848. (when (and (stringp state) (> (length state) 0))
  10849. (setq changes (append changes (cdr (assoc state l)))))
  10850. (when (member state org-not-done-keywords)
  10851. (setq changes (append changes (cdr (assoc 'todo l)))))
  10852. (when (member state org-done-keywords)
  10853. (setq changes (append changes (cdr (assoc 'done l)))))
  10854. (dolist (c changes)
  10855. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10856. (defun org-local-logging (value)
  10857. "Get logging settings from a property VALUE."
  10858. (let* (words w a)
  10859. ;; directly set the variables, they are already local.
  10860. (setq org-log-done nil
  10861. org-log-repeat nil
  10862. org-todo-log-states nil)
  10863. (setq words (org-split-string value))
  10864. (while (setq w (pop words))
  10865. (cond
  10866. ((setq a (assoc w org-startup-options))
  10867. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10868. (set (nth 1 a) (nth 2 a))))
  10869. ((setq a (org-extract-log-state-settings w))
  10870. (and (member (car a) org-todo-keywords-1)
  10871. (push a org-todo-log-states)))))))
  10872. (defun org-get-todo-sequence-head (kwd)
  10873. "Return the head of the TODO sequence to which KWD belongs.
  10874. If KWD is not set, check if there is a text property remembering the
  10875. right sequence."
  10876. (let (p)
  10877. (cond
  10878. ((not kwd)
  10879. (or (get-text-property (point-at-bol) 'org-todo-head)
  10880. (progn
  10881. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  10882. nil (point-at-eol)))
  10883. (get-text-property p 'org-todo-head))))
  10884. ((not (member kwd org-todo-keywords-1))
  10885. (car org-todo-keywords-1))
  10886. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  10887. (defun org-fast-todo-selection ()
  10888. "Fast TODO keyword selection with single keys.
  10889. Returns the new TODO keyword, or nil if no state change should occur."
  10890. (let* ((fulltable org-todo-key-alist)
  10891. (done-keywords org-done-keywords) ;; needed for the faces.
  10892. (maxlen (apply 'max (mapcar
  10893. (lambda (x)
  10894. (if (stringp (car x)) (string-width (car x)) 0))
  10895. fulltable)))
  10896. (expert nil)
  10897. (fwidth (+ maxlen 3 1 3))
  10898. (ncol (/ (- (window-width) 4) fwidth))
  10899. tg cnt e c tbl
  10900. groups ingroup)
  10901. (save-excursion
  10902. (save-window-excursion
  10903. (if expert
  10904. (set-buffer (get-buffer-create " *Org todo*"))
  10905. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  10906. (erase-buffer)
  10907. (org-set-local 'org-done-keywords done-keywords)
  10908. (setq tbl fulltable cnt 0)
  10909. (while (setq e (pop tbl))
  10910. (cond
  10911. ((equal e '(:startgroup))
  10912. (push '() groups) (setq ingroup t)
  10913. (when (not (= cnt 0))
  10914. (setq cnt 0)
  10915. (insert "\n"))
  10916. (insert "{ "))
  10917. ((equal e '(:endgroup))
  10918. (setq ingroup nil cnt 0)
  10919. (insert "}\n"))
  10920. ((equal e '(:newline))
  10921. (when (not (= cnt 0))
  10922. (setq cnt 0)
  10923. (insert "\n")
  10924. (setq e (car tbl))
  10925. (while (equal (car tbl) '(:newline))
  10926. (insert "\n")
  10927. (setq tbl (cdr tbl)))))
  10928. (t
  10929. (setq tg (car e) c (cdr e))
  10930. (if ingroup (push tg (car groups)))
  10931. (setq tg (org-add-props tg nil 'face
  10932. (org-get-todo-face tg)))
  10933. (if (and (= cnt 0) (not ingroup)) (insert " "))
  10934. (insert "[" c "] " tg (make-string
  10935. (- fwidth 4 (length tg)) ?\ ))
  10936. (when (= (setq cnt (1+ cnt)) ncol)
  10937. (insert "\n")
  10938. (if ingroup (insert " "))
  10939. (setq cnt 0)))))
  10940. (insert "\n")
  10941. (goto-char (point-min))
  10942. (if (not expert) (org-fit-window-to-buffer))
  10943. (message "[a-z..]:Set [SPC]:clear")
  10944. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  10945. (cond
  10946. ((or (= c ?\C-g)
  10947. (and (= c ?q) (not (rassoc c fulltable))))
  10948. (setq quit-flag t))
  10949. ((= c ?\ ) nil)
  10950. ((setq e (rassoc c fulltable) tg (car e))
  10951. tg)
  10952. (t (setq quit-flag t)))))))
  10953. (defun org-entry-is-todo-p ()
  10954. (member (org-get-todo-state) org-not-done-keywords))
  10955. (defun org-entry-is-done-p ()
  10956. (member (org-get-todo-state) org-done-keywords))
  10957. (defun org-get-todo-state ()
  10958. (save-excursion
  10959. (org-back-to-heading t)
  10960. (and (looking-at org-todo-line-regexp)
  10961. (match-end 2)
  10962. (match-string 2))))
  10963. (defun org-at-date-range-p (&optional inactive-ok)
  10964. "Is the cursor inside a date range?"
  10965. (interactive)
  10966. (save-excursion
  10967. (catch 'exit
  10968. (let ((pos (point)))
  10969. (skip-chars-backward "^[<\r\n")
  10970. (skip-chars-backward "<[")
  10971. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10972. (>= (match-end 0) pos)
  10973. (throw 'exit t))
  10974. (skip-chars-backward "^<[\r\n")
  10975. (skip-chars-backward "<[")
  10976. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10977. (>= (match-end 0) pos)
  10978. (throw 'exit t)))
  10979. nil)))
  10980. (defun org-get-repeat (&optional tagline)
  10981. "Check if there is a deadline/schedule with repeater in this entry."
  10982. (save-match-data
  10983. (save-excursion
  10984. (org-back-to-heading t)
  10985. (and (re-search-forward (if tagline
  10986. (concat tagline "\\s-*" org-repeat-re)
  10987. org-repeat-re)
  10988. (org-entry-end-position) t)
  10989. (match-string-no-properties 1)))))
  10990. (defvar org-last-changed-timestamp)
  10991. (defvar org-last-inserted-timestamp)
  10992. (defvar org-log-post-message)
  10993. (defvar org-log-note-purpose)
  10994. (defvar org-log-note-how)
  10995. (defvar org-log-note-extra)
  10996. (defun org-auto-repeat-maybe (done-word)
  10997. "Check if the current headline contains a repeated deadline/schedule.
  10998. If yes, set TODO state back to what it was and change the base date
  10999. of repeating deadline/scheduled time stamps to new date.
  11000. This function is run automatically after each state change to a DONE state."
  11001. ;; last-state is dynamically scoped into this function
  11002. (let* ((repeat (org-get-repeat))
  11003. (aa (assoc org-last-state org-todo-kwd-alist))
  11004. (interpret (nth 1 aa))
  11005. (head (nth 2 aa))
  11006. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11007. (msg "Entry repeats: ")
  11008. (org-log-done nil)
  11009. (org-todo-log-states nil)
  11010. re type n what ts time to-state)
  11011. (when repeat
  11012. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  11013. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  11014. org-todo-repeat-to-state))
  11015. (unless (and to-state (member to-state org-todo-keywords-1))
  11016. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11017. (org-todo to-state)
  11018. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11019. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11020. (org-time-stamp-format t t))))
  11021. (when org-log-repeat
  11022. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11023. (memq 'org-add-log-note post-command-hook))
  11024. ;; OK, we are already setup for some record
  11025. (if (eq org-log-repeat 'note)
  11026. ;; make sure we take a note, not only a time stamp
  11027. (setq org-log-note-how 'note))
  11028. ;; Set up for taking a record
  11029. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  11030. org-last-state
  11031. 'findpos org-log-repeat)))
  11032. (org-back-to-heading t)
  11033. (org-add-planning-info nil nil 'closed)
  11034. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11035. org-deadline-time-regexp "\\)\\|\\("
  11036. org-ts-regexp "\\)"))
  11037. (while (re-search-forward
  11038. re (save-excursion (outline-next-heading) (point)) t)
  11039. (setq type (if (match-end 1) org-scheduled-string
  11040. (if (match-end 3) org-deadline-string "Plain:"))
  11041. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  11042. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  11043. (setq n (string-to-number (match-string 2 ts))
  11044. what (match-string 3 ts))
  11045. (if (equal what "w") (setq n (* n 7) what "d"))
  11046. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  11047. (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  11048. ;; Preparation, see if we need to modify the start date for the change
  11049. (when (match-end 1)
  11050. (setq time (save-match-data (org-time-string-to-time ts)))
  11051. (cond
  11052. ((equal (match-string 1 ts) ".")
  11053. ;; Shift starting date to today
  11054. (org-timestamp-change
  11055. (- (org-today) (time-to-days time))
  11056. 'day))
  11057. ((equal (match-string 1 ts) "+")
  11058. (let ((nshiftmax 10) (nshift 0))
  11059. (while (or (= nshift 0)
  11060. (<= (time-to-days time)
  11061. (time-to-days (current-time))))
  11062. (when (= (incf nshift) nshiftmax)
  11063. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  11064. (error "Abort")))
  11065. (org-timestamp-change n (cdr (assoc what whata)))
  11066. (org-at-timestamp-p t)
  11067. (setq ts (match-string 1))
  11068. (setq time (save-match-data (org-time-string-to-time ts)))))
  11069. (org-timestamp-change (- n) (cdr (assoc what whata)))
  11070. ;; rematch, so that we have everything in place for the real shift
  11071. (org-at-timestamp-p t)
  11072. (setq ts (match-string 1))
  11073. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  11074. (org-timestamp-change n (cdr (assoc what whata)))
  11075. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  11076. (setq org-log-post-message msg)
  11077. (message "%s" msg))))
  11078. (defun org-show-todo-tree (arg)
  11079. "Make a compact tree which shows all headlines marked with TODO.
  11080. The tree will show the lines where the regexp matches, and all higher
  11081. headlines above the match.
  11082. With a \\[universal-argument] prefix, prompt for a regexp to match.
  11083. With a numeric prefix N, construct a sparse tree for the Nth element
  11084. of `org-todo-keywords-1'."
  11085. (interactive "P")
  11086. (let ((case-fold-search nil)
  11087. (kwd-re
  11088. (cond ((null arg) org-not-done-regexp)
  11089. ((equal arg '(4))
  11090. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  11091. (mapcar 'list org-todo-keywords-1))))
  11092. (concat "\\("
  11093. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  11094. "\\)\\>")))
  11095. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  11096. (regexp-quote (nth (1- (prefix-numeric-value arg))
  11097. org-todo-keywords-1)))
  11098. (t (error "Invalid prefix argument: %s" arg)))))
  11099. (message "%d TODO entries found"
  11100. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  11101. (defun org-deadline (&optional remove time)
  11102. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  11103. With argument REMOVE, remove any deadline from the item.
  11104. With argument TIME, set the deadline at the corresponding date. TIME
  11105. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11106. (interactive "P")
  11107. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11108. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11109. 'region-start-level 'region))
  11110. org-loop-over-headlines-in-active-region)
  11111. (org-map-entries
  11112. `(org-deadline ',remove ,time)
  11113. org-loop-over-headlines-in-active-region
  11114. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11115. (let* ((old-date (org-entry-get nil "DEADLINE"))
  11116. (repeater (and old-date
  11117. (string-match
  11118. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11119. old-date)
  11120. (match-string 1 old-date))))
  11121. (if remove
  11122. (progn
  11123. (when (and old-date org-log-redeadline)
  11124. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11125. org-log-redeadline))
  11126. (org-remove-timestamp-with-keyword org-deadline-string)
  11127. (message "Item no longer has a deadline."))
  11128. (org-add-planning-info 'deadline time 'closed)
  11129. (when (and old-date org-log-redeadline
  11130. (not (equal old-date
  11131. (substring org-last-inserted-timestamp 1 -1))))
  11132. (org-add-log-setup 'redeadline nil old-date 'findpos
  11133. org-log-redeadline))
  11134. (when repeater
  11135. (save-excursion
  11136. (org-back-to-heading t)
  11137. (when (re-search-forward (concat org-deadline-string " "
  11138. org-last-inserted-timestamp)
  11139. (save-excursion
  11140. (outline-next-heading) (point)) t)
  11141. (goto-char (1- (match-end 0)))
  11142. (insert " " repeater)
  11143. (setq org-last-inserted-timestamp
  11144. (concat (substring org-last-inserted-timestamp 0 -1)
  11145. " " repeater
  11146. (substring org-last-inserted-timestamp -1))))))
  11147. (message "Deadline on %s" org-last-inserted-timestamp)))))
  11148. (defun org-schedule (&optional remove time)
  11149. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11150. With argument REMOVE, remove any scheduling date from the item.
  11151. With argument TIME, scheduled at the corresponding date. TIME can
  11152. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11153. (interactive "P")
  11154. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11155. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11156. 'region-start-level 'region))
  11157. org-loop-over-headlines-in-active-region)
  11158. (org-map-entries
  11159. `(org-schedule ',remove ,time)
  11160. org-loop-over-headlines-in-active-region
  11161. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11162. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11163. (repeater (and old-date
  11164. (string-match
  11165. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11166. old-date)
  11167. (match-string 1 old-date))))
  11168. (if remove
  11169. (progn
  11170. (when (and old-date org-log-reschedule)
  11171. (org-add-log-setup 'delschedule nil old-date 'findpos
  11172. org-log-reschedule))
  11173. (org-remove-timestamp-with-keyword org-scheduled-string)
  11174. (message "Item is no longer scheduled."))
  11175. (org-add-planning-info 'scheduled time 'closed)
  11176. (when (and old-date org-log-reschedule
  11177. (not (equal old-date
  11178. (substring org-last-inserted-timestamp 1 -1))))
  11179. (org-add-log-setup 'reschedule nil old-date 'findpos
  11180. org-log-reschedule))
  11181. (when repeater
  11182. (save-excursion
  11183. (org-back-to-heading t)
  11184. (when (re-search-forward (concat org-scheduled-string " "
  11185. org-last-inserted-timestamp)
  11186. (save-excursion
  11187. (outline-next-heading) (point)) t)
  11188. (goto-char (1- (match-end 0)))
  11189. (insert " " repeater)
  11190. (setq org-last-inserted-timestamp
  11191. (concat (substring org-last-inserted-timestamp 0 -1)
  11192. " " repeater
  11193. (substring org-last-inserted-timestamp -1))))))
  11194. (message "Scheduled to %s" org-last-inserted-timestamp)))))
  11195. (defun org-get-scheduled-time (pom &optional inherit)
  11196. "Get the scheduled time as a time tuple, of a format suitable
  11197. for calling org-schedule with, or if there is no scheduling,
  11198. returns nil."
  11199. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11200. (when time
  11201. (apply 'encode-time (org-parse-time-string time)))))
  11202. (defun org-get-deadline-time (pom &optional inherit)
  11203. "Get the deadline as a time tuple, of a format suitable for
  11204. calling org-deadline with, or if there is no scheduling, returns
  11205. nil."
  11206. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11207. (when time
  11208. (apply 'encode-time (org-parse-time-string time)))))
  11209. (defun org-remove-timestamp-with-keyword (keyword)
  11210. "Remove all time stamps with KEYWORD in the current entry."
  11211. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11212. beg)
  11213. (save-excursion
  11214. (org-back-to-heading t)
  11215. (setq beg (point))
  11216. (outline-next-heading)
  11217. (while (re-search-backward re beg t)
  11218. (replace-match "")
  11219. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11220. (equal (char-before) ?\ ))
  11221. (backward-delete-char 1)
  11222. (if (string-match "^[ \t]*$" (buffer-substring
  11223. (point-at-bol) (point-at-eol)))
  11224. (delete-region (point-at-bol)
  11225. (min (point-max) (1+ (point-at-eol))))))))))
  11226. (defun org-add-planning-info (what &optional time &rest remove)
  11227. "Insert new timestamp with keyword in the line directly after the headline.
  11228. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11229. If non is given, the user is prompted for a date.
  11230. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11231. be removed."
  11232. (interactive)
  11233. (let (org-time-was-given org-end-time-was-given ts
  11234. end default-time default-input)
  11235. (catch 'exit
  11236. (when (and (memq what '(scheduled deadline))
  11237. (or (not time)
  11238. (and (stringp time)
  11239. (string-match "^[-+]+[0-9]" time))))
  11240. ;; Try to get a default date/time from existing timestamp
  11241. (save-excursion
  11242. (org-back-to-heading t)
  11243. (setq end (save-excursion (outline-next-heading) (point)))
  11244. (when (re-search-forward (if (eq what 'scheduled)
  11245. org-scheduled-time-regexp
  11246. org-deadline-time-regexp)
  11247. end t)
  11248. (setq ts (match-string 1)
  11249. default-time
  11250. (apply 'encode-time (org-parse-time-string ts))
  11251. default-input (and ts (org-get-compact-tod ts))))))
  11252. (when what
  11253. (setq time
  11254. (if (stringp time)
  11255. ;; This is a string (relative or absolute), set proper date
  11256. (apply 'encode-time
  11257. (org-read-date-analyze
  11258. time default-time (decode-time default-time)))
  11259. ;; If necessary, get the time from the user
  11260. (or time (org-read-date nil 'to-time nil nil
  11261. default-time default-input)))))
  11262. (when (and org-insert-labeled-timestamps-at-point
  11263. (member what '(scheduled deadline)))
  11264. (insert
  11265. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11266. (org-insert-time-stamp time org-time-was-given
  11267. nil nil nil (list org-end-time-was-given))
  11268. (setq what nil))
  11269. (save-excursion
  11270. (save-restriction
  11271. (let (col list elt ts buffer-invisibility-spec)
  11272. (org-back-to-heading t)
  11273. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11274. (goto-char (match-end 1))
  11275. (setq col (current-column))
  11276. (goto-char (match-end 0))
  11277. (if (eobp) (insert "\n") (forward-char 1))
  11278. (when (and (not what)
  11279. (not (looking-at
  11280. (concat "[ \t]*"
  11281. org-keyword-time-not-clock-regexp))))
  11282. ;; Nothing to add, nothing to remove...... :-)
  11283. (throw 'exit nil))
  11284. (if (and (not (looking-at org-outline-regexp))
  11285. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11286. "[^\r\n]*"))
  11287. (not (equal (match-string 1) org-clock-string)))
  11288. (narrow-to-region (match-beginning 0) (match-end 0))
  11289. (insert-before-markers "\n")
  11290. (backward-char 1)
  11291. (narrow-to-region (point) (point))
  11292. (and org-adapt-indentation (org-indent-to-column col)))
  11293. ;; Check if we have to remove something.
  11294. (setq list (cons what remove))
  11295. (while list
  11296. (setq elt (pop list))
  11297. (when (or (and (eq elt 'scheduled)
  11298. (re-search-forward org-scheduled-time-regexp nil t))
  11299. (and (eq elt 'deadline)
  11300. (re-search-forward org-deadline-time-regexp nil t))
  11301. (and (eq elt 'closed)
  11302. (re-search-forward org-closed-time-regexp nil t)))
  11303. (replace-match "")
  11304. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11305. (and (looking-at "[ \t]+") (replace-match ""))
  11306. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11307. (when what
  11308. (insert
  11309. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11310. (cond ((eq what 'scheduled) org-scheduled-string)
  11311. ((eq what 'deadline) org-deadline-string)
  11312. ((eq what 'closed) org-closed-string))
  11313. " ")
  11314. (setq ts (org-insert-time-stamp
  11315. time
  11316. (or org-time-was-given
  11317. (and (eq what 'closed) org-log-done-with-time))
  11318. (eq what 'closed)
  11319. nil nil (list org-end-time-was-given)))
  11320. (insert
  11321. (if (not (or (bolp) (eq (char-before) ?\ )
  11322. (memq (char-after) '(32 10))
  11323. (eobp))) " " ""))
  11324. (end-of-line 1))
  11325. (goto-char (point-min))
  11326. (widen)
  11327. (if (and (looking-at "[ \t]*\n")
  11328. (equal (char-before) ?\n))
  11329. (delete-region (1- (point)) (point-at-eol)))
  11330. ts))))))
  11331. (defvar org-log-note-marker (make-marker))
  11332. (defvar org-log-note-purpose nil)
  11333. (defvar org-log-note-state nil)
  11334. (defvar org-log-note-previous-state nil)
  11335. (defvar org-log-note-how nil)
  11336. (defvar org-log-note-extra nil)
  11337. (defvar org-log-note-window-configuration nil)
  11338. (defvar org-log-note-return-to (make-marker))
  11339. (defvar org-log-note-effective-time nil
  11340. "Remembered current time so that dynamically scoped
  11341. `org-extend-today-until' affects tha timestamps in state change
  11342. log")
  11343. (defvar org-log-post-message nil
  11344. "Message to be displayed after a log note has been stored.
  11345. The auto-repeater uses this.")
  11346. (defun org-add-note ()
  11347. "Add a note to the current entry.
  11348. This is done in the same way as adding a state change note."
  11349. (interactive)
  11350. (org-add-log-setup 'note nil nil 'findpos nil))
  11351. (defvar org-property-end-re)
  11352. (defun org-add-log-setup (&optional purpose state prev-state
  11353. findpos how extra)
  11354. "Set up the post command hook to take a note.
  11355. If this is about to TODO state change, the new state is expected in STATE.
  11356. When FINDPOS is non-nil, find the correct position for the note in
  11357. the current entry. If not, assume that it can be inserted at point.
  11358. HOW is an indicator what kind of note should be created.
  11359. EXTRA is additional text that will be inserted into the notes buffer."
  11360. (let* ((org-log-into-drawer (org-log-into-drawer))
  11361. (drawer (cond ((stringp org-log-into-drawer)
  11362. org-log-into-drawer)
  11363. (org-log-into-drawer "LOGBOOK"))))
  11364. (save-restriction
  11365. (save-excursion
  11366. (when findpos
  11367. (org-back-to-heading t)
  11368. (narrow-to-region (point) (save-excursion
  11369. (outline-next-heading) (point)))
  11370. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  11371. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  11372. "[^\r\n]*\\)?"))
  11373. (goto-char (match-end 0))
  11374. (cond
  11375. (drawer
  11376. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  11377. nil t)
  11378. (progn
  11379. (goto-char (match-end 0))
  11380. (or org-log-states-order-reversed
  11381. (and (re-search-forward org-property-end-re nil t)
  11382. (goto-char (1- (match-beginning 0))))))
  11383. (insert "\n:" drawer ":\n:END:")
  11384. (beginning-of-line 0)
  11385. (org-indent-line)
  11386. (beginning-of-line 2)
  11387. (org-indent-line)
  11388. (end-of-line 0)))
  11389. ((and org-log-state-notes-insert-after-drawers
  11390. (save-excursion
  11391. (forward-line) (looking-at org-drawer-regexp)))
  11392. (forward-line)
  11393. (while (looking-at org-drawer-regexp)
  11394. (goto-char (match-end 0))
  11395. (re-search-forward org-property-end-re (point-max) t)
  11396. (forward-line))
  11397. (forward-line -1)))
  11398. (unless org-log-states-order-reversed
  11399. (and (= (char-after) ?\n) (forward-char 1))
  11400. (org-skip-over-state-notes)
  11401. (skip-chars-backward " \t\n\r")))
  11402. (move-marker org-log-note-marker (point))
  11403. (setq org-log-note-purpose purpose
  11404. org-log-note-state state
  11405. org-log-note-previous-state prev-state
  11406. org-log-note-how how
  11407. org-log-note-extra extra
  11408. org-log-note-effective-time (org-current-effective-time))
  11409. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  11410. (defun org-skip-over-state-notes ()
  11411. "Skip past the list of State notes in an entry."
  11412. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  11413. (when (ignore-errors (goto-char (org-in-item-p)))
  11414. (let* ((struct (org-list-struct))
  11415. (prevs (org-list-prevs-alist struct)))
  11416. (while (looking-at "[ \t]*- State")
  11417. (goto-char (or (org-list-get-next-item (point) struct prevs)
  11418. (org-list-get-item-end (point) struct)))))))
  11419. (defun org-add-log-note (&optional purpose)
  11420. "Pop up a window for taking a note, and add this note later at point."
  11421. (remove-hook 'post-command-hook 'org-add-log-note)
  11422. (setq org-log-note-window-configuration (current-window-configuration))
  11423. (delete-other-windows)
  11424. (move-marker org-log-note-return-to (point))
  11425. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  11426. (goto-char org-log-note-marker)
  11427. (org-switch-to-buffer-other-window "*Org Note*")
  11428. (erase-buffer)
  11429. (if (memq org-log-note-how '(time state))
  11430. (let (current-prefix-arg) (org-store-log-note))
  11431. (let ((org-inhibit-startup t)) (org-mode))
  11432. (insert (format "# Insert note for %s.
  11433. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  11434. (cond
  11435. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  11436. ((eq org-log-note-purpose 'done) "closed todo item")
  11437. ((eq org-log-note-purpose 'state)
  11438. (format "state change from \"%s\" to \"%s\""
  11439. (or org-log-note-previous-state "")
  11440. (or org-log-note-state "")))
  11441. ((eq org-log-note-purpose 'reschedule)
  11442. "rescheduling")
  11443. ((eq org-log-note-purpose 'delschedule)
  11444. "no longer scheduled")
  11445. ((eq org-log-note-purpose 'redeadline)
  11446. "changing deadline")
  11447. ((eq org-log-note-purpose 'deldeadline)
  11448. "removing deadline")
  11449. ((eq org-log-note-purpose 'refile)
  11450. "refiling")
  11451. ((eq org-log-note-purpose 'note)
  11452. "this entry")
  11453. (t (error "This should not happen")))))
  11454. (if org-log-note-extra (insert org-log-note-extra))
  11455. (org-set-local 'org-finish-function 'org-store-log-note)
  11456. (run-hooks 'org-log-buffer-setup-hook)))
  11457. (defvar org-note-abort nil) ; dynamically scoped
  11458. (defun org-store-log-note ()
  11459. "Finish taking a log note, and insert it to where it belongs."
  11460. (let ((txt (buffer-string))
  11461. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  11462. lines ind bul)
  11463. (kill-buffer (current-buffer))
  11464. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  11465. (setq txt (replace-match "" t t txt)))
  11466. (if (string-match "\\s-+\\'" txt)
  11467. (setq txt (replace-match "" t t txt)))
  11468. (setq lines (org-split-string txt "\n"))
  11469. (when (and note (string-match "\\S-" note))
  11470. (setq note
  11471. (org-replace-escapes
  11472. note
  11473. (list (cons "%u" (user-login-name))
  11474. (cons "%U" user-full-name)
  11475. (cons "%t" (format-time-string
  11476. (org-time-stamp-format 'long 'inactive)
  11477. org-log-note-effective-time))
  11478. (cons "%T" (format-time-string
  11479. (org-time-stamp-format 'long nil)
  11480. org-log-note-effective-time))
  11481. (cons "%d" (format-time-string
  11482. (org-time-stamp-format nil 'inactive)
  11483. org-log-note-effective-time))
  11484. (cons "%D" (format-time-string
  11485. (org-time-stamp-format nil nil)
  11486. org-log-note-effective-time))
  11487. (cons "%s" (if org-log-note-state
  11488. (concat "\"" org-log-note-state "\"")
  11489. ""))
  11490. (cons "%S" (if org-log-note-previous-state
  11491. (concat "\"" org-log-note-previous-state "\"")
  11492. "\"\"")))))
  11493. (if lines (setq note (concat note " \\\\")))
  11494. (push note lines))
  11495. (when (or current-prefix-arg org-note-abort)
  11496. (when org-log-into-drawer
  11497. (org-remove-empty-drawer-at
  11498. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  11499. org-log-note-marker))
  11500. (setq lines nil))
  11501. (when lines
  11502. (with-current-buffer (marker-buffer org-log-note-marker)
  11503. (save-excursion
  11504. (goto-char org-log-note-marker)
  11505. (move-marker org-log-note-marker nil)
  11506. (end-of-line 1)
  11507. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  11508. (setq ind (save-excursion
  11509. (if (ignore-errors (goto-char (org-in-item-p)))
  11510. (let ((struct (org-list-struct)))
  11511. (org-list-get-ind
  11512. (org-list-get-top-point struct) struct))
  11513. (skip-chars-backward " \r\t\n")
  11514. (cond
  11515. ((and (org-at-heading-p)
  11516. org-adapt-indentation)
  11517. (1+ (org-current-level)))
  11518. ((org-at-heading-p) 0)
  11519. (t (org-get-indentation))))))
  11520. (setq bul (org-list-bullet-string "-"))
  11521. (org-indent-line-to ind)
  11522. (insert bul (pop lines))
  11523. (let ((ind-body (+ (length bul) ind)))
  11524. (while lines
  11525. (insert "\n")
  11526. (org-indent-line-to ind-body)
  11527. (insert (pop lines))))
  11528. (message "Note stored")
  11529. (org-back-to-heading t)
  11530. (org-cycle-hide-drawers 'children)))))
  11531. (set-window-configuration org-log-note-window-configuration)
  11532. (with-current-buffer (marker-buffer org-log-note-return-to)
  11533. (goto-char org-log-note-return-to))
  11534. (move-marker org-log-note-return-to nil)
  11535. (and org-log-post-message (message "%s" org-log-post-message)))
  11536. (defun org-remove-empty-drawer-at (drawer pos)
  11537. "Remove an empty drawer DRAWER at position POS.
  11538. POS may also be a marker."
  11539. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  11540. (save-excursion
  11541. (save-restriction
  11542. (widen)
  11543. (goto-char pos)
  11544. (if (org-in-regexp
  11545. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  11546. (replace-match ""))))))
  11547. (defvar org-ts-type nil)
  11548. (defun org-sparse-tree (&optional arg type)
  11549. "Create a sparse tree, prompt for the details.
  11550. This command can create sparse trees. You first need to select the type
  11551. of match used to create the tree:
  11552. t Show all TODO entries.
  11553. T Show entries with a specific TODO keyword.
  11554. m Show entries selected by a tags/property match.
  11555. p Enter a property name and its value (both with completion on existing
  11556. names/values) and show entries with that property.
  11557. r Show entries matching a regular expression (`/' can be used as well).
  11558. b Show deadlines and scheduled items before a date.
  11559. a Show deadlines and scheduled items after a date.
  11560. d Show deadlines due within `org-deadline-warning-days'.
  11561. D Show deadlines and scheduled items between a date range."
  11562. (interactive "P")
  11563. (let (ans kwd value ts-type)
  11564. (setq type (or type org-sparse-tree-default-date-type))
  11565. (setq org-ts-type type)
  11566. (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range\n [c]ycle through date types: %s"
  11567. (cond ((eq type 'all) "all timestamps")
  11568. ((eq type 'scheduled) "only scheduled")
  11569. ((eq type 'deadline) "only deadline")
  11570. ((eq type 'active) "only active timestamps")
  11571. ((eq type 'inactive) "only inactive timestamps")
  11572. ((eq type 'scheduled-or-deadline) "scheduled/deadline")
  11573. (t "scheduled/deadline")))
  11574. (setq ans (read-char-exclusive))
  11575. (cond
  11576. ((equal ans ?c)
  11577. (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
  11578. ((equal ans ?d)
  11579. (call-interactively 'org-check-deadlines))
  11580. ((equal ans ?b)
  11581. (call-interactively 'org-check-before-date))
  11582. ((equal ans ?a)
  11583. (call-interactively 'org-check-after-date))
  11584. ((equal ans ?D)
  11585. (call-interactively 'org-check-dates-range))
  11586. ((equal ans ?t)
  11587. (org-show-todo-tree nil))
  11588. ((equal ans ?T)
  11589. (org-show-todo-tree '(4)))
  11590. ((member ans '(?T ?m))
  11591. (call-interactively 'org-match-sparse-tree))
  11592. ((member ans '(?p ?P))
  11593. (setq kwd (org-icompleting-read "Property: "
  11594. (mapcar 'list (org-buffer-property-keys))))
  11595. (setq value (org-icompleting-read "Value: "
  11596. (mapcar 'list (org-property-values kwd))))
  11597. (unless (string-match "\\`{.*}\\'" value)
  11598. (setq value (concat "\"" value "\"")))
  11599. (org-match-sparse-tree arg (concat kwd "=" value)))
  11600. ((member ans '(?r ?R ?/))
  11601. (call-interactively 'org-occur))
  11602. (t (error "No such sparse tree command \"%c\"" ans)))))
  11603. (defvar org-occur-highlights nil
  11604. "List of overlays used for occur matches.")
  11605. (make-variable-buffer-local 'org-occur-highlights)
  11606. (defvar org-occur-parameters nil
  11607. "Parameters of the active org-occur calls.
  11608. This is a list, each call to org-occur pushes as cons cell,
  11609. containing the regular expression and the callback, onto the list.
  11610. The list can contain several entries if `org-occur' has been called
  11611. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  11612. will only contain one set of parameters. When the highlights are
  11613. removed (for example with `C-c C-c', or with the next edit (depending
  11614. on `org-remove-highlights-with-change'), this variable is emptied
  11615. as well.")
  11616. (make-variable-buffer-local 'org-occur-parameters)
  11617. (defun org-occur (regexp &optional keep-previous callback)
  11618. "Make a compact tree which shows all matches of REGEXP.
  11619. The tree will show the lines where the regexp matches, and all higher
  11620. headlines above the match. It will also show the heading after the match,
  11621. to make sure editing the matching entry is easy.
  11622. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  11623. call to `org-occur' will be kept, to allow stacking of calls to this
  11624. command.
  11625. If CALLBACK is non-nil, it is a function which is called to confirm
  11626. that the match should indeed be shown."
  11627. (interactive "sRegexp: \nP")
  11628. (when (equal regexp "")
  11629. (error "Regexp cannot be empty"))
  11630. (unless keep-previous
  11631. (org-remove-occur-highlights nil nil t))
  11632. (push (cons regexp callback) org-occur-parameters)
  11633. (let ((cnt 0))
  11634. (save-excursion
  11635. (goto-char (point-min))
  11636. (if (or (not keep-previous) ; do not want to keep
  11637. (not org-occur-highlights)) ; no previous matches
  11638. ;; hide everything
  11639. (org-overview))
  11640. (while (re-search-forward regexp nil t)
  11641. (when (or (not callback)
  11642. (save-match-data (funcall callback)))
  11643. (setq cnt (1+ cnt))
  11644. (when org-highlight-sparse-tree-matches
  11645. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  11646. (org-show-context 'occur-tree))))
  11647. (when org-remove-highlights-with-change
  11648. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  11649. nil 'local))
  11650. (unless org-sparse-tree-open-archived-trees
  11651. (org-hide-archived-subtrees (point-min) (point-max)))
  11652. (run-hooks 'org-occur-hook)
  11653. (if (org-called-interactively-p 'interactive)
  11654. (message "%d match(es) for regexp %s" cnt regexp))
  11655. cnt))
  11656. (defun org-occur-next-match (&optional n reset)
  11657. "Function for `next-error-function' to find sparse tree matches.
  11658. N is the number of matches to move, when negative move backwards.
  11659. RESET is entirely ignored - this function always goes back to the
  11660. starting point when no match is found."
  11661. (let* ((limit (if (< n 0) (point-min) (point-max)))
  11662. (search-func (if (< n 0)
  11663. 'previous-single-char-property-change
  11664. 'next-single-char-property-change))
  11665. (n (abs n))
  11666. (pos (point))
  11667. p1)
  11668. (catch 'exit
  11669. (while (setq p1 (funcall search-func (point) 'org-type))
  11670. (when (equal p1 limit)
  11671. (goto-char pos)
  11672. (error "No more matches"))
  11673. (when (equal (get-char-property p1 'org-type) 'org-occur)
  11674. (setq n (1- n))
  11675. (when (= n 0)
  11676. (goto-char p1)
  11677. (throw 'exit (point))))
  11678. (goto-char p1))
  11679. (goto-char p1)
  11680. (error "No more matches"))))
  11681. (defun org-show-context (&optional key)
  11682. "Make sure point and context are visible.
  11683. How much context is shown depends upon the variables
  11684. `org-show-hierarchy-above', `org-show-following-heading',
  11685. `org-show-entry-below' and `org-show-siblings'."
  11686. (let ((heading-p (org-at-heading-p t))
  11687. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  11688. (following-p (org-get-alist-option org-show-following-heading key))
  11689. (entry-p (org-get-alist-option org-show-entry-below key))
  11690. (siblings-p (org-get-alist-option org-show-siblings key)))
  11691. (catch 'exit
  11692. ;; Show heading or entry text
  11693. (if (and heading-p (not entry-p))
  11694. (org-flag-heading nil) ; only show the heading
  11695. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  11696. (org-show-hidden-entry))) ; show entire entry
  11697. (when following-p
  11698. ;; Show next sibling, or heading below text
  11699. (save-excursion
  11700. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  11701. (org-flag-heading nil))))
  11702. (when siblings-p (org-show-siblings))
  11703. (when hierarchy-p
  11704. ;; show all higher headings, possibly with siblings
  11705. (save-excursion
  11706. (while (and (condition-case nil
  11707. (progn (org-up-heading-all 1) t)
  11708. (error nil))
  11709. (not (bobp)))
  11710. (org-flag-heading nil)
  11711. (when siblings-p (org-show-siblings))))))))
  11712. (defvar org-reveal-start-hook nil
  11713. "Hook run before revealing a location.")
  11714. (defun org-reveal (&optional siblings)
  11715. "Show current entry, hierarchy above it, and the following headline.
  11716. This can be used to show a consistent set of context around locations
  11717. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  11718. not t for the search context.
  11719. With optional argument SIBLINGS, on each level of the hierarchy all
  11720. siblings are shown. This repairs the tree structure to what it would
  11721. look like when opened with hierarchical calls to `org-cycle'.
  11722. With double optional argument \\[universal-argument] \\[universal-argument], \
  11723. go to the parent and show the
  11724. entire tree."
  11725. (interactive "P")
  11726. (run-hooks 'org-reveal-start-hook)
  11727. (let ((org-show-hierarchy-above t)
  11728. (org-show-following-heading t)
  11729. (org-show-siblings (if siblings t org-show-siblings)))
  11730. (org-show-context nil))
  11731. (when (equal siblings '(16))
  11732. (save-excursion
  11733. (when (org-up-heading-safe)
  11734. (org-show-subtree)
  11735. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  11736. (defun org-highlight-new-match (beg end)
  11737. "Highlight from BEG to END and mark the highlight is an occur headline."
  11738. (let ((ov (make-overlay beg end)))
  11739. (overlay-put ov 'face 'secondary-selection)
  11740. (overlay-put ov 'org-type 'org-occur)
  11741. (push ov org-occur-highlights)))
  11742. (defun org-remove-occur-highlights (&optional beg end noremove)
  11743. "Remove the occur highlights from the buffer.
  11744. BEG and END are ignored. If NOREMOVE is nil, remove this function
  11745. from the `before-change-functions' in the current buffer."
  11746. (interactive)
  11747. (unless org-inhibit-highlight-removal
  11748. (mapc 'delete-overlay org-occur-highlights)
  11749. (setq org-occur-highlights nil)
  11750. (setq org-occur-parameters nil)
  11751. (unless noremove
  11752. (remove-hook 'before-change-functions
  11753. 'org-remove-occur-highlights 'local))))
  11754. ;;;; Priorities
  11755. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  11756. "Regular expression matching the priority indicator.")
  11757. (defvar org-remove-priority-next-time nil)
  11758. (defun org-priority-up ()
  11759. "Increase the priority of the current item."
  11760. (interactive)
  11761. (org-priority 'up))
  11762. (defun org-priority-down ()
  11763. "Decrease the priority of the current item."
  11764. (interactive)
  11765. (org-priority 'down))
  11766. (defun org-priority (&optional action show)
  11767. "Change the priority of an item.
  11768. ACTION can be `set', `up', `down', or a character."
  11769. (interactive "P")
  11770. (if (equal action '(4))
  11771. (org-show-priority)
  11772. (unless org-enable-priority-commands
  11773. (error "Priority commands are disabled"))
  11774. (setq action (or action 'set))
  11775. (let (current new news have remove)
  11776. (save-excursion
  11777. (org-back-to-heading t)
  11778. (if (looking-at org-priority-regexp)
  11779. (setq current (string-to-char (match-string 2))
  11780. have t))
  11781. (cond
  11782. ((eq action 'remove)
  11783. (setq remove t new ?\ ))
  11784. ((or (eq action 'set)
  11785. (if (featurep 'xemacs) (characterp action) (integerp action)))
  11786. (if (not (eq action 'set))
  11787. (setq new action)
  11788. (message "Priority %c-%c, SPC to remove: "
  11789. org-highest-priority org-lowest-priority)
  11790. (save-match-data
  11791. (setq new (read-char-exclusive))))
  11792. (if (and (= (upcase org-highest-priority) org-highest-priority)
  11793. (= (upcase org-lowest-priority) org-lowest-priority))
  11794. (setq new (upcase new)))
  11795. (cond ((equal new ?\ ) (setq remove t))
  11796. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  11797. (error "Priority must be between `%c' and `%c'"
  11798. org-highest-priority org-lowest-priority))))
  11799. ((eq action 'up)
  11800. (setq new (if have
  11801. (1- current) ; normal cycling
  11802. ;; last priority was empty
  11803. (if (eq last-command this-command)
  11804. org-lowest-priority ; wrap around empty to lowest
  11805. ;; default
  11806. (if org-priority-start-cycle-with-default
  11807. org-default-priority
  11808. (1- org-default-priority))))))
  11809. ((eq action 'down)
  11810. (setq new (if have
  11811. (1+ current) ; normal cycling
  11812. ;; last priority was empty
  11813. (if (eq last-command this-command)
  11814. org-highest-priority ; wrap around empty to highest
  11815. ;; default
  11816. (if org-priority-start-cycle-with-default
  11817. org-default-priority
  11818. (1+ org-default-priority))))))
  11819. (t (error "Invalid action")))
  11820. (if (or (< (upcase new) org-highest-priority)
  11821. (> (upcase new) org-lowest-priority))
  11822. (if (and (memq action '(up down))
  11823. (not have) (not (eq last-command this-command)))
  11824. ;; `new' is from default priority
  11825. (error
  11826. "The default can not be set, see `org-default-priority' why")
  11827. ;; normal cycling: `new' is beyond highest/lowest priority
  11828. ;; and is wrapped around to the empty priority
  11829. (setq remove t)))
  11830. (setq news (format "%c" new))
  11831. (if have
  11832. (if remove
  11833. (replace-match "" t t nil 1)
  11834. (replace-match news t t nil 2))
  11835. (if remove
  11836. (error "No priority cookie found in line")
  11837. (let ((case-fold-search nil))
  11838. (looking-at org-todo-line-regexp))
  11839. (if (match-end 2)
  11840. (progn
  11841. (goto-char (match-end 2))
  11842. (insert " [#" news "]"))
  11843. (goto-char (match-beginning 3))
  11844. (insert "[#" news "] "))))
  11845. (org-preserve-lc (org-set-tags nil 'align)))
  11846. (if remove
  11847. (message "Priority removed")
  11848. (message "Priority of current item set to %s" news)))))
  11849. (defun org-show-priority ()
  11850. "Show the priority of the current item.
  11851. This priority is composed of the main priority given with the [#A] cookies,
  11852. and by additional input from the age of a schedules or deadline entry."
  11853. (interactive)
  11854. (let ((pri (if (eq major-mode 'org-agenda-mode)
  11855. (org-get-at-bol 'priority)
  11856. (save-excursion
  11857. (save-match-data
  11858. (beginning-of-line)
  11859. (and (looking-at org-heading-regexp)
  11860. (org-get-priority (match-string 0))))))))
  11861. (message "Priority is %d" (if pri pri -1000))))
  11862. (defun org-get-priority (s)
  11863. "Find priority cookie and return priority."
  11864. (if (functionp org-get-priority-function)
  11865. (funcall org-get-priority-function)
  11866. (save-match-data
  11867. (if (not (string-match org-priority-regexp s))
  11868. (* 1000 (- org-lowest-priority org-default-priority))
  11869. (* 1000 (- org-lowest-priority
  11870. (string-to-char (match-string 2 s))))))))
  11871. ;;;; Tags
  11872. (defvar org-agenda-archives-mode)
  11873. (defvar org-map-continue-from nil
  11874. "Position from where mapping should continue.
  11875. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  11876. (defvar org-scanner-tags nil
  11877. "The current tag list while the tags scanner is running.")
  11878. (defvar org-trust-scanner-tags nil
  11879. "Should `org-get-tags-at' use the tags for the scanner.
  11880. This is for internal dynamical scoping only.
  11881. When this is non-nil, the function `org-get-tags-at' will return the value
  11882. of `org-scanner-tags' instead of building the list by itself. This
  11883. can lead to large speed-ups when the tags scanner is used in a file with
  11884. many entries, and when the list of tags is retrieved, for example to
  11885. obtain a list of properties. Building the tags list for each entry in such
  11886. a file becomes an N^2 operation - but with this variable set, it scales
  11887. as N.")
  11888. (defun org-scan-tags (action matcher todo-only &optional start-level)
  11889. "Scan headline tags with inheritance and produce output ACTION.
  11890. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  11891. or `agenda' to produce an entry list for an agenda view. It can also be
  11892. a Lisp form or a function that should be called at each matched headline, in
  11893. this case the return value is a list of all return values from these calls.
  11894. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  11895. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  11896. only lines with a not-done TODO keyword are included in the output.
  11897. This should be the same variable that was scoped into
  11898. and set by `org-make-tags-matcher' when it constructed MATCHER.
  11899. START-LEVEL can be a string with asterisks, reducing the scope to
  11900. headlines matching this string."
  11901. (require 'org-agenda)
  11902. (let* ((re (concat "^"
  11903. (if start-level
  11904. ;; Get the correct level to match
  11905. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  11906. org-outline-regexp)
  11907. " *\\(\\<\\("
  11908. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  11909. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  11910. (props (list 'face 'default
  11911. 'done-face 'org-agenda-done
  11912. 'undone-face 'default
  11913. 'mouse-face 'highlight
  11914. 'org-not-done-regexp org-not-done-regexp
  11915. 'org-todo-regexp org-todo-regexp
  11916. 'org-complex-heading-regexp org-complex-heading-regexp
  11917. 'help-echo
  11918. (format "mouse-2 or RET jump to org file %s"
  11919. (abbreviate-file-name
  11920. (or (buffer-file-name (buffer-base-buffer))
  11921. (buffer-name (buffer-base-buffer)))))))
  11922. (case-fold-search nil)
  11923. (org-map-continue-from nil)
  11924. lspos tags tags-list
  11925. (tags-alist (list (cons 0 org-file-tags)))
  11926. (llast 0) rtn rtn1 level category i txt
  11927. todo marker entry priority)
  11928. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  11929. (setq action (list 'lambda nil action)))
  11930. (save-excursion
  11931. (goto-char (point-min))
  11932. (when (eq action 'sparse-tree)
  11933. (org-overview)
  11934. (org-remove-occur-highlights))
  11935. (while (re-search-forward re nil t)
  11936. (setq org-map-continue-from nil)
  11937. (catch :skip
  11938. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  11939. tags (if (match-end 4) (org-match-string-no-properties 4)))
  11940. (goto-char (setq lspos (match-beginning 0)))
  11941. (setq level (org-reduced-level (org-outline-level))
  11942. category (org-get-category))
  11943. (setq i llast llast level)
  11944. ;; remove tag lists from same and sublevels
  11945. (while (>= i level)
  11946. (when (setq entry (assoc i tags-alist))
  11947. (setq tags-alist (delete entry tags-alist)))
  11948. (setq i (1- i)))
  11949. ;; add the next tags
  11950. (when tags
  11951. (setq tags (org-split-string tags ":")
  11952. tags-alist
  11953. (cons (cons level tags) tags-alist)))
  11954. ;; compile tags for current headline
  11955. (setq tags-list
  11956. (if org-use-tag-inheritance
  11957. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  11958. tags)
  11959. org-scanner-tags tags-list)
  11960. (when org-use-tag-inheritance
  11961. (setcdr (car tags-alist)
  11962. (mapcar (lambda (x)
  11963. (setq x (copy-sequence x))
  11964. (org-add-prop-inherited x))
  11965. (cdar tags-alist))))
  11966. (when (and tags org-use-tag-inheritance
  11967. (or (not (eq t org-use-tag-inheritance))
  11968. org-tags-exclude-from-inheritance))
  11969. ;; selective inheritance, remove uninherited ones
  11970. (setcdr (car tags-alist)
  11971. (org-remove-uninherited-tags (cdar tags-alist))))
  11972. (when (and
  11973. ;; eval matcher only when the todo condition is OK
  11974. (and (or (not todo-only) (member todo org-not-done-keywords))
  11975. (let ((case-fold-search t) (org-trust-scanner-tags t))
  11976. (eval matcher)))
  11977. ;; Call the skipper, but return t if it does not skip,
  11978. ;; so that the `and' form continues evaluating
  11979. (progn
  11980. (unless (eq action 'sparse-tree) (org-agenda-skip))
  11981. t)
  11982. ;; Check if timestamps are deselecting this entry
  11983. (or (not todo-only)
  11984. (and (member todo org-not-done-keywords)
  11985. (or (not org-agenda-tags-todo-honor-ignore-options)
  11986. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  11987. ;; Extra check for the archive tag
  11988. ;; FIXME: Does the skipper already do this????
  11989. (or
  11990. (not (member org-archive-tag tags-list))
  11991. ;; we have an archive tag, should we use this anyway?
  11992. (or (not org-agenda-skip-archived-trees)
  11993. (and (eq action 'agenda) org-agenda-archives-mode))))
  11994. ;; select this headline
  11995. (cond
  11996. ((eq action 'sparse-tree)
  11997. (and org-highlight-sparse-tree-matches
  11998. (org-get-heading) (match-end 0)
  11999. (org-highlight-new-match
  12000. (match-beginning 1) (match-end 1)))
  12001. (org-show-context 'tags-tree))
  12002. ((eq action 'agenda)
  12003. (setq txt (org-agenda-format-item
  12004. ""
  12005. (concat
  12006. (if (eq org-tags-match-list-sublevels 'indented)
  12007. (make-string (1- level) ?.) "")
  12008. (org-get-heading))
  12009. level category
  12010. tags-list)
  12011. priority (org-get-priority txt))
  12012. (goto-char lspos)
  12013. (setq marker (org-agenda-new-marker))
  12014. (org-add-props txt props
  12015. 'org-marker marker 'org-hd-marker marker 'org-category category
  12016. 'todo-state todo
  12017. 'priority priority 'type "tagsmatch")
  12018. (push txt rtn))
  12019. ((functionp action)
  12020. (setq org-map-continue-from nil)
  12021. (save-excursion
  12022. (setq rtn1 (funcall action))
  12023. (push rtn1 rtn)))
  12024. (t (error "Invalid action")))
  12025. ;; if we are to skip sublevels, jump to end of subtree
  12026. (unless org-tags-match-list-sublevels
  12027. (org-end-of-subtree t)
  12028. (backward-char 1))))
  12029. ;; Get the correct position from where to continue
  12030. (if org-map-continue-from
  12031. (goto-char org-map-continue-from)
  12032. (and (= (point) lspos) (end-of-line 1)))))
  12033. (when (and (eq action 'sparse-tree)
  12034. (not org-sparse-tree-open-archived-trees))
  12035. (org-hide-archived-subtrees (point-min) (point-max)))
  12036. (nreverse rtn)))
  12037. (defun org-remove-uninherited-tags (tags)
  12038. "Remove all tags that are not inherited from the list TAGS."
  12039. (cond
  12040. ((eq org-use-tag-inheritance t)
  12041. (if org-tags-exclude-from-inheritance
  12042. (org-delete-all org-tags-exclude-from-inheritance tags)
  12043. tags))
  12044. ((not org-use-tag-inheritance) nil)
  12045. ((stringp org-use-tag-inheritance)
  12046. (delq nil (mapcar
  12047. (lambda (x)
  12048. (if (and (string-match org-use-tag-inheritance x)
  12049. (not (member x org-tags-exclude-from-inheritance)))
  12050. x nil))
  12051. tags)))
  12052. ((listp org-use-tag-inheritance)
  12053. (delq nil (mapcar
  12054. (lambda (x)
  12055. (if (member x org-use-tag-inheritance) x nil))
  12056. tags)))))
  12057. (defun org-match-sparse-tree (&optional todo-only match)
  12058. "Create a sparse tree according to tags string MATCH.
  12059. MATCH can contain positive and negative selection of tags, like
  12060. \"+WORK+URGENT-WITHBOSS\".
  12061. If optional argument TODO-ONLY is non-nil, only select lines that are
  12062. also TODO lines."
  12063. (interactive "P")
  12064. (org-agenda-prepare-buffers (list (current-buffer)))
  12065. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  12066. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  12067. (defvar org-cached-props nil)
  12068. (defun org-cached-entry-get (pom property)
  12069. (if (or (eq t org-use-property-inheritance)
  12070. (and (stringp org-use-property-inheritance)
  12071. (string-match org-use-property-inheritance property))
  12072. (and (listp org-use-property-inheritance)
  12073. (member property org-use-property-inheritance)))
  12074. ;; Caching is not possible, check it directly
  12075. (org-entry-get pom property 'inherit)
  12076. ;; Get all properties, so that we can do complicated checks easily
  12077. (cdr (assoc property (or org-cached-props
  12078. (setq org-cached-props
  12079. (org-entry-properties pom)))))))
  12080. (defun org-global-tags-completion-table (&optional files)
  12081. "Return the list of all tags in all agenda buffer/files.
  12082. Optional FILES argument is a list of files which can be used
  12083. instead of the agenda files."
  12084. (save-excursion
  12085. (org-uniquify
  12086. (delq nil
  12087. (apply 'append
  12088. (mapcar
  12089. (lambda (file)
  12090. (set-buffer (find-file-noselect file))
  12091. (append (org-get-buffer-tags)
  12092. (mapcar (lambda (x) (if (stringp (car-safe x))
  12093. (list (car-safe x)) nil))
  12094. org-tag-alist)))
  12095. (if (and files (car files))
  12096. files
  12097. (org-agenda-files))))))))
  12098. (defun org-make-tags-matcher (match)
  12099. "Create the TAGS/TODO matcher form for the selection string MATCH.
  12100. The variable `todo-only' is scoped dynamically into this function.
  12101. It will be set to t if the matcher restricts matching to TODO entries,
  12102. otherwise will not be touched.
  12103. Returns a cons of the selection string MATCH and the constructed
  12104. lisp form implementing the matcher. The matcher is to be evaluated
  12105. at an Org entry, with point on the headline, and returns t if the
  12106. entry matches the selection string MATCH. The returned lisp form
  12107. references two variables with information about the entry, which
  12108. must be bound around the form's evaluation: todo, the TODO keyword
  12109. at the entry (or nil of none); and tags-list, the list of all tags
  12110. at the entry including inherited ones. Additionally, the category
  12111. of the entry (if any) must be specified as the text property
  12112. 'org-category on the headline.
  12113. See also `org-scan-tags'.
  12114. "
  12115. (declare (special todo-only))
  12116. (unless (boundp 'todo-only)
  12117. (error "org-make-tags-matcher expects todo-only to be scoped in"))
  12118. (unless match
  12119. ;; Get a new match request, with completion
  12120. (let ((org-last-tags-completion-table
  12121. (org-global-tags-completion-table)))
  12122. (setq match (org-completing-read-no-i
  12123. "Match: " 'org-tags-completion-function nil nil nil
  12124. 'org-tags-history))))
  12125. ;; Parse the string and create a lisp form
  12126. (let ((match0 match)
  12127. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  12128. minus tag mm
  12129. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  12130. orterms term orlist re-p str-p level-p level-op time-p
  12131. prop-p pn pv po gv rest)
  12132. (if (string-match "/+" match)
  12133. ;; match contains also a todo-matching request
  12134. (progn
  12135. (setq tagsmatch (substring match 0 (match-beginning 0))
  12136. todomatch (substring match (match-end 0)))
  12137. (if (string-match "^!" todomatch)
  12138. (setq todo-only t todomatch (substring todomatch 1)))
  12139. (if (string-match "^\\s-*$" todomatch)
  12140. (setq todomatch nil)))
  12141. ;; only matching tags
  12142. (setq tagsmatch match todomatch nil))
  12143. ;; Make the tags matcher
  12144. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12145. (setq tagsmatcher t)
  12146. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12147. (while (setq term (pop orterms))
  12148. (while (and (equal (substring term -1) "\\") orterms)
  12149. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12150. (while (string-match re term)
  12151. (setq rest (substring term (match-end 0))
  12152. minus (and (match-end 1)
  12153. (equal (match-string 1 term) "-"))
  12154. tag (save-match-data (replace-regexp-in-string
  12155. "\\\\-" "-"
  12156. (match-string 2 term)))
  12157. re-p (equal (string-to-char tag) ?{)
  12158. level-p (match-end 4)
  12159. prop-p (match-end 5)
  12160. mm (cond
  12161. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12162. (level-p
  12163. (setq level-op (org-op-to-function (match-string 3 term)))
  12164. `(,level-op level ,(string-to-number
  12165. (match-string 4 term))))
  12166. (prop-p
  12167. (setq pn (match-string 5 term)
  12168. po (match-string 6 term)
  12169. pv (match-string 7 term)
  12170. re-p (equal (string-to-char pv) ?{)
  12171. str-p (equal (string-to-char pv) ?\")
  12172. time-p (save-match-data
  12173. (string-match "^\"[[<].*[]>]\"$" pv))
  12174. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12175. (if time-p (setq pv (org-matcher-time pv)))
  12176. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12177. (cond
  12178. ((equal pn "CATEGORY")
  12179. (setq gv '(get-text-property (point) 'org-category)))
  12180. ((equal pn "TODO")
  12181. (setq gv 'todo))
  12182. (t
  12183. (setq gv `(org-cached-entry-get nil ,pn))))
  12184. (if re-p
  12185. (if (eq po 'org<>)
  12186. `(not (string-match ,pv (or ,gv "")))
  12187. `(string-match ,pv (or ,gv "")))
  12188. (if str-p
  12189. `(,po (or ,gv "") ,pv)
  12190. `(,po (string-to-number (or ,gv ""))
  12191. ,(string-to-number pv) ))))
  12192. (t `(member ,tag tags-list)))
  12193. mm (if minus (list 'not mm) mm)
  12194. term rest)
  12195. (push mm tagsmatcher))
  12196. (push (if (> (length tagsmatcher) 1)
  12197. (cons 'and tagsmatcher)
  12198. (car tagsmatcher))
  12199. orlist)
  12200. (setq tagsmatcher nil))
  12201. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12202. (setq tagsmatcher
  12203. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12204. ;; Make the todo matcher
  12205. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12206. (setq todomatcher t)
  12207. (setq orterms (org-split-string todomatch "|") orlist nil)
  12208. (while (setq term (pop orterms))
  12209. (while (string-match re term)
  12210. (setq minus (and (match-end 1)
  12211. (equal (match-string 1 term) "-"))
  12212. kwd (match-string 2 term)
  12213. re-p (equal (string-to-char kwd) ?{)
  12214. term (substring term (match-end 0))
  12215. mm (if re-p
  12216. `(string-match ,(substring kwd 1 -1) todo)
  12217. (list 'equal 'todo kwd))
  12218. mm (if minus (list 'not mm) mm))
  12219. (push mm todomatcher))
  12220. (push (if (> (length todomatcher) 1)
  12221. (cons 'and todomatcher)
  12222. (car todomatcher))
  12223. orlist)
  12224. (setq todomatcher nil))
  12225. (setq todomatcher (if (> (length orlist) 1)
  12226. (cons 'or orlist) (car orlist))))
  12227. ;; Return the string and lisp forms of the matcher
  12228. (setq matcher (if todomatcher
  12229. (list 'and tagsmatcher todomatcher)
  12230. tagsmatcher))
  12231. (when todo-only
  12232. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12233. matcher)))
  12234. (cons match0 matcher)))
  12235. (defun org-op-to-function (op &optional stringp)
  12236. "Turn an operator into the appropriate function."
  12237. (setq op
  12238. (cond
  12239. ((equal op "<" ) '(< string< org-time<))
  12240. ((equal op ">" ) '(> org-string> org-time>))
  12241. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12242. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12243. ((member op '("=" "==")) '(= string= org-time=))
  12244. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12245. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12246. (defun org<> (a b) (not (= a b)))
  12247. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12248. (defun org-string>= (a b) (not (string< a b)))
  12249. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12250. (defun org-string<> (a b) (not (string= a b)))
  12251. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  12252. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  12253. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  12254. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  12255. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  12256. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  12257. (defun org-2ft (s)
  12258. "Convert S to a floating point time.
  12259. If S is already a number, just return it. If it is a string, parse
  12260. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  12261. (cond
  12262. ((numberp s) s)
  12263. ((stringp s)
  12264. (condition-case nil
  12265. (float-time (apply 'encode-time (org-parse-time-string s)))
  12266. (error 0.)))
  12267. (t 0.)))
  12268. (defun org-time-today ()
  12269. "Time in seconds today at 0:00.
  12270. Returns the float number of seconds since the beginning of the
  12271. epoch to the beginning of today (00:00)."
  12272. (float-time (apply 'encode-time
  12273. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  12274. (defun org-matcher-time (s)
  12275. "Interpret a time comparison value."
  12276. (save-match-data
  12277. (cond
  12278. ((string= s "<now>") (float-time))
  12279. ((string= s "<today>") (org-time-today))
  12280. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  12281. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  12282. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  12283. (+ (org-time-today)
  12284. (* (string-to-number (match-string 1 s))
  12285. (cdr (assoc (match-string 2 s)
  12286. '(("d" . 86400.0) ("w" . 604800.0)
  12287. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  12288. (t (org-2ft s)))))
  12289. (defun org-match-any-p (re list)
  12290. "Does re match any element of list?"
  12291. (setq list (mapcar (lambda (x) (string-match re x)) list))
  12292. (delq nil list))
  12293. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  12294. (defvar org-tags-overlay (make-overlay 1 1))
  12295. (org-detach-overlay org-tags-overlay)
  12296. (defun org-get-local-tags-at (&optional pos)
  12297. "Get a list of tags defined in the current headline."
  12298. (org-get-tags-at pos 'local))
  12299. (defun org-get-local-tags ()
  12300. "Get a list of tags defined in the current headline."
  12301. (org-get-tags-at nil 'local))
  12302. (defun org-get-tags-at (&optional pos local)
  12303. "Get a list of all headline tags applicable at POS.
  12304. POS defaults to point. If tags are inherited, the list contains
  12305. the targets in the same sequence as the headlines appear, i.e.
  12306. the tags of the current headline come last.
  12307. When LOCAL is non-nil, only return tags from the current headline,
  12308. ignore inherited ones."
  12309. (interactive)
  12310. (if (and org-trust-scanner-tags
  12311. (or (not pos) (equal pos (point)))
  12312. (not local))
  12313. org-scanner-tags
  12314. (let (tags ltags lastpos parent)
  12315. (save-excursion
  12316. (save-restriction
  12317. (widen)
  12318. (goto-char (or pos (point)))
  12319. (save-match-data
  12320. (catch 'done
  12321. (condition-case nil
  12322. (progn
  12323. (org-back-to-heading t)
  12324. (while (not (equal lastpos (point)))
  12325. (setq lastpos (point))
  12326. (when (looking-at
  12327. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  12328. (setq ltags (org-split-string
  12329. (org-match-string-no-properties 1) ":"))
  12330. (when parent
  12331. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  12332. (setq tags (append
  12333. (if parent
  12334. (org-remove-uninherited-tags ltags)
  12335. ltags)
  12336. tags)))
  12337. (or org-use-tag-inheritance (throw 'done t))
  12338. (if local (throw 'done t))
  12339. (or (org-up-heading-safe) (error nil))
  12340. (setq parent t)))
  12341. (error nil)))))
  12342. (if local
  12343. tags
  12344. (append (org-remove-uninherited-tags org-file-tags) tags))))))
  12345. (defun org-add-prop-inherited (s)
  12346. (add-text-properties 0 (length s) '(inherited t) s)
  12347. s)
  12348. (defun org-toggle-tag (tag &optional onoff)
  12349. "Toggle the tag TAG for the current line.
  12350. If ONOFF is `on' or `off', don't toggle but set to this state."
  12351. (let (res current)
  12352. (save-excursion
  12353. (org-back-to-heading t)
  12354. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  12355. (point-at-eol) t)
  12356. (progn
  12357. (setq current (match-string 1))
  12358. (replace-match ""))
  12359. (setq current ""))
  12360. (setq current (nreverse (org-split-string current ":")))
  12361. (cond
  12362. ((eq onoff 'on)
  12363. (setq res t)
  12364. (or (member tag current) (push tag current)))
  12365. ((eq onoff 'off)
  12366. (or (not (member tag current)) (setq current (delete tag current))))
  12367. (t (if (member tag current)
  12368. (setq current (delete tag current))
  12369. (setq res t)
  12370. (push tag current))))
  12371. (end-of-line 1)
  12372. (if current
  12373. (progn
  12374. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  12375. (org-set-tags nil t))
  12376. (delete-horizontal-space))
  12377. (run-hooks 'org-after-tags-change-hook))
  12378. res))
  12379. (defun org-align-tags-here (to-col)
  12380. ;; Assumes that this is a headline
  12381. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  12382. (beginning-of-line 1)
  12383. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12384. (< pos (match-beginning 2)))
  12385. (progn
  12386. (setq tags-l (- (match-end 2) (match-beginning 2)))
  12387. (goto-char (match-beginning 1))
  12388. (insert " ")
  12389. (delete-region (point) (1+ (match-beginning 2)))
  12390. (setq ncol (max (current-column)
  12391. (1+ col)
  12392. (if (> to-col 0)
  12393. to-col
  12394. (- (abs to-col) tags-l))))
  12395. (setq p (point))
  12396. (insert (make-string (- ncol (current-column)) ?\ ))
  12397. (setq ncol (current-column))
  12398. (when indent-tabs-mode (tabify p (point-at-eol)))
  12399. (org-move-to-column (min ncol col) t))
  12400. (goto-char pos))))
  12401. (defun org-set-tags-command (&optional arg just-align)
  12402. "Call the set-tags command for the current entry."
  12403. (interactive "P")
  12404. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  12405. (org-set-tags arg just-align)
  12406. (save-excursion
  12407. (org-back-to-heading t)
  12408. (org-set-tags arg just-align))))
  12409. (defun org-set-tags-to (data)
  12410. "Set the tags of the current entry to DATA, replacing the current tags.
  12411. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  12412. If DATA is nil or the empty string, any tags will be removed."
  12413. (interactive "sTags: ")
  12414. (setq data
  12415. (cond
  12416. ((eq data nil) "")
  12417. ((equal data "") "")
  12418. ((stringp data)
  12419. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  12420. ":"))
  12421. ((listp data)
  12422. (concat ":" (mapconcat 'identity data ":") ":"))))
  12423. (when data
  12424. (save-excursion
  12425. (org-back-to-heading t)
  12426. (when (looking-at org-complex-heading-regexp)
  12427. (if (match-end 5)
  12428. (progn
  12429. (goto-char (match-beginning 5))
  12430. (insert data)
  12431. (delete-region (point) (point-at-eol))
  12432. (org-set-tags nil 'align))
  12433. (goto-char (point-at-eol))
  12434. (insert " " data)
  12435. (org-set-tags nil 'align)))
  12436. (beginning-of-line 1)
  12437. (if (looking-at ".*?\\([ \t]+\\)$")
  12438. (delete-region (match-beginning 1) (match-end 1))))))
  12439. (defun org-align-all-tags ()
  12440. "Align the tags i all headings."
  12441. (interactive)
  12442. (save-excursion
  12443. (or (ignore-errors (org-back-to-heading t))
  12444. (outline-next-heading))
  12445. (if (org-at-heading-p)
  12446. (org-set-tags t)
  12447. (message "No headings"))))
  12448. (defvar org-indent-indentation-per-level)
  12449. (defun org-set-tags (&optional arg just-align)
  12450. "Set the tags for the current headline.
  12451. With prefix ARG, realign all tags in headings in the current buffer."
  12452. (interactive "P")
  12453. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12454. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12455. 'region-start-level 'region))
  12456. org-loop-over-headlines-in-active-region)
  12457. (org-map-entries
  12458. ;; We don't use ARG and JUST-ALIGN here these args are not
  12459. ;; useful when looping over headlines
  12460. `(org-set-tags)
  12461. org-loop-over-headlines-in-active-region
  12462. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12463. (let* ((re org-outline-regexp-bol)
  12464. (current (unless arg (org-get-tags-string)))
  12465. (col (current-column))
  12466. (org-setting-tags t)
  12467. table current-tags inherited-tags ; computed below when needed
  12468. tags p0 c0 c1 rpl di tc level)
  12469. (if arg
  12470. (save-excursion
  12471. (goto-char (point-min))
  12472. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  12473. (while (re-search-forward re nil t)
  12474. (org-set-tags nil t)
  12475. (end-of-line 1)))
  12476. (message "All tags realigned to column %d" org-tags-column))
  12477. (if just-align
  12478. (setq tags current)
  12479. ;; Get a new set of tags from the user
  12480. (save-excursion
  12481. (setq table (append org-tag-persistent-alist
  12482. (or org-tag-alist (org-get-buffer-tags))
  12483. (and
  12484. org-complete-tags-always-offer-all-agenda-tags
  12485. (org-global-tags-completion-table
  12486. (org-agenda-files))))
  12487. org-last-tags-completion-table table
  12488. current-tags (org-split-string current ":")
  12489. inherited-tags (nreverse
  12490. (nthcdr (length current-tags)
  12491. (nreverse (org-get-tags-at))))
  12492. tags
  12493. (if (or (eq t org-use-fast-tag-selection)
  12494. (and org-use-fast-tag-selection
  12495. (delq nil (mapcar 'cdr table))))
  12496. (org-fast-tag-selection
  12497. current-tags inherited-tags table
  12498. (if org-fast-tag-selection-include-todo
  12499. org-todo-key-alist))
  12500. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  12501. (org-trim
  12502. (org-icompleting-read "Tags: "
  12503. 'org-tags-completion-function
  12504. nil nil current 'org-tags-history))))))
  12505. (while (string-match "[-+&]+" tags)
  12506. ;; No boolean logic, just a list
  12507. (setq tags (replace-match ":" t t tags))))
  12508. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  12509. (if org-tags-sort-function
  12510. (setq tags (mapconcat 'identity
  12511. (sort (org-split-string
  12512. tags (org-re "[^[:alnum:]_@#%]+"))
  12513. org-tags-sort-function) ":")))
  12514. (if (string-match "\\`[\t ]*\\'" tags)
  12515. (setq tags "")
  12516. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  12517. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  12518. ;; Insert new tags at the correct column
  12519. (beginning-of-line 1)
  12520. (setq level (or (and (looking-at org-outline-regexp)
  12521. (- (match-end 0) (point) 1))
  12522. 1))
  12523. (cond
  12524. ((and (equal current "") (equal tags "")))
  12525. ((re-search-forward
  12526. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  12527. (point-at-eol) t)
  12528. (if (equal tags "")
  12529. (setq rpl "")
  12530. (goto-char (match-beginning 0))
  12531. (setq c0 (current-column)
  12532. ;; compute offset for the case of org-indent-mode active
  12533. di (if org-indent-mode
  12534. (* (1- org-indent-indentation-per-level) (1- level))
  12535. 0)
  12536. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  12537. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  12538. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  12539. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  12540. (replace-match rpl t t)
  12541. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  12542. tags)
  12543. (t (error "Tags alignment failed")))
  12544. (org-move-to-column col)
  12545. (unless just-align
  12546. (run-hooks 'org-after-tags-change-hook))))))
  12547. (defun org-change-tag-in-region (beg end tag off)
  12548. "Add or remove TAG for each entry in the region.
  12549. This works in the agenda, and also in an org-mode buffer."
  12550. (interactive
  12551. (list (region-beginning) (region-end)
  12552. (let ((org-last-tags-completion-table
  12553. (if (derived-mode-p 'org-mode)
  12554. (org-get-buffer-tags)
  12555. (org-global-tags-completion-table))))
  12556. (org-icompleting-read
  12557. "Tag: " 'org-tags-completion-function nil nil nil
  12558. 'org-tags-history))
  12559. (progn
  12560. (message "[s]et or [r]emove? ")
  12561. (equal (read-char-exclusive) ?r))))
  12562. (if (fboundp 'deactivate-mark) (deactivate-mark))
  12563. (let ((agendap (equal major-mode 'org-agenda-mode))
  12564. l1 l2 m buf pos newhead (cnt 0))
  12565. (goto-char end)
  12566. (setq l2 (1- (org-current-line)))
  12567. (goto-char beg)
  12568. (setq l1 (org-current-line))
  12569. (loop for l from l1 to l2 do
  12570. (org-goto-line l)
  12571. (setq m (get-text-property (point) 'org-hd-marker))
  12572. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  12573. (and agendap m))
  12574. (setq buf (if agendap (marker-buffer m) (current-buffer))
  12575. pos (if agendap m (point)))
  12576. (with-current-buffer buf
  12577. (save-excursion
  12578. (save-restriction
  12579. (goto-char pos)
  12580. (setq cnt (1+ cnt))
  12581. (org-toggle-tag tag (if off 'off 'on))
  12582. (setq newhead (org-get-heading)))))
  12583. (and agendap (org-agenda-change-all-lines newhead m))))
  12584. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  12585. (defun org-tags-completion-function (string predicate &optional flag)
  12586. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  12587. (confirm (lambda (x) (stringp (car x)))))
  12588. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  12589. (setq s1 (match-string 1 string)
  12590. s2 (match-string 2 string))
  12591. (setq s1 "" s2 string))
  12592. (cond
  12593. ((eq flag nil)
  12594. ;; try completion
  12595. (setq rtn (try-completion s2 ctable confirm))
  12596. (if (stringp rtn)
  12597. (setq rtn
  12598. (concat s1 s2 (substring rtn (length s2))
  12599. (if (and org-add-colon-after-tag-completion
  12600. (assoc rtn ctable))
  12601. ":" ""))))
  12602. rtn)
  12603. ((eq flag t)
  12604. ;; all-completions
  12605. (all-completions s2 ctable confirm)
  12606. )
  12607. ((eq flag 'lambda)
  12608. ;; exact match?
  12609. (assoc s2 ctable)))
  12610. ))
  12611. (defun org-fast-tag-insert (kwd tags face &optional end)
  12612. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  12613. (insert (format "%-12s" (concat kwd ":"))
  12614. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  12615. (or end "")))
  12616. (defun org-fast-tag-show-exit (flag)
  12617. (save-excursion
  12618. (org-goto-line 3)
  12619. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  12620. (replace-match ""))
  12621. (when flag
  12622. (end-of-line 1)
  12623. (org-move-to-column (- (window-width) 19) t)
  12624. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  12625. (defun org-set-current-tags-overlay (current prefix)
  12626. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  12627. (if (featurep 'xemacs)
  12628. (org-overlay-display org-tags-overlay (concat prefix s)
  12629. 'secondary-selection)
  12630. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  12631. (org-overlay-display org-tags-overlay (concat prefix s)))))
  12632. (defvar org-last-tag-selection-key nil)
  12633. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  12634. "Fast tag selection with single keys.
  12635. CURRENT is the current list of tags in the headline, INHERITED is the
  12636. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  12637. possibly with grouping information. TODO-TABLE is a similar table with
  12638. TODO keywords, should these have keys assigned to them.
  12639. If the keys are nil, a-z are automatically assigned.
  12640. Returns the new tags string, or nil to not change the current settings."
  12641. (let* ((fulltable (append table todo-table))
  12642. (maxlen (apply 'max (mapcar
  12643. (lambda (x)
  12644. (if (stringp (car x)) (string-width (car x)) 0))
  12645. fulltable)))
  12646. (buf (current-buffer))
  12647. (expert (eq org-fast-tag-selection-single-key 'expert))
  12648. (buffer-tags nil)
  12649. (fwidth (+ maxlen 3 1 3))
  12650. (ncol (/ (- (window-width) 4) fwidth))
  12651. (i-face 'org-done)
  12652. (c-face 'org-todo)
  12653. tg cnt e c char c1 c2 ntable tbl rtn
  12654. ov-start ov-end ov-prefix
  12655. (exit-after-next org-fast-tag-selection-single-key)
  12656. (done-keywords org-done-keywords)
  12657. groups ingroup)
  12658. (save-excursion
  12659. (beginning-of-line 1)
  12660. (if (looking-at
  12661. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12662. (setq ov-start (match-beginning 1)
  12663. ov-end (match-end 1)
  12664. ov-prefix "")
  12665. (setq ov-start (1- (point-at-eol))
  12666. ov-end (1+ ov-start))
  12667. (skip-chars-forward "^\n\r")
  12668. (setq ov-prefix
  12669. (concat
  12670. (buffer-substring (1- (point)) (point))
  12671. (if (> (current-column) org-tags-column)
  12672. " "
  12673. (make-string (- org-tags-column (current-column)) ?\ ))))))
  12674. (move-overlay org-tags-overlay ov-start ov-end)
  12675. (save-window-excursion
  12676. (if expert
  12677. (set-buffer (get-buffer-create " *Org tags*"))
  12678. (delete-other-windows)
  12679. (split-window-vertically)
  12680. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  12681. (erase-buffer)
  12682. (org-set-local 'org-done-keywords done-keywords)
  12683. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  12684. (org-fast-tag-insert "Current" current c-face "\n\n")
  12685. (org-fast-tag-show-exit exit-after-next)
  12686. (org-set-current-tags-overlay current ov-prefix)
  12687. (setq tbl fulltable char ?a cnt 0)
  12688. (while (setq e (pop tbl))
  12689. (cond
  12690. ((equal (car e) :startgroup)
  12691. (push '() groups) (setq ingroup t)
  12692. (when (not (= cnt 0))
  12693. (setq cnt 0)
  12694. (insert "\n"))
  12695. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  12696. ((equal (car e) :endgroup)
  12697. (setq ingroup nil cnt 0)
  12698. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  12699. ((equal e '(:newline))
  12700. (when (not (= cnt 0))
  12701. (setq cnt 0)
  12702. (insert "\n")
  12703. (setq e (car tbl))
  12704. (while (equal (car tbl) '(:newline))
  12705. (insert "\n")
  12706. (setq tbl (cdr tbl)))))
  12707. (t
  12708. (setq tg (copy-sequence (car e)) c2 nil)
  12709. (if (cdr e)
  12710. (setq c (cdr e))
  12711. ;; automatically assign a character.
  12712. (setq c1 (string-to-char
  12713. (downcase (substring
  12714. tg (if (= (string-to-char tg) ?@) 1 0)))))
  12715. (if (or (rassoc c1 ntable) (rassoc c1 table))
  12716. (while (or (rassoc char ntable) (rassoc char table))
  12717. (setq char (1+ char)))
  12718. (setq c2 c1))
  12719. (setq c (or c2 char)))
  12720. (if ingroup (push tg (car groups)))
  12721. (setq tg (org-add-props tg nil 'face
  12722. (cond
  12723. ((not (assoc tg table))
  12724. (org-get-todo-face tg))
  12725. ((member tg current) c-face)
  12726. ((member tg inherited) i-face))))
  12727. (if (and (= cnt 0) (not ingroup)) (insert " "))
  12728. (insert "[" c "] " tg (make-string
  12729. (- fwidth 4 (length tg)) ?\ ))
  12730. (push (cons tg c) ntable)
  12731. (when (= (setq cnt (1+ cnt)) ncol)
  12732. (insert "\n")
  12733. (if ingroup (insert " "))
  12734. (setq cnt 0)))))
  12735. (setq ntable (nreverse ntable))
  12736. (insert "\n")
  12737. (goto-char (point-min))
  12738. (if (not expert) (org-fit-window-to-buffer))
  12739. (setq rtn
  12740. (catch 'exit
  12741. (while t
  12742. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  12743. (if (not groups) "no " "")
  12744. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  12745. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  12746. (setq org-last-tag-selection-key c)
  12747. (cond
  12748. ((= c ?\r) (throw 'exit t))
  12749. ((= c ?!)
  12750. (setq groups (not groups))
  12751. (goto-char (point-min))
  12752. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  12753. ((= c ?\C-c)
  12754. (if (not expert)
  12755. (org-fast-tag-show-exit
  12756. (setq exit-after-next (not exit-after-next)))
  12757. (setq expert nil)
  12758. (delete-other-windows)
  12759. (set-window-buffer (split-window-vertically) " *Org tags*")
  12760. (org-switch-to-buffer-other-window " *Org tags*")
  12761. (org-fit-window-to-buffer)))
  12762. ((or (= c ?\C-g)
  12763. (and (= c ?q) (not (rassoc c ntable))))
  12764. (org-detach-overlay org-tags-overlay)
  12765. (setq quit-flag t))
  12766. ((= c ?\ )
  12767. (setq current nil)
  12768. (if exit-after-next (setq exit-after-next 'now)))
  12769. ((= c ?\t)
  12770. (condition-case nil
  12771. (setq tg (org-icompleting-read
  12772. "Tag: "
  12773. (or buffer-tags
  12774. (with-current-buffer buf
  12775. (org-get-buffer-tags)))))
  12776. (quit (setq tg "")))
  12777. (when (string-match "\\S-" tg)
  12778. (add-to-list 'buffer-tags (list tg))
  12779. (if (member tg current)
  12780. (setq current (delete tg current))
  12781. (push tg current)))
  12782. (if exit-after-next (setq exit-after-next 'now)))
  12783. ((setq e (rassoc c todo-table) tg (car e))
  12784. (with-current-buffer buf
  12785. (save-excursion (org-todo tg)))
  12786. (if exit-after-next (setq exit-after-next 'now)))
  12787. ((setq e (rassoc c ntable) tg (car e))
  12788. (if (member tg current)
  12789. (setq current (delete tg current))
  12790. (loop for g in groups do
  12791. (if (member tg g)
  12792. (mapc (lambda (x)
  12793. (setq current (delete x current)))
  12794. g)))
  12795. (push tg current))
  12796. (if exit-after-next (setq exit-after-next 'now))))
  12797. ;; Create a sorted list
  12798. (setq current
  12799. (sort current
  12800. (lambda (a b)
  12801. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  12802. (if (eq exit-after-next 'now) (throw 'exit t))
  12803. (goto-char (point-min))
  12804. (beginning-of-line 2)
  12805. (delete-region (point) (point-at-eol))
  12806. (org-fast-tag-insert "Current" current c-face)
  12807. (org-set-current-tags-overlay current ov-prefix)
  12808. (while (re-search-forward
  12809. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  12810. (setq tg (match-string 1))
  12811. (add-text-properties
  12812. (match-beginning 1) (match-end 1)
  12813. (list 'face
  12814. (cond
  12815. ((member tg current) c-face)
  12816. ((member tg inherited) i-face)
  12817. (t (get-text-property (match-beginning 1) 'face))))))
  12818. (goto-char (point-min)))))
  12819. (org-detach-overlay org-tags-overlay)
  12820. (if rtn
  12821. (mapconcat 'identity current ":")
  12822. nil))))
  12823. (defun org-get-tags-string ()
  12824. "Get the TAGS string in the current headline."
  12825. (unless (org-at-heading-p t)
  12826. (error "Not on a heading"))
  12827. (save-excursion
  12828. (beginning-of-line 1)
  12829. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12830. (org-match-string-no-properties 1)
  12831. "")))
  12832. (defun org-get-tags ()
  12833. "Get the list of tags specified in the current headline."
  12834. (org-split-string (org-get-tags-string) ":"))
  12835. (defun org-get-buffer-tags ()
  12836. "Get a table of all tags used in the buffer, for completion."
  12837. (let (tags)
  12838. (save-excursion
  12839. (goto-char (point-min))
  12840. (while (re-search-forward
  12841. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  12842. (when (equal (char-after (point-at-bol 0)) ?*)
  12843. (mapc (lambda (x) (add-to-list 'tags x))
  12844. (org-split-string (org-match-string-no-properties 1) ":")))))
  12845. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  12846. (mapcar 'list tags)))
  12847. ;;;; The mapping API
  12848. (defun org-map-entries (func &optional match scope &rest skip)
  12849. "Call FUNC at each headline selected by MATCH in SCOPE.
  12850. FUNC is a function or a lisp form. The function will be called without
  12851. arguments, with the cursor positioned at the beginning of the headline.
  12852. The return values of all calls to the function will be collected and
  12853. returned as a list.
  12854. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  12855. does not need to preserve point. After evaluation, the cursor will be
  12856. moved to the end of the line (presumably of the headline of the
  12857. processed entry) and search continues from there. Under some
  12858. circumstances, this may not produce the wanted results. For example,
  12859. if you have removed (e.g. archived) the current (sub)tree it could
  12860. mean that the next entry will be skipped entirely. In such cases, you
  12861. can specify the position from where search should continue by making
  12862. FUNC set the variable `org-map-continue-from' to the desired buffer
  12863. position.
  12864. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  12865. Only headlines that are matched by this query will be considered during
  12866. the iteration. When MATCH is nil or t, all headlines will be
  12867. visited by the iteration.
  12868. SCOPE determines the scope of this command. It can be any of:
  12869. nil The current buffer, respecting the restriction if any
  12870. tree The subtree started with the entry at point
  12871. region The entries within the active region, if any
  12872. region-start-level
  12873. The entries within the active region, but only those at
  12874. the same level than the first one.
  12875. file The current buffer, without restriction
  12876. file-with-archives
  12877. The current buffer, and any archives associated with it
  12878. agenda All agenda files
  12879. agenda-with-archives
  12880. All agenda files with any archive files associated with them
  12881. \(file1 file2 ...)
  12882. If this is a list, all files in the list will be scanned
  12883. The remaining args are treated as settings for the skipping facilities of
  12884. the scanner. The following items can be given here:
  12885. archive skip trees with the archive tag.
  12886. comment skip trees with the COMMENT keyword
  12887. function or Emacs Lisp form:
  12888. will be used as value for `org-agenda-skip-function', so whenever
  12889. the function returns t, FUNC will not be called for that
  12890. entry and search will continue from the point where the
  12891. function leaves it.
  12892. If your function needs to retrieve the tags including inherited tags
  12893. at the *current* entry, you can use the value of the variable
  12894. `org-scanner-tags' which will be much faster than getting the value
  12895. with `org-get-tags-at'. If your function gets properties with
  12896. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  12897. to t around the call to `org-entry-properties' to get the same speedup.
  12898. Note that if your function moves around to retrieve tags and properties at
  12899. a *different* entry, you cannot use these techniques."
  12900. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  12901. (not (org-region-active-p)))
  12902. (let* ((org-agenda-archives-mode nil) ; just to make sure
  12903. (org-agenda-skip-archived-trees (memq 'archive skip))
  12904. (org-agenda-skip-comment-trees (memq 'comment skip))
  12905. (org-agenda-skip-function
  12906. (car (org-delete-all '(comment archive) skip)))
  12907. (org-tags-match-list-sublevels t)
  12908. (start-level (eq scope 'region-start-level))
  12909. matcher file res
  12910. org-todo-keywords-for-agenda
  12911. org-done-keywords-for-agenda
  12912. org-todo-keyword-alist-for-agenda
  12913. org-drawers-for-agenda
  12914. org-tag-alist-for-agenda
  12915. todo-only)
  12916. (cond
  12917. ((eq match t) (setq matcher t))
  12918. ((eq match nil) (setq matcher t))
  12919. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  12920. (save-excursion
  12921. (save-restriction
  12922. (cond ((eq scope 'tree)
  12923. (org-back-to-heading t)
  12924. (org-narrow-to-subtree)
  12925. (setq scope nil))
  12926. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  12927. (org-region-active-p))
  12928. ;; If needed, set start-level to a string like "2"
  12929. (when start-level
  12930. (save-excursion
  12931. (goto-char (region-beginning))
  12932. (unless (org-at-heading-p) (outline-next-heading))
  12933. (setq start-level (org-current-level))))
  12934. (narrow-to-region (region-beginning)
  12935. (save-excursion
  12936. (goto-char (region-end))
  12937. (unless (and (bolp) (org-at-heading-p))
  12938. (outline-next-heading))
  12939. (point)))
  12940. (setq scope nil)))
  12941. (if (not scope)
  12942. (progn
  12943. (org-agenda-prepare-buffers
  12944. (list (buffer-file-name (current-buffer))))
  12945. (setq res (org-scan-tags func matcher todo-only start-level)))
  12946. ;; Get the right scope
  12947. (cond
  12948. ((and scope (listp scope) (symbolp (car scope)))
  12949. (setq scope (eval scope)))
  12950. ((eq scope 'agenda)
  12951. (setq scope (org-agenda-files t)))
  12952. ((eq scope 'agenda-with-archives)
  12953. (setq scope (org-agenda-files t))
  12954. (setq scope (org-add-archive-files scope)))
  12955. ((eq scope 'file)
  12956. (setq scope (list (buffer-file-name))))
  12957. ((eq scope 'file-with-archives)
  12958. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  12959. (org-agenda-prepare-buffers scope)
  12960. (while (setq file (pop scope))
  12961. (with-current-buffer (org-find-base-buffer-visiting file)
  12962. (save-excursion
  12963. (save-restriction
  12964. (widen)
  12965. (goto-char (point-min))
  12966. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  12967. res)))
  12968. ;;;; Properties
  12969. ;;; Setting and retrieving properties
  12970. (defconst org-special-properties
  12971. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  12972. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
  12973. "The special properties valid in Org-mode.
  12974. These are properties that are not defined in the property drawer,
  12975. but in some other way.")
  12976. (defconst org-default-properties
  12977. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  12978. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  12979. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  12980. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  12981. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  12982. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  12983. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  12984. "Some properties that are used by Org-mode for various purposes.
  12985. Being in this list makes sure that they are offered for completion.")
  12986. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  12987. "Regular expression matching the first line of a property drawer.")
  12988. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  12989. "Regular expression matching the last line of a property drawer.")
  12990. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  12991. "Regular expression matching the first line of a property drawer.")
  12992. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  12993. "Regular expression matching the first line of a property drawer.")
  12994. (defconst org-property-drawer-re
  12995. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  12996. org-property-end-re "\\)\n?")
  12997. "Matches an entire property drawer.")
  12998. (defconst org-clock-drawer-re
  12999. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  13000. org-property-end-re "\\)\n?")
  13001. "Matches an entire clock drawer.")
  13002. (defsubst org-re-property (property)
  13003. "Return a regexp matching a PROPERTY line.
  13004. Match group 1 will be set to the value."
  13005. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
  13006. (defsubst org-re-property-keyword (property)
  13007. "Return a regexp matching a PROPERTY line, possibly with no
  13008. value for the property."
  13009. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)?"))
  13010. (defun org-property-action ()
  13011. "Do an action on properties."
  13012. (interactive)
  13013. (let (c)
  13014. (org-at-property-p)
  13015. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  13016. (setq c (read-char-exclusive))
  13017. (cond
  13018. ((equal c ?s)
  13019. (call-interactively 'org-set-property))
  13020. ((equal c ?d)
  13021. (call-interactively 'org-delete-property))
  13022. ((equal c ?D)
  13023. (call-interactively 'org-delete-property-globally))
  13024. ((equal c ?c)
  13025. (call-interactively 'org-compute-property-at-point))
  13026. (t (error "No such property action %c" c)))))
  13027. (defun org-inc-effort ()
  13028. "Increment the value of the effort property in the current entry."
  13029. (interactive)
  13030. (org-set-effort nil t))
  13031. (defun org-set-effort (&optional value increment)
  13032. "Set the effort property of the current entry.
  13033. With numerical prefix arg, use the nth allowed value, 0 stands for the
  13034. 10th allowed value.
  13035. When INCREMENT is non-nil, set the property to the next allowed value."
  13036. (interactive "P")
  13037. (if (equal value 0) (setq value 10))
  13038. (let* ((completion-ignore-case t)
  13039. (prop org-effort-property)
  13040. (cur (org-entry-get nil prop))
  13041. (allowed (org-property-get-allowed-values nil prop 'table))
  13042. (existing (mapcar 'list (org-property-values prop)))
  13043. rpl
  13044. (val (cond
  13045. ((stringp value) value)
  13046. ((and allowed (integerp value))
  13047. (or (car (nth (1- value) allowed))
  13048. (car (org-last allowed))))
  13049. ((and allowed increment)
  13050. (or (caadr (member (list cur) allowed))
  13051. (error "Allowed effort values are not set")))
  13052. (allowed
  13053. (message "Select 1-9,0, [RET%s]: %s"
  13054. (if cur (concat "=" cur) "")
  13055. (mapconcat 'car allowed " "))
  13056. (setq rpl (read-char-exclusive))
  13057. (if (equal rpl ?\r)
  13058. cur
  13059. (setq rpl (- rpl ?0))
  13060. (if (equal rpl 0) (setq rpl 10))
  13061. (if (and (> rpl 0) (<= rpl (length allowed)))
  13062. (car (nth (1- rpl) allowed))
  13063. (org-completing-read "Effort: " allowed nil))))
  13064. (t
  13065. (let (org-completion-use-ido org-completion-use-iswitchb)
  13066. (org-completing-read
  13067. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  13068. (concat "[" cur "]") "")
  13069. ": ")
  13070. existing nil nil "" nil cur))))))
  13071. (unless (equal (org-entry-get nil prop) val)
  13072. (org-entry-put nil prop val))
  13073. (message "%s is now %s" prop val)))
  13074. (defun org-at-property-p ()
  13075. "Is cursor inside a property drawer?"
  13076. (save-excursion
  13077. (beginning-of-line 1)
  13078. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  13079. (save-match-data ;; Used by calling procedures
  13080. (let ((p (point))
  13081. (range (unless (org-before-first-heading-p)
  13082. (org-get-property-block))))
  13083. (and range (<= (car range) p) (< p (cdr range))))))))
  13084. (defun org-get-property-block (&optional beg end force)
  13085. "Return the (beg . end) range of the body of the property drawer.
  13086. BEG and END are the beginning and end of the current subtree, or of
  13087. the part before the first headline. If they are not given, they will
  13088. be found. If the drawer does not exist and FORCE is non-nil, create
  13089. the drawer."
  13090. (catch 'exit
  13091. (save-excursion
  13092. (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
  13093. (progn (org-back-to-heading t) (point))))
  13094. (end (or end (and (not (outline-next-heading)) (point-max))
  13095. (point))))
  13096. (goto-char beg)
  13097. (if (re-search-forward org-property-start-re end t)
  13098. (setq beg (1+ (match-end 0)))
  13099. (if force
  13100. (save-excursion
  13101. (org-insert-property-drawer)
  13102. (setq end (progn (outline-next-heading) (point))))
  13103. (throw 'exit nil))
  13104. (goto-char beg)
  13105. (if (re-search-forward org-property-start-re end t)
  13106. (setq beg (1+ (match-end 0)))))
  13107. (if (re-search-forward org-property-end-re end t)
  13108. (setq end (match-beginning 0))
  13109. (or force (throw 'exit nil))
  13110. (goto-char beg)
  13111. (setq end beg)
  13112. (org-indent-line)
  13113. (insert ":END:\n"))
  13114. (cons beg end)))))
  13115. (defun org-entry-properties (&optional pom which specific)
  13116. "Get all properties of the entry at point-or-marker POM.
  13117. This includes the TODO keyword, the tags, time strings for deadline,
  13118. scheduled, and clocking, and any additional properties defined in the
  13119. entry. The return value is an alist, keys may occur multiple times
  13120. if the property key was used several times.
  13121. POM may also be nil, in which case the current entry is used.
  13122. If WHICH is nil or `all', get all properties. If WHICH is
  13123. `special' or `standard', only get that subclass. If WHICH
  13124. is a string only get exactly this property. SPECIFIC can be a string, the
  13125. specific property we are interested in. Specifying it can speed
  13126. things up because then unnecessary parsing is avoided."
  13127. (setq which (or which 'all))
  13128. (org-with-point-at pom
  13129. (let ((clockstr (substring org-clock-string 0 -1))
  13130. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  13131. (case-fold-search nil)
  13132. beg end range props sum-props key key1 value string clocksum clocksumt)
  13133. (save-excursion
  13134. (when (condition-case nil
  13135. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  13136. (error nil))
  13137. (setq beg (point))
  13138. (setq sum-props (get-text-property (point) 'org-summaries))
  13139. (setq clocksum (get-text-property (point) :org-clock-minutes)
  13140. clocksumt (get-text-property (point) :org-clock-minutes-today))
  13141. (outline-next-heading)
  13142. (setq end (point))
  13143. (when (memq which '(all special))
  13144. ;; Get the special properties, like TODO and tags
  13145. (goto-char beg)
  13146. (when (and (or (not specific) (string= specific "TODO"))
  13147. (looking-at org-todo-line-regexp) (match-end 2))
  13148. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  13149. (when (and (or (not specific) (string= specific "PRIORITY"))
  13150. (looking-at org-priority-regexp))
  13151. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  13152. (when (or (not specific) (string= specific "FILE"))
  13153. (push (cons "FILE" buffer-file-name) props))
  13154. (when (and (or (not specific) (string= specific "TAGS"))
  13155. (setq value (org-get-tags-string))
  13156. (string-match "\\S-" value))
  13157. (push (cons "TAGS" value) props))
  13158. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13159. (setq value (org-get-tags-at)))
  13160. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13161. ":"))
  13162. props))
  13163. (when (or (not specific) (string= specific "BLOCKED"))
  13164. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13165. (when (or (not specific)
  13166. (member specific
  13167. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13168. "TIMESTAMP" "TIMESTAMP_IA")))
  13169. (catch 'match
  13170. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13171. (setq key (if (match-end 1)
  13172. (substring (org-match-string-no-properties 1)
  13173. 0 -1))
  13174. string (if (equal key clockstr)
  13175. (org-trim
  13176. (buffer-substring-no-properties
  13177. (match-beginning 3) (goto-char
  13178. (point-at-eol))))
  13179. (substring (org-match-string-no-properties 3)
  13180. 1 -1)))
  13181. ;; Get the correct property name from the key. This is
  13182. ;; necessary if the user has configured time keywords.
  13183. (setq key1 (concat key ":"))
  13184. (cond
  13185. ((not key)
  13186. (setq key
  13187. (if (= (char-after (match-beginning 3)) ?\[)
  13188. "TIMESTAMP_IA" "TIMESTAMP")))
  13189. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13190. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13191. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13192. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13193. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13194. (progn
  13195. (push (cons key string) props)
  13196. ;; no need to search further if match is found
  13197. (throw 'match t))
  13198. (when (or (equal key "CLOCK") (not (assoc key props)))
  13199. (push (cons key string) props)))))))
  13200. (when (memq which '(all standard))
  13201. ;; Get the standard properties, like :PROP: ...
  13202. (setq range (org-get-property-block beg end))
  13203. (when range
  13204. (goto-char (car range))
  13205. (while (re-search-forward
  13206. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  13207. (cdr range) t)
  13208. (setq key (org-match-string-no-properties 1)
  13209. value (org-trim (or (org-match-string-no-properties 2) "")))
  13210. (unless (member key excluded)
  13211. (push (cons key (or value "")) props)))))
  13212. (if clocksum
  13213. (push (cons "CLOCKSUM"
  13214. (org-columns-number-to-string (/ (float clocksum) 60.)
  13215. 'add_times))
  13216. props))
  13217. (if clocksumt
  13218. (push (cons "CLOCKSUM_T"
  13219. (org-columns-number-to-string (/ (float clocksumt) 60.)
  13220. 'add_times))
  13221. props))
  13222. (unless (assoc "CATEGORY" props)
  13223. (push (cons "CATEGORY" (org-get-category)) props))
  13224. (append sum-props (nreverse props)))))))
  13225. (defun org-entry-get (pom property &optional inherit literal-nil)
  13226. "Get value of PROPERTY for entry or content at point-or-marker POM.
  13227. If INHERIT is non-nil and the entry does not have the property,
  13228. then also check higher levels of the hierarchy.
  13229. If INHERIT is the symbol `selective', use inheritance only if the setting
  13230. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13231. If the property is present but empty, the return value is the empty string.
  13232. If the property is not present at all, nil is returned.
  13233. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13234. do not interpret it as the list atom nil. This is used for inheritance
  13235. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13236. (org-with-point-at pom
  13237. (if (and inherit (if (eq inherit 'selective)
  13238. (org-property-inherit-p property)
  13239. t))
  13240. (org-entry-get-with-inheritance property literal-nil)
  13241. (if (member property org-special-properties)
  13242. ;; We need a special property. Use `org-entry-properties' to
  13243. ;; retrieve it, but specify the wanted property
  13244. (cdr (assoc property (org-entry-properties nil 'special property)))
  13245. (let* ((range (org-get-property-block))
  13246. (props (list (or (assoc property org-file-properties)
  13247. (assoc property org-global-properties)
  13248. (assoc property org-global-properties-fixed))))
  13249. (ap (lambda (key)
  13250. (when (re-search-forward
  13251. (org-re-property key) (cdr range) t)
  13252. (setq props
  13253. (org-update-property-plist
  13254. key
  13255. (if (match-end 1)
  13256. (org-match-string-no-properties 1) "")
  13257. props)))))
  13258. val)
  13259. (when (and range (goto-char (car range)))
  13260. (funcall ap property)
  13261. (goto-char (car range))
  13262. (while (funcall ap (concat property "+")))
  13263. (setq val (cdr (assoc property props)))
  13264. (when val (if literal-nil val (org-not-nil val)))))))))
  13265. (defun org-property-or-variable-value (var &optional inherit)
  13266. "Check if there is a property fixing the value of VAR.
  13267. If yes, return this value. If not, return the current value of the variable."
  13268. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  13269. (if (and prop (stringp prop) (string-match "\\S-" prop))
  13270. (read prop)
  13271. (symbol-value var))))
  13272. (defun org-entry-delete (pom property)
  13273. "Delete the property PROPERTY from entry at point-or-marker POM."
  13274. (org-with-point-at pom
  13275. (if (member property org-special-properties)
  13276. nil ; cannot delete these properties.
  13277. (let ((range (org-get-property-block)))
  13278. (if (and range
  13279. (goto-char (car range))
  13280. (re-search-forward
  13281. (org-re-property property)
  13282. (cdr range) t))
  13283. (progn
  13284. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  13285. t)
  13286. nil)))))
  13287. ;; Multi-values properties are properties that contain multiple values
  13288. ;; These values are assumed to be single words, separated by whitespace.
  13289. (defun org-entry-add-to-multivalued-property (pom property value)
  13290. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  13291. (let* ((old (org-entry-get pom property))
  13292. (values (and old (org-split-string old "[ \t]"))))
  13293. (setq value (org-entry-protect-space value))
  13294. (unless (member value values)
  13295. (setq values (cons value values))
  13296. (org-entry-put pom property
  13297. (mapconcat 'identity values " ")))))
  13298. (defun org-entry-remove-from-multivalued-property (pom property value)
  13299. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  13300. (let* ((old (org-entry-get pom property))
  13301. (values (and old (org-split-string old "[ \t]"))))
  13302. (setq value (org-entry-protect-space value))
  13303. (when (member value values)
  13304. (setq values (delete value values))
  13305. (org-entry-put pom property
  13306. (mapconcat 'identity values " ")))))
  13307. (defun org-entry-member-in-multivalued-property (pom property value)
  13308. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  13309. (let* ((old (org-entry-get pom property))
  13310. (values (and old (org-split-string old "[ \t]"))))
  13311. (setq value (org-entry-protect-space value))
  13312. (member value values)))
  13313. (defun org-entry-get-multivalued-property (pom property)
  13314. "Return a list of values in a multivalued property."
  13315. (let* ((value (org-entry-get pom property))
  13316. (values (and value (org-split-string value "[ \t]"))))
  13317. (mapcar 'org-entry-restore-space values)))
  13318. (defun org-entry-put-multivalued-property (pom property &rest values)
  13319. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  13320. VALUES should be a list of strings. Spaces will be protected."
  13321. (org-entry-put pom property
  13322. (mapconcat 'org-entry-protect-space values " "))
  13323. (let* ((value (org-entry-get pom property))
  13324. (values (and value (org-split-string value "[ \t]"))))
  13325. (mapcar 'org-entry-restore-space values)))
  13326. (defun org-entry-protect-space (s)
  13327. "Protect spaces and newline in string S."
  13328. (while (string-match " " s)
  13329. (setq s (replace-match "%20" t t s)))
  13330. (while (string-match "\n" s)
  13331. (setq s (replace-match "%0A" t t s)))
  13332. s)
  13333. (defun org-entry-restore-space (s)
  13334. "Restore spaces and newline in string S."
  13335. (while (string-match "%20" s)
  13336. (setq s (replace-match " " t t s)))
  13337. (while (string-match "%0A" s)
  13338. (setq s (replace-match "\n" t t s)))
  13339. s)
  13340. (defvar org-entry-property-inherited-from (make-marker)
  13341. "Marker pointing to the entry from where a property was inherited.
  13342. Each call to `org-entry-get-with-inheritance' will set this marker to the
  13343. location of the entry where the inheritance search matched. If there was
  13344. no match, the marker will point nowhere.
  13345. Note that also `org-entry-get' calls this function, if the INHERIT flag
  13346. is set.")
  13347. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  13348. "Get PROPERTY of entry or content at point, search higher levels if needed.
  13349. The search will stop at the first ancestor which has the property defined.
  13350. If the value found is \"nil\", return nil to show that the property
  13351. should be considered as undefined (this is the meaning of nil here).
  13352. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  13353. (move-marker org-entry-property-inherited-from nil)
  13354. (let (tmp)
  13355. (save-excursion
  13356. (save-restriction
  13357. (widen)
  13358. (catch 'ex
  13359. (while t
  13360. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  13361. (or (ignore-errors (org-back-to-heading t))
  13362. (goto-char (point-min)))
  13363. (move-marker org-entry-property-inherited-from (point))
  13364. (throw 'ex tmp))
  13365. (or (ignore-errors (org-up-heading-safe))
  13366. (throw 'ex nil))))))
  13367. (setq tmp (or tmp
  13368. (cdr (assoc property org-file-properties))
  13369. (cdr (assoc property org-global-properties))
  13370. (cdr (assoc property org-global-properties-fixed))))
  13371. (if literal-nil tmp (org-not-nil tmp))))
  13372. (defvar org-property-changed-functions nil
  13373. "Hook called when the value of a property has changed.
  13374. Each hook function should accept two arguments, the name of the property
  13375. and the new value.")
  13376. (defun org-entry-put (pom property value)
  13377. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  13378. (org-with-point-at pom
  13379. (org-back-to-heading t)
  13380. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  13381. range)
  13382. (cond
  13383. ((equal property "TODO")
  13384. (when (and (stringp value) (string-match "\\S-" value)
  13385. (not (member value org-todo-keywords-1)))
  13386. (error "\"%s\" is not a valid TODO state" value))
  13387. (if (or (not value)
  13388. (not (string-match "\\S-" value)))
  13389. (setq value 'none))
  13390. (org-todo value)
  13391. (org-set-tags nil 'align))
  13392. ((equal property "PRIORITY")
  13393. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  13394. (string-to-char value) ?\ ))
  13395. (org-set-tags nil 'align))
  13396. ((equal property "CLOCKSUM")
  13397. (if (not (re-search-forward
  13398. (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
  13399. (error "Cannot find a clock log")
  13400. (goto-char (- (match-end 1) 2))
  13401. (cond
  13402. ((eq value 'earlier) (org-timestamp-down))
  13403. ((eq value 'later) (org-timestamp-up)))
  13404. (org-clock-sum-current-item)))
  13405. ((equal property "SCHEDULED")
  13406. (if (re-search-forward org-scheduled-time-regexp end t)
  13407. (cond
  13408. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13409. ((eq value 'later) (org-timestamp-change 1 'day))
  13410. (t (call-interactively 'org-schedule)))
  13411. (call-interactively 'org-schedule)))
  13412. ((equal property "DEADLINE")
  13413. (if (re-search-forward org-deadline-time-regexp end t)
  13414. (cond
  13415. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13416. ((eq value 'later) (org-timestamp-change 1 'day))
  13417. (t (call-interactively 'org-deadline)))
  13418. (call-interactively 'org-deadline)))
  13419. ((member property org-special-properties)
  13420. (error "The %s property can not yet be set with `org-entry-put'"
  13421. property))
  13422. (t ; a non-special property
  13423. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  13424. (setq range (org-get-property-block beg end 'force))
  13425. (goto-char (car range))
  13426. (if (re-search-forward
  13427. (org-re-property-keyword property) (cdr range) t)
  13428. (progn
  13429. (delete-region (match-beginning 0) (match-end 0))
  13430. (goto-char (match-beginning 0)))
  13431. (goto-char (cdr range))
  13432. (insert "\n")
  13433. (backward-char 1)
  13434. (org-indent-line))
  13435. (insert ":" property ":")
  13436. (and value (insert " " value))
  13437. (org-indent-line)))))
  13438. (run-hook-with-args 'org-property-changed-functions property value)))
  13439. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  13440. "Get all property keys in the current buffer.
  13441. With INCLUDE-SPECIALS, also list the special properties that reflect things
  13442. like tags and TODO state.
  13443. With INCLUDE-DEFAULTS, also include properties that has special meaning
  13444. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  13445. and others.
  13446. With INCLUDE-COLUMNS, also include property names given in COLUMN
  13447. formats in the current buffer."
  13448. (let (rtn range cfmt s p)
  13449. (save-excursion
  13450. (save-restriction
  13451. (widen)
  13452. (goto-char (point-min))
  13453. (while (re-search-forward org-property-start-re nil t)
  13454. (setq range (org-get-property-block))
  13455. (goto-char (car range))
  13456. (while (re-search-forward
  13457. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  13458. (cdr range) t)
  13459. (add-to-list 'rtn (org-match-string-no-properties 1)))
  13460. (outline-next-heading))))
  13461. (when include-specials
  13462. (setq rtn (append org-special-properties rtn)))
  13463. (when include-defaults
  13464. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  13465. (add-to-list 'rtn org-effort-property))
  13466. (when include-columns
  13467. (save-excursion
  13468. (save-restriction
  13469. (widen)
  13470. (goto-char (point-min))
  13471. (while (re-search-forward
  13472. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  13473. nil t)
  13474. (setq cfmt (match-string 2) s 0)
  13475. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  13476. cfmt s)
  13477. (setq s (match-end 0)
  13478. p (match-string 1 cfmt))
  13479. (unless (or (equal p "ITEM")
  13480. (member p org-special-properties))
  13481. (add-to-list 'rtn (match-string 1 cfmt))))))))
  13482. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  13483. (defun org-property-values (key)
  13484. "Return a list of all values of property KEY in the current buffer."
  13485. (save-excursion
  13486. (save-restriction
  13487. (widen)
  13488. (goto-char (point-min))
  13489. (let ((re (org-re-property key))
  13490. values)
  13491. (while (re-search-forward re nil t)
  13492. (add-to-list 'values (org-trim (match-string 1))))
  13493. (delete "" values)))))
  13494. (defun org-insert-property-drawer ()
  13495. "Insert a property drawer into the current entry."
  13496. (org-back-to-heading t)
  13497. (looking-at org-outline-regexp)
  13498. (let ((indent (if org-adapt-indentation
  13499. (- (match-end 0) (match-beginning 0))
  13500. 0))
  13501. (beg (point))
  13502. (re (concat "^[ \t]*" org-keyword-time-regexp))
  13503. end hiddenp)
  13504. (outline-next-heading)
  13505. (setq end (point))
  13506. (goto-char beg)
  13507. (while (re-search-forward re end t))
  13508. (setq hiddenp (outline-invisible-p))
  13509. (end-of-line 1)
  13510. (and (equal (char-after) ?\n) (forward-char 1))
  13511. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  13512. (if (member (match-string 1) '("CLOCK:" ":END:"))
  13513. ;; just skip this line
  13514. (beginning-of-line 2)
  13515. ;; Drawer start, find the end
  13516. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  13517. (beginning-of-line 1)))
  13518. (org-skip-over-state-notes)
  13519. (skip-chars-backward " \t\n\r")
  13520. (if (eq (char-before) ?*) (forward-char 1))
  13521. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  13522. (beginning-of-line 0)
  13523. (org-indent-to-column indent)
  13524. (beginning-of-line 2)
  13525. (org-indent-to-column indent)
  13526. (beginning-of-line 0)
  13527. (if hiddenp
  13528. (save-excursion
  13529. (org-back-to-heading t)
  13530. (hide-entry))
  13531. (org-flag-drawer t))))
  13532. (defun org-insert-drawer (&optional arg drawer)
  13533. "Insert a drawer at point.
  13534. Optional argument DRAWER, when non-nil, is a string representing
  13535. drawer's name. Otherwise, the user is prompted for a name.
  13536. If a region is active, insert the drawer around that region
  13537. instead.
  13538. Point is left between drawer's boundaries."
  13539. (interactive "P")
  13540. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  13541. "LOGBOOK"))
  13542. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  13543. ;; internally by Org. They are meant to be inserted
  13544. ;; automatically.
  13545. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  13546. ;; Remove system drawers from list. Note: For some reason,
  13547. ;; `org-completing-read' ignores the predicate while
  13548. ;; `completing-read' handles it fine.
  13549. (drawer (if arg "PROPERTIES"
  13550. (or drawer
  13551. (completing-read
  13552. "Drawer: " org-drawers
  13553. (lambda (d) (not (member d system-drawers))))))))
  13554. (cond
  13555. ;; With C-u, fall back on `org-insert-property-drawer'
  13556. (arg (org-insert-property-drawer))
  13557. ;; With an active region, insert a drawer at point.
  13558. ((not (org-region-active-p))
  13559. (progn
  13560. (unless (bolp) (insert "\n"))
  13561. (insert (format ":%s:\n\n:END:\n" drawer))
  13562. (forward-line -2)))
  13563. ;; Otherwise, insert the drawer at point
  13564. (t
  13565. (let ((rbeg (region-beginning))
  13566. (rend (copy-marker (region-end))))
  13567. (unwind-protect
  13568. (progn
  13569. (goto-char rbeg)
  13570. (beginning-of-line)
  13571. (when (save-excursion
  13572. (re-search-forward org-outline-regexp-bol rend t))
  13573. (error "Drawers cannot contain headlines"))
  13574. ;; Position point at the beginning of the first
  13575. ;; non-blank line in region. Insert drawer's opening
  13576. ;; there, then indent it.
  13577. (org-skip-whitespace)
  13578. (beginning-of-line)
  13579. (insert ":" drawer ":\n")
  13580. (forward-line -1)
  13581. (indent-for-tab-command)
  13582. ;; Move point to the beginning of the first blank line
  13583. ;; after the last non-blank line in region. Insert
  13584. ;; drawer's closing, then indent it.
  13585. (goto-char rend)
  13586. (skip-chars-backward " \r\t\n")
  13587. (insert "\n:END:")
  13588. (deactivate-mark t)
  13589. (indent-for-tab-command)
  13590. (unless (eolp) (insert "\n")))
  13591. ;; Clear marker, whatever the outcome of insertion is.
  13592. (set-marker rend nil)))))))
  13593. (defvar org-property-set-functions-alist nil
  13594. "Property set function alist.
  13595. Each entry should have the following format:
  13596. (PROPERTY . READ-FUNCTION)
  13597. The read function will be called with the same argument as
  13598. `org-completing-read'.")
  13599. (defun org-set-property-function (property)
  13600. "Get the function that should be used to set PROPERTY.
  13601. This is computed according to `org-property-set-functions-alist'."
  13602. (or (cdr (assoc property org-property-set-functions-alist))
  13603. 'org-completing-read))
  13604. (defun org-read-property-value (property)
  13605. "Read PROPERTY value from user."
  13606. (let* ((completion-ignore-case t)
  13607. (allowed (org-property-get-allowed-values nil property 'table))
  13608. (cur (org-entry-get nil property))
  13609. (prompt (concat property " value"
  13610. (if (and cur (string-match "\\S-" cur))
  13611. (concat " [" cur "]") "") ": "))
  13612. (set-function (org-set-property-function property))
  13613. (val (if allowed
  13614. (funcall set-function prompt allowed nil
  13615. (not (get-text-property 0 'org-unrestricted
  13616. (caar allowed))))
  13617. (let (org-completion-use-ido org-completion-use-iswitchb)
  13618. (funcall set-function prompt
  13619. (mapcar 'list (org-property-values property))
  13620. nil nil "" nil cur)))))
  13621. (if (equal val "")
  13622. cur
  13623. val)))
  13624. (defvar org-last-set-property nil)
  13625. (defun org-read-property-name ()
  13626. "Read a property name."
  13627. (let* ((completion-ignore-case t)
  13628. (keys (org-buffer-property-keys nil t t))
  13629. (default-prop (or (save-excursion
  13630. (save-match-data
  13631. (beginning-of-line)
  13632. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  13633. (null (string= (match-string 1) "END"))
  13634. (match-string 1))))
  13635. org-last-set-property))
  13636. (property (org-icompleting-read
  13637. (concat "Property"
  13638. (if default-prop (concat " [" default-prop "]") "")
  13639. ": ")
  13640. (mapcar 'list keys)
  13641. nil nil nil nil
  13642. default-prop
  13643. )))
  13644. (if (member property keys)
  13645. property
  13646. (or (cdr (assoc (downcase property)
  13647. (mapcar (lambda (x) (cons (downcase x) x))
  13648. keys)))
  13649. property))))
  13650. (defun org-set-property (property value)
  13651. "In the current entry, set PROPERTY to VALUE.
  13652. When called interactively, this will prompt for a property name, offering
  13653. completion on existing and default properties. And then it will prompt
  13654. for a value, offering completion either on allowed values (via an inherited
  13655. xxx_ALL property) or on existing values in other instances of this property
  13656. in the current file."
  13657. (interactive (list nil nil))
  13658. (let* ((property (or property (org-read-property-name)))
  13659. (value (or value (org-read-property-value property)))
  13660. (fn (cdr (assoc property org-properties-postprocess-alist))))
  13661. (setq org-last-set-property property)
  13662. ;; Possibly postprocess the inserted value:
  13663. (when fn (setq value (funcall fn value)))
  13664. (unless (equal (org-entry-get nil property) value)
  13665. (org-entry-put nil property value))))
  13666. (defun org-delete-property (property)
  13667. "In the current entry, delete PROPERTY."
  13668. (interactive
  13669. (let* ((completion-ignore-case t)
  13670. (prop (org-icompleting-read "Property: "
  13671. (org-entry-properties nil 'standard))))
  13672. (list prop)))
  13673. (message "Property %s %s" property
  13674. (if (org-entry-delete nil property)
  13675. "deleted"
  13676. "was not present in the entry")))
  13677. (defun org-delete-property-globally (property)
  13678. "Remove PROPERTY globally, from all entries."
  13679. (interactive
  13680. (let* ((completion-ignore-case t)
  13681. (prop (org-icompleting-read
  13682. "Globally remove property: "
  13683. (mapcar 'list (org-buffer-property-keys)))))
  13684. (list prop)))
  13685. (save-excursion
  13686. (save-restriction
  13687. (widen)
  13688. (goto-char (point-min))
  13689. (let ((cnt 0))
  13690. (while (re-search-forward
  13691. (org-re-property property)
  13692. nil t)
  13693. (setq cnt (1+ cnt))
  13694. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  13695. (message "Property \"%s\" removed from %d entries" property cnt)))))
  13696. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  13697. (defun org-compute-property-at-point ()
  13698. "Compute the property at point.
  13699. This looks for an enclosing column format, extracts the operator and
  13700. then applies it to the property in the column format's scope."
  13701. (interactive)
  13702. (unless (org-at-property-p)
  13703. (error "Not at a property"))
  13704. (let ((prop (org-match-string-no-properties 2)))
  13705. (org-columns-get-format-and-top-level)
  13706. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  13707. (error "No operator defined for property %s" prop))
  13708. (org-columns-compute prop)))
  13709. (defvar org-property-allowed-value-functions nil
  13710. "Hook for functions supplying allowed values for a specific property.
  13711. The functions must take a single argument, the name of the property, and
  13712. return a flat list of allowed values. If \":ETC\" is one of
  13713. the values, this means that these values are intended as defaults for
  13714. completion, but that other values should be allowed too.
  13715. The functions must return nil if they are not responsible for this
  13716. property.")
  13717. (defun org-property-get-allowed-values (pom property &optional table)
  13718. "Get allowed values for the property PROPERTY.
  13719. When TABLE is non-nil, return an alist that can directly be used for
  13720. completion."
  13721. (let (vals)
  13722. (cond
  13723. ((equal property "TODO")
  13724. (setq vals (org-with-point-at pom
  13725. (append org-todo-keywords-1 '("")))))
  13726. ((equal property "PRIORITY")
  13727. (let ((n org-lowest-priority))
  13728. (while (>= n org-highest-priority)
  13729. (push (char-to-string n) vals)
  13730. (setq n (1- n)))))
  13731. ((member property org-special-properties))
  13732. ((setq vals (run-hook-with-args-until-success
  13733. 'org-property-allowed-value-functions property)))
  13734. (t
  13735. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  13736. (when (and vals (string-match "\\S-" vals))
  13737. (setq vals (car (read-from-string (concat "(" vals ")"))))
  13738. (setq vals (mapcar (lambda (x)
  13739. (cond ((stringp x) x)
  13740. ((numberp x) (number-to-string x))
  13741. ((symbolp x) (symbol-name x))
  13742. (t "???")))
  13743. vals)))))
  13744. (when (member ":ETC" vals)
  13745. (setq vals (remove ":ETC" vals))
  13746. (org-add-props (car vals) '(org-unrestricted t)))
  13747. (if table (mapcar 'list vals) vals)))
  13748. (defun org-property-previous-allowed-value (&optional previous)
  13749. "Switch to the next allowed value for this property."
  13750. (interactive)
  13751. (org-property-next-allowed-value t))
  13752. (defun org-property-next-allowed-value (&optional previous)
  13753. "Switch to the next allowed value for this property."
  13754. (interactive)
  13755. (unless (org-at-property-p)
  13756. (error "Not at a property"))
  13757. (let* ((key (match-string 2))
  13758. (value (match-string 3))
  13759. (allowed (or (org-property-get-allowed-values (point) key)
  13760. (and (member value '("[ ]" "[-]" "[X]"))
  13761. '("[ ]" "[X]"))))
  13762. nval)
  13763. (unless allowed
  13764. (error "Allowed values for this property have not been defined"))
  13765. (if previous (setq allowed (reverse allowed)))
  13766. (if (member value allowed)
  13767. (setq nval (car (cdr (member value allowed)))))
  13768. (setq nval (or nval (car allowed)))
  13769. (if (equal nval value)
  13770. (error "Only one allowed value for this property"))
  13771. (org-at-property-p)
  13772. (replace-match (concat " :" key ": " nval) t t)
  13773. (org-indent-line)
  13774. (beginning-of-line 1)
  13775. (skip-chars-forward " \t")
  13776. (run-hook-with-args 'org-property-changed-functions key nval)))
  13777. (defun org-find-olp (path &optional this-buffer)
  13778. "Return a marker pointing to the entry at outline path OLP.
  13779. If anything goes wrong, throw an error.
  13780. You can wrap this call to catch the error like this:
  13781. (condition-case msg
  13782. (org-mobile-locate-entry (match-string 4))
  13783. (error (nth 1 msg)))
  13784. The return value will then be either a string with the error message,
  13785. or a marker if everything is OK.
  13786. If THIS-BUFFER is set, the outline path does not contain a file,
  13787. only headings."
  13788. (let* ((file (if this-buffer buffer-file-name (pop path)))
  13789. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  13790. (level 1)
  13791. (lmin 1)
  13792. (lmax 1)
  13793. limit re end found pos heading cnt flevel)
  13794. (unless buffer (error "File not found :%s" file))
  13795. (with-current-buffer buffer
  13796. (save-excursion
  13797. (save-restriction
  13798. (widen)
  13799. (setq limit (point-max))
  13800. (goto-char (point-min))
  13801. (while (setq heading (pop path))
  13802. (setq re (format org-complex-heading-regexp-format
  13803. (regexp-quote heading)))
  13804. (setq cnt 0 pos (point))
  13805. (while (re-search-forward re end t)
  13806. (setq level (- (match-end 1) (match-beginning 1)))
  13807. (if (and (>= level lmin) (<= level lmax))
  13808. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  13809. (when (= cnt 0) (error "Heading not found on level %d: %s"
  13810. lmax heading))
  13811. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  13812. lmax heading))
  13813. (goto-char found)
  13814. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  13815. (setq end (save-excursion (org-end-of-subtree t t))))
  13816. (when (org-at-heading-p)
  13817. (move-marker (make-marker) (point))))))))
  13818. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  13819. "Find node HEADING in BUFFER.
  13820. Return a marker to the heading if it was found, or nil if not.
  13821. If POS-ONLY is set, return just the position instead of a marker.
  13822. The heading text must match exact, but it may have a TODO keyword,
  13823. a priority cookie and tags in the standard locations."
  13824. (with-current-buffer (or buffer (current-buffer))
  13825. (save-excursion
  13826. (save-restriction
  13827. (widen)
  13828. (goto-char (point-min))
  13829. (let (case-fold-search)
  13830. (if (re-search-forward
  13831. (format org-complex-heading-regexp-format
  13832. (regexp-quote heading)) nil t)
  13833. (if pos-only
  13834. (match-beginning 0)
  13835. (move-marker (make-marker) (match-beginning 0)))))))))
  13836. (defun org-find-exact-heading-in-directory (heading &optional dir)
  13837. "Find Org node headline HEADING in all .org files in directory DIR.
  13838. When the target headline is found, return a marker to this location."
  13839. (let ((files (directory-files (or dir default-directory)
  13840. nil "\\`[^.#].*\\.org\\'"))
  13841. file visiting m buffer)
  13842. (catch 'found
  13843. (while (setq file (pop files))
  13844. (message "trying %s" file)
  13845. (setq visiting (org-find-base-buffer-visiting file))
  13846. (setq buffer (or visiting (find-file-noselect file)))
  13847. (setq m (org-find-exact-headline-in-buffer
  13848. heading buffer))
  13849. (when (and (not m) (not visiting)) (kill-buffer buffer))
  13850. (and m (throw 'found m))))))
  13851. (defun org-find-entry-with-id (ident)
  13852. "Locate the entry that contains the ID property with exact value IDENT.
  13853. IDENT can be a string, a symbol or a number, this function will search for
  13854. the string representation of it.
  13855. Return the position where this entry starts, or nil if there is no such entry."
  13856. (interactive "sID: ")
  13857. (let ((id (cond
  13858. ((stringp ident) ident)
  13859. ((symbol-name ident) (symbol-name ident))
  13860. ((numberp ident) (number-to-string ident))
  13861. (t (error "IDENT %s must be a string, symbol or number" ident))))
  13862. (case-fold-search nil))
  13863. (save-excursion
  13864. (save-restriction
  13865. (widen)
  13866. (goto-char (point-min))
  13867. (when (re-search-forward
  13868. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  13869. nil t)
  13870. (org-back-to-heading t)
  13871. (point))))))
  13872. ;;;; Timestamps
  13873. (defvar org-last-changed-timestamp nil)
  13874. (defvar org-last-inserted-timestamp nil
  13875. "The last time stamp inserted with `org-insert-time-stamp'.")
  13876. (defvar org-time-was-given) ; dynamically scoped parameter
  13877. (defvar org-end-time-was-given) ; dynamically scoped parameter
  13878. (defvar org-ts-what) ; dynamically scoped parameter
  13879. (defun org-time-stamp (arg &optional inactive)
  13880. "Prompt for a date/time and insert a time stamp.
  13881. If the user specifies a time like HH:MM or if this command is
  13882. called with at least one prefix argument, the time stamp contains
  13883. the date and the time. Otherwise, only the date is be included.
  13884. All parts of a date not specified by the user is filled in from
  13885. the current date/time. So if you just press return without
  13886. typing anything, the time stamp will represent the current
  13887. date/time.
  13888. If there is already a timestamp at the cursor, it will be
  13889. modified.
  13890. With two universal prefix arguments, insert an active timestamp
  13891. with the current time without prompting the user."
  13892. (interactive "P")
  13893. (let* ((ts nil)
  13894. (default-time
  13895. ;; Default time is either today, or, when entering a range,
  13896. ;; the range start.
  13897. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  13898. (save-excursion
  13899. (re-search-backward
  13900. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  13901. (- (point) 20) t)))
  13902. (apply 'encode-time (org-parse-time-string (match-string 1)))
  13903. (current-time)))
  13904. (default-input (and ts (org-get-compact-tod ts)))
  13905. (repeater (save-excursion
  13906. (save-match-data
  13907. (beginning-of-line)
  13908. (when (re-search-forward
  13909. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  13910. (save-excursion (progn (end-of-line) (point))) t)
  13911. (match-string 0)))))
  13912. org-time-was-given org-end-time-was-given time)
  13913. (cond
  13914. ((and (org-at-timestamp-p t)
  13915. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  13916. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  13917. (insert "--")
  13918. (setq time (let ((this-command this-command))
  13919. (org-read-date arg 'totime nil nil
  13920. default-time default-input inactive)))
  13921. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  13922. ((org-at-timestamp-p t)
  13923. (setq time (let ((this-command this-command))
  13924. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  13925. (when (org-at-timestamp-p t) ; just to get the match data
  13926. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  13927. (replace-match "")
  13928. (setq org-last-changed-timestamp
  13929. (org-insert-time-stamp
  13930. time (or org-time-was-given arg)
  13931. inactive nil nil (list org-end-time-was-given)))
  13932. (when repeater (goto-char (1- (point))) (insert " " repeater)
  13933. (setq org-last-changed-timestamp
  13934. (concat (substring org-last-inserted-timestamp 0 -1)
  13935. " " repeater ">"))))
  13936. (message "Timestamp updated"))
  13937. ((equal arg '(16))
  13938. (org-insert-time-stamp (current-time) t))
  13939. (t
  13940. (setq time (let ((this-command this-command))
  13941. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  13942. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  13943. nil nil (list org-end-time-was-given))))))
  13944. ;; FIXME: can we use this for something else, like computing time differences?
  13945. (defun org-get-compact-tod (s)
  13946. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  13947. (let* ((t1 (match-string 1 s))
  13948. (h1 (string-to-number (match-string 2 s)))
  13949. (m1 (string-to-number (match-string 3 s)))
  13950. (t2 (and (match-end 4) (match-string 5 s)))
  13951. (h2 (and t2 (string-to-number (match-string 6 s))))
  13952. (m2 (and t2 (string-to-number (match-string 7 s))))
  13953. dh dm)
  13954. (if (not t2)
  13955. t1
  13956. (setq dh (- h2 h1) dm (- m2 m1))
  13957. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  13958. (concat t1 "+" (number-to-string dh)
  13959. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  13960. (defun org-time-stamp-inactive (&optional arg)
  13961. "Insert an inactive time stamp.
  13962. An inactive time stamp is enclosed in square brackets instead of angle
  13963. brackets. It is inactive in the sense that it does not trigger agenda entries,
  13964. does not link to the calendar and cannot be changed with the S-cursor keys.
  13965. So these are more for recording a certain time/date."
  13966. (interactive "P")
  13967. (org-time-stamp arg 'inactive))
  13968. (defvar org-date-ovl (make-overlay 1 1))
  13969. (overlay-put org-date-ovl 'face 'org-date-selected)
  13970. (org-detach-overlay org-date-ovl)
  13971. (defvar org-ans1) ; dynamically scoped parameter
  13972. (defvar org-ans2) ; dynamically scoped parameter
  13973. (defvar org-plain-time-of-day-regexp) ; defined below
  13974. (defvar org-overriding-default-time nil) ; dynamically scoped
  13975. (defvar org-read-date-overlay nil)
  13976. (defvar org-dcst nil) ; dynamically scoped
  13977. (defvar org-read-date-history nil)
  13978. (defvar org-read-date-final-answer nil)
  13979. (defvar org-read-date-analyze-futurep nil)
  13980. (defvar org-read-date-analyze-forced-year nil)
  13981. (defvar org-read-date-inactive)
  13982. (defun org-read-date (&optional org-with-time to-time from-string prompt
  13983. default-time default-input inactive)
  13984. "Read a date, possibly a time, and make things smooth for the user.
  13985. The prompt will suggest to enter an ISO date, but you can also enter anything
  13986. which will at least partially be understood by `parse-time-string'.
  13987. Unrecognized parts of the date will default to the current day, month, year,
  13988. hour and minute. If this command is called to replace a timestamp at point,
  13989. or to enter the second timestamp of a range, the default time is taken
  13990. from the existing stamp. Furthermore, the command prefers the future,
  13991. so if you are giving a date where the year is not given, and the day-month
  13992. combination is already past in the current year, it will assume you
  13993. mean next year. For details, see the manual. A few examples:
  13994. 3-2-5 --> 2003-02-05
  13995. feb 15 --> currentyear-02-15
  13996. 2/15 --> currentyear-02-15
  13997. sep 12 9 --> 2009-09-12
  13998. 12:45 --> today 12:45
  13999. 22 sept 0:34 --> currentyear-09-22 0:34
  14000. 12 --> currentyear-currentmonth-12
  14001. Fri --> nearest Friday (today or later)
  14002. etc.
  14003. Furthermore you can specify a relative date by giving, as the *first* thing
  14004. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  14005. change in days weeks, months, years.
  14006. With a single plus or minus, the date is relative to today. With a double
  14007. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  14008. +4d --> four days from today
  14009. +4 --> same as above
  14010. +2w --> two weeks from today
  14011. ++5 --> five days from default date
  14012. The function understands only English month and weekday abbreviations.
  14013. While prompting, a calendar is popped up - you can also select the
  14014. date with the mouse (button 1). The calendar shows a period of three
  14015. months. To scroll it to other months, use the keys `>' and `<'.
  14016. If you don't like the calendar, turn it off with
  14017. \(setq org-read-date-popup-calendar nil)
  14018. With optional argument TO-TIME, the date will immediately be converted
  14019. to an internal time.
  14020. With an optional argument ORG-WITH-TIME, the prompt will suggest to
  14021. also insert a time. Note that when ORG-WITH-TIME is not set, you can
  14022. still enter a time, and this function will inform the calling routine
  14023. about this change. The calling routine may then choose to change the
  14024. format used to insert the time stamp into the buffer to include the time.
  14025. With optional argument FROM-STRING, read from this string instead from
  14026. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  14027. the time/date that is used for everything that is not specified by the
  14028. user."
  14029. (require 'parse-time)
  14030. (let* ((org-time-stamp-rounding-minutes
  14031. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  14032. (org-dcst org-display-custom-times)
  14033. (ct (org-current-time))
  14034. (org-def (or org-overriding-default-time default-time ct))
  14035. (org-defdecode (decode-time org-def))
  14036. (dummy (progn
  14037. (when (< (nth 2 org-defdecode) org-extend-today-until)
  14038. (setcar (nthcdr 2 org-defdecode) -1)
  14039. (setcar (nthcdr 1 org-defdecode) 59)
  14040. (setq org-def (apply 'encode-time org-defdecode)
  14041. org-defdecode (decode-time org-def)))))
  14042. (calendar-frame-setup nil)
  14043. (calendar-setup nil)
  14044. (calendar-move-hook nil)
  14045. (calendar-view-diary-initially-flag nil)
  14046. (calendar-view-holidays-initially-flag nil)
  14047. (timestr (format-time-string
  14048. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  14049. (prompt (concat (if prompt (concat prompt " ") "")
  14050. (format "Date+time [%s]: " timestr)))
  14051. ans (org-ans0 "") org-ans1 org-ans2 final)
  14052. (cond
  14053. (from-string (setq ans from-string))
  14054. (org-read-date-popup-calendar
  14055. (save-excursion
  14056. (save-window-excursion
  14057. (calendar)
  14058. (org-eval-in-calendar '(setq cursor-type nil) t)
  14059. (unwind-protect
  14060. (progn
  14061. (calendar-forward-day (- (time-to-days org-def)
  14062. (calendar-absolute-from-gregorian
  14063. (calendar-current-date))))
  14064. (org-eval-in-calendar nil t)
  14065. (let* ((old-map (current-local-map))
  14066. (map (copy-keymap calendar-mode-map))
  14067. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  14068. (org-defkey map (kbd "RET") 'org-calendar-select)
  14069. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  14070. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  14071. (org-defkey minibuffer-local-map [(meta shift left)]
  14072. (lambda () (interactive)
  14073. (org-eval-in-calendar '(calendar-backward-month 1))))
  14074. (org-defkey minibuffer-local-map [(meta shift right)]
  14075. (lambda () (interactive)
  14076. (org-eval-in-calendar '(calendar-forward-month 1))))
  14077. (org-defkey minibuffer-local-map [(meta shift up)]
  14078. (lambda () (interactive)
  14079. (org-eval-in-calendar '(calendar-backward-year 1))))
  14080. (org-defkey minibuffer-local-map [(meta shift down)]
  14081. (lambda () (interactive)
  14082. (org-eval-in-calendar '(calendar-forward-year 1))))
  14083. (org-defkey minibuffer-local-map [?\e (shift left)]
  14084. (lambda () (interactive)
  14085. (org-eval-in-calendar '(calendar-backward-month 1))))
  14086. (org-defkey minibuffer-local-map [?\e (shift right)]
  14087. (lambda () (interactive)
  14088. (org-eval-in-calendar '(calendar-forward-month 1))))
  14089. (org-defkey minibuffer-local-map [?\e (shift up)]
  14090. (lambda () (interactive)
  14091. (org-eval-in-calendar '(calendar-backward-year 1))))
  14092. (org-defkey minibuffer-local-map [?\e (shift down)]
  14093. (lambda () (interactive)
  14094. (org-eval-in-calendar '(calendar-forward-year 1))))
  14095. (org-defkey minibuffer-local-map [(shift up)]
  14096. (lambda () (interactive)
  14097. (org-eval-in-calendar '(calendar-backward-week 1))))
  14098. (org-defkey minibuffer-local-map [(shift down)]
  14099. (lambda () (interactive)
  14100. (org-eval-in-calendar '(calendar-forward-week 1))))
  14101. (org-defkey minibuffer-local-map [(shift left)]
  14102. (lambda () (interactive)
  14103. (org-eval-in-calendar '(calendar-backward-day 1))))
  14104. (org-defkey minibuffer-local-map [(shift right)]
  14105. (lambda () (interactive)
  14106. (org-eval-in-calendar '(calendar-forward-day 1))))
  14107. (org-defkey minibuffer-local-map ">"
  14108. (lambda () (interactive)
  14109. (org-eval-in-calendar '(scroll-calendar-left 1))))
  14110. (org-defkey minibuffer-local-map "<"
  14111. (lambda () (interactive)
  14112. (org-eval-in-calendar '(scroll-calendar-right 1))))
  14113. (org-defkey minibuffer-local-map "\C-v"
  14114. (lambda () (interactive)
  14115. (org-eval-in-calendar
  14116. '(calendar-scroll-left-three-months 1))))
  14117. (org-defkey minibuffer-local-map "\M-v"
  14118. (lambda () (interactive)
  14119. (org-eval-in-calendar
  14120. '(calendar-scroll-right-three-months 1))))
  14121. (run-hooks 'org-read-date-minibuffer-setup-hook)
  14122. (unwind-protect
  14123. (progn
  14124. (use-local-map map)
  14125. (setq org-read-date-inactive inactive)
  14126. (add-hook 'post-command-hook 'org-read-date-display)
  14127. (setq org-ans0 (read-string prompt default-input
  14128. 'org-read-date-history nil))
  14129. ;; org-ans0: from prompt
  14130. ;; org-ans1: from mouse click
  14131. ;; org-ans2: from calendar motion
  14132. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  14133. (remove-hook 'post-command-hook 'org-read-date-display)
  14134. (use-local-map old-map)
  14135. (when org-read-date-overlay
  14136. (delete-overlay org-read-date-overlay)
  14137. (setq org-read-date-overlay nil)))))
  14138. (bury-buffer "*Calendar*")))))
  14139. (t ; Naked prompt only
  14140. (unwind-protect
  14141. (setq ans (read-string prompt default-input
  14142. 'org-read-date-history timestr))
  14143. (when org-read-date-overlay
  14144. (delete-overlay org-read-date-overlay)
  14145. (setq org-read-date-overlay nil)))))
  14146. (setq final (org-read-date-analyze ans org-def org-defdecode))
  14147. (when org-read-date-analyze-forced-year
  14148. (message "Year was forced into %s"
  14149. (if org-read-date-force-compatible-dates
  14150. "compatible range (1970-2037)"
  14151. "range representable on this machine"))
  14152. (ding))
  14153. ;; One round trip to get rid of 34th of August and stuff like that....
  14154. (setq final (decode-time (apply 'encode-time final)))
  14155. (setq org-read-date-final-answer ans)
  14156. (if to-time
  14157. (apply 'encode-time final)
  14158. (if (and (boundp 'org-time-was-given) org-time-was-given)
  14159. (format "%04d-%02d-%02d %02d:%02d"
  14160. (nth 5 final) (nth 4 final) (nth 3 final)
  14161. (nth 2 final) (nth 1 final))
  14162. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  14163. (defvar org-def)
  14164. (defvar org-defdecode)
  14165. (defvar org-with-time)
  14166. (defun org-read-date-display ()
  14167. "Display the current date prompt interpretation in the minibuffer."
  14168. (when org-read-date-display-live
  14169. (when org-read-date-overlay
  14170. (delete-overlay org-read-date-overlay))
  14171. (when (minibufferp (current-buffer))
  14172. (save-excursion
  14173. (end-of-line 1)
  14174. (while (not (equal (buffer-substring
  14175. (max (point-min) (- (point) 4)) (point))
  14176. " "))
  14177. (insert " ")))
  14178. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14179. " " (or org-ans1 org-ans2)))
  14180. (org-end-time-was-given nil)
  14181. (f (org-read-date-analyze ans org-def org-defdecode))
  14182. (fmts (if org-dcst
  14183. org-time-stamp-custom-formats
  14184. org-time-stamp-formats))
  14185. (fmt (if (or org-with-time
  14186. (and (boundp 'org-time-was-given) org-time-was-given))
  14187. (cdr fmts)
  14188. (car fmts)))
  14189. (txt (format-time-string fmt (apply 'encode-time f)))
  14190. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  14191. (txt (concat "=> " txt)))
  14192. (when (and org-end-time-was-given
  14193. (string-match org-plain-time-of-day-regexp txt))
  14194. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  14195. org-end-time-was-given
  14196. (substring txt (match-end 0)))))
  14197. (when org-read-date-analyze-futurep
  14198. (setq txt (concat txt " (=>F)")))
  14199. (setq org-read-date-overlay
  14200. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  14201. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  14202. (defun org-read-date-analyze (ans org-def org-defdecode)
  14203. "Analyze the combined answer of the date prompt."
  14204. ;; FIXME: cleanup and comment
  14205. (let ((nowdecode (decode-time (current-time)))
  14206. delta deltan deltaw deltadef year month day
  14207. hour minute second wday pm h2 m2 tl wday1
  14208. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  14209. (setq org-read-date-analyze-futurep nil
  14210. org-read-date-analyze-forced-year nil)
  14211. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  14212. (setq ans "+0"))
  14213. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  14214. (setq ans (replace-match "" t t ans)
  14215. deltan (car delta)
  14216. deltaw (nth 1 delta)
  14217. deltadef (nth 2 delta)))
  14218. ;; Check if there is an iso week date in there. If yes, store the
  14219. ;; info and postpone interpreting it until the rest of the parsing
  14220. ;; is done.
  14221. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  14222. (setq iso-year (if (match-end 1)
  14223. (org-small-year-to-year
  14224. (string-to-number (match-string 1 ans))))
  14225. iso-weekday (if (match-end 3)
  14226. (string-to-number (match-string 3 ans)))
  14227. iso-week (string-to-number (match-string 2 ans)))
  14228. (setq ans (replace-match "" t t ans)))
  14229. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  14230. (when (string-match
  14231. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  14232. (setq year (if (match-end 2)
  14233. (string-to-number (match-string 2 ans))
  14234. (progn (setq kill-year t)
  14235. (string-to-number (format-time-string "%Y"))))
  14236. month (string-to-number (match-string 3 ans))
  14237. day (string-to-number (match-string 4 ans)))
  14238. (if (< year 100) (setq year (+ 2000 year)))
  14239. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14240. t nil ans)))
  14241. ;; Help matching dotted european dates
  14242. (when (string-match
  14243. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
  14244. (setq year (if (match-end 3)
  14245. (string-to-number (match-string 3 ans))
  14246. (progn (setq kill-year t)
  14247. (string-to-number (format-time-string "%Y"))))
  14248. day (string-to-number (match-string 1 ans))
  14249. month (string-to-number (match-string 2 ans))
  14250. ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14251. t nil ans)))
  14252. ;; Help matching american dates, like 5/30 or 5/30/7
  14253. (when (string-match
  14254. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  14255. (setq year (if (match-end 4)
  14256. (string-to-number (match-string 4 ans))
  14257. (progn (setq kill-year t)
  14258. (string-to-number (format-time-string "%Y"))))
  14259. month (string-to-number (match-string 1 ans))
  14260. day (string-to-number (match-string 2 ans)))
  14261. (if (< year 100) (setq year (+ 2000 year)))
  14262. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14263. t nil ans)))
  14264. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  14265. ;; If there is a time with am/pm, and *no* time without it, we convert
  14266. ;; so that matching will be successful.
  14267. (loop for i from 1 to 2 do ; twice, for end time as well
  14268. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  14269. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  14270. (setq hour (string-to-number (match-string 1 ans))
  14271. minute (if (match-end 3)
  14272. (string-to-number (match-string 3 ans))
  14273. 0)
  14274. pm (equal ?p
  14275. (string-to-char (downcase (match-string 4 ans)))))
  14276. (if (and (= hour 12) (not pm))
  14277. (setq hour 0)
  14278. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  14279. (setq ans (replace-match (format "%02d:%02d" hour minute)
  14280. t t ans))))
  14281. ;; Check if a time range is given as a duration
  14282. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  14283. (setq hour (string-to-number (match-string 1 ans))
  14284. h2 (+ hour (string-to-number (match-string 3 ans)))
  14285. minute (string-to-number (match-string 2 ans))
  14286. m2 (+ minute (if (match-end 5) (string-to-number
  14287. (match-string 5 ans))0)))
  14288. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  14289. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  14290. t t ans)))
  14291. ;; Check if there is a time range
  14292. (when (boundp 'org-end-time-was-given)
  14293. (setq org-time-was-given nil)
  14294. (when (and (string-match org-plain-time-of-day-regexp ans)
  14295. (match-end 8))
  14296. (setq org-end-time-was-given (match-string 8 ans))
  14297. (setq ans (concat (substring ans 0 (match-beginning 7))
  14298. (substring ans (match-end 7))))))
  14299. (setq tl (parse-time-string ans)
  14300. day (or (nth 3 tl) (nth 3 org-defdecode))
  14301. month (or (nth 4 tl)
  14302. (if (and org-read-date-prefer-future
  14303. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  14304. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  14305. (nth 4 org-defdecode)))
  14306. year (or (and (not kill-year) (nth 5 tl))
  14307. (if (and org-read-date-prefer-future
  14308. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  14309. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  14310. (nth 5 org-defdecode)))
  14311. hour (or (nth 2 tl) (nth 2 org-defdecode))
  14312. minute (or (nth 1 tl) (nth 1 org-defdecode))
  14313. second (or (nth 0 tl) 0)
  14314. wday (nth 6 tl))
  14315. (when (and (eq org-read-date-prefer-future 'time)
  14316. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  14317. (equal day (nth 3 nowdecode))
  14318. (equal month (nth 4 nowdecode))
  14319. (equal year (nth 5 nowdecode))
  14320. (nth 2 tl)
  14321. (or (< (nth 2 tl) (nth 2 nowdecode))
  14322. (and (= (nth 2 tl) (nth 2 nowdecode))
  14323. (nth 1 tl)
  14324. (< (nth 1 tl) (nth 1 nowdecode)))))
  14325. (setq day (1+ day)
  14326. futurep t))
  14327. ;; Special date definitions below
  14328. (cond
  14329. (iso-week
  14330. ;; There was an iso week
  14331. (require 'cal-iso)
  14332. (setq futurep nil)
  14333. (setq year (or iso-year year)
  14334. day (or iso-weekday wday 1)
  14335. wday nil ; to make sure that the trigger below does not match
  14336. iso-date (calendar-gregorian-from-absolute
  14337. (calendar-absolute-from-iso
  14338. (list iso-week day year))))
  14339. ; FIXME: Should we also push ISO weeks into the future?
  14340. ; (when (and org-read-date-prefer-future
  14341. ; (not iso-year)
  14342. ; (< (calendar-absolute-from-gregorian iso-date)
  14343. ; (time-to-days (current-time))))
  14344. ; (setq year (1+ year)
  14345. ; iso-date (calendar-gregorian-from-absolute
  14346. ; (calendar-absolute-from-iso
  14347. ; (list iso-week day year)))))
  14348. (setq month (car iso-date)
  14349. year (nth 2 iso-date)
  14350. day (nth 1 iso-date)))
  14351. (deltan
  14352. (setq futurep nil)
  14353. (unless deltadef
  14354. (let ((now (decode-time (current-time))))
  14355. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  14356. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  14357. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  14358. ((equal deltaw "m") (setq month (+ month deltan)))
  14359. ((equal deltaw "y") (setq year (+ year deltan)))))
  14360. ((and wday (not (nth 3 tl)))
  14361. ;; Weekday was given, but no day, so pick that day in the week
  14362. ;; on or after the derived date.
  14363. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  14364. (unless (equal wday wday1)
  14365. (setq day (+ day (% (- wday wday1 -7) 7))))))
  14366. (if (and (boundp 'org-time-was-given)
  14367. (nth 2 tl))
  14368. (setq org-time-was-given t))
  14369. (if (< year 100) (setq year (+ 2000 year)))
  14370. ;; Check of the date is representable
  14371. (if org-read-date-force-compatible-dates
  14372. (progn
  14373. (if (< year 1970)
  14374. (setq year 1970 org-read-date-analyze-forced-year t))
  14375. (if (> year 2037)
  14376. (setq year 2037 org-read-date-analyze-forced-year t)))
  14377. (condition-case nil
  14378. (ignore (encode-time second minute hour day month year))
  14379. (error
  14380. (setq year (nth 5 org-defdecode))
  14381. (setq org-read-date-analyze-forced-year t))))
  14382. (setq org-read-date-analyze-futurep futurep)
  14383. (list second minute hour day month year)))
  14384. (defvar parse-time-weekdays)
  14385. (defun org-read-date-get-relative (s today default)
  14386. "Check string S for special relative date string.
  14387. TODAY and DEFAULT are internal times, for today and for a default.
  14388. Return shift list (N what def-flag)
  14389. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  14390. N is the number of WHATs to shift.
  14391. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  14392. the DEFAULT date rather than TODAY."
  14393. (require 'parse-time)
  14394. (when (and
  14395. (string-match
  14396. (concat
  14397. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  14398. "\\([0-9]+\\)?"
  14399. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  14400. "\\([ \t]\\|$\\)") s)
  14401. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  14402. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  14403. (string-to-char (substring (match-string 1 s) -1))
  14404. ?+))
  14405. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  14406. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  14407. (what (if (match-end 3) (match-string 3 s) "d"))
  14408. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  14409. (date (if rel default today))
  14410. (wday (nth 6 (decode-time date)))
  14411. delta)
  14412. (if wday1
  14413. (progn
  14414. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  14415. (if (= dir ?-) (setq delta (- delta 7)))
  14416. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  14417. (list delta "d" rel))
  14418. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  14419. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  14420. "Turn a user-specified date into the internal representation.
  14421. The internal representation needed by the calendar is (month day year).
  14422. This is a wrapper to handle the brain-dead convention in calendar that
  14423. user function argument order change dependent on argument order."
  14424. (if (boundp 'calendar-date-style)
  14425. (cond
  14426. ((eq calendar-date-style 'american)
  14427. (list arg1 arg2 arg3))
  14428. ((eq calendar-date-style 'european)
  14429. (list arg2 arg1 arg3))
  14430. ((eq calendar-date-style 'iso)
  14431. (list arg2 arg3 arg1)))
  14432. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  14433. (if (org-bound-and-true-p european-calendar-style)
  14434. (list arg2 arg1 arg3)
  14435. (list arg1 arg2 arg3)))))
  14436. (defun org-eval-in-calendar (form &optional keepdate)
  14437. "Eval FORM in the calendar window and return to current window.
  14438. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  14439. otherwise stick to the current value of `org-ans2'."
  14440. (let ((sf (selected-frame))
  14441. (sw (selected-window)))
  14442. (select-window (get-buffer-window "*Calendar*" t))
  14443. (eval form)
  14444. (when (and (not keepdate) (calendar-cursor-to-date))
  14445. (let* ((date (calendar-cursor-to-date))
  14446. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14447. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  14448. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  14449. (select-window sw)
  14450. (org-select-frame-set-input-focus sf)))
  14451. (defun org-calendar-select ()
  14452. "Return to `org-read-date' with the date currently selected.
  14453. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14454. (interactive)
  14455. (when (calendar-cursor-to-date)
  14456. (let* ((date (calendar-cursor-to-date))
  14457. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14458. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14459. (if (active-minibuffer-window) (exit-minibuffer))))
  14460. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  14461. "Insert a date stamp for the date given by the internal TIME.
  14462. WITH-HM means use the stamp format that includes the time of the day.
  14463. INACTIVE means use square brackets instead of angular ones, so that the
  14464. stamp will not contribute to the agenda.
  14465. PRE and POST are optional strings to be inserted before and after the
  14466. stamp.
  14467. The command returns the inserted time stamp."
  14468. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  14469. stamp)
  14470. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  14471. (insert-before-markers (or pre ""))
  14472. (when (listp extra)
  14473. (setq extra (car extra))
  14474. (if (and (stringp extra)
  14475. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  14476. (setq extra (format "-%02d:%02d"
  14477. (string-to-number (match-string 1 extra))
  14478. (string-to-number (match-string 2 extra))))
  14479. (setq extra nil)))
  14480. (when extra
  14481. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  14482. (insert-before-markers (setq stamp (format-time-string fmt time)))
  14483. (insert-before-markers (or post ""))
  14484. (setq org-last-inserted-timestamp stamp)))
  14485. (defun org-toggle-time-stamp-overlays ()
  14486. "Toggle the use of custom time stamp formats."
  14487. (interactive)
  14488. (setq org-display-custom-times (not org-display-custom-times))
  14489. (unless org-display-custom-times
  14490. (let ((p (point-min)) (bmp (buffer-modified-p)))
  14491. (while (setq p (next-single-property-change p 'display))
  14492. (if (and (get-text-property p 'display)
  14493. (eq (get-text-property p 'face) 'org-date))
  14494. (remove-text-properties
  14495. p (setq p (next-single-property-change p 'display))
  14496. '(display t))))
  14497. (set-buffer-modified-p bmp)))
  14498. (if (featurep 'xemacs)
  14499. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  14500. (org-restart-font-lock)
  14501. (setq org-table-may-need-update t)
  14502. (if org-display-custom-times
  14503. (message "Time stamps are overlaid with custom format")
  14504. (message "Time stamp overlays removed")))
  14505. (defun org-display-custom-time (beg end)
  14506. "Overlay modified time stamp format over timestamp between BEG and END."
  14507. (let* ((ts (buffer-substring beg end))
  14508. t1 w1 with-hm tf time str w2 (off 0))
  14509. (save-match-data
  14510. (setq t1 (org-parse-time-string ts t))
  14511. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  14512. (setq off (- (match-end 0) (match-beginning 0)))))
  14513. (setq end (- end off))
  14514. (setq w1 (- end beg)
  14515. with-hm (and (nth 1 t1) (nth 2 t1))
  14516. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  14517. time (org-fix-decoded-time t1)
  14518. str (org-add-props
  14519. (format-time-string
  14520. (substring tf 1 -1) (apply 'encode-time time))
  14521. nil 'mouse-face 'highlight)
  14522. w2 (length str))
  14523. (if (not (= w2 w1))
  14524. (add-text-properties (1+ beg) (+ 2 beg)
  14525. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  14526. (if (featurep 'xemacs)
  14527. (progn
  14528. (put-text-property beg end 'invisible t)
  14529. (put-text-property beg end 'end-glyph (make-glyph str)))
  14530. (put-text-property beg end 'display str))))
  14531. (defun org-translate-time (string)
  14532. "Translate all timestamps in STRING to custom format.
  14533. But do this only if the variable `org-display-custom-times' is set."
  14534. (when org-display-custom-times
  14535. (save-match-data
  14536. (let* ((start 0)
  14537. (re org-ts-regexp-both)
  14538. t1 with-hm inactive tf time str beg end)
  14539. (while (setq start (string-match re string start))
  14540. (setq beg (match-beginning 0)
  14541. end (match-end 0)
  14542. t1 (save-match-data
  14543. (org-parse-time-string (substring string beg end) t))
  14544. with-hm (and (nth 1 t1) (nth 2 t1))
  14545. inactive (equal (substring string beg (1+ beg)) "[")
  14546. tf (funcall (if with-hm 'cdr 'car)
  14547. org-time-stamp-custom-formats)
  14548. time (org-fix-decoded-time t1)
  14549. str (format-time-string
  14550. (concat
  14551. (if inactive "[" "<") (substring tf 1 -1)
  14552. (if inactive "]" ">"))
  14553. (apply 'encode-time time))
  14554. string (replace-match str t t string)
  14555. start (+ start (length str)))))))
  14556. string)
  14557. (defun org-fix-decoded-time (time)
  14558. "Set 0 instead of nil for the first 6 elements of time.
  14559. Don't touch the rest."
  14560. (let ((n 0))
  14561. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  14562. (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.3")
  14563. (defun org-time-stamp-to-now (timestamp-string &optional seconds)
  14564. "Difference between TIMESTAMP-STRING and now in days.
  14565. If SECONDS is non-nil, return the difference in seconds."
  14566. (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
  14567. (- (funcall fdiff (org-time-string-to-time timestamp-string))
  14568. (funcall fdiff (current-time)))))
  14569. (defun org-deadline-close (timestamp-string &optional ndays)
  14570. "Is the time in TIMESTAMP-STRING close to the current date?"
  14571. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  14572. (and (< (org-time-stamp-to-now timestamp-string) ndays)
  14573. (not (org-entry-is-done-p))))
  14574. (defun org-get-wdays (ts)
  14575. "Get the deadline lead time appropriate for timestring TS."
  14576. (cond
  14577. ((<= org-deadline-warning-days 0)
  14578. ;; 0 or negative, enforce this value no matter what
  14579. (- org-deadline-warning-days))
  14580. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  14581. ;; lead time is specified.
  14582. (floor (* (string-to-number (match-string 1 ts))
  14583. (cdr (assoc (match-string 2 ts)
  14584. '(("d" . 1) ("w" . 7)
  14585. ("m" . 30.4) ("y" . 365.25)))))))
  14586. ;; go for the default.
  14587. (t org-deadline-warning-days)))
  14588. (defun org-calendar-select-mouse (ev)
  14589. "Return to `org-read-date' with the date currently selected.
  14590. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14591. (interactive "e")
  14592. (mouse-set-point ev)
  14593. (when (calendar-cursor-to-date)
  14594. (let* ((date (calendar-cursor-to-date))
  14595. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14596. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14597. (if (active-minibuffer-window) (exit-minibuffer))))
  14598. (defun org-check-deadlines (ndays)
  14599. "Check if there are any deadlines due or past due.
  14600. A deadline is considered due if it happens within `org-deadline-warning-days'
  14601. days from today's date. If the deadline appears in an entry marked DONE,
  14602. it is not shown. The prefix arg NDAYS can be used to test that many
  14603. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  14604. (interactive "P")
  14605. (let* ((org-warn-days
  14606. (cond
  14607. ((equal ndays '(4)) 100000)
  14608. (ndays (prefix-numeric-value ndays))
  14609. (t (abs org-deadline-warning-days))))
  14610. (case-fold-search nil)
  14611. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14612. (callback
  14613. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  14614. (message "%d deadlines past-due or due within %d days"
  14615. (org-occur regexp nil callback)
  14616. org-warn-days)))
  14617. (defsubst org-re-timestamp (type)
  14618. "Return a regexp for timestamp TYPE.
  14619. Allowed values for TYPE are:
  14620. all: all timestamps
  14621. active: only active timestamps (<...>)
  14622. inactive: only inactive timestamps ([...])
  14623. scheduled: only scheduled timestamps
  14624. deadline: only deadline timestamps
  14625. When TYPE is nil, fall back on returning a regexp that matches
  14626. both scheduled and deadline timestamps."
  14627. (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
  14628. ((eq type 'active) org-ts-regexp)
  14629. ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
  14630. ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
  14631. ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14632. ((eq type 'scheduled-or-deadline)
  14633. (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
  14634. (defun org-check-before-date (date)
  14635. "Check if there are deadlines or scheduled entries before DATE."
  14636. (interactive (list (org-read-date)))
  14637. (let ((case-fold-search nil)
  14638. (regexp (org-re-timestamp org-ts-type))
  14639. (callback
  14640. (lambda () (time-less-p
  14641. (org-time-string-to-time (match-string 1))
  14642. (org-time-string-to-time date)))))
  14643. (message "%d entries before %s"
  14644. (org-occur regexp nil callback) date)))
  14645. (defun org-check-after-date (date)
  14646. "Check if there are deadlines or scheduled entries after DATE."
  14647. (interactive (list (org-read-date)))
  14648. (let ((case-fold-search nil)
  14649. (regexp (org-re-timestamp org-ts-type))
  14650. (callback
  14651. (lambda () (not
  14652. (time-less-p
  14653. (org-time-string-to-time (match-string 1))
  14654. (org-time-string-to-time date))))))
  14655. (message "%d entries after %s"
  14656. (org-occur regexp nil callback) date)))
  14657. (defun org-check-dates-range (start-date end-date)
  14658. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  14659. (interactive (list (org-read-date nil nil nil "Range starts")
  14660. (org-read-date nil nil nil "Range end")))
  14661. (let ((case-fold-search nil)
  14662. (regexp (org-re-timestamp org-ts-type))
  14663. (callback
  14664. (lambda ()
  14665. (let ((match (match-string 1)))
  14666. (and
  14667. (not (time-less-p
  14668. (org-time-string-to-time match)
  14669. (org-time-string-to-time start-date)))
  14670. (time-less-p
  14671. (org-time-string-to-time match)
  14672. (org-time-string-to-time end-date)))))))
  14673. (message "%d entries between %s and %s"
  14674. (org-occur regexp nil callback) start-date end-date)))
  14675. (defun org-evaluate-time-range (&optional to-buffer)
  14676. "Evaluate a time range by computing the difference between start and end.
  14677. Normally the result is just printed in the echo area, but with prefix arg
  14678. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  14679. If the time range is actually in a table, the result is inserted into the
  14680. next column.
  14681. For time difference computation, a year is assumed to be exactly 365
  14682. days in order to avoid rounding problems."
  14683. (interactive "P")
  14684. (or
  14685. (org-clock-update-time-maybe)
  14686. (save-excursion
  14687. (unless (org-at-date-range-p t)
  14688. (goto-char (point-at-bol))
  14689. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  14690. (if (not (org-at-date-range-p t))
  14691. (error "Not at a time-stamp range, and none found in current line")))
  14692. (let* ((ts1 (match-string 1))
  14693. (ts2 (match-string 2))
  14694. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  14695. (match-end (match-end 0))
  14696. (time1 (org-time-string-to-time ts1))
  14697. (time2 (org-time-string-to-time ts2))
  14698. (t1 (org-float-time time1))
  14699. (t2 (org-float-time time2))
  14700. (diff (abs (- t2 t1)))
  14701. (negative (< (- t2 t1) 0))
  14702. ;; (ys (floor (* 365 24 60 60)))
  14703. (ds (* 24 60 60))
  14704. (hs (* 60 60))
  14705. (fy "%dy %dd %02d:%02d")
  14706. (fy1 "%dy %dd")
  14707. (fd "%dd %02d:%02d")
  14708. (fd1 "%dd")
  14709. (fh "%02d:%02d")
  14710. y d h m align)
  14711. (if havetime
  14712. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14713. y 0
  14714. d (floor (/ diff ds)) diff (mod diff ds)
  14715. h (floor (/ diff hs)) diff (mod diff hs)
  14716. m (floor (/ diff 60)))
  14717. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14718. y 0
  14719. d (floor (+ (/ diff ds) 0.5))
  14720. h 0 m 0))
  14721. (if (not to-buffer)
  14722. (message "%s" (org-make-tdiff-string y d h m))
  14723. (if (org-at-table-p)
  14724. (progn
  14725. (goto-char match-end)
  14726. (setq align t)
  14727. (and (looking-at " *|") (goto-char (match-end 0))))
  14728. (goto-char match-end))
  14729. (if (looking-at
  14730. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  14731. (replace-match ""))
  14732. (if negative (insert " -"))
  14733. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  14734. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  14735. (insert " " (format fh h m))))
  14736. (if align (org-table-align))
  14737. (message "Time difference inserted")))))
  14738. (defun org-make-tdiff-string (y d h m)
  14739. (let ((fmt "")
  14740. (l nil))
  14741. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  14742. l (push y l)))
  14743. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  14744. l (push d l)))
  14745. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  14746. l (push h l)))
  14747. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  14748. l (push m l)))
  14749. (apply 'format fmt (nreverse l))))
  14750. (defun org-time-string-to-time (s &optional buffer pos)
  14751. "Convert a timestamp string into internal time."
  14752. (condition-case errdata
  14753. (apply 'encode-time (org-parse-time-string s))
  14754. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14755. s (if (not (and buffer pos))
  14756. ""
  14757. (format " at %d in buffer `%s'" pos buffer))
  14758. (cdr errdata)))))
  14759. (defun org-time-string-to-seconds (s)
  14760. "Convert a timestamp string to a number of seconds."
  14761. (org-float-time (org-time-string-to-time s)))
  14762. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  14763. "Convert a time stamp to an absolute day number.
  14764. If there is a specifier for a cyclic time stamp, get the closest date to
  14765. DAYNR.
  14766. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  14767. The variable date is bound by the calendar when this is called."
  14768. (cond
  14769. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  14770. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  14771. daynr
  14772. (+ daynr 1000)))
  14773. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  14774. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  14775. (time-to-days (current-time))) (match-string 0 s)
  14776. prefer show-all))
  14777. (t (time-to-days
  14778. (condition-case errdata
  14779. (apply 'encode-time (org-parse-time-string s))
  14780. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14781. s (if (not (and buffer pos))
  14782. ""
  14783. (format " at %d in buffer `%s'" pos buffer))
  14784. (cdr errdata))))))))
  14785. (defun org-days-to-iso-week (days)
  14786. "Return the iso week number."
  14787. (require 'cal-iso)
  14788. (car (calendar-iso-from-absolute days)))
  14789. (defun org-small-year-to-year (year)
  14790. "Convert 2-digit years into 4-digit years.
  14791. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  14792. The year 2000 cannot be abbreviated. Any year larger than 99
  14793. is returned unchanged."
  14794. (if (< year 38)
  14795. (setq year (+ 2000 year))
  14796. (if (< year 100)
  14797. (setq year (+ 1900 year))))
  14798. year)
  14799. (defun org-time-from-absolute (d)
  14800. "Return the time corresponding to date D.
  14801. D may be an absolute day number, or a calendar-type list (month day year)."
  14802. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  14803. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  14804. (defun org-calendar-holiday ()
  14805. "List of holidays, for Diary display in Org-mode."
  14806. (require 'holidays)
  14807. (let ((hl (funcall
  14808. (if (fboundp 'calendar-check-holidays)
  14809. 'calendar-check-holidays 'check-calendar-holidays) date)))
  14810. (if hl (mapconcat 'identity hl "; "))))
  14811. (defun org-diary-sexp-entry (sexp entry date)
  14812. "Process a SEXP diary ENTRY for DATE."
  14813. (require 'diary-lib)
  14814. (let ((result (if calendar-debug-sexp
  14815. (let ((stack-trace-on-error t))
  14816. (eval (car (read-from-string sexp))))
  14817. (condition-case nil
  14818. (eval (car (read-from-string sexp)))
  14819. (error
  14820. (beep)
  14821. (message "Bad sexp at line %d in %s: %s"
  14822. (org-current-line)
  14823. (buffer-file-name) sexp)
  14824. (sleep-for 2))))))
  14825. (cond ((stringp result) (split-string result "; "))
  14826. ((and (consp result)
  14827. (not (consp (cdr result)))
  14828. (stringp (cdr result))) (cdr result))
  14829. ((and (consp result)
  14830. (stringp (car result))) result)
  14831. (result entry))))
  14832. (defun org-diary-to-ical-string (frombuf)
  14833. "Get iCalendar entries from diary entries in buffer FROMBUF.
  14834. This uses the icalendar.el library."
  14835. (let* ((tmpdir (if (featurep 'xemacs)
  14836. (temp-directory)
  14837. temporary-file-directory))
  14838. (tmpfile (make-temp-name
  14839. (expand-file-name "orgics" tmpdir)))
  14840. buf rtn b e)
  14841. (with-current-buffer frombuf
  14842. (icalendar-export-region (point-min) (point-max) tmpfile)
  14843. (setq buf (find-buffer-visiting tmpfile))
  14844. (set-buffer buf)
  14845. (goto-char (point-min))
  14846. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  14847. (setq b (match-beginning 0)))
  14848. (goto-char (point-max))
  14849. (if (re-search-backward "^END:VEVENT" nil t)
  14850. (setq e (match-end 0)))
  14851. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  14852. (kill-buffer buf)
  14853. (delete-file tmpfile)
  14854. rtn))
  14855. (defun org-closest-date (start current change prefer show-all)
  14856. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  14857. When PREFER is `past', return a date that is either CURRENT or past.
  14858. When PREFER is `future', return a date that is either CURRENT or future.
  14859. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  14860. ;; Make the proper lists from the dates
  14861. (catch 'exit
  14862. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  14863. dn dw sday cday n1 n2 n0
  14864. d m y y1 y2 date1 date2 nmonths nm ny m2)
  14865. (setq start (org-date-to-gregorian start)
  14866. current (org-date-to-gregorian
  14867. (if show-all
  14868. current
  14869. (time-to-days (current-time))))
  14870. sday (calendar-absolute-from-gregorian start)
  14871. cday (calendar-absolute-from-gregorian current))
  14872. (if (<= cday sday) (throw 'exit sday))
  14873. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  14874. (setq dn (string-to-number (match-string 1 change))
  14875. dw (cdr (assoc (match-string 2 change) a1)))
  14876. (error "Invalid change specifier: %s" change))
  14877. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  14878. (cond
  14879. ((eq dw 'day)
  14880. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  14881. n2 (+ n1 dn)))
  14882. ((eq dw 'year)
  14883. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  14884. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  14885. (setq date1 (list m d y1)
  14886. n1 (calendar-absolute-from-gregorian date1)
  14887. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  14888. n2 (calendar-absolute-from-gregorian date2)))
  14889. ((eq dw 'month)
  14890. ;; approx number of month between the two dates
  14891. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  14892. ;; How often does dn fit in there?
  14893. (setq d (nth 1 start) m (car start) y (nth 2 start)
  14894. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  14895. m (+ m nm)
  14896. ny (floor (/ m 12))
  14897. y (+ y ny)
  14898. m (- m (* ny 12)))
  14899. (while (> m 12) (setq m (- m 12) y (1+ y)))
  14900. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  14901. (setq m2 (+ m dn) y2 y)
  14902. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14903. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  14904. (while (<= n2 cday)
  14905. (setq n1 n2 m m2 y y2)
  14906. (setq m2 (+ m dn) y2 y)
  14907. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14908. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  14909. ;; Make sure n1 is the earlier date
  14910. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  14911. (if show-all
  14912. (cond
  14913. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14914. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14915. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  14916. (cond
  14917. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14918. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14919. (t (if (= cday n1) n1 n2)))))))
  14920. (defun org-date-to-gregorian (date)
  14921. "Turn any specification of DATE into a Gregorian date for the calendar."
  14922. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  14923. ((and (listp date) (= (length date) 3)) date)
  14924. ((stringp date)
  14925. (setq date (org-parse-time-string date))
  14926. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  14927. ((listp date)
  14928. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  14929. (defun org-parse-time-string (s &optional nodefault)
  14930. "Parse the standard Org-mode time string.
  14931. This should be a lot faster than the normal `parse-time-string'.
  14932. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  14933. hour and minute fields will be nil if not given."
  14934. (if (string-match org-ts-regexp0 s)
  14935. (list 0
  14936. (if (or (match-beginning 8) (not nodefault))
  14937. (string-to-number (or (match-string 8 s) "0")))
  14938. (if (or (match-beginning 7) (not nodefault))
  14939. (string-to-number (or (match-string 7 s) "0")))
  14940. (string-to-number (match-string 4 s))
  14941. (string-to-number (match-string 3 s))
  14942. (string-to-number (match-string 2 s))
  14943. nil nil nil)
  14944. (error "Not a standard Org-mode time string: %s" s)))
  14945. (defun org-timestamp-up (&optional arg)
  14946. "Increase the date item at the cursor by one.
  14947. If the cursor is on the year, change the year. If it is on the month,
  14948. the day or the time, change that.
  14949. With prefix ARG, change by that many units."
  14950. (interactive "p")
  14951. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  14952. (defun org-timestamp-down (&optional arg)
  14953. "Decrease the date item at the cursor by one.
  14954. If the cursor is on the year, change the year. If it is on the month,
  14955. the day or the time, change that.
  14956. With prefix ARG, change by that many units."
  14957. (interactive "p")
  14958. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  14959. (defun org-timestamp-up-day (&optional arg)
  14960. "Increase the date in the time stamp by one day.
  14961. With prefix ARG, change that many days."
  14962. (interactive "p")
  14963. (if (and (not (org-at-timestamp-p t))
  14964. (org-at-heading-p))
  14965. (org-todo 'up)
  14966. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  14967. (defun org-timestamp-down-day (&optional arg)
  14968. "Decrease the date in the time stamp by one day.
  14969. With prefix ARG, change that many days."
  14970. (interactive "p")
  14971. (if (and (not (org-at-timestamp-p t))
  14972. (org-at-heading-p))
  14973. (org-todo 'down)
  14974. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  14975. (defun org-at-timestamp-p (&optional inactive-ok)
  14976. "Determine if the cursor is in or at a timestamp."
  14977. (interactive)
  14978. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  14979. (pos (point))
  14980. (ans (or (looking-at tsr)
  14981. (save-excursion
  14982. (skip-chars-backward "^[<\n\r\t")
  14983. (if (> (point) (point-min)) (backward-char 1))
  14984. (and (looking-at tsr)
  14985. (> (- (match-end 0) pos) -1))))))
  14986. (and ans
  14987. (boundp 'org-ts-what)
  14988. (setq org-ts-what
  14989. (cond
  14990. ((= pos (match-beginning 0)) 'bracket)
  14991. ;; Point is considered to be "on the bracket" whether
  14992. ;; it's really on it or right after it.
  14993. ((= pos (1- (match-end 0))) 'bracket)
  14994. ((= pos (match-end 0)) 'after)
  14995. ((org-pos-in-match-range pos 2) 'year)
  14996. ((org-pos-in-match-range pos 3) 'month)
  14997. ((org-pos-in-match-range pos 7) 'hour)
  14998. ((org-pos-in-match-range pos 8) 'minute)
  14999. ((or (org-pos-in-match-range pos 4)
  15000. (org-pos-in-match-range pos 5)) 'day)
  15001. ((and (> pos (or (match-end 8) (match-end 5)))
  15002. (< pos (match-end 0)))
  15003. (- pos (or (match-end 8) (match-end 5))))
  15004. (t 'day))))
  15005. ans))
  15006. (defun org-toggle-timestamp-type ()
  15007. "Toggle the type (<active> or [inactive]) of a time stamp."
  15008. (interactive)
  15009. (when (org-at-timestamp-p t)
  15010. (let ((beg (match-beginning 0)) (end (match-end 0))
  15011. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  15012. (save-excursion
  15013. (goto-char beg)
  15014. (while (re-search-forward "[][<>]" end t)
  15015. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  15016. t t)))
  15017. (message "Timestamp is now %sactive"
  15018. (if (equal (char-after beg) ?<) "" "in")))))
  15019. (defvar org-clock-history) ; defined in org-clock.el
  15020. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  15021. (defun org-timestamp-change (n &optional what updown)
  15022. "Change the date in the time stamp at point.
  15023. The date will be changed by N times WHAT. WHAT can be `day', `month',
  15024. `year', `minute', `second'. If WHAT is not given, the cursor position
  15025. in the timestamp determines what will be changed."
  15026. (let ((origin (point)) origin-cat
  15027. with-hm inactive
  15028. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  15029. org-ts-what
  15030. extra rem
  15031. ts time time0 fixnext clrgx)
  15032. (if (not (org-at-timestamp-p t))
  15033. (error "Not at a timestamp"))
  15034. (if (and (not what) (eq org-ts-what 'bracket))
  15035. (org-toggle-timestamp-type)
  15036. ;; Point isn't on brackets. Remember the part of the time-stamp
  15037. ;; the point was in. Indeed, size of time-stamps may change,
  15038. ;; but point must be kept in the same category nonetheless.
  15039. (setq origin-cat org-ts-what)
  15040. (if (and (not what) (not (eq org-ts-what 'day))
  15041. org-display-custom-times
  15042. (get-text-property (point) 'display)
  15043. (not (get-text-property (1- (point)) 'display)))
  15044. (setq org-ts-what 'day))
  15045. (setq org-ts-what (or what org-ts-what)
  15046. inactive (= (char-after (match-beginning 0)) ?\[)
  15047. ts (match-string 0))
  15048. (replace-match "")
  15049. (if (string-match
  15050. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  15051. ts)
  15052. (setq extra (match-string 1 ts)))
  15053. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  15054. (setq with-hm t))
  15055. (setq time0 (org-parse-time-string ts))
  15056. (when (and updown
  15057. (eq org-ts-what 'minute)
  15058. (not current-prefix-arg))
  15059. ;; This looks like s-up and s-down. Change by one rounding step.
  15060. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  15061. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  15062. (setcar (cdr time0) (+ (nth 1 time0)
  15063. (if (> n 0) (- rem) (- dm rem))))))
  15064. (setq time
  15065. (encode-time (or (car time0) 0)
  15066. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  15067. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  15068. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  15069. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  15070. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  15071. (nthcdr 6 time0)))
  15072. (when (and (member org-ts-what '(hour minute))
  15073. extra
  15074. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  15075. (setq extra (org-modify-ts-extra
  15076. extra
  15077. (if (eq org-ts-what 'hour) 2 5)
  15078. n dm)))
  15079. (when (integerp org-ts-what)
  15080. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  15081. (if (eq what 'calendar)
  15082. (let ((cal-date (org-get-date-from-calendar)))
  15083. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  15084. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  15085. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  15086. (setcar time0 (or (car time0) 0))
  15087. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  15088. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  15089. (setq time (apply 'encode-time time0))))
  15090. ;; Insert the new time-stamp, and ensure point stays in the same
  15091. ;; category as before (i.e. not after the last position in that
  15092. ;; category).
  15093. (let ((pos (point)))
  15094. ;; Stay before inserted string. `save-excursion' is of no use.
  15095. (setq org-last-changed-timestamp
  15096. (org-insert-time-stamp time with-hm inactive nil nil extra))
  15097. (goto-char pos))
  15098. (save-match-data
  15099. (looking-at org-ts-regexp3)
  15100. (goto-char (cond
  15101. ;; `day' category ends before `hour' if any, or at
  15102. ;; the end of the day name.
  15103. ((eq origin-cat 'day)
  15104. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  15105. ((eq origin-cat 'hour) (min (match-end 7) origin))
  15106. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  15107. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  15108. ;; `year' and `month' have both fixed size: point
  15109. ;; couldn't have moved into another part.
  15110. (t origin))))
  15111. ;; Update clock if on a CLOCK line.
  15112. (org-clock-update-time-maybe)
  15113. ;; Maybe adjust the closest clock in `org-clock-history'
  15114. (when org-clock-adjust-closest
  15115. (if (not (and (org-at-clock-log-p)
  15116. (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
  15117. org-clock-history))))))
  15118. (message "No clock to adjust")
  15119. (cond ((save-excursion ; fix previous clock?
  15120. (re-search-backward org-ts-regexp0 nil t)
  15121. (org-looking-back (concat org-clock-string " \\[")))
  15122. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  15123. ((save-excursion ; fix next clock?
  15124. (re-search-backward org-ts-regexp0 nil t)
  15125. (looking-at (concat org-ts-regexp0 "\\] =>")))
  15126. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  15127. (save-window-excursion
  15128. ;; Find closest clock to point, adjust the previous/next one in history
  15129. (let* ((p (save-excursion (org-back-to-heading t)))
  15130. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  15131. (clfixnth
  15132. (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
  15133. (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
  15134. (if (not clfixpos)
  15135. (message "No clock to adjust")
  15136. (save-excursion
  15137. (org-goto-marker-or-bmk clfixpos)
  15138. (org-show-subtree)
  15139. (when (re-search-forward clrgx nil t)
  15140. (goto-char (match-beginning 1))
  15141. (let (org-clock-adjust-closest)
  15142. (org-timestamp-change n org-ts-what updown))
  15143. (message "Clock adjusted in %s for heading: %s"
  15144. (file-name-nondirectory (buffer-file-name))
  15145. (org-get-heading t t)))))))))
  15146. ;; Try to recenter the calendar window, if any.
  15147. (if (and org-calendar-follow-timestamp-change
  15148. (get-buffer-window "*Calendar*" t)
  15149. (memq org-ts-what '(day month year)))
  15150. (org-recenter-calendar (time-to-days time))))))
  15151. (defun org-modify-ts-extra (s pos n dm)
  15152. "Change the different parts of the lead-time and repeat fields in timestamp."
  15153. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  15154. ng h m new rem)
  15155. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  15156. (cond
  15157. ((or (org-pos-in-match-range pos 2)
  15158. (org-pos-in-match-range pos 3))
  15159. (setq m (string-to-number (match-string 3 s))
  15160. h (string-to-number (match-string 2 s)))
  15161. (if (org-pos-in-match-range pos 2)
  15162. (setq h (+ h n))
  15163. (setq n (* dm (org-no-warnings (signum n))))
  15164. (when (not (= 0 (setq rem (% m dm))))
  15165. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  15166. (setq m (+ m n)))
  15167. (if (< m 0) (setq m (+ m 60) h (1- h)))
  15168. (if (> m 59) (setq m (- m 60) h (1+ h)))
  15169. (setq h (min 24 (max 0 h)))
  15170. (setq ng 1 new (format "-%02d:%02d" h m)))
  15171. ((org-pos-in-match-range pos 6)
  15172. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  15173. ((org-pos-in-match-range pos 5)
  15174. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  15175. ((org-pos-in-match-range pos 9)
  15176. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  15177. ((org-pos-in-match-range pos 8)
  15178. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  15179. (when ng
  15180. (setq s (concat
  15181. (substring s 0 (match-beginning ng))
  15182. new
  15183. (substring s (match-end ng))))))
  15184. s))
  15185. (defun org-recenter-calendar (date)
  15186. "If the calendar is visible, recenter it to DATE."
  15187. (let ((cwin (get-buffer-window "*Calendar*" t)))
  15188. (when cwin
  15189. (let ((calendar-move-hook nil))
  15190. (with-selected-window cwin
  15191. (calendar-goto-date (if (listp date) date
  15192. (calendar-gregorian-from-absolute date))))))))
  15193. (defun org-goto-calendar (&optional arg)
  15194. "Go to the Emacs calendar at the current date.
  15195. If there is a time stamp in the current line, go to that date.
  15196. A prefix ARG can be used to force the current date."
  15197. (interactive "P")
  15198. (let ((tsr org-ts-regexp) diff
  15199. (calendar-move-hook nil)
  15200. (calendar-view-holidays-initially-flag nil)
  15201. (calendar-view-diary-initially-flag nil))
  15202. (if (or (org-at-timestamp-p)
  15203. (save-excursion
  15204. (beginning-of-line 1)
  15205. (looking-at (concat ".*" tsr))))
  15206. (let ((d1 (time-to-days (current-time)))
  15207. (d2 (time-to-days
  15208. (org-time-string-to-time (match-string 1)))))
  15209. (setq diff (- d2 d1))))
  15210. (calendar)
  15211. (calendar-goto-today)
  15212. (if (and diff (not arg)) (calendar-forward-day diff))))
  15213. (defun org-get-date-from-calendar ()
  15214. "Return a list (month day year) of date at point in calendar."
  15215. (with-current-buffer "*Calendar*"
  15216. (save-match-data
  15217. (calendar-cursor-to-date))))
  15218. (defun org-date-from-calendar ()
  15219. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  15220. If there is already a time stamp at the cursor position, update it."
  15221. (interactive)
  15222. (if (org-at-timestamp-p t)
  15223. (org-timestamp-change 0 'calendar)
  15224. (let ((cal-date (org-get-date-from-calendar)))
  15225. (org-insert-time-stamp
  15226. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  15227. (defun org-minutes-to-hh:mm-string (m)
  15228. "Compute H:MM from a number of minutes."
  15229. (let ((h (/ m 60)))
  15230. (setq m (- m (* 60 h)))
  15231. (format org-time-clocksum-format h m)))
  15232. (defun org-hh:mm-string-to-minutes (s)
  15233. "Convert a string H:MM to a number of minutes.
  15234. If the string is just a number, interpret it as minutes.
  15235. In fact, the first hh:mm or number in the string will be taken,
  15236. there can be extra stuff in the string.
  15237. If no number is found, the return value is 0."
  15238. (cond
  15239. ((integerp s) s)
  15240. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  15241. (+ (* (string-to-number (match-string 1 s)) 60)
  15242. (string-to-number (match-string 2 s))))
  15243. ((string-match "\\([0-9]+\\)" s)
  15244. (string-to-number (match-string 1 s)))
  15245. (t 0)))
  15246. (defcustom org-effort-durations
  15247. `(("h" . 60)
  15248. ("d" . ,(* 60 8))
  15249. ("w" . ,(* 60 8 5))
  15250. ("m" . ,(* 60 8 5 4))
  15251. ("y" . ,(* 60 8 5 40)))
  15252. "Conversion factor to minutes for an effort modifier.
  15253. Each entry has the form (MODIFIER . MINUTES).
  15254. In an effort string, a number followed by MODIFIER is multiplied
  15255. by the specified number of MINUTES to obtain an effort in
  15256. minutes.
  15257. For example, if the value of this variable is ((\"hours\" . 60)), then an
  15258. effort string \"2hours\" is equivalent to 120 minutes."
  15259. :group 'org-agenda
  15260. :version "24.1"
  15261. :type '(alist :key-type (string :tag "Modifier")
  15262. :value-type (number :tag "Minutes")))
  15263. (defcustom org-image-actual-width t
  15264. "Should we use the actual width of images when inlining them?
  15265. When set to `t', always use the image width.
  15266. When set to a number, use imagemagick (when available) to set
  15267. the image's width to this value.
  15268. When set to a number in a list, try to get the width from the
  15269. #+ATTR.* keyword if it matches a width specification like
  15270. width=\"[0-9]+\", and fall back on that number if none is found.
  15271. When set to nil, try to get the width from an #+ATTR.* keyword
  15272. and fall back on the original width if none is found.
  15273. This requires Emacs >= 24.1, build with imagemagick support."
  15274. :group 'org-appearance
  15275. :version "24.3"
  15276. :type '(choice
  15277. (const :tag "Use the image width" t)
  15278. (integer :tag "Use a number of pixels")
  15279. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  15280. (const :tag "Use #+ATTR* or don't resize" nil)))
  15281. (defun org-duration-string-to-minutes (s &optional output-to-string)
  15282. "Convert a duration string S to minutes.
  15283. A bare number is interpreted as minutes, modifiers can be set by
  15284. customizing `org-effort-durations' (which see).
  15285. Entries containing a colon are interpreted as H:MM by
  15286. `org-hh:mm-string-to-minutes'."
  15287. (let ((result 0)
  15288. (re (concat "\\([0-9.]+\\) *\\("
  15289. (regexp-opt (mapcar 'car org-effort-durations))
  15290. "\\)")))
  15291. (while (string-match re s)
  15292. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  15293. (string-to-number (match-string 1 s))))
  15294. (setq s (replace-match "" nil t s)))
  15295. (setq result (floor result))
  15296. (incf result (org-hh:mm-string-to-minutes s))
  15297. (if output-to-string (number-to-string result) result)))
  15298. ;;;; Files
  15299. (defun org-save-all-org-buffers ()
  15300. "Save all Org-mode buffers without user confirmation."
  15301. (interactive)
  15302. (message "Saving all Org-mode buffers...")
  15303. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  15304. (when (featurep 'org-id) (org-id-locations-save))
  15305. (message "Saving all Org-mode buffers... done"))
  15306. (defun org-revert-all-org-buffers ()
  15307. "Revert all Org-mode buffers.
  15308. Prompt for confirmation when there are unsaved changes.
  15309. Be sure you know what you are doing before letting this function
  15310. overwrite your changes.
  15311. This function is useful in a setup where one tracks org files
  15312. with a version control system, to revert on one machine after pulling
  15313. changes from another. I believe the procedure must be like this:
  15314. 1. M-x org-save-all-org-buffers
  15315. 2. Pull changes from the other machine, resolve conflicts
  15316. 3. M-x org-revert-all-org-buffers"
  15317. (interactive)
  15318. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  15319. (error "Abort"))
  15320. (save-excursion
  15321. (save-window-excursion
  15322. (mapc
  15323. (lambda (b)
  15324. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  15325. (with-current-buffer b buffer-file-name))
  15326. (org-pop-to-buffer-same-window b)
  15327. (revert-buffer t 'no-confirm)))
  15328. (buffer-list))
  15329. (when (and (featurep 'org-id) org-id-track-globally)
  15330. (org-id-locations-load)))))
  15331. ;;;; Agenda files
  15332. ;;;###autoload
  15333. (defun org-switchb (&optional arg)
  15334. "Switch between Org buffers.
  15335. With one prefix argument, restrict available buffers to files.
  15336. With two prefix arguments, restrict available buffers to agenda files.
  15337. Defaults to `iswitchb' for buffer name completion.
  15338. Set `org-completion-use-ido' to make it use ido instead."
  15339. (interactive "P")
  15340. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  15341. ((equal arg '(16)) (org-buffer-list 'agenda))
  15342. (t (org-buffer-list))))
  15343. (org-completion-use-iswitchb org-completion-use-iswitchb)
  15344. (org-completion-use-ido org-completion-use-ido))
  15345. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  15346. (setq org-completion-use-iswitchb t))
  15347. (org-pop-to-buffer-same-window
  15348. (org-icompleting-read "Org buffer: "
  15349. (mapcar 'list (mapcar 'buffer-name blist))
  15350. nil t))))
  15351. ;;; Define some older names previously used for this functionality
  15352. ;;;###autoload
  15353. (defalias 'org-ido-switchb 'org-switchb)
  15354. ;;;###autoload
  15355. (defalias 'org-iswitchb 'org-switchb)
  15356. (defun org-buffer-list (&optional predicate exclude-tmp)
  15357. "Return a list of Org buffers.
  15358. PREDICATE can be `export', `files' or `agenda'.
  15359. export restrict the list to Export buffers.
  15360. files restrict the list to buffers visiting Org files.
  15361. agenda restrict the list to buffers visiting agenda files.
  15362. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  15363. (let* ((bfn nil)
  15364. (agenda-files (and (eq predicate 'agenda)
  15365. (mapcar 'file-truename (org-agenda-files t))))
  15366. (filter
  15367. (cond
  15368. ((eq predicate 'files)
  15369. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  15370. ((eq predicate 'export)
  15371. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  15372. ((eq predicate 'agenda)
  15373. (lambda (b)
  15374. (with-current-buffer b
  15375. (and (derived-mode-p 'org-mode)
  15376. (setq bfn (buffer-file-name b))
  15377. (member (file-truename bfn) agenda-files)))))
  15378. (t (lambda (b) (with-current-buffer b
  15379. (or (derived-mode-p 'org-mode)
  15380. (string-match "\*Org .*Export"
  15381. (buffer-name b)))))))))
  15382. (delq nil
  15383. (mapcar
  15384. (lambda(b)
  15385. (if (and (funcall filter b)
  15386. (or (not exclude-tmp)
  15387. (not (string-match "tmp" (buffer-name b)))))
  15388. b
  15389. nil))
  15390. (buffer-list)))))
  15391. (defun org-agenda-files (&optional unrestricted archives)
  15392. "Get the list of agenda files.
  15393. Optional UNRESTRICTED means return the full list even if a restriction
  15394. is currently in place.
  15395. When ARCHIVES is t, include all archive files that are really being
  15396. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  15397. `org-agenda-archives-mode' is t."
  15398. (let ((files
  15399. (cond
  15400. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  15401. ((stringp org-agenda-files) (org-read-agenda-file-list))
  15402. ((listp org-agenda-files) org-agenda-files)
  15403. (t (error "Invalid value of `org-agenda-files'")))))
  15404. (setq files (apply 'append
  15405. (mapcar (lambda (f)
  15406. (if (file-directory-p f)
  15407. (directory-files
  15408. f t org-agenda-file-regexp)
  15409. (list f)))
  15410. files)))
  15411. (when org-agenda-skip-unavailable-files
  15412. (setq files (delq nil
  15413. (mapcar (function
  15414. (lambda (file)
  15415. (and (file-readable-p file) file)))
  15416. files))))
  15417. (when (or (eq archives t)
  15418. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  15419. (setq files (org-add-archive-files files)))
  15420. files))
  15421. (defun org-agenda-file-p (&optional file)
  15422. "Return non-nil, if FILE is an agenda file.
  15423. If FILE is omitted, use the file associated with the current
  15424. buffer."
  15425. (member (or file (buffer-file-name))
  15426. (org-agenda-files t)))
  15427. (defun org-edit-agenda-file-list ()
  15428. "Edit the list of agenda files.
  15429. Depending on setup, this either uses customize to edit the variable
  15430. `org-agenda-files', or it visits the file that is holding the list. In the
  15431. latter case, the buffer is set up in a way that saving it automatically kills
  15432. the buffer and restores the previous window configuration."
  15433. (interactive)
  15434. (if (stringp org-agenda-files)
  15435. (let ((cw (current-window-configuration)))
  15436. (find-file org-agenda-files)
  15437. (org-set-local 'org-window-configuration cw)
  15438. (org-add-hook 'after-save-hook
  15439. (lambda ()
  15440. (set-window-configuration
  15441. (prog1 org-window-configuration
  15442. (kill-buffer (current-buffer))))
  15443. (org-install-agenda-files-menu)
  15444. (message "New agenda file list installed"))
  15445. nil 'local)
  15446. (message "%s" (substitute-command-keys
  15447. "Edit list and finish with \\[save-buffer]")))
  15448. (customize-variable 'org-agenda-files)))
  15449. (defun org-store-new-agenda-file-list (list)
  15450. "Set new value for the agenda file list and save it correctly."
  15451. (if (stringp org-agenda-files)
  15452. (let ((fe (org-read-agenda-file-list t)) b u)
  15453. (while (setq b (find-buffer-visiting org-agenda-files))
  15454. (kill-buffer b))
  15455. (with-temp-file org-agenda-files
  15456. (insert
  15457. (mapconcat
  15458. (lambda (f) ;; Keep un-expanded entries.
  15459. (if (setq u (assoc f fe))
  15460. (cdr u)
  15461. f))
  15462. list "\n")
  15463. "\n")))
  15464. (let ((org-mode-hook nil) (org-inhibit-startup t)
  15465. (org-insert-mode-line-in-empty-file nil))
  15466. (setq org-agenda-files list)
  15467. (customize-save-variable 'org-agenda-files org-agenda-files))))
  15468. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  15469. "Read the list of agenda files from a file.
  15470. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  15471. filenames, used by `org-store-new-agenda-file-list' to write back
  15472. un-expanded file names."
  15473. (when (file-directory-p org-agenda-files)
  15474. (error "`org-agenda-files' cannot be a single directory"))
  15475. (when (stringp org-agenda-files)
  15476. (with-temp-buffer
  15477. (insert-file-contents org-agenda-files)
  15478. (mapcar
  15479. (lambda (f)
  15480. (let ((e (expand-file-name (substitute-in-file-name f)
  15481. org-directory)))
  15482. (if pair-with-expansion
  15483. (cons e f)
  15484. e)))
  15485. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  15486. ;;;###autoload
  15487. (defun org-cycle-agenda-files ()
  15488. "Cycle through the files in `org-agenda-files'.
  15489. If the current buffer visits an agenda file, find the next one in the list.
  15490. If the current buffer does not, find the first agenda file."
  15491. (interactive)
  15492. (let* ((fs (org-agenda-files t))
  15493. (files (append fs (list (car fs))))
  15494. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  15495. file)
  15496. (unless files (error "No agenda files"))
  15497. (catch 'exit
  15498. (while (setq file (pop files))
  15499. (if (equal (file-truename file) tcf)
  15500. (when (car files)
  15501. (find-file (car files))
  15502. (throw 'exit t))))
  15503. (find-file (car fs)))
  15504. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  15505. (defun org-agenda-file-to-front (&optional to-end)
  15506. "Move/add the current file to the top of the agenda file list.
  15507. If the file is not present in the list, it is added to the front. If it is
  15508. present, it is moved there. With optional argument TO-END, add/move to the
  15509. end of the list."
  15510. (interactive "P")
  15511. (let ((org-agenda-skip-unavailable-files nil)
  15512. (file-alist (mapcar (lambda (x)
  15513. (cons (file-truename x) x))
  15514. (org-agenda-files t)))
  15515. (ctf (file-truename buffer-file-name))
  15516. x had)
  15517. (setq x (assoc ctf file-alist) had x)
  15518. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  15519. (if to-end
  15520. (setq file-alist (append (delq x file-alist) (list x)))
  15521. (setq file-alist (cons x (delq x file-alist))))
  15522. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  15523. (org-install-agenda-files-menu)
  15524. (message "File %s to %s of agenda file list"
  15525. (if had "moved" "added") (if to-end "end" "front"))))
  15526. (defun org-remove-file (&optional file)
  15527. "Remove current file from the list of files in variable `org-agenda-files'.
  15528. These are the files which are being checked for agenda entries.
  15529. Optional argument FILE means use this file instead of the current."
  15530. (interactive)
  15531. (let* ((org-agenda-skip-unavailable-files nil)
  15532. (file (or file buffer-file-name))
  15533. (true-file (file-truename file))
  15534. (afile (abbreviate-file-name file))
  15535. (files (delq nil (mapcar
  15536. (lambda (x)
  15537. (if (equal true-file
  15538. (file-truename x))
  15539. nil x))
  15540. (org-agenda-files t)))))
  15541. (if (not (= (length files) (length (org-agenda-files t))))
  15542. (progn
  15543. (org-store-new-agenda-file-list files)
  15544. (org-install-agenda-files-menu)
  15545. (message "Removed file: %s" afile))
  15546. (message "File was not in list: %s (not removed)" afile))))
  15547. (defun org-file-menu-entry (file)
  15548. (vector file (list 'find-file file) t))
  15549. (defun org-check-agenda-file (file)
  15550. "Make sure FILE exists. If not, ask user what to do."
  15551. (when (not (file-exists-p file))
  15552. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  15553. (abbreviate-file-name file))
  15554. (let ((r (downcase (read-char-exclusive))))
  15555. (cond
  15556. ((equal r ?r)
  15557. (org-remove-file file)
  15558. (throw 'nextfile t))
  15559. (t (error "Abort"))))))
  15560. (defun org-get-agenda-file-buffer (file)
  15561. "Get a buffer visiting FILE. If the buffer needs to be created, add
  15562. it to the list of buffers which might be released later."
  15563. (let ((buf (org-find-base-buffer-visiting file)))
  15564. (if buf
  15565. buf ; just return it
  15566. ;; Make a new buffer and remember it
  15567. (setq buf (find-file-noselect file))
  15568. (if buf (push buf org-agenda-new-buffers))
  15569. buf)))
  15570. (defun org-release-buffers (blist)
  15571. "Release all buffers in list, asking the user for confirmation when needed.
  15572. When a buffer is unmodified, it is just killed. When modified, it is saved
  15573. \(if the user agrees) and then killed."
  15574. (let (buf file)
  15575. (while (setq buf (pop blist))
  15576. (setq file (buffer-file-name buf))
  15577. (when (and (buffer-modified-p buf)
  15578. file
  15579. (y-or-n-p (format "Save file %s? " file)))
  15580. (with-current-buffer buf (save-buffer)))
  15581. (kill-buffer buf))))
  15582. (defun org-agenda-prepare-buffers (files)
  15583. "Create buffers for all agenda files, protect archived trees and comments."
  15584. (interactive)
  15585. (let ((pa '(:org-archived t))
  15586. (pc '(:org-comment t))
  15587. (pall '(:org-archived t :org-comment t))
  15588. (inhibit-read-only t)
  15589. (rea (concat ":" org-archive-tag ":"))
  15590. bmp file re)
  15591. (save-excursion
  15592. (save-restriction
  15593. (while (setq file (pop files))
  15594. (catch 'nextfile
  15595. (if (bufferp file)
  15596. (set-buffer file)
  15597. (org-check-agenda-file file)
  15598. (set-buffer (org-get-agenda-file-buffer file)))
  15599. (widen)
  15600. (setq bmp (buffer-modified-p))
  15601. (org-refresh-category-properties)
  15602. (setq org-todo-keywords-for-agenda
  15603. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  15604. (setq org-done-keywords-for-agenda
  15605. (append org-done-keywords-for-agenda org-done-keywords))
  15606. (setq org-todo-keyword-alist-for-agenda
  15607. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  15608. (setq org-drawers-for-agenda
  15609. (append org-drawers-for-agenda org-drawers))
  15610. (setq org-tag-alist-for-agenda
  15611. (append org-tag-alist-for-agenda org-tag-alist))
  15612. (save-excursion
  15613. (remove-text-properties (point-min) (point-max) pall)
  15614. (when org-agenda-skip-archived-trees
  15615. (goto-char (point-min))
  15616. (while (re-search-forward rea nil t)
  15617. (if (org-at-heading-p t)
  15618. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  15619. (goto-char (point-min))
  15620. (setq re (format org-heading-keyword-regexp-format
  15621. org-comment-string))
  15622. (while (re-search-forward re nil t)
  15623. (add-text-properties
  15624. (match-beginning 0) (org-end-of-subtree t) pc)))
  15625. (set-buffer-modified-p bmp)))))
  15626. (setq org-todo-keywords-for-agenda
  15627. (org-uniquify org-todo-keywords-for-agenda))
  15628. (setq org-todo-keyword-alist-for-agenda
  15629. (org-uniquify org-todo-keyword-alist-for-agenda)
  15630. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  15631. ;;;; Embedded LaTeX
  15632. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  15633. "Keymap for the minor `org-cdlatex-mode'.")
  15634. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  15635. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  15636. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  15637. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  15638. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  15639. (defvar org-cdlatex-texmathp-advice-is-done nil
  15640. "Flag remembering if we have applied the advice to texmathp already.")
  15641. (define-minor-mode org-cdlatex-mode
  15642. "Toggle the minor `org-cdlatex-mode'.
  15643. This mode supports entering LaTeX environment and math in LaTeX fragments
  15644. in Org-mode.
  15645. \\{org-cdlatex-mode-map}"
  15646. nil " OCDL" nil
  15647. (when org-cdlatex-mode
  15648. (require 'cdlatex)
  15649. (run-hooks 'cdlatex-mode-hook)
  15650. (cdlatex-compute-tables))
  15651. (unless org-cdlatex-texmathp-advice-is-done
  15652. (setq org-cdlatex-texmathp-advice-is-done t)
  15653. (defadvice texmathp (around org-math-always-on activate)
  15654. "Always return t in org-mode buffers.
  15655. This is because we want to insert math symbols without dollars even outside
  15656. the LaTeX math segments. If Orgmode thinks that point is actually inside
  15657. an embedded LaTeX fragment, let texmathp do its job.
  15658. \\[org-cdlatex-mode-map]"
  15659. (interactive)
  15660. (let (p)
  15661. (cond
  15662. ((not (derived-mode-p 'org-mode)) ad-do-it)
  15663. ((eq this-command 'cdlatex-math-symbol)
  15664. (setq ad-return-value t
  15665. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  15666. (t
  15667. (let ((p (org-inside-LaTeX-fragment-p)))
  15668. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  15669. (setq ad-return-value t
  15670. texmathp-why '("Org-mode embedded math" . 0))
  15671. (if p ad-do-it)))))))))
  15672. (defun turn-on-org-cdlatex ()
  15673. "Unconditionally turn on `org-cdlatex-mode'."
  15674. (org-cdlatex-mode 1))
  15675. (defun org-inside-LaTeX-fragment-p ()
  15676. "Test if point is inside a LaTeX fragment.
  15677. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  15678. sequence appearing also before point.
  15679. Even though the matchers for math are configurable, this function assumes
  15680. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  15681. delimiters are skipped when they have been removed by customization.
  15682. The return value is nil, or a cons cell with the delimiter and the
  15683. position of this delimiter.
  15684. This function does a reasonably good job, but can locally be fooled by
  15685. for example currency specifications. For example it will assume being in
  15686. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  15687. fragments that are properly closed, but during editing, we have to live
  15688. with the uncertainty caused by missing closing delimiters. This function
  15689. looks only before point, not after."
  15690. (catch 'exit
  15691. (let ((pos (point))
  15692. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  15693. (lim (progn
  15694. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  15695. (point)))
  15696. dd-on str (start 0) m re)
  15697. (goto-char pos)
  15698. (when dodollar
  15699. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  15700. re (nth 1 (assoc "$" org-latex-regexps)))
  15701. (while (string-match re str start)
  15702. (cond
  15703. ((= (match-end 0) (length str))
  15704. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  15705. ((= (match-end 0) (- (length str) 5))
  15706. (throw 'exit nil))
  15707. (t (setq start (match-end 0))))))
  15708. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  15709. (goto-char pos)
  15710. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  15711. (and (match-beginning 2) (throw 'exit nil))
  15712. ;; count $$
  15713. (while (re-search-backward "\\$\\$" lim t)
  15714. (setq dd-on (not dd-on)))
  15715. (goto-char pos)
  15716. (if dd-on (cons "$$" m))))))
  15717. (defun org-inside-latex-macro-p ()
  15718. "Is point inside a LaTeX macro or its arguments?"
  15719. (save-match-data
  15720. (org-in-regexp
  15721. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  15722. (defun org-try-cdlatex-tab ()
  15723. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  15724. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  15725. - inside a LaTeX fragment, or
  15726. - after the first word in a line, where an abbreviation expansion could
  15727. insert a LaTeX environment."
  15728. (when org-cdlatex-mode
  15729. (cond
  15730. ;; Before any word on the line: No expansion possible.
  15731. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  15732. ;; Just after first word on the line: Expand it. Make sure it
  15733. ;; cannot happen on headlines, though.
  15734. ((save-excursion
  15735. (skip-chars-backward "a-zA-Z0-9*")
  15736. (skip-chars-backward " \t")
  15737. (and (bolp) (not (org-at-heading-p))))
  15738. (cdlatex-tab) t)
  15739. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  15740. (defun org-cdlatex-underscore-caret (&optional arg)
  15741. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  15742. Revert to the normal definition outside of these fragments."
  15743. (interactive "P")
  15744. (if (org-inside-LaTeX-fragment-p)
  15745. (call-interactively 'cdlatex-sub-superscript)
  15746. (let (org-cdlatex-mode)
  15747. (call-interactively (key-binding (vector last-input-event))))))
  15748. (defun org-cdlatex-math-modify (&optional arg)
  15749. "Execute `cdlatex-math-modify' in LaTeX fragments.
  15750. Revert to the normal definition outside of these fragments."
  15751. (interactive "P")
  15752. (if (org-inside-LaTeX-fragment-p)
  15753. (call-interactively 'cdlatex-math-modify)
  15754. (let (org-cdlatex-mode)
  15755. (call-interactively (key-binding (vector last-input-event))))))
  15756. (defvar org-latex-fragment-image-overlays nil
  15757. "List of overlays carrying the images of latex fragments.")
  15758. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  15759. (defun org-remove-latex-fragment-image-overlays ()
  15760. "Remove all overlays with LaTeX fragment images in current buffer."
  15761. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  15762. (setq org-latex-fragment-image-overlays nil))
  15763. (defun org-preview-latex-fragment (&optional subtree)
  15764. "Preview the LaTeX fragment at point, or all locally or globally.
  15765. If the cursor is in a LaTeX fragment, create the image and overlay
  15766. it over the source code. If there is no fragment at point, display
  15767. all fragments in the current text, from one headline to the next. With
  15768. prefix SUBTREE, display all fragments in the current subtree. With a
  15769. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  15770. the cursor is before the first headline,
  15771. display all fragments in the buffer.
  15772. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  15773. (interactive "P")
  15774. (unless buffer-file-name
  15775. (error "Can't preview LaTeX fragment in a non-file buffer"))
  15776. (org-remove-latex-fragment-image-overlays)
  15777. (save-excursion
  15778. (save-restriction
  15779. (let (beg end at msg)
  15780. (cond
  15781. ((or (equal subtree '(16))
  15782. (not (save-excursion
  15783. (re-search-backward org-outline-regexp-bol nil t))))
  15784. (setq beg (point-min) end (point-max)
  15785. msg "Creating images for buffer...%s"))
  15786. ((equal subtree '(4))
  15787. (org-back-to-heading)
  15788. (setq beg (point) end (org-end-of-subtree t)
  15789. msg "Creating images for subtree...%s"))
  15790. (t
  15791. (if (setq at (org-inside-LaTeX-fragment-p))
  15792. (goto-char (max (point-min) (- (cdr at) 2)))
  15793. (org-back-to-heading))
  15794. (setq beg (point) end (progn (outline-next-heading) (point))
  15795. msg (if at "Creating image...%s"
  15796. "Creating images for entry...%s"))))
  15797. (message msg "")
  15798. (narrow-to-region beg end)
  15799. (goto-char beg)
  15800. (org-format-latex
  15801. (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
  15802. (file-name-nondirectory
  15803. buffer-file-name)))
  15804. default-directory 'overlays msg at 'forbuffer
  15805. org-latex-create-formula-image-program)
  15806. (message msg "done. Use `C-c C-c' to remove images.")))))
  15807. (defvar org-latex-regexps
  15808. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  15809. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  15810. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  15811. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15812. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15813. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  15814. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  15815. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  15816. "Regular expressions for matching embedded LaTeX.")
  15817. (defvar org-export-have-math nil) ;; dynamic scoping
  15818. (defun org-format-latex (prefix &optional dir overlays msg at
  15819. forbuffer processing-type)
  15820. "Replace LaTeX fragments with links to an image, and produce images.
  15821. Some of the options can be changed using the variable
  15822. `org-format-latex-options'."
  15823. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  15824. (let* ((prefixnodir (file-name-nondirectory prefix))
  15825. (absprefix (expand-file-name prefix dir))
  15826. (todir (file-name-directory absprefix))
  15827. (opt org-format-latex-options)
  15828. (optnew org-format-latex-options)
  15829. (matchers (plist-get opt :matchers))
  15830. (re-list org-latex-regexps)
  15831. (org-format-latex-header-extra
  15832. (plist-get (org-infile-export-plist) :latex-header-extra))
  15833. (cnt 0) txt hash link beg end re e checkdir
  15834. string
  15835. m n block-type block linkfile movefile ov)
  15836. ;; Check the different regular expressions
  15837. (while (setq e (pop re-list))
  15838. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  15839. block (if block-type "\n\n" ""))
  15840. (when (member m matchers)
  15841. (goto-char (point-min))
  15842. (while (re-search-forward re nil t)
  15843. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  15844. (not (get-text-property (match-beginning n)
  15845. 'org-protected))
  15846. (or (not overlays)
  15847. (not (eq (get-char-property (match-beginning n)
  15848. 'org-overlay-type)
  15849. 'org-latex-overlay))))
  15850. (setq org-export-have-math t)
  15851. (cond
  15852. ((eq processing-type 'verbatim)
  15853. ;; Leave the text verbatim, just protect it
  15854. (add-text-properties (match-beginning n) (match-end n)
  15855. '(org-protected t)))
  15856. ((eq processing-type 'mathjax)
  15857. ;; Prepare for MathJax processing
  15858. (setq string (match-string n))
  15859. (if (member m '("$" "$1"))
  15860. (save-excursion
  15861. (delete-region (match-beginning n) (match-end n))
  15862. (goto-char (match-beginning n))
  15863. (insert (org-add-props (concat "\\(" (substring string 1 -1)
  15864. "\\)")
  15865. '(org-protected t))))
  15866. (add-text-properties (match-beginning n) (match-end n)
  15867. '(org-protected t))))
  15868. ((or (eq processing-type 'dvipng)
  15869. (eq processing-type 'imagemagick))
  15870. ;; Process to an image
  15871. (setq txt (match-string n)
  15872. beg (match-beginning n) end (match-end n)
  15873. cnt (1+ cnt))
  15874. (let ((face (face-at-point))
  15875. (fg (plist-get opt :foreground))
  15876. (bg (plist-get opt :background))
  15877. print-length print-level) ; make sure full list is printed
  15878. (when forbuffer
  15879. ; Get the colors from the face at point
  15880. (goto-char beg)
  15881. (when (eq fg 'auto)
  15882. (setq fg (face-attribute face :foreground nil 'default)))
  15883. (when (eq bg 'auto)
  15884. (setq bg (face-attribute face :background nil 'default)))
  15885. (setq optnew (copy-sequence opt))
  15886. (plist-put optnew :foreground fg)
  15887. (plist-put optnew :background bg))
  15888. (setq hash (sha1 (prin1-to-string
  15889. (list org-format-latex-header
  15890. org-format-latex-header-extra
  15891. org-export-latex-default-packages-alist
  15892. org-export-latex-packages-alist
  15893. org-format-latex-options
  15894. forbuffer txt fg bg)))
  15895. linkfile (format "%s_%s.png" prefix hash)
  15896. movefile (format "%s_%s.png" absprefix hash)))
  15897. (setq link (concat block "[[file:" linkfile "]]" block))
  15898. (if msg (message msg cnt))
  15899. (goto-char beg)
  15900. (unless checkdir ; make sure the directory exists
  15901. (setq checkdir t)
  15902. (or (file-directory-p todir) (make-directory todir t)))
  15903. (org-create-formula-image
  15904. txt movefile optnew forbuffer processing-type)
  15905. (if overlays
  15906. (progn
  15907. (mapc (lambda (o)
  15908. (if (eq (overlay-get o 'org-overlay-type)
  15909. 'org-latex-overlay)
  15910. (delete-overlay o)))
  15911. (overlays-in beg end))
  15912. (setq ov (make-overlay beg end))
  15913. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  15914. (if (featurep 'xemacs)
  15915. (progn
  15916. (overlay-put ov 'invisible t)
  15917. (overlay-put
  15918. ov 'end-glyph
  15919. (make-glyph (vector 'png :file movefile))))
  15920. (overlay-put
  15921. ov 'display
  15922. (list 'image :type 'png :file movefile :ascent 'center)))
  15923. (push ov org-latex-fragment-image-overlays)
  15924. (goto-char end))
  15925. (delete-region beg end)
  15926. (insert (org-add-props link
  15927. (list 'org-latex-src
  15928. (replace-regexp-in-string
  15929. "\"" "" txt)
  15930. 'org-latex-src-embed-type
  15931. (if block-type 'paragraph 'character))))))
  15932. ((eq processing-type 'mathml)
  15933. ;; Process to MathML
  15934. (unless (save-match-data (org-format-latex-mathml-available-p))
  15935. (error "LaTeX to MathML converter not configured"))
  15936. (setq txt (match-string n)
  15937. beg (match-beginning n) end (match-end n)
  15938. cnt (1+ cnt))
  15939. (if msg (message msg cnt))
  15940. (goto-char beg)
  15941. (delete-region beg end)
  15942. (insert (org-format-latex-as-mathml
  15943. txt block-type prefix dir)))
  15944. (t
  15945. (error "Unknown conversion type %s for latex fragments"
  15946. processing-type)))))))))
  15947. (defun org-create-math-formula (latex-frag &optional mathml-file)
  15948. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  15949. Use `org-latex-to-mathml-convert-command'. If the conversion is
  15950. sucessful, return the portion between \"<math...> </math>\"
  15951. elements otherwise return nil. When MATHML-FILE is specified,
  15952. write the results in to that file. When invoked as an
  15953. interactive command, prompt for LATEX-FRAG, with initial value
  15954. set to the current active region and echo the results for user
  15955. inspection."
  15956. (interactive (list (let ((frag (when (org-region-active-p)
  15957. (buffer-substring-no-properties
  15958. (region-beginning) (region-end)))))
  15959. (read-string "LaTeX Fragment: " frag nil frag))))
  15960. (unless latex-frag (error "Invalid latex-frag"))
  15961. (let* ((tmp-in-file (file-relative-name
  15962. (make-temp-name (expand-file-name "ltxmathml-in"))))
  15963. (ignore (write-region latex-frag nil tmp-in-file))
  15964. (tmp-out-file (file-relative-name
  15965. (make-temp-name (expand-file-name "ltxmathml-out"))))
  15966. (cmd (format-spec
  15967. org-latex-to-mathml-convert-command
  15968. `((?j . ,(shell-quote-argument
  15969. (expand-file-name org-latex-to-mathml-jar-file)))
  15970. (?I . ,(shell-quote-argument tmp-in-file))
  15971. (?o . ,(shell-quote-argument tmp-out-file)))))
  15972. mathml shell-command-output)
  15973. (when (org-called-interactively-p 'any)
  15974. (unless (org-format-latex-mathml-available-p)
  15975. (error "LaTeX to MathML converter not configured")))
  15976. (message "Running %s" cmd)
  15977. (setq shell-command-output (shell-command-to-string cmd))
  15978. (setq mathml
  15979. (when (file-readable-p tmp-out-file)
  15980. (with-current-buffer (find-file-noselect tmp-out-file t)
  15981. (goto-char (point-min))
  15982. (when (re-search-forward
  15983. (concat
  15984. (regexp-quote
  15985. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  15986. "\\(.\\|\n\\)*"
  15987. (regexp-quote "</math>")) nil t)
  15988. (prog1 (match-string 0) (kill-buffer))))))
  15989. (cond
  15990. (mathml
  15991. (setq mathml
  15992. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  15993. (when mathml-file
  15994. (write-region mathml nil mathml-file))
  15995. (when (org-called-interactively-p 'any)
  15996. (message mathml)))
  15997. ((message "LaTeX to MathML conversion failed")
  15998. (message shell-command-output)))
  15999. (delete-file tmp-in-file)
  16000. (when (file-exists-p tmp-out-file)
  16001. (delete-file tmp-out-file))
  16002. mathml))
  16003. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  16004. prefix &optional dir)
  16005. "Use `org-create-math-formula' but check local cache first."
  16006. (let* ((absprefix (expand-file-name prefix dir))
  16007. (print-length nil) (print-level nil)
  16008. (formula-id (concat
  16009. "formula-"
  16010. (sha1
  16011. (prin1-to-string
  16012. (list latex-frag
  16013. org-latex-to-mathml-convert-command)))))
  16014. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  16015. (formula-cache-dir (file-name-directory formula-cache)))
  16016. (unless (file-directory-p formula-cache-dir)
  16017. (make-directory formula-cache-dir t))
  16018. (unless (file-exists-p formula-cache)
  16019. (org-create-math-formula latex-frag formula-cache))
  16020. (if (file-exists-p formula-cache)
  16021. ;; Successful conversion. Return the link to MathML file.
  16022. (org-add-props
  16023. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  16024. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  16025. 'org-latex-src-embed-type (if latex-frag-type
  16026. 'paragraph 'character)))
  16027. ;; Failed conversion. Return the LaTeX fragment verbatim
  16028. (add-text-properties
  16029. 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
  16030. latex-frag)))
  16031. (defun org-create-formula-image (string tofile options buffer &optional type)
  16032. "Create an image from LaTeX source using dvipng or convert.
  16033. This function calls either `org-create-formula-image-with-dvipng'
  16034. or `org-create-formula-image-with-imagemagick' depending on the
  16035. value of `org-latex-create-formula-image-program' or on the value
  16036. of the optional TYPE variable.
  16037. Note: ultimately these two function should be combined as they
  16038. share a good deal of logic."
  16039. (org-check-external-command
  16040. "latex" "needed to convert LaTeX fragments to images")
  16041. (funcall
  16042. (case (or type org-latex-create-formula-image-program)
  16043. ('dvipng
  16044. (org-check-external-command
  16045. "dvipng" "needed to convert LaTeX fragments to images")
  16046. #'org-create-formula-image-with-dvipng)
  16047. ('imagemagick
  16048. (org-check-external-command
  16049. "convert" "you need to install imagemagick")
  16050. #'org-create-formula-image-with-imagemagick)
  16051. (t (error
  16052. "invalid value of `org-latex-create-formula-image-program'")))
  16053. string tofile options buffer))
  16054. ;; This function borrows from Ganesh Swami's latex2png.el
  16055. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  16056. "This calls dvipng."
  16057. (require 'org-latex)
  16058. (let* ((tmpdir (if (featurep 'xemacs)
  16059. (temp-directory)
  16060. temporary-file-directory))
  16061. (texfilebase (make-temp-name
  16062. (expand-file-name "orgtex" tmpdir)))
  16063. (texfile (concat texfilebase ".tex"))
  16064. (dvifile (concat texfilebase ".dvi"))
  16065. (pngfile (concat texfilebase ".png"))
  16066. (fnh (if (featurep 'xemacs)
  16067. (font-height (face-font 'default))
  16068. (face-attribute 'default :height nil)))
  16069. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16070. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16071. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16072. "Black"))
  16073. (bg (or (plist-get options (if buffer :background :html-background))
  16074. "Transparent")))
  16075. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
  16076. (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
  16077. (if (eq bg 'default) (setq bg (org-dvipng-color :background))
  16078. (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
  16079. (with-temp-file texfile
  16080. (insert (org-splice-latex-header
  16081. org-format-latex-header
  16082. org-export-latex-default-packages-alist
  16083. org-export-latex-packages-alist t
  16084. org-format-latex-header-extra))
  16085. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  16086. (require 'org-latex)
  16087. (org-export-latex-fix-inputenc))
  16088. (let ((dir default-directory))
  16089. (condition-case nil
  16090. (progn
  16091. (cd tmpdir)
  16092. (call-process "latex" nil nil nil texfile))
  16093. (error nil))
  16094. (cd dir))
  16095. (if (not (file-exists-p dvifile))
  16096. (progn (message "Failed to create dvi file from %s" texfile) nil)
  16097. (condition-case nil
  16098. (if (featurep 'xemacs)
  16099. (call-process "dvipng" nil nil nil
  16100. "-fg" fg "-bg" bg
  16101. "-T" "tight"
  16102. "-o" pngfile
  16103. dvifile)
  16104. (call-process "dvipng" nil nil nil
  16105. "-fg" fg "-bg" bg
  16106. "-D" dpi
  16107. ;;"-x" scale "-y" scale
  16108. "-T" "tight"
  16109. "-o" pngfile
  16110. dvifile))
  16111. (error nil))
  16112. (if (not (file-exists-p pngfile))
  16113. (if org-format-latex-signal-error
  16114. (error "Failed to create png file from %s" texfile)
  16115. (message "Failed to create png file from %s" texfile)
  16116. nil)
  16117. ;; Use the requested file name and clean up
  16118. (copy-file pngfile tofile 'replace)
  16119. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  16120. (if (file-exists-p (concat texfilebase e))
  16121. (delete-file (concat texfilebase e))))
  16122. pngfile))))
  16123. (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
  16124. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  16125. "This calls convert, which is included into imagemagick."
  16126. (require 'org-latex)
  16127. (let* ((tmpdir (if (featurep 'xemacs)
  16128. (temp-directory)
  16129. temporary-file-directory))
  16130. (texfilebase (make-temp-name
  16131. (expand-file-name "orgtex" tmpdir)))
  16132. (texfile (concat texfilebase ".tex"))
  16133. (pdffile (concat texfilebase ".pdf"))
  16134. (pngfile (concat texfilebase ".png"))
  16135. (fnh (if (featurep 'xemacs)
  16136. (font-height (face-font 'default))
  16137. (face-attribute 'default :height nil)))
  16138. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16139. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16140. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16141. "black"))
  16142. (bg (or (plist-get options (if buffer :background :html-background))
  16143. "white")))
  16144. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  16145. (setq fg (org-latex-color-format fg)))
  16146. (if (eq bg 'default) (setq bg (org-latex-color :background))
  16147. (setq bg (org-latex-color-format
  16148. (if (string= bg "Transparent") "white" bg))))
  16149. (with-temp-file texfile
  16150. (insert (org-splice-latex-header
  16151. org-format-latex-header
  16152. org-export-latex-default-packages-alist
  16153. org-export-latex-packages-alist t
  16154. org-format-latex-header-extra))
  16155. (insert "\n\\begin{document}\n"
  16156. "\\definecolor{fg}{rgb}{" fg "}\n"
  16157. "\\definecolor{bg}{rgb}{" bg "}\n"
  16158. "\n\\pagecolor{bg}\n"
  16159. "\n{\\color{fg}\n"
  16160. string
  16161. "\n}\n"
  16162. "\n\\end{document}\n" )
  16163. (require 'org-latex)
  16164. (org-export-latex-fix-inputenc))
  16165. (let ((dir default-directory) cmd cmds latex-frags-cmds)
  16166. (condition-case nil
  16167. (progn
  16168. (cd tmpdir)
  16169. (setq cmds org-latex-to-pdf-process)
  16170. (while cmds
  16171. (setq latex-frags-cmds (pop cmds))
  16172. (if (listp latex-frags-cmds)
  16173. (setq cmds nil)
  16174. (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
  16175. (while latex-frags-cmds
  16176. (setq cmd (pop latex-frags-cmds))
  16177. (while (string-match "%b" cmd)
  16178. (setq cmd (replace-match
  16179. (save-match-data
  16180. (shell-quote-argument texfile))
  16181. t t cmd)))
  16182. (while (string-match "%f" cmd)
  16183. (setq cmd (replace-match
  16184. (save-match-data
  16185. (shell-quote-argument (file-name-nondirectory texfile)))
  16186. t t cmd)))
  16187. (while (string-match "%o" cmd)
  16188. (setq cmd (replace-match
  16189. (save-match-data
  16190. (shell-quote-argument (file-name-directory texfile)))
  16191. t t cmd)))
  16192. (setq cmd (split-string cmd))
  16193. (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
  16194. (error nil))
  16195. (cd dir))
  16196. (if (not (file-exists-p pdffile))
  16197. (progn (message "Failed to create pdf file from %s" texfile) nil)
  16198. (condition-case nil
  16199. (if (featurep 'xemacs)
  16200. (call-process "convert" nil nil nil
  16201. "-density" "96"
  16202. "-trim"
  16203. "-antialias"
  16204. pdffile
  16205. "-quality" "100"
  16206. ;; "-sharpen" "0x1.0"
  16207. pngfile)
  16208. (call-process "convert" nil nil nil
  16209. "-density" dpi
  16210. "-trim"
  16211. "-antialias"
  16212. pdffile
  16213. "-quality" "100"
  16214. ; "-sharpen" "0x1.0"
  16215. pngfile))
  16216. (error nil))
  16217. (if (not (file-exists-p pngfile))
  16218. (if org-format-latex-signal-error
  16219. (error "Failed to create png file from %s" texfile)
  16220. (message "Failed to create png file from %s" texfile)
  16221. nil)
  16222. ;; Use the requested file name and clean up
  16223. (copy-file pngfile tofile 'replace)
  16224. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  16225. (if (file-exists-p (concat texfilebase e))
  16226. (delete-file (concat texfilebase e))))
  16227. pngfile))))
  16228. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  16229. "Fill a LaTeX header template TPL.
  16230. In the template, the following place holders will be recognized:
  16231. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  16232. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  16233. [PACKAGES] \\usepackage statements for PKG
  16234. [NO-PACKAGES] do not include PKG
  16235. [EXTRA] the string EXTRA
  16236. [NO-EXTRA] do not include EXTRA
  16237. For backward compatibility, if both the positive and the negative place
  16238. holder is missing, the positive one (without the \"NO-\") will be
  16239. assumed to be present at the end of the template.
  16240. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  16241. EXTRA is a string.
  16242. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  16243. (let (rpl (end ""))
  16244. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  16245. (setq rpl (if (or (match-end 1) (not def-pkg))
  16246. "" (org-latex-packages-to-string def-pkg snippets-p t))
  16247. tpl (replace-match rpl t t tpl))
  16248. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  16249. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  16250. (setq rpl (if (or (match-end 1) (not pkg))
  16251. "" (org-latex-packages-to-string pkg snippets-p t))
  16252. tpl (replace-match rpl t t tpl))
  16253. (if pkg (setq end
  16254. (concat end "\n"
  16255. (org-latex-packages-to-string pkg snippets-p)))))
  16256. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  16257. (setq rpl (if (or (match-end 1) (not extra))
  16258. "" (concat extra "\n"))
  16259. tpl (replace-match rpl t t tpl))
  16260. (if (and extra (string-match "\\S-" extra))
  16261. (setq end (concat end "\n" extra))))
  16262. (if (string-match "\\S-" end)
  16263. (concat tpl "\n" end)
  16264. tpl)))
  16265. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  16266. "Turn an alist of packages into a string with the \\usepackage macros."
  16267. (setq pkg (mapconcat (lambda(p)
  16268. (cond
  16269. ((stringp p) p)
  16270. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  16271. (format "%% Package %s omitted" (cadr p)))
  16272. ((equal "" (car p))
  16273. (format "\\usepackage{%s}" (cadr p)))
  16274. (t
  16275. (format "\\usepackage[%s]{%s}"
  16276. (car p) (cadr p)))))
  16277. pkg
  16278. "\n"))
  16279. (if newline (concat pkg "\n") pkg))
  16280. (defun org-dvipng-color (attr)
  16281. "Return a RGB color specification for dvipng."
  16282. (apply 'format "rgb %s %s %s"
  16283. (mapcar 'org-normalize-color
  16284. (if (featurep 'xemacs)
  16285. (color-rgb-components
  16286. (face-property 'default
  16287. (cond ((eq attr :foreground) 'foreground)
  16288. ((eq attr :background) 'background))))
  16289. (color-values (face-attribute 'default attr nil))))))
  16290. (defun org-dvipng-color-format (color-name)
  16291. "Convert COLOR-NAME to a RGB color value for dvipng."
  16292. (apply 'format "rgb %s %s %s"
  16293. (mapcar 'org-normalize-color
  16294. (color-values color-name))))
  16295. (defun org-latex-color (attr)
  16296. "Return a RGB color for the LaTeX color package."
  16297. (apply 'format "%s,%s,%s"
  16298. (mapcar 'org-normalize-color
  16299. (if (featurep 'xemacs)
  16300. (color-rgb-components
  16301. (face-property 'default
  16302. (cond ((eq attr :foreground) 'foreground)
  16303. ((eq attr :background) 'background))))
  16304. (color-values (face-attribute 'default attr nil))))))
  16305. (defun org-latex-color-format (color-name)
  16306. "Convert COLOR-NAME to a RGB color value."
  16307. (apply 'format "%s,%s,%s"
  16308. (mapcar 'org-normalize-color
  16309. (color-values color-name))))
  16310. (defun org-normalize-color (value)
  16311. "Return string to be used as color value for an RGB component."
  16312. (format "%g" (/ value 65535.0)))
  16313. ;; Image display
  16314. (defvar org-inline-image-overlays nil)
  16315. (make-variable-buffer-local 'org-inline-image-overlays)
  16316. (defun org-toggle-inline-images (&optional include-linked)
  16317. "Toggle the display of inline images.
  16318. INCLUDE-LINKED is passed to `org-display-inline-images'."
  16319. (interactive "P")
  16320. (if org-inline-image-overlays
  16321. (progn
  16322. (org-remove-inline-images)
  16323. (message "Inline image display turned off"))
  16324. (org-display-inline-images include-linked)
  16325. (if (and (org-called-interactively-p)
  16326. org-inline-image-overlays)
  16327. (message "%d images displayed inline"
  16328. (length org-inline-image-overlays))
  16329. (message "No images to display inline"))))
  16330. (defun org-redisplay-inline-images ()
  16331. "Refresh the display of inline images."
  16332. (interactive)
  16333. (if (not org-inline-image-overlays)
  16334. (org-toggle-inline-images)
  16335. (org-toggle-inline-images)
  16336. (org-toggle-inline-images)))
  16337. (defun org-display-inline-images (&optional include-linked refresh beg end)
  16338. "Display inline images.
  16339. Normally only links without a description part are inlined, because this
  16340. is how it will work for export. When INCLUDE-LINKED is set, also links
  16341. with a description part will be inlined. This can be nice for a quick
  16342. look at those images, but it does not reflect what exported files will look
  16343. like.
  16344. When REFRESH is set, refresh existing images between BEG and END.
  16345. This will create new image displays only if necessary.
  16346. BEG and END default to the buffer boundaries."
  16347. (interactive "P")
  16348. (unless refresh
  16349. (org-remove-inline-images)
  16350. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  16351. (save-excursion
  16352. (save-restriction
  16353. (widen)
  16354. (setq beg (or beg (point-min)) end (or end (point-max)))
  16355. (goto-char beg)
  16356. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  16357. (substring (org-image-file-name-regexp) 0 -2)
  16358. "\\)\\]" (if include-linked "" "\\]")))
  16359. old file ov img type attrwidth width)
  16360. (while (re-search-forward re end t)
  16361. (setq old (get-char-property-and-overlay (match-beginning 1)
  16362. 'org-image-overlay)
  16363. file (expand-file-name
  16364. (concat (or (match-string 3) "") (match-string 4))))
  16365. (when (image-type-available-p 'imagemagick)
  16366. (setq attrwidth (if (or (listp org-image-actual-width)
  16367. (null org-image-actual-width))
  16368. (save-excursion
  16369. (save-match-data
  16370. (when (re-search-backward
  16371. "#\\+ATTR.*width=\"\\([^\"]+\\)\""
  16372. (save-excursion
  16373. (re-search-backward "^[ \t]*$\\|\\`" nil t)) t)
  16374. (string-to-number (match-string 1))))))
  16375. width (cond ((eq org-image-actual-width t) nil)
  16376. ((null org-image-actual-width) attrwidth)
  16377. ((numberp org-image-actual-width)
  16378. org-image-actual-width)
  16379. ((listp org-image-actual-width)
  16380. (or attrwidth (car org-image-actual-width))))
  16381. type (if width 'imagemagick)))
  16382. (when (file-exists-p file)
  16383. (if (and (car-safe old) refresh)
  16384. (image-refresh (overlay-get (cdr old) 'display))
  16385. (setq img (save-match-data (create-image file type nil :width width)))
  16386. (when img
  16387. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  16388. (overlay-put ov 'display img)
  16389. (overlay-put ov 'face 'default)
  16390. (overlay-put ov 'org-image-overlay t)
  16391. (overlay-put ov 'modification-hooks
  16392. (list 'org-display-inline-remove-overlay))
  16393. (push ov org-inline-image-overlays)))))))))
  16394. (define-obsolete-function-alias
  16395. 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
  16396. (defun org-display-inline-remove-overlay (ov after beg end &optional len)
  16397. "Remove inline-display overlay if a corresponding region is modified."
  16398. (let ((inhibit-modification-hooks t))
  16399. (when (and ov after)
  16400. (delete ov org-inline-image-overlays)
  16401. (delete-overlay ov))))
  16402. (defun org-remove-inline-images ()
  16403. "Remove inline display of images."
  16404. (interactive)
  16405. (mapc 'delete-overlay org-inline-image-overlays)
  16406. (setq org-inline-image-overlays nil))
  16407. ;;;; Key bindings
  16408. ;; Outline functions from `outline-mode-prefix-map'
  16409. ;; that can be remapped in Org:
  16410. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  16411. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  16412. (define-key org-mode-map [remap outline-forward-same-level]
  16413. 'org-forward-heading-same-level)
  16414. (define-key org-mode-map [remap outline-backward-same-level]
  16415. 'org-backward-heading-same-level)
  16416. (define-key org-mode-map [remap show-branches]
  16417. 'org-kill-note-or-show-branches)
  16418. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  16419. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  16420. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  16421. ;; Outline functions from `outline-mode-prefix-map' that can not
  16422. ;; be remapped in Org:
  16423. ;;
  16424. ;; - the column "key binding" shows whether the Outline function is still
  16425. ;; available in Org mode on the same key that it has been bound to in
  16426. ;; Outline mode:
  16427. ;; - "overridden": key used for a different functionality in Org mode
  16428. ;; - else: key still bound to the same Outline function in Org mode
  16429. ;;
  16430. ;; | Outline function | key binding | Org replacement |
  16431. ;; |------------------------------------+-------------+-----------------------|
  16432. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  16433. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  16434. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  16435. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  16436. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  16437. ;; | `show-entry' | overridden | no replacement |
  16438. ;; | `show-children' | `C-c C-i' | visibility cycling |
  16439. ;; | `show-branches' | `C-c C-k' | still same function |
  16440. ;; | `show-subtree' | overridden | visibility cycling |
  16441. ;; | `show-all' | overridden | no replacement |
  16442. ;; | `hide-subtree' | overridden | visibility cycling |
  16443. ;; | `hide-body' | overridden | no replacement |
  16444. ;; | `hide-entry' | overridden | visibility cycling |
  16445. ;; | `hide-leaves' | overridden | no replacement |
  16446. ;; | `hide-sublevels' | overridden | no replacement |
  16447. ;; | `hide-other' | overridden | no replacement |
  16448. ;; Make `C-c C-x' a prefix key
  16449. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  16450. ;; TAB key with modifiers
  16451. (org-defkey org-mode-map "\C-i" 'org-cycle)
  16452. (org-defkey org-mode-map [(tab)] 'org-cycle)
  16453. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  16454. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  16455. ;; The following line is necessary under Suse GNU/Linux
  16456. (unless (featurep 'xemacs)
  16457. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  16458. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  16459. (define-key org-mode-map [backtab] 'org-shifttab)
  16460. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  16461. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  16462. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  16463. ;; Cursor keys with modifiers
  16464. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  16465. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  16466. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  16467. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  16468. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  16469. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  16470. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  16471. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  16472. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  16473. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  16474. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  16475. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  16476. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  16477. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  16478. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  16479. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  16480. ;; Babel keys
  16481. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  16482. (mapc (lambda (pair)
  16483. (define-key org-babel-map (car pair) (cdr pair)))
  16484. org-babel-key-bindings)
  16485. ;;; Extra keys for tty access.
  16486. ;; We only set them when really needed because otherwise the
  16487. ;; menus don't show the simple keys
  16488. (when (or org-use-extra-keys
  16489. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  16490. (not window-system))
  16491. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  16492. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  16493. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  16494. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  16495. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  16496. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  16497. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  16498. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  16499. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  16500. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  16501. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  16502. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  16503. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  16504. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  16505. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  16506. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  16507. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  16508. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  16509. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  16510. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  16511. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  16512. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  16513. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  16514. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  16515. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  16516. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  16517. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  16518. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  16519. ;; All the other keys
  16520. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  16521. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  16522. (if (boundp 'narrow-map)
  16523. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  16524. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  16525. (if (boundp 'narrow-map)
  16526. (org-defkey narrow-map "b" 'org-narrow-to-block)
  16527. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  16528. (if (boundp 'narrow-map)
  16529. (org-defkey narrow-map "e" 'org-narrow-to-element)
  16530. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  16531. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  16532. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  16533. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  16534. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  16535. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  16536. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  16537. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  16538. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  16539. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  16540. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  16541. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  16542. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  16543. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  16544. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  16545. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  16546. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  16547. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  16548. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  16549. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  16550. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  16551. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  16552. (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
  16553. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  16554. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  16555. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  16556. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  16557. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  16558. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  16559. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  16560. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  16561. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  16562. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  16563. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  16564. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  16565. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  16566. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  16567. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  16568. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  16569. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  16570. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  16571. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  16572. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  16573. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  16574. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  16575. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  16576. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  16577. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  16578. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  16579. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  16580. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  16581. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  16582. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  16583. (org-defkey org-mode-map "\C-c^" 'org-sort)
  16584. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  16585. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  16586. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  16587. (org-defkey org-mode-map "\C-m" 'org-return)
  16588. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  16589. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  16590. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  16591. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  16592. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  16593. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  16594. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  16595. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  16596. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  16597. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  16598. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  16599. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  16600. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  16601. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  16602. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  16603. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  16604. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  16605. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  16606. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  16607. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  16608. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  16609. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  16610. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  16611. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  16612. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  16613. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  16614. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  16615. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  16616. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  16617. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  16618. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  16619. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  16620. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  16621. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  16622. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  16623. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  16624. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  16625. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  16626. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  16627. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  16628. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  16629. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  16630. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  16631. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  16632. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  16633. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  16634. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  16635. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  16636. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  16637. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  16638. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  16639. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  16640. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  16641. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  16642. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  16643. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  16644. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  16645. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  16646. (when (featurep 'xemacs)
  16647. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  16648. (defconst org-speed-commands-default
  16649. '(
  16650. ("Outline Navigation")
  16651. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  16652. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  16653. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  16654. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  16655. ("u" . (org-speed-move-safe 'outline-up-heading))
  16656. ("j" . org-goto)
  16657. ("g" . (org-refile t))
  16658. ("Outline Visibility")
  16659. ("c" . org-cycle)
  16660. ("C" . org-shifttab)
  16661. (" " . org-display-outline-path)
  16662. (":" . org-columns)
  16663. ("Outline Structure Editing")
  16664. ("U" . org-shiftmetaup)
  16665. ("D" . org-shiftmetadown)
  16666. ("r" . org-metaright)
  16667. ("l" . org-metaleft)
  16668. ("R" . org-shiftmetaright)
  16669. ("L" . org-shiftmetaleft)
  16670. ("i" . (progn (forward-char 1) (call-interactively
  16671. 'org-insert-heading-respect-content)))
  16672. ("^" . org-sort)
  16673. ("w" . org-refile)
  16674. ("a" . org-archive-subtree-default-with-confirmation)
  16675. ("." . org-mark-subtree)
  16676. ("#" . org-toggle-comment)
  16677. ("Clock Commands")
  16678. ("I" . org-clock-in)
  16679. ("O" . org-clock-out)
  16680. ("Meta Data Editing")
  16681. ("t" . org-todo)
  16682. ("," . (org-priority))
  16683. ("0" . (org-priority ?\ ))
  16684. ("1" . (org-priority ?A))
  16685. ("2" . (org-priority ?B))
  16686. ("3" . (org-priority ?C))
  16687. (";" . org-set-tags-command)
  16688. ("e" . org-set-effort)
  16689. ("E" . org-inc-effort)
  16690. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  16691. (org-entry-put (point) "APPT_WARNTIME" m)))
  16692. ("Agenda Views etc")
  16693. ("v" . org-agenda)
  16694. ("/" . org-sparse-tree)
  16695. ("Misc")
  16696. ("o" . org-open-at-point)
  16697. ("?" . org-speed-command-help)
  16698. ("<" . (org-agenda-set-restriction-lock 'subtree))
  16699. (">" . (org-agenda-remove-restriction-lock))
  16700. )
  16701. "The default speed commands.")
  16702. (defun org-print-speed-command (e)
  16703. (if (> (length (car e)) 1)
  16704. (progn
  16705. (princ "\n")
  16706. (princ (car e))
  16707. (princ "\n")
  16708. (princ (make-string (length (car e)) ?-))
  16709. (princ "\n"))
  16710. (princ (car e))
  16711. (princ " ")
  16712. (if (symbolp (cdr e))
  16713. (princ (symbol-name (cdr e)))
  16714. (prin1 (cdr e)))
  16715. (princ "\n")))
  16716. (defun org-speed-command-help ()
  16717. "Show the available speed commands."
  16718. (interactive)
  16719. (if (not org-use-speed-commands)
  16720. (error "Speed commands are not activated, customize `org-use-speed-commands'")
  16721. (with-output-to-temp-buffer "*Help*"
  16722. (princ "User-defined Speed commands\n===========================\n")
  16723. (mapc 'org-print-speed-command org-speed-commands-user)
  16724. (princ "\n")
  16725. (princ "Built-in Speed commands\n=======================\n")
  16726. (mapc 'org-print-speed-command org-speed-commands-default))
  16727. (with-current-buffer "*Help*"
  16728. (setq truncate-lines t))))
  16729. (defun org-speed-move-safe (cmd)
  16730. "Execute CMD, but make sure that the cursor always ends up in a headline.
  16731. If not, return to the original position and throw an error."
  16732. (interactive)
  16733. (let ((pos (point)))
  16734. (call-interactively cmd)
  16735. (unless (and (bolp) (org-at-heading-p))
  16736. (goto-char pos)
  16737. (error "Boundary reached while executing %s" cmd))))
  16738. (defvar org-self-insert-command-undo-counter 0)
  16739. (defvar org-table-auto-blank-field) ; defined in org-table.el
  16740. (defvar org-speed-command nil)
  16741. (define-obsolete-function-alias
  16742. 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
  16743. (defun org-speed-command-activate (keys)
  16744. "Hook for activating single-letter speed commands.
  16745. `org-speed-commands-default' specifies a minimal command set.
  16746. Use `org-speed-commands-user' for further customization."
  16747. (when (or (and (bolp) (looking-at org-outline-regexp))
  16748. (and (functionp org-use-speed-commands)
  16749. (funcall org-use-speed-commands)))
  16750. (cdr (assoc keys (append org-speed-commands-user
  16751. org-speed-commands-default)))))
  16752. (define-obsolete-function-alias
  16753. 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
  16754. (defun org-babel-speed-command-activate (keys)
  16755. "Hook for activating single-letter code block commands."
  16756. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  16757. (cdr (assoc keys org-babel-key-bindings))))
  16758. (defcustom org-speed-command-hook
  16759. '(org-speed-command-default-hook org-babel-speed-command-hook)
  16760. "Hook for activating speed commands at strategic locations.
  16761. Hook functions are called in sequence until a valid handler is
  16762. found.
  16763. Each hook takes a single argument, a user-pressed command key
  16764. which is also a `self-insert-command' from the global map.
  16765. Within the hook, examine the cursor position and the command key
  16766. and return nil or a valid handler as appropriate. Handler could
  16767. be one of an interactive command, a function, or a form.
  16768. Set `org-use-speed-commands' to non-nil value to enable this
  16769. hook. The default setting is `org-speed-command-activate'."
  16770. :group 'org-structure
  16771. :version "24.1"
  16772. :type 'hook)
  16773. (defun org-self-insert-command (N)
  16774. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  16775. If the cursor is in a table looking at whitespace, the whitespace is
  16776. overwritten, and the table is not marked as requiring realignment."
  16777. (interactive "p")
  16778. (org-check-before-invisible-edit 'insert)
  16779. (cond
  16780. ((and org-use-speed-commands
  16781. (setq org-speed-command
  16782. (run-hook-with-args-until-success
  16783. 'org-speed-command-hook (this-command-keys))))
  16784. (cond
  16785. ((commandp org-speed-command)
  16786. (setq this-command org-speed-command)
  16787. (call-interactively org-speed-command))
  16788. ((functionp org-speed-command)
  16789. (funcall org-speed-command))
  16790. ((and org-speed-command (listp org-speed-command))
  16791. (eval org-speed-command))
  16792. (t (let (org-use-speed-commands)
  16793. (call-interactively 'org-self-insert-command)))))
  16794. ((and
  16795. (org-table-p)
  16796. (progn
  16797. ;; check if we blank the field, and if that triggers align
  16798. (and (featurep 'org-table) org-table-auto-blank-field
  16799. (member last-command
  16800. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  16801. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  16802. ;; got extra space, this field does not determine column width
  16803. (let (org-table-may-need-update) (org-table-blank-field))
  16804. ;; no extra space, this field may determine column width
  16805. (org-table-blank-field)))
  16806. t)
  16807. (eq N 1)
  16808. (looking-at "[^|\n]* |"))
  16809. (let (org-table-may-need-update)
  16810. (goto-char (1- (match-end 0)))
  16811. (backward-delete-char 1)
  16812. (goto-char (match-beginning 0))
  16813. (self-insert-command N)))
  16814. (t
  16815. (setq org-table-may-need-update t)
  16816. (self-insert-command N)
  16817. (org-fix-tags-on-the-fly)
  16818. (if org-self-insert-cluster-for-undo
  16819. (if (not (eq last-command 'org-self-insert-command))
  16820. (setq org-self-insert-command-undo-counter 1)
  16821. (if (>= org-self-insert-command-undo-counter 20)
  16822. (setq org-self-insert-command-undo-counter 1)
  16823. (and (> org-self-insert-command-undo-counter 0)
  16824. buffer-undo-list (listp buffer-undo-list)
  16825. (not (cadr buffer-undo-list)) ; remove nil entry
  16826. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  16827. (setq org-self-insert-command-undo-counter
  16828. (1+ org-self-insert-command-undo-counter))))))))
  16829. (defun org-check-before-invisible-edit (kind)
  16830. "Check is editing if kind KIND would be dangerous with invisible text around.
  16831. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  16832. ;; First, try to get out of here as quickly as possible, to reduce overhead
  16833. (if (and org-catch-invisible-edits
  16834. (or (not (boundp 'visible-mode)) (not visible-mode))
  16835. (or (get-char-property (point) 'invisible)
  16836. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  16837. ;; OK, we need to take a closer look
  16838. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  16839. (invisible-before-point (if (bobp) nil (get-char-property
  16840. (1- (point)) 'invisible)))
  16841. (border-and-ok-direction
  16842. (or
  16843. ;; Check if we are acting predictably before invisible text
  16844. (and invisible-at-point (not invisible-before-point)
  16845. (memq kind '(insert delete-backward)))
  16846. ;; Check if we are acting predictably after invisible text
  16847. ;; This works not well, and I have turned it off. It seems
  16848. ;; better to always show and stop after invisible text.
  16849. ;; (and (not invisible-at-point) invisible-before-point
  16850. ;; (memq kind '(insert delete)))
  16851. )))
  16852. (when (or (memq invisible-at-point '(outline org-hide-block t))
  16853. (memq invisible-before-point '(outline org-hide-block t)))
  16854. (if (eq org-catch-invisible-edits 'error)
  16855. (error "Editing in invisible areas is prohibited - make visible first"))
  16856. (if (and org-custom-properties-overlays
  16857. (y-or-n-p "Display invisible properties in this buffer? "))
  16858. (org-toggle-custom-properties-visibility)
  16859. ;; Make the area visible
  16860. (save-excursion
  16861. (if invisible-before-point
  16862. (goto-char (previous-single-char-property-change
  16863. (point) 'invisible)))
  16864. (org-cycle))
  16865. (cond
  16866. ((eq org-catch-invisible-edits 'show)
  16867. ;; That's it, we do the edit after showing
  16868. (message
  16869. "Unfolding invisible region around point before editing")
  16870. (sit-for 1))
  16871. ((and (eq org-catch-invisible-edits 'smart)
  16872. border-and-ok-direction)
  16873. (message "Unfolding invisible region around point before editing"))
  16874. (t
  16875. ;; Don't do the edit, make the user repeat it in full visibility
  16876. (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  16877. (defun org-fix-tags-on-the-fly ()
  16878. (when (and (equal (char-after (point-at-bol)) ?*)
  16879. (org-at-heading-p))
  16880. (org-align-tags-here org-tags-column)))
  16881. (defun org-delete-backward-char (N)
  16882. "Like `delete-backward-char', insert whitespace at field end in tables.
  16883. When deleting backwards, in tables this function will insert whitespace in
  16884. front of the next \"|\" separator, to keep the table aligned. The table will
  16885. still be marked for re-alignment if the field did fill the entire column,
  16886. because, in this case the deletion might narrow the column."
  16887. (interactive "p")
  16888. (org-check-before-invisible-edit 'delete-backward)
  16889. (if (and (org-table-p)
  16890. (eq N 1)
  16891. (string-match "|" (buffer-substring (point-at-bol) (point)))
  16892. (looking-at ".*?|"))
  16893. (let ((pos (point))
  16894. (noalign (looking-at "[^|\n\r]* |"))
  16895. (c org-table-may-need-update))
  16896. (backward-delete-char N)
  16897. (if (not overwrite-mode)
  16898. (progn
  16899. (skip-chars-forward "^|")
  16900. (insert " ")
  16901. (goto-char (1- pos))))
  16902. ;; noalign: if there were two spaces at the end, this field
  16903. ;; does not determine the width of the column.
  16904. (if noalign (setq org-table-may-need-update c)))
  16905. (backward-delete-char N)
  16906. (org-fix-tags-on-the-fly)))
  16907. (defun org-delete-char (N)
  16908. "Like `delete-char', but insert whitespace at field end in tables.
  16909. When deleting characters, in tables this function will insert whitespace in
  16910. front of the next \"|\" separator, to keep the table aligned. The table will
  16911. still be marked for re-alignment if the field did fill the entire column,
  16912. because, in this case the deletion might narrow the column."
  16913. (interactive "p")
  16914. (org-check-before-invisible-edit 'delete)
  16915. (if (and (org-table-p)
  16916. (not (bolp))
  16917. (not (= (char-after) ?|))
  16918. (eq N 1))
  16919. (if (looking-at ".*?|")
  16920. (let ((pos (point))
  16921. (noalign (looking-at "[^|\n\r]* |"))
  16922. (c org-table-may-need-update))
  16923. (replace-match (concat
  16924. (substring (match-string 0) 1 -1)
  16925. " |"))
  16926. (goto-char pos)
  16927. ;; noalign: if there were two spaces at the end, this field
  16928. ;; does not determine the width of the column.
  16929. (if noalign (setq org-table-may-need-update c)))
  16930. (delete-char N))
  16931. (delete-char N)
  16932. (org-fix-tags-on-the-fly)))
  16933. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  16934. (put 'org-self-insert-command 'delete-selection t)
  16935. (put 'orgtbl-self-insert-command 'delete-selection t)
  16936. (put 'org-delete-char 'delete-selection 'supersede)
  16937. (put 'org-delete-backward-char 'delete-selection 'supersede)
  16938. (put 'org-yank 'delete-selection 'yank)
  16939. ;; Make `flyspell-mode' delay after some commands
  16940. (put 'org-self-insert-command 'flyspell-delayed t)
  16941. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  16942. (put 'org-delete-char 'flyspell-delayed t)
  16943. (put 'org-delete-backward-char 'flyspell-delayed t)
  16944. ;; Make pabbrev-mode expand after org-mode commands
  16945. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  16946. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  16947. ;; How to do this: Measure non-white length of current string
  16948. ;; If equal to column width, we should realign.
  16949. (defun org-remap (map &rest commands)
  16950. "In MAP, remap the functions given in COMMANDS.
  16951. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  16952. (let (new old)
  16953. (while commands
  16954. (setq old (pop commands) new (pop commands))
  16955. (if (fboundp 'command-remapping)
  16956. (org-defkey map (vector 'remap old) new)
  16957. (substitute-key-definition old new map global-map)))))
  16958. (when (eq org-enable-table-editor 'optimized)
  16959. ;; If the user wants maximum table support, we need to hijack
  16960. ;; some standard editing functions
  16961. (org-remap org-mode-map
  16962. 'self-insert-command 'org-self-insert-command
  16963. 'delete-char 'org-delete-char
  16964. 'delete-backward-char 'org-delete-backward-char)
  16965. (org-defkey org-mode-map "|" 'org-force-self-insert))
  16966. (defvar org-ctrl-c-ctrl-c-hook nil
  16967. "Hook for functions attaching themselves to `C-c C-c'.
  16968. This can be used to add additional functionality to the C-c C-c
  16969. key which executes context-dependent commands. This hook is run
  16970. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  16971. run after the last test.
  16972. Each function will be called with no arguments. The function
  16973. must check if the context is appropriate for it to act. If yes,
  16974. it should do its thing and then return a non-nil value. If the
  16975. context is wrong, just do nothing and return nil.")
  16976. (defvar org-ctrl-c-ctrl-c-final-hook nil
  16977. "Hook for functions attaching themselves to `C-c C-c'.
  16978. This can be used to add additional functionality to the C-c C-c
  16979. key which executes context-dependent commands. This hook is run
  16980. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  16981. before the first test.
  16982. Each function will be called with no arguments. The function
  16983. must check if the context is appropriate for it to act. If yes,
  16984. it should do its thing and then return a non-nil value. If the
  16985. context is wrong, just do nothing and return nil.")
  16986. (defvar org-tab-first-hook nil
  16987. "Hook for functions to attach themselves to TAB.
  16988. See `org-ctrl-c-ctrl-c-hook' for more information.
  16989. This hook runs as the first action when TAB is pressed, even before
  16990. `org-cycle' messes around with the `outline-regexp' to cater for
  16991. inline tasks and plain list item folding.
  16992. If any function in this hook returns t, any other actions that
  16993. would have been caused by TAB (such as table field motion or visibility
  16994. cycling) will not occur.")
  16995. (defvar org-tab-after-check-for-table-hook nil
  16996. "Hook for functions to attach themselves to TAB.
  16997. See `org-ctrl-c-ctrl-c-hook' for more information.
  16998. This hook runs after it has been established that the cursor is not in a
  16999. table, but before checking if the cursor is in a headline or if global cycling
  17000. should be done.
  17001. If any function in this hook returns t, not other actions like visibility
  17002. cycling will be done.")
  17003. (defvar org-tab-after-check-for-cycling-hook nil
  17004. "Hook for functions to attach themselves to TAB.
  17005. See `org-ctrl-c-ctrl-c-hook' for more information.
  17006. This hook runs after it has been established that not table field motion and
  17007. not visibility should be done because of current context. This is probably
  17008. the place where a package like yasnippets can hook in.")
  17009. (defvar org-tab-before-tab-emulation-hook nil
  17010. "Hook for functions to attach themselves to TAB.
  17011. See `org-ctrl-c-ctrl-c-hook' for more information.
  17012. This hook runs after every other options for TAB have been exhausted, but
  17013. before indentation and \t insertion takes place.")
  17014. (defvar org-metaleft-hook nil
  17015. "Hook for functions attaching themselves to `M-left'.
  17016. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17017. (defvar org-metaright-hook nil
  17018. "Hook for functions attaching themselves to `M-right'.
  17019. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17020. (defvar org-metaup-hook nil
  17021. "Hook for functions attaching themselves to `M-up'.
  17022. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17023. (defvar org-metadown-hook nil
  17024. "Hook for functions attaching themselves to `M-down'.
  17025. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17026. (defvar org-shiftmetaleft-hook nil
  17027. "Hook for functions attaching themselves to `M-S-left'.
  17028. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17029. (defvar org-shiftmetaright-hook nil
  17030. "Hook for functions attaching themselves to `M-S-right'.
  17031. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17032. (defvar org-shiftmetaup-hook nil
  17033. "Hook for functions attaching themselves to `M-S-up'.
  17034. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17035. (defvar org-shiftmetadown-hook nil
  17036. "Hook for functions attaching themselves to `M-S-down'.
  17037. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17038. (defvar org-metareturn-hook nil
  17039. "Hook for functions attaching themselves to `M-RET'.
  17040. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17041. (defvar org-shiftup-hook nil
  17042. "Hook for functions attaching themselves to `S-up'.
  17043. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17044. (defvar org-shiftup-final-hook nil
  17045. "Hook for functions attaching themselves to `S-up'.
  17046. This one runs after all other options except shift-select have been excluded.
  17047. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17048. (defvar org-shiftdown-hook nil
  17049. "Hook for functions attaching themselves to `S-down'.
  17050. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17051. (defvar org-shiftdown-final-hook nil
  17052. "Hook for functions attaching themselves to `S-down'.
  17053. This one runs after all other options except shift-select have been excluded.
  17054. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17055. (defvar org-shiftleft-hook nil
  17056. "Hook for functions attaching themselves to `S-left'.
  17057. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17058. (defvar org-shiftleft-final-hook nil
  17059. "Hook for functions attaching themselves to `S-left'.
  17060. This one runs after all other options except shift-select have been excluded.
  17061. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17062. (defvar org-shiftright-hook nil
  17063. "Hook for functions attaching themselves to `S-right'.
  17064. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17065. (defvar org-shiftright-final-hook nil
  17066. "Hook for functions attaching themselves to `S-right'.
  17067. This one runs after all other options except shift-select have been excluded.
  17068. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17069. (defun org-modifier-cursor-error ()
  17070. "Throw an error, a modified cursor command was applied in wrong context."
  17071. (error "This command is active in special context like tables, headlines or items"))
  17072. (defun org-shiftselect-error ()
  17073. "Throw an error because Shift-Cursor command was applied in wrong context."
  17074. (if (and (boundp 'shift-select-mode) shift-select-mode)
  17075. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  17076. (error "This command works only in special context like headlines or timestamps")))
  17077. (defun org-call-for-shift-select (cmd)
  17078. (let ((this-command-keys-shift-translated t))
  17079. (call-interactively cmd)))
  17080. (defun org-shifttab (&optional arg)
  17081. "Global visibility cycling or move to previous table field.
  17082. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  17083. on context.
  17084. See the individual commands for more information."
  17085. (interactive "P")
  17086. (cond
  17087. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  17088. ((integerp arg)
  17089. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  17090. (message "Content view to level: %d" arg)
  17091. (org-content (prefix-numeric-value arg2))
  17092. (setq org-cycle-global-status 'overview)))
  17093. (t (call-interactively 'org-global-cycle))))
  17094. (defun org-shiftmetaleft ()
  17095. "Promote subtree or delete table column.
  17096. Calls `org-promote-subtree', `org-outdent-item-tree', or
  17097. `org-table-delete-column', depending on context. See the
  17098. individual commands for more information."
  17099. (interactive)
  17100. (cond
  17101. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  17102. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  17103. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  17104. ((if (not (org-region-active-p)) (org-at-item-p)
  17105. (save-excursion (goto-char (region-beginning))
  17106. (org-at-item-p)))
  17107. (call-interactively 'org-outdent-item-tree))
  17108. (t (org-modifier-cursor-error))))
  17109. (defun org-shiftmetaright ()
  17110. "Demote subtree or insert table column.
  17111. Calls `org-demote-subtree', `org-indent-item-tree', or
  17112. `org-table-insert-column', depending on context. See the
  17113. individual commands for more information."
  17114. (interactive)
  17115. (cond
  17116. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  17117. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  17118. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  17119. ((if (not (org-region-active-p)) (org-at-item-p)
  17120. (save-excursion (goto-char (region-beginning))
  17121. (org-at-item-p)))
  17122. (call-interactively 'org-indent-item-tree))
  17123. (t (org-modifier-cursor-error))))
  17124. (defun org-shiftmetaup (&optional arg)
  17125. "Move subtree up or kill table row.
  17126. Calls `org-move-subtree-up' or `org-table-kill-row' or
  17127. `org-move-item-up' or `org-timestamp-up', depending on context.
  17128. See the individual commands for more information."
  17129. (interactive "P")
  17130. (cond
  17131. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  17132. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  17133. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17134. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17135. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17136. (call-interactively 'org-timestamp-up)))
  17137. (t (org-modifier-cursor-error))))
  17138. (defun org-shiftmetadown (&optional arg)
  17139. "Move subtree down or insert table row.
  17140. Calls `org-move-subtree-down' or `org-table-insert-row' or
  17141. `org-move-item-down' or `org-timestamp-up', depending on context.
  17142. See the individual commands for more information."
  17143. (interactive "P")
  17144. (cond
  17145. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  17146. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  17147. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17148. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17149. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17150. (call-interactively 'org-timestamp-down)))
  17151. (t (org-modifier-cursor-error))))
  17152. (defsubst org-hidden-tree-error ()
  17153. (error
  17154. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  17155. (defun org-metaleft (&optional arg)
  17156. "Promote heading or move table column to left.
  17157. Calls `org-do-promote' or `org-table-move-column', depending on context.
  17158. With no specific context, calls the Emacs default `backward-word'.
  17159. See the individual commands for more information."
  17160. (interactive "P")
  17161. (cond
  17162. ((run-hook-with-args-until-success 'org-metaleft-hook))
  17163. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  17164. ((org-with-limited-levels
  17165. (or (org-at-heading-p)
  17166. (and (org-region-active-p)
  17167. (save-excursion
  17168. (goto-char (region-beginning))
  17169. (org-at-heading-p)))))
  17170. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17171. (call-interactively 'org-do-promote))
  17172. ;; At an inline task.
  17173. ((org-at-heading-p)
  17174. (call-interactively 'org-inlinetask-promote))
  17175. ((or (org-at-item-p)
  17176. (and (org-region-active-p)
  17177. (save-excursion
  17178. (goto-char (region-beginning))
  17179. (org-at-item-p))))
  17180. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17181. (call-interactively 'org-outdent-item))
  17182. (t (call-interactively 'backward-word))))
  17183. (defun org-metaright (&optional arg)
  17184. "Demote a subtree, a list item or move table column to right.
  17185. In front of a drawer or a block keyword, indent it correctly.
  17186. With no specific context, calls the Emacs default `forward-word'.
  17187. See the individual commands for more information."
  17188. (interactive "P")
  17189. (cond
  17190. ((run-hook-with-args-until-success 'org-metaright-hook))
  17191. ((org-at-table-p) (call-interactively 'org-table-move-column))
  17192. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  17193. ((org-at-block-p) (call-interactively 'org-indent-block))
  17194. ((org-with-limited-levels
  17195. (or (org-at-heading-p)
  17196. (and (org-region-active-p)
  17197. (save-excursion
  17198. (goto-char (region-beginning))
  17199. (org-at-heading-p)))))
  17200. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17201. (call-interactively 'org-do-demote))
  17202. ;; At an inline task.
  17203. ((org-at-heading-p)
  17204. (call-interactively 'org-inlinetask-demote))
  17205. ((or (org-at-item-p)
  17206. (and (org-region-active-p)
  17207. (save-excursion
  17208. (goto-char (region-beginning))
  17209. (org-at-item-p))))
  17210. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17211. (call-interactively 'org-indent-item))
  17212. (t (call-interactively 'forward-word))))
  17213. (defun org-check-for-hidden (what)
  17214. "Check if there are hidden headlines/items in the current visual line.
  17215. WHAT can be either `headlines' or `items'. If the current line is
  17216. an outline or item heading and it has a folded subtree below it,
  17217. this function returns t, nil otherwise."
  17218. (let ((re (cond
  17219. ((eq what 'headlines) org-outline-regexp-bol)
  17220. ((eq what 'items) (org-item-beginning-re))
  17221. (t (error "This should not happen"))))
  17222. beg end)
  17223. (save-excursion
  17224. (catch 'exit
  17225. (unless (org-region-active-p)
  17226. (setq beg (point-at-bol))
  17227. (beginning-of-line 2)
  17228. (while (and (not (eobp)) ;; this is like `next-line'
  17229. (get-char-property (1- (point)) 'invisible))
  17230. (beginning-of-line 2))
  17231. (setq end (point))
  17232. (goto-char beg)
  17233. (goto-char (point-at-eol))
  17234. (setq end (max end (point)))
  17235. (while (re-search-forward re end t)
  17236. (if (get-char-property (match-beginning 0) 'invisible)
  17237. (throw 'exit t))))
  17238. nil))))
  17239. (autoload 'org-element-at-point "org-element")
  17240. (declare-function org-element-at-point "org-element" (&optional keep-trail))
  17241. (declare-function org-element-type "org-element" (element))
  17242. (declare-function org-element-context "org-element" ())
  17243. (declare-function org-element-contents "org-element" (element))
  17244. (declare-function org-element-property "org-element" (property element))
  17245. (declare-function org-element-paragraph-parser "org-element" (limit))
  17246. (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
  17247. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  17248. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  17249. (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
  17250. (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
  17251. (defun org-metaup (&optional arg)
  17252. "Move subtree up or move table row up.
  17253. Calls `org-move-subtree-up' or `org-table-move-row' or
  17254. `org-move-item-up', depending on context. See the individual commands
  17255. for more information."
  17256. (interactive "P")
  17257. (cond
  17258. ((run-hook-with-args-until-success 'org-metaup-hook))
  17259. ((org-region-active-p)
  17260. (let* ((a (min (region-beginning) (region-end)))
  17261. (b (1- (max (region-beginning) (region-end))))
  17262. (c (save-excursion (goto-char a)
  17263. (move-beginning-of-line 0)))
  17264. (d (save-excursion (goto-char a)
  17265. (move-end-of-line 0) (point))))
  17266. (transpose-regions a b c d)
  17267. (goto-char c)))
  17268. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  17269. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17270. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17271. (t (org-drag-element-backward))))
  17272. (defun org-metadown (&optional arg)
  17273. "Move subtree down or move table row down.
  17274. Calls `org-move-subtree-down' or `org-table-move-row' or
  17275. `org-move-item-down', depending on context. See the individual
  17276. commands for more information."
  17277. (interactive "P")
  17278. (cond
  17279. ((run-hook-with-args-until-success 'org-metadown-hook))
  17280. ((org-region-active-p)
  17281. (let* ((a (min (region-beginning) (region-end)))
  17282. (b (max (region-beginning) (region-end)))
  17283. (c (save-excursion (goto-char b)
  17284. (move-beginning-of-line 1)))
  17285. (d (save-excursion (goto-char b)
  17286. (move-end-of-line 1) (1+ (point)))))
  17287. (transpose-regions a b c d)
  17288. (goto-char d)))
  17289. ((org-at-table-p) (call-interactively 'org-table-move-row))
  17290. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17291. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17292. (t (org-drag-element-forward))))
  17293. (defun org-shiftup (&optional arg)
  17294. "Increase item in timestamp or increase priority of current headline.
  17295. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  17296. depending on context. See the individual commands for more information."
  17297. (interactive "P")
  17298. (cond
  17299. ((run-hook-with-args-until-success 'org-shiftup-hook))
  17300. ((and org-support-shift-select (org-region-active-p))
  17301. (org-call-for-shift-select 'previous-line))
  17302. ((org-at-timestamp-p t)
  17303. (call-interactively (if org-edit-timestamp-down-means-later
  17304. 'org-timestamp-down 'org-timestamp-up)))
  17305. ((and (not (eq org-support-shift-select 'always))
  17306. org-enable-priority-commands
  17307. (org-at-heading-p))
  17308. (call-interactively 'org-priority-up))
  17309. ((and (not org-support-shift-select) (org-at-item-p))
  17310. (call-interactively 'org-previous-item))
  17311. ((org-clocktable-try-shift 'up arg))
  17312. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  17313. (org-support-shift-select
  17314. (org-call-for-shift-select 'previous-line))
  17315. (t (org-shiftselect-error))))
  17316. (defun org-shiftdown (&optional arg)
  17317. "Decrease item in timestamp or decrease priority of current headline.
  17318. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  17319. depending on context. See the individual commands for more information."
  17320. (interactive "P")
  17321. (cond
  17322. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  17323. ((and org-support-shift-select (org-region-active-p))
  17324. (org-call-for-shift-select 'next-line))
  17325. ((org-at-timestamp-p t)
  17326. (call-interactively (if org-edit-timestamp-down-means-later
  17327. 'org-timestamp-up 'org-timestamp-down)))
  17328. ((and (not (eq org-support-shift-select 'always))
  17329. org-enable-priority-commands
  17330. (org-at-heading-p))
  17331. (call-interactively 'org-priority-down))
  17332. ((and (not org-support-shift-select) (org-at-item-p))
  17333. (call-interactively 'org-next-item))
  17334. ((org-clocktable-try-shift 'down arg))
  17335. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  17336. (org-support-shift-select
  17337. (org-call-for-shift-select 'next-line))
  17338. (t (org-shiftselect-error))))
  17339. (defun org-shiftright (&optional arg)
  17340. "Cycle the thing at point or in the current line, depending on context.
  17341. Depending on context, this does one of the following:
  17342. - switch a timestamp at point one day into the future
  17343. - on a headline, switch to the next TODO keyword.
  17344. - on an item, switch entire list to the next bullet type
  17345. - on a property line, switch to the next allowed value
  17346. - on a clocktable definition line, move time block into the future"
  17347. (interactive "P")
  17348. (cond
  17349. ((run-hook-with-args-until-success 'org-shiftright-hook))
  17350. ((and org-support-shift-select (org-region-active-p))
  17351. (org-call-for-shift-select 'forward-char))
  17352. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  17353. ((and (not (eq org-support-shift-select 'always))
  17354. (org-at-heading-p))
  17355. (let ((org-inhibit-logging
  17356. (not org-treat-S-cursor-todo-selection-as-state-change))
  17357. (org-inhibit-blocking
  17358. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17359. (org-call-with-arg 'org-todo 'right)))
  17360. ((or (and org-support-shift-select
  17361. (not (eq org-support-shift-select 'always))
  17362. (org-at-item-bullet-p))
  17363. (and (not org-support-shift-select) (org-at-item-p)))
  17364. (org-call-with-arg 'org-cycle-list-bullet nil))
  17365. ((and (not (eq org-support-shift-select 'always))
  17366. (org-at-property-p))
  17367. (call-interactively 'org-property-next-allowed-value))
  17368. ((org-clocktable-try-shift 'right arg))
  17369. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  17370. (org-support-shift-select
  17371. (org-call-for-shift-select 'forward-char))
  17372. (t (org-shiftselect-error))))
  17373. (defun org-shiftleft (&optional arg)
  17374. "Cycle the thing at point or in the current line, depending on context.
  17375. Depending on context, this does one of the following:
  17376. - switch a timestamp at point one day into the past
  17377. - on a headline, switch to the previous TODO keyword.
  17378. - on an item, switch entire list to the previous bullet type
  17379. - on a property line, switch to the previous allowed value
  17380. - on a clocktable definition line, move time block into the past"
  17381. (interactive "P")
  17382. (cond
  17383. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  17384. ((and org-support-shift-select (org-region-active-p))
  17385. (org-call-for-shift-select 'backward-char))
  17386. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  17387. ((and (not (eq org-support-shift-select 'always))
  17388. (org-at-heading-p))
  17389. (let ((org-inhibit-logging
  17390. (not org-treat-S-cursor-todo-selection-as-state-change))
  17391. (org-inhibit-blocking
  17392. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17393. (org-call-with-arg 'org-todo 'left)))
  17394. ((or (and org-support-shift-select
  17395. (not (eq org-support-shift-select 'always))
  17396. (org-at-item-bullet-p))
  17397. (and (not org-support-shift-select) (org-at-item-p)))
  17398. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  17399. ((and (not (eq org-support-shift-select 'always))
  17400. (org-at-property-p))
  17401. (call-interactively 'org-property-previous-allowed-value))
  17402. ((org-clocktable-try-shift 'left arg))
  17403. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  17404. (org-support-shift-select
  17405. (org-call-for-shift-select 'backward-char))
  17406. (t (org-shiftselect-error))))
  17407. (defun org-shiftcontrolright ()
  17408. "Switch to next TODO set."
  17409. (interactive)
  17410. (cond
  17411. ((and org-support-shift-select (org-region-active-p))
  17412. (org-call-for-shift-select 'forward-word))
  17413. ((and (not (eq org-support-shift-select 'always))
  17414. (org-at-heading-p))
  17415. (org-call-with-arg 'org-todo 'nextset))
  17416. (org-support-shift-select
  17417. (org-call-for-shift-select 'forward-word))
  17418. (t (org-shiftselect-error))))
  17419. (defun org-shiftcontrolleft ()
  17420. "Switch to previous TODO set."
  17421. (interactive)
  17422. (cond
  17423. ((and org-support-shift-select (org-region-active-p))
  17424. (org-call-for-shift-select 'backward-word))
  17425. ((and (not (eq org-support-shift-select 'always))
  17426. (org-at-heading-p))
  17427. (org-call-with-arg 'org-todo 'previousset))
  17428. (org-support-shift-select
  17429. (org-call-for-shift-select 'backward-word))
  17430. (t (org-shiftselect-error))))
  17431. (defun org-shiftcontrolup ()
  17432. "Change timestamps synchronously up in CLOCK log lines."
  17433. (interactive)
  17434. (cond ((and (not org-support-shift-select)
  17435. (org-at-clock-log-p)
  17436. (org-at-timestamp-p t))
  17437. (org-clock-timestamps-up))
  17438. (t (org-shiftselect-error))))
  17439. (defun org-shiftcontroldown ()
  17440. "Change timestamps synchronously down in CLOCK log lines."
  17441. (interactive)
  17442. (cond ((and (not org-support-shift-select)
  17443. (org-at-clock-log-p)
  17444. (org-at-timestamp-p t))
  17445. (org-clock-timestamps-down))
  17446. (t (org-shiftselect-error))))
  17447. (defun org-ctrl-c-ret ()
  17448. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  17449. (interactive)
  17450. (cond
  17451. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  17452. (t (call-interactively 'org-insert-heading))))
  17453. (defun org-find-visible ()
  17454. (let ((s (point)))
  17455. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17456. (get-char-property s 'invisible)))
  17457. s))
  17458. (defun org-find-invisible ()
  17459. (let ((s (point)))
  17460. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17461. (not (get-char-property s 'invisible))))
  17462. s))
  17463. (defun org-copy-visible (beg end)
  17464. "Copy the visible parts of the region."
  17465. (interactive "r")
  17466. (let (snippets s)
  17467. (save-excursion
  17468. (save-restriction
  17469. (narrow-to-region beg end)
  17470. (setq s (goto-char (point-min)))
  17471. (while (not (= (point) (point-max)))
  17472. (goto-char (org-find-invisible))
  17473. (push (buffer-substring s (point)) snippets)
  17474. (setq s (goto-char (org-find-visible))))))
  17475. (kill-new (apply 'concat (nreverse snippets)))))
  17476. (defun org-copy-special ()
  17477. "Copy region in table or copy current subtree.
  17478. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  17479. See the individual commands for more information."
  17480. (interactive)
  17481. (call-interactively
  17482. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  17483. (defun org-cut-special ()
  17484. "Cut region in table or cut current subtree.
  17485. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  17486. See the individual commands for more information."
  17487. (interactive)
  17488. (call-interactively
  17489. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  17490. (defun org-paste-special (arg)
  17491. "Paste rectangular region into table, or past subtree relative to level.
  17492. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  17493. See the individual commands for more information."
  17494. (interactive "P")
  17495. (if (org-at-table-p)
  17496. (org-table-paste-rectangle)
  17497. (org-paste-subtree arg)))
  17498. (defun org-edit-special (&optional arg)
  17499. "Call a special editor for the stuff at point.
  17500. When at a table, call the formula editor with `org-table-edit-formulas'.
  17501. When at the first line of an src example, call `org-edit-src-code'.
  17502. When in an #+include line, visit the include file. Otherwise call
  17503. `ffap' to visit the file at point."
  17504. (interactive)
  17505. ;; possibly prep session before editing source
  17506. (when arg
  17507. (let* ((info (org-babel-get-src-block-info))
  17508. (lang (nth 0 info))
  17509. (params (nth 2 info))
  17510. (session (cdr (assoc :session params))))
  17511. (when (and info session) ;; we are in a source-code block with a session
  17512. (funcall
  17513. (intern (concat "org-babel-prep-session:" lang)) session params))))
  17514. (cond ;; proceed with `org-edit-special'
  17515. ((save-excursion
  17516. (beginning-of-line 1)
  17517. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  17518. (find-file (org-trim (match-string 1))))
  17519. ((org-edit-src-code))
  17520. ((org-edit-fixed-width-region))
  17521. ((org-at-table.el-p)
  17522. (org-edit-src-code))
  17523. ((or (org-at-table-p)
  17524. (save-excursion
  17525. (beginning-of-line 1)
  17526. (let ((case-fold-search )) (looking-at "[ \t]*#\\+tblfm:"))))
  17527. (call-interactively 'org-table-edit-formulas))
  17528. (t (call-interactively 'ffap))))
  17529. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  17530. (defun org-ctrl-c-ctrl-c (&optional arg)
  17531. "Set tags in headline, or update according to changed information at point.
  17532. This command does many different things, depending on context:
  17533. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  17534. this is what we do.
  17535. - If the cursor is on a statistics cookie, update it.
  17536. - If the cursor is in a headline, prompt for tags and insert them
  17537. into the current line, aligned to `org-tags-column'. When called
  17538. with prefix arg, realign all tags in the current buffer.
  17539. - If the cursor is in one of the special #+KEYWORD lines, this
  17540. triggers scanning the buffer for these lines and updating the
  17541. information.
  17542. - If the cursor is inside a table, realign the table. This command
  17543. works even if the automatic table editor has been turned off.
  17544. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  17545. the entire table.
  17546. - If the cursor is at a footnote reference or definition, jump to
  17547. the corresponding definition or references, respectively.
  17548. - If the cursor is a the beginning of a dynamic block, update it.
  17549. - If the current buffer is a capture buffer, close note and file it.
  17550. - If the cursor is on a <<<target>>>, update radio targets and
  17551. corresponding links in this buffer.
  17552. - If the cursor is on a numbered item in a plain list, renumber the
  17553. ordered list.
  17554. - If the cursor is on a checkbox, toggle it.
  17555. - If the cursor is on a code block, evaluate it. The variable
  17556. `org-confirm-babel-evaluate' can be used to control prompting
  17557. before code block evaluation, by default every code block
  17558. evaluation requires confirmation. Code block evaluation can be
  17559. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  17560. (interactive "P")
  17561. (let ((org-enable-table-editor t))
  17562. (cond
  17563. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  17564. org-occur-highlights
  17565. org-latex-fragment-image-overlays)
  17566. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  17567. (org-remove-occur-highlights)
  17568. (org-remove-latex-fragment-image-overlays)
  17569. (message "Temporary highlights/overlays removed from current buffer"))
  17570. ((and (local-variable-p 'org-finish-function (current-buffer))
  17571. (fboundp org-finish-function))
  17572. (funcall org-finish-function))
  17573. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  17574. ((org-in-regexp org-ts-regexp-both)
  17575. (org-timestamp-change 0 'day))
  17576. ((or (looking-at org-property-start-re)
  17577. (org-at-property-p))
  17578. (call-interactively 'org-property-action))
  17579. ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
  17580. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  17581. (or (org-at-heading-p) (org-at-item-p)))
  17582. (call-interactively 'org-update-statistics-cookies))
  17583. ((org-at-heading-p) (call-interactively 'org-set-tags))
  17584. ((org-at-table.el-p)
  17585. (message "Use C-c ' to edit table.el tables"))
  17586. ((org-at-table-p)
  17587. (org-table-maybe-eval-formula)
  17588. (if arg
  17589. (call-interactively 'org-table-recalculate)
  17590. (org-table-maybe-recalculate-line))
  17591. (call-interactively 'org-table-align)
  17592. (orgtbl-send-table 'maybe))
  17593. ((or (org-footnote-at-reference-p)
  17594. (org-footnote-at-definition-p))
  17595. (call-interactively 'org-footnote-action))
  17596. ((org-at-item-checkbox-p)
  17597. ;; Cursor at a checkbox: repair list and update checkboxes. Send
  17598. ;; list only if at top item.
  17599. (let* ((cbox (match-string 1))
  17600. (struct (org-list-struct))
  17601. (old-struct (copy-tree struct))
  17602. (parents (org-list-parents-alist struct))
  17603. (orderedp (org-entry-get nil "ORDERED"))
  17604. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17605. block-item)
  17606. ;; Use a light version of `org-toggle-checkbox' to avoid
  17607. ;; computing list structure twice.
  17608. (let ((new-box (cond
  17609. ((equal arg '(16)) "[-]")
  17610. ((equal arg '(4)) nil)
  17611. ((equal "[X]" cbox) "[ ]")
  17612. (t "[X]"))))
  17613. (if (and firstp arg)
  17614. ;; If at first item of sub-list, remove check-box from
  17615. ;; every item at the same level.
  17616. (mapc
  17617. (lambda (pos) (org-list-set-checkbox pos struct new-box))
  17618. (org-list-get-all-items
  17619. (point-at-bol) struct (org-list-prevs-alist struct)))
  17620. (org-list-set-checkbox (point-at-bol) struct new-box)))
  17621. ;; Replicate `org-list-write-struct', while grabbing a return
  17622. ;; value from `org-list-struct-fix-box'.
  17623. (org-list-struct-fix-ind struct parents 2)
  17624. (org-list-struct-fix-item-end struct)
  17625. (let ((prevs (org-list-prevs-alist struct)))
  17626. (org-list-struct-fix-bul struct prevs)
  17627. (org-list-struct-fix-ind struct parents)
  17628. (setq block-item
  17629. (org-list-struct-fix-box struct parents prevs orderedp)))
  17630. (org-list-struct-apply-struct struct old-struct)
  17631. (org-update-checkbox-count-maybe)
  17632. (when block-item
  17633. (message
  17634. "Checkboxes were removed due to unchecked box at line %d"
  17635. (org-current-line block-item)))
  17636. (when firstp (org-list-send-list 'maybe))))
  17637. ((org-at-item-p)
  17638. ;; Cursor at an item: repair list. Do checkbox related actions
  17639. ;; only if function was called with an argument. Send list only
  17640. ;; if at top item.
  17641. (let* ((struct (org-list-struct))
  17642. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17643. old-struct)
  17644. (when arg
  17645. (setq old-struct (copy-tree struct))
  17646. (if firstp
  17647. ;; If at first item of sub-list, add check-box to every
  17648. ;; item at the same level.
  17649. (mapc
  17650. (lambda (pos)
  17651. (unless (org-list-get-checkbox pos struct)
  17652. (org-list-set-checkbox pos struct "[ ]")))
  17653. (org-list-get-all-items
  17654. (point-at-bol) struct (org-list-prevs-alist struct)))
  17655. (org-list-set-checkbox (point-at-bol) struct "[ ]")))
  17656. (org-list-write-struct
  17657. struct (org-list-parents-alist struct) old-struct)
  17658. (when arg (org-update-checkbox-count-maybe))
  17659. (when firstp (org-list-send-list 'maybe))))
  17660. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  17661. ;; Dynamic block
  17662. (beginning-of-line 1)
  17663. (save-excursion (org-update-dblock)))
  17664. ((save-excursion
  17665. (let ((case-fold-search t))
  17666. (beginning-of-line 1)
  17667. (looking-at "[ \t]*#\\+\\([a-z]+\\)")))
  17668. (cond
  17669. ((or (equal (match-string 1) "TBLFM")
  17670. (equal (match-string 1) "tblfm"))
  17671. ;; Recalculate the table before this line
  17672. (save-excursion
  17673. (beginning-of-line 1)
  17674. (skip-chars-backward " \r\n\t")
  17675. (if (org-at-table-p)
  17676. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  17677. (t
  17678. (let ((org-inhibit-startup-visibility-stuff t)
  17679. (org-startup-align-all-tables nil))
  17680. (when (boundp 'org-table-coordinate-overlays)
  17681. (mapc 'delete-overlay org-table-coordinate-overlays)
  17682. (setq org-table-coordinate-overlays nil))
  17683. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  17684. (message "Local setup has been refreshed"))))
  17685. ((org-clock-update-time-maybe))
  17686. (t
  17687. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  17688. (error "C-c C-c can do nothing useful at this location"))))))
  17689. (defun org-mode-restart ()
  17690. "Restart Org-mode, to scan again for special lines.
  17691. Also updates the keyword regular expressions."
  17692. (interactive)
  17693. (org-mode)
  17694. (message "Org-mode restarted"))
  17695. (defun org-kill-note-or-show-branches ()
  17696. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  17697. (interactive)
  17698. (if (not org-finish-function)
  17699. (progn
  17700. (hide-subtree)
  17701. (call-interactively 'show-branches))
  17702. (let ((org-note-abort t))
  17703. (funcall org-finish-function))))
  17704. (defun org-return (&optional indent)
  17705. "Goto next table row or insert a newline.
  17706. Calls `org-table-next-row' or `newline', depending on context.
  17707. See the individual commands for more information."
  17708. (interactive)
  17709. (let (org-ts-what)
  17710. (cond
  17711. ((or (bobp) (org-in-src-block-p))
  17712. (if indent (newline-and-indent) (newline)))
  17713. ((org-at-table-p)
  17714. (org-table-justify-field-maybe)
  17715. (call-interactively 'org-table-next-row))
  17716. ;; when `newline-and-indent' is called within a list, make sure
  17717. ;; text moved stays inside the item.
  17718. ((and (org-in-item-p) indent)
  17719. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  17720. (progn
  17721. (save-match-data (newline))
  17722. (org-indent-line-to (length (match-string 0))))
  17723. (let ((ind (org-get-indentation)))
  17724. (newline)
  17725. (if (org-looking-back org-list-end-re)
  17726. (org-indent-line)
  17727. (org-indent-line-to ind)))))
  17728. ((and org-return-follows-link
  17729. (org-at-timestamp-p t)
  17730. (not (eq org-ts-what 'after)))
  17731. (org-follow-timestamp-link))
  17732. ((and org-return-follows-link
  17733. (let ((tprop (get-text-property (point) 'face)))
  17734. (or (eq tprop 'org-link)
  17735. (and (listp tprop) (memq 'org-link tprop)))))
  17736. (call-interactively 'org-open-at-point))
  17737. ((and (org-at-heading-p)
  17738. (looking-at
  17739. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  17740. (org-show-entry)
  17741. (end-of-line 1)
  17742. (newline))
  17743. (t (if indent (newline-and-indent) (newline))))))
  17744. (defun org-return-indent ()
  17745. "Goto next table row or insert a newline and indent.
  17746. Calls `org-table-next-row' or `newline-and-indent', depending on
  17747. context. See the individual commands for more information."
  17748. (interactive)
  17749. (org-return t))
  17750. (defun org-ctrl-c-star ()
  17751. "Compute table, or change heading status of lines.
  17752. Calls `org-table-recalculate' or `org-toggle-heading',
  17753. depending on context."
  17754. (interactive)
  17755. (cond
  17756. ((org-at-table-p)
  17757. (call-interactively 'org-table-recalculate))
  17758. (t
  17759. ;; Convert all lines in region to list items
  17760. (call-interactively 'org-toggle-heading))))
  17761. (defun org-ctrl-c-minus ()
  17762. "Insert separator line in table or modify bullet status of line.
  17763. Also turns a plain line or a region of lines into list items.
  17764. Calls `org-table-insert-hline', `org-toggle-item', or
  17765. `org-cycle-list-bullet', depending on context."
  17766. (interactive)
  17767. (cond
  17768. ((org-at-table-p)
  17769. (call-interactively 'org-table-insert-hline))
  17770. ((org-region-active-p)
  17771. (call-interactively 'org-toggle-item))
  17772. ((org-in-item-p)
  17773. (call-interactively 'org-cycle-list-bullet))
  17774. (t
  17775. (call-interactively 'org-toggle-item))))
  17776. (defun org-toggle-item (arg)
  17777. "Convert headings or normal lines to items, items to normal lines.
  17778. If there is no active region, only the current line is considered.
  17779. If the first non blank line in the region is an headline, convert
  17780. all headlines to items, shifting text accordingly.
  17781. If it is an item, convert all items to normal lines.
  17782. If it is normal text, change region into an item. With a prefix
  17783. argument ARG, change each line in region into an item."
  17784. (interactive "P")
  17785. (let ((shift-text
  17786. (function
  17787. ;; Shift text in current section to IND, from point to END.
  17788. ;; The function leaves point to END line.
  17789. (lambda (ind end)
  17790. (let ((min-i 1000) (end (copy-marker end)))
  17791. ;; First determine the minimum indentation (MIN-I) of
  17792. ;; the text.
  17793. (save-excursion
  17794. (catch 'exit
  17795. (while (< (point) end)
  17796. (let ((i (org-get-indentation)))
  17797. (cond
  17798. ;; Skip blank lines and inline tasks.
  17799. ((looking-at "^[ \t]*$"))
  17800. ((looking-at org-outline-regexp-bol))
  17801. ;; We can't find less than 0 indentation.
  17802. ((zerop i) (throw 'exit (setq min-i 0)))
  17803. ((< i min-i) (setq min-i i))))
  17804. (forward-line))))
  17805. ;; Then indent each line so that a line indented to
  17806. ;; MIN-I becomes indented to IND. Ignore blank lines
  17807. ;; and inline tasks in the process.
  17808. (let ((delta (- ind min-i)))
  17809. (while (< (point) end)
  17810. (unless (or (looking-at "^[ \t]*$")
  17811. (looking-at org-outline-regexp-bol))
  17812. (org-indent-line-to (+ (org-get-indentation) delta)))
  17813. (forward-line)))))))
  17814. (skip-blanks
  17815. (function
  17816. ;; Return beginning of first non-blank line, starting from
  17817. ;; line at POS.
  17818. (lambda (pos)
  17819. (save-excursion
  17820. (goto-char pos)
  17821. (skip-chars-forward " \r\t\n")
  17822. (point-at-bol)))))
  17823. beg end)
  17824. ;; Determine boundaries of changes.
  17825. (if (org-region-active-p)
  17826. (setq beg (funcall skip-blanks (region-beginning))
  17827. end (copy-marker (region-end)))
  17828. (setq beg (funcall skip-blanks (point-at-bol))
  17829. end (copy-marker (point-at-eol))))
  17830. ;; Depending on the starting line, choose an action on the text
  17831. ;; between BEG and END.
  17832. (org-with-limited-levels
  17833. (save-excursion
  17834. (goto-char beg)
  17835. (cond
  17836. ;; Case 1. Start at an item: de-itemize. Note that it only
  17837. ;; happens when a region is active: `org-ctrl-c-minus'
  17838. ;; would call `org-cycle-list-bullet' otherwise.
  17839. ((org-at-item-p)
  17840. (while (< (point) end)
  17841. (when (org-at-item-p)
  17842. (skip-chars-forward " \t")
  17843. (delete-region (point) (match-end 0)))
  17844. (forward-line)))
  17845. ;; Case 2. Start at an heading: convert to items.
  17846. ((org-at-heading-p)
  17847. (let* ((bul (org-list-bullet-string "-"))
  17848. (bul-len (length bul))
  17849. ;; Indentation of the first heading. It should be
  17850. ;; relative to the indentation of its parent, if any.
  17851. (start-ind (save-excursion
  17852. (cond
  17853. ((not org-adapt-indentation) 0)
  17854. ((not (outline-previous-heading)) 0)
  17855. (t (length (match-string 0))))))
  17856. ;; Level of first heading. Further headings will be
  17857. ;; compared to it to determine hierarchy in the list.
  17858. (ref-level (org-reduced-level (org-outline-level))))
  17859. (while (< (point) end)
  17860. (let* ((level (org-reduced-level (org-outline-level)))
  17861. (delta (max 0 (- level ref-level))))
  17862. ;; If current headline is less indented than the first
  17863. ;; one, set it as reference, in order to preserve
  17864. ;; subtrees.
  17865. (when (< level ref-level) (setq ref-level level))
  17866. (replace-match bul t t)
  17867. (org-indent-line-to (+ start-ind (* delta bul-len)))
  17868. ;; Ensure all text down to END (or SECTION-END) belongs
  17869. ;; to the newly created item.
  17870. (let ((section-end (save-excursion
  17871. (or (outline-next-heading) (point)))))
  17872. (forward-line)
  17873. (funcall shift-text
  17874. (+ start-ind (* (1+ delta) bul-len))
  17875. (min end section-end)))))))
  17876. ;; Case 3. Normal line with ARG: turn each non-item line into
  17877. ;; an item.
  17878. (arg
  17879. (while (< (point) end)
  17880. (unless (or (org-at-heading-p) (org-at-item-p))
  17881. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  17882. (replace-match
  17883. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  17884. (forward-line)))
  17885. ;; Case 4. Normal line without ARG: make the first line of
  17886. ;; region an item, and shift indentation of others
  17887. ;; lines to set them as item's body.
  17888. (t (let* ((bul (org-list-bullet-string "-"))
  17889. (bul-len (length bul))
  17890. (ref-ind (org-get-indentation)))
  17891. (skip-chars-forward " \t")
  17892. (insert bul)
  17893. (forward-line)
  17894. (while (< (point) end)
  17895. ;; Ensure that lines less indented than first one
  17896. ;; still get included in item body.
  17897. (funcall shift-text
  17898. (+ ref-ind bul-len)
  17899. (min end (save-excursion (or (outline-next-heading)
  17900. (point)))))
  17901. (forward-line)))))))))
  17902. (defun org-toggle-heading (&optional nstars)
  17903. "Convert headings to normal text, or items or text to headings.
  17904. If there is no active region, only the current line is considered.
  17905. With a \\[universal-argument] prefix, convert the whole list at
  17906. point into heading.
  17907. In a region:
  17908. - If the first non blank line is an headline, remove the stars
  17909. from all headlines in the region.
  17910. - If it is a normal line turn each and every normal line (i.e. not an
  17911. heading or an item) in the region into a heading.
  17912. - If it is a plain list item, turn all plain list items into headings.
  17913. When converting a line into a heading, the number of stars is chosen
  17914. such that the lines become children of the current entry. However,
  17915. when a prefix argument is given, its value determines the number of
  17916. stars to add."
  17917. (interactive "P")
  17918. (let ((skip-blanks
  17919. (function
  17920. ;; Return beginning of first non-blank line, starting from
  17921. ;; line at POS.
  17922. (lambda (pos)
  17923. (save-excursion
  17924. (goto-char pos)
  17925. (while (org-at-comment-p) (forward-line))
  17926. (skip-chars-forward " \r\t\n")
  17927. (point-at-bol)))))
  17928. beg end toggled)
  17929. ;; Determine boundaries of changes. If a universal prefix has
  17930. ;; been given, put the list in a region. If region ends at a bol,
  17931. ;; do not consider the last line to be in the region.
  17932. (when (and current-prefix-arg (org-at-item-p))
  17933. (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
  17934. (org-mark-element))
  17935. (if (org-region-active-p)
  17936. (setq beg (funcall skip-blanks (region-beginning))
  17937. end (copy-marker (save-excursion
  17938. (goto-char (region-end))
  17939. (if (bolp) (point) (point-at-eol)))))
  17940. (setq beg (funcall skip-blanks (point-at-bol))
  17941. end (copy-marker (point-at-eol))))
  17942. ;; Ensure inline tasks don't count as headings.
  17943. (org-with-limited-levels
  17944. (save-excursion
  17945. (goto-char beg)
  17946. (cond
  17947. ;; Case 1. Started at an heading: de-star headings.
  17948. ((org-at-heading-p)
  17949. (while (< (point) end)
  17950. (when (org-at-heading-p t)
  17951. (looking-at org-outline-regexp) (replace-match "")
  17952. (setq toggled t))
  17953. (forward-line)))
  17954. ;; Case 2. Started at an item: change items into headlines.
  17955. ;; One star will be added by `org-list-to-subtree'.
  17956. ((org-at-item-p)
  17957. (let* ((stars (make-string
  17958. (if nstars
  17959. ;; subtract the star that will be added again by
  17960. ;; `org-list-to-subtree'
  17961. (1- (prefix-numeric-value current-prefix-arg))
  17962. (or (org-current-level) 0))
  17963. ?*))
  17964. (add-stars
  17965. (cond (nstars "") ; stars from prefix only
  17966. ((equal stars "") "") ; before first heading
  17967. (org-odd-levels-only "*") ; inside heading, odd
  17968. (t "")))) ; inside heading, oddeven
  17969. (while (< (point) end)
  17970. (when (org-at-item-p)
  17971. ;; Pay attention to cases when region ends before list.
  17972. (let* ((struct (org-list-struct))
  17973. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  17974. (save-restriction
  17975. (narrow-to-region (point) list-end)
  17976. (insert
  17977. (org-list-to-subtree
  17978. (org-list-parse-list t)
  17979. '(:istart (concat stars add-stars (funcall get-stars depth))
  17980. :icount (concat stars add-stars (funcall get-stars depth)))))))
  17981. (setq toggled t))
  17982. (forward-line))))
  17983. ;; Case 3. Started at normal text: make every line an heading,
  17984. ;; skipping headlines and items.
  17985. (t (let* ((stars (make-string
  17986. (if nstars
  17987. (prefix-numeric-value current-prefix-arg)
  17988. (or (org-current-level) 0))
  17989. ?*))
  17990. (add-stars
  17991. (cond (nstars "") ; stars from prefix only
  17992. ((equal stars "") "*") ; before first heading
  17993. (org-odd-levels-only "**") ; inside heading, odd
  17994. (t "*"))) ; inside heading, oddeven
  17995. (rpl (concat stars add-stars " ")))
  17996. (while (< (point) end)
  17997. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  17998. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  17999. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  18000. (forward-line)))))))
  18001. (unless toggled (message "Cannot toggle heading from here"))))
  18002. (defun org-meta-return (&optional arg)
  18003. "Insert a new heading or wrap a region in a table.
  18004. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  18005. See the individual commands for more information."
  18006. (interactive "P")
  18007. (cond
  18008. ((run-hook-with-args-until-success 'org-metareturn-hook))
  18009. ((or (org-at-drawer-p) (org-at-property-p))
  18010. (newline-and-indent))
  18011. ((org-at-table-p)
  18012. (call-interactively 'org-table-wrap-region))
  18013. (t (call-interactively 'org-insert-heading))))
  18014. ;;; Menu entries
  18015. (defsubst org-in-subtree-not-table-p ()
  18016. "Are we in a subtree and not in a table?"
  18017. (and (not (org-before-first-heading-p))
  18018. (not (org-at-table-p))))
  18019. ;; Define the Org-mode menus
  18020. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  18021. '("Tbl"
  18022. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  18023. ["Next Field" org-cycle (org-at-table-p)]
  18024. ["Previous Field" org-shifttab (org-at-table-p)]
  18025. ["Next Row" org-return (org-at-table-p)]
  18026. "--"
  18027. ["Blank Field" org-table-blank-field (org-at-table-p)]
  18028. ["Edit Field" org-table-edit-field (org-at-table-p)]
  18029. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  18030. "--"
  18031. ("Column"
  18032. ["Move Column Left" org-metaleft (org-at-table-p)]
  18033. ["Move Column Right" org-metaright (org-at-table-p)]
  18034. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  18035. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  18036. ("Row"
  18037. ["Move Row Up" org-metaup (org-at-table-p)]
  18038. ["Move Row Down" org-metadown (org-at-table-p)]
  18039. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  18040. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  18041. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  18042. "--"
  18043. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  18044. ("Rectangle"
  18045. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  18046. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  18047. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  18048. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  18049. "--"
  18050. ("Calculate"
  18051. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  18052. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  18053. ["Edit Formulas" org-edit-special (org-at-table-p)]
  18054. "--"
  18055. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  18056. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  18057. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  18058. "--"
  18059. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  18060. "--"
  18061. ["Sum Column/Rectangle" org-table-sum
  18062. (or (org-at-table-p) (org-region-active-p))]
  18063. ["Which Column?" org-table-current-column (org-at-table-p)])
  18064. ["Debug Formulas"
  18065. org-table-toggle-formula-debugger
  18066. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  18067. ["Show Col/Row Numbers"
  18068. org-table-toggle-coordinate-overlays
  18069. :style toggle
  18070. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  18071. "--"
  18072. ["Create" org-table-create (and (not (org-at-table-p))
  18073. org-enable-table-editor)]
  18074. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  18075. ["Import from File" org-table-import (not (org-at-table-p))]
  18076. ["Export to File" org-table-export (org-at-table-p)]
  18077. "--"
  18078. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  18079. (easy-menu-define org-org-menu org-mode-map "Org menu"
  18080. '("Org"
  18081. ("Show/Hide"
  18082. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  18083. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  18084. ["Sparse Tree..." org-sparse-tree t]
  18085. ["Reveal Context" org-reveal t]
  18086. ["Show All" show-all t]
  18087. "--"
  18088. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  18089. "--"
  18090. ["New Heading" org-insert-heading t]
  18091. ("Navigate Headings"
  18092. ["Up" outline-up-heading t]
  18093. ["Next" outline-next-visible-heading t]
  18094. ["Previous" outline-previous-visible-heading t]
  18095. ["Next Same Level" outline-forward-same-level t]
  18096. ["Previous Same Level" outline-backward-same-level t]
  18097. "--"
  18098. ["Jump" org-goto t])
  18099. ("Edit Structure"
  18100. ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
  18101. "--"
  18102. ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
  18103. ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
  18104. "--"
  18105. ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
  18106. ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
  18107. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  18108. "--"
  18109. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  18110. "--"
  18111. ["Copy visible text" org-copy-visible t]
  18112. "--"
  18113. ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
  18114. ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
  18115. ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
  18116. ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
  18117. "--"
  18118. ["Sort Region/Children" org-sort t]
  18119. "--"
  18120. ["Convert to odd levels" org-convert-to-odd-levels t]
  18121. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  18122. ("Editing"
  18123. ["Emphasis..." org-emphasize t]
  18124. ["Edit Source Example" org-edit-special t]
  18125. "--"
  18126. ["Footnote new/jump" org-footnote-action t]
  18127. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  18128. ("Archive"
  18129. ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
  18130. "--"
  18131. ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
  18132. ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
  18133. ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
  18134. )
  18135. "--"
  18136. ("Hyperlinks"
  18137. ["Store Link (Global)" org-store-link t]
  18138. ["Find existing link to here" org-occur-link-in-agenda-files t]
  18139. ["Insert Link" org-insert-link t]
  18140. ["Follow Link" org-open-at-point t]
  18141. "--"
  18142. ["Next link" org-next-link t]
  18143. ["Previous link" org-previous-link t]
  18144. "--"
  18145. ["Descriptive Links"
  18146. org-toggle-link-display
  18147. :style radio
  18148. :selected org-descriptive-links
  18149. ]
  18150. ["Literal Links"
  18151. org-toggle-link-display
  18152. :style radio
  18153. :selected (not org-descriptive-links)])
  18154. "--"
  18155. ("TODO Lists"
  18156. ["TODO/DONE/-" org-todo t]
  18157. ("Select keyword"
  18158. ["Next keyword" org-shiftright (org-at-heading-p)]
  18159. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  18160. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  18161. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  18162. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  18163. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  18164. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  18165. "--"
  18166. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  18167. :selected org-enforce-todo-dependencies :style toggle :active t]
  18168. "Settings for tree at point"
  18169. ["Do Children sequentially" org-toggle-ordered-property :style radio
  18170. :selected (org-entry-get nil "ORDERED")
  18171. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18172. ["Do Children parallel" org-toggle-ordered-property :style radio
  18173. :selected (not (org-entry-get nil "ORDERED"))
  18174. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18175. "--"
  18176. ["Set Priority" org-priority t]
  18177. ["Priority Up" org-shiftup t]
  18178. ["Priority Down" org-shiftdown t]
  18179. "--"
  18180. ["Get news from all feeds" org-feed-update-all t]
  18181. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  18182. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  18183. ("TAGS and Properties"
  18184. ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
  18185. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  18186. "--"
  18187. ["Set property" org-set-property (not (org-before-first-heading-p))]
  18188. ["Column view of properties" org-columns t]
  18189. ["Insert Column View DBlock" org-insert-columns-dblock t])
  18190. ("Dates and Scheduling"
  18191. ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
  18192. ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
  18193. ("Change Date"
  18194. ["1 Day Later" org-shiftright (org-at-timestamp-p)]
  18195. ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
  18196. ["1 ... Later" org-shiftup (org-at-timestamp-p)]
  18197. ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
  18198. ["Compute Time Range" org-evaluate-time-range t]
  18199. ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
  18200. ["Deadline" org-deadline (not (org-before-first-heading-p))]
  18201. "--"
  18202. ["Custom time format" org-toggle-time-stamp-overlays
  18203. :style radio :selected org-display-custom-times]
  18204. "--"
  18205. ["Goto Calendar" org-goto-calendar t]
  18206. ["Date from Calendar" org-date-from-calendar t]
  18207. "--"
  18208. ["Start/Restart Timer" org-timer-start t]
  18209. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  18210. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  18211. ["Insert Timer String" org-timer t]
  18212. ["Insert Timer Item" org-timer-item t])
  18213. ("Logging work"
  18214. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  18215. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  18216. ["Clock out" org-clock-out t]
  18217. ["Clock cancel" org-clock-cancel t]
  18218. "--"
  18219. ["Mark as default task" org-clock-mark-default-task t]
  18220. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  18221. ["Goto running clock" org-clock-goto t]
  18222. "--"
  18223. ["Display times" org-clock-display t]
  18224. ["Create clock table" org-clock-report t]
  18225. "--"
  18226. ["Record DONE time"
  18227. (progn (setq org-log-done (not org-log-done))
  18228. (message "Switching to %s will %s record a timestamp"
  18229. (car org-done-keywords)
  18230. (if org-log-done "automatically" "not")))
  18231. :style toggle :selected org-log-done])
  18232. "--"
  18233. ["Agenda Command..." org-agenda t]
  18234. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  18235. ("File List for Agenda")
  18236. ("Special views current file"
  18237. ["TODO Tree" org-show-todo-tree t]
  18238. ["Check Deadlines" org-check-deadlines t]
  18239. ["Timeline" org-timeline t]
  18240. ["Tags/Property tree" org-match-sparse-tree t])
  18241. "--"
  18242. ["Export/Publish..." org-export t]
  18243. ("LaTeX"
  18244. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  18245. :selected org-cdlatex-mode]
  18246. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  18247. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  18248. ["Modify math symbol" org-cdlatex-math-modify
  18249. (org-inside-LaTeX-fragment-p)]
  18250. ["Insert citation" org-reftex-citation t]
  18251. "--"
  18252. ["Template for BEAMER" (progn (require 'org-beamer)
  18253. (org-insert-beamer-options-template)) t])
  18254. "--"
  18255. ("MobileOrg"
  18256. ["Push Files and Views" org-mobile-push t]
  18257. ["Get Captured and Flagged" org-mobile-pull t]
  18258. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  18259. "--"
  18260. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  18261. "--"
  18262. ("Documentation"
  18263. ["Show Version" org-version t]
  18264. ["Info Documentation" org-info t])
  18265. ("Customize"
  18266. ["Browse Org Group" org-customize t]
  18267. "--"
  18268. ["Expand This Menu" org-create-customize-menu
  18269. (fboundp 'customize-menu-create)])
  18270. ["Send bug report" org-submit-bug-report t]
  18271. "--"
  18272. ("Refresh/Reload"
  18273. ["Refresh setup current buffer" org-mode-restart t]
  18274. ["Reload Org (after update)" org-reload t]
  18275. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  18276. ))
  18277. (defun org-info (&optional node)
  18278. "Read documentation for Org-mode in the info system.
  18279. With optional NODE, go directly to that node."
  18280. (interactive)
  18281. (info (format "(org)%s" (or node ""))))
  18282. ;;;###autoload
  18283. (defun org-submit-bug-report ()
  18284. "Submit a bug report on Org-mode via mail.
  18285. Don't hesitate to report any problems or inaccurate documentation.
  18286. If you don't have setup sending mail from (X)Emacs, please copy the
  18287. output buffer into your mail program, as it gives us important
  18288. information about your Org-mode version and configuration."
  18289. (interactive)
  18290. (require 'reporter)
  18291. (org-load-modules-maybe)
  18292. (org-require-autoloaded-modules)
  18293. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  18294. (reporter-submit-bug-report
  18295. "emacs-orgmode@gnu.org"
  18296. (org-version nil 'full)
  18297. (let (list)
  18298. (save-window-excursion
  18299. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  18300. (delete-other-windows)
  18301. (erase-buffer)
  18302. (insert "You are about to submit a bug report to the Org-mode mailing list.
  18303. We would like to add your full Org-mode and Outline configuration to the
  18304. bug report. This greatly simplifies the work of the maintainer and
  18305. other experts on the mailing list.
  18306. HOWEVER, some variables you have customized may contain private
  18307. information. The names of customers, colleagues, or friends, might
  18308. appear in the form of file names, tags, todo states, or search strings.
  18309. If you answer yes to the prompt, you might want to check and remove
  18310. such private information before sending the email.")
  18311. (add-text-properties (point-min) (point-max) '(face org-warning))
  18312. (when (yes-or-no-p "Include your Org-mode configuration ")
  18313. (mapatoms
  18314. (lambda (v)
  18315. (and (boundp v)
  18316. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  18317. (or (and (symbol-value v)
  18318. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  18319. (and
  18320. (get v 'custom-type) (get v 'standard-value)
  18321. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  18322. (push v list)))))
  18323. (kill-buffer (get-buffer "*Warn about privacy*"))
  18324. list))
  18325. nil nil
  18326. "Remember to cover the basics, that is, what you expected to happen and
  18327. what in fact did happen. You don't know how to make a good report? See
  18328. http://orgmode.org/manual/Feedback.html#Feedback
  18329. Your bug report will be posted to the Org-mode mailing list.
  18330. ------------------------------------------------------------------------")
  18331. (save-excursion
  18332. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  18333. (replace-match "\\1Bug: \\3 [\\2]")))))
  18334. (defun org-install-agenda-files-menu ()
  18335. (let ((bl (buffer-list)))
  18336. (save-excursion
  18337. (while bl
  18338. (set-buffer (pop bl))
  18339. (if (derived-mode-p 'org-mode) (setq bl nil)))
  18340. (when (derived-mode-p 'org-mode)
  18341. (easy-menu-change
  18342. '("Org") "File List for Agenda"
  18343. (append
  18344. (list
  18345. ["Edit File List" (org-edit-agenda-file-list) t]
  18346. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  18347. ["Remove Current File from List" org-remove-file t]
  18348. ["Cycle through agenda files" org-cycle-agenda-files t]
  18349. ["Occur in all agenda files" org-occur-in-agenda-files t]
  18350. "--")
  18351. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  18352. ;;;; Documentation
  18353. (defun org-require-autoloaded-modules ()
  18354. (interactive)
  18355. (mapc 'require
  18356. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  18357. org-docbook org-exp org-html org-icalendar
  18358. org-id org-latex
  18359. org-publish org-remember org-table
  18360. org-timer org-xoxo)))
  18361. ;;;###autoload
  18362. (defun org-reload (&optional uncompiled)
  18363. "Reload all org lisp files.
  18364. With prefix arg UNCOMPILED, load the uncompiled versions."
  18365. (interactive "P")
  18366. (require 'find-func)
  18367. (let* ((file-re "^org\\(-.*\\)?\\.el")
  18368. (dir-org (file-name-directory (org-find-library-dir "org")))
  18369. (dir-org-contrib (ignore-errors
  18370. (file-name-directory
  18371. (org-find-library-dir "org-contribdir"))))
  18372. (babel-files
  18373. (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
  18374. (append (list nil "comint" "eval" "exp" "keys"
  18375. "lob" "ref" "table" "tangle")
  18376. (delq nil
  18377. (mapcar
  18378. (lambda (lang)
  18379. (when (cdr lang) (symbol-name (car lang))))
  18380. org-babel-load-languages)))))
  18381. (files
  18382. (append babel-files
  18383. (and dir-org-contrib
  18384. (directory-files dir-org-contrib t file-re))
  18385. (directory-files dir-org t file-re)))
  18386. (remove-re (concat (if (featurep 'xemacs)
  18387. "org-colview" "org-colview-xemacs")
  18388. "\\'")))
  18389. (setq files (mapcar 'file-name-sans-extension files))
  18390. (setq files (mapcar
  18391. (lambda (x) (if (string-match remove-re x) nil x))
  18392. files))
  18393. (setq files (delq nil files))
  18394. (mapc
  18395. (lambda (f)
  18396. (when (featurep (intern (file-name-nondirectory f)))
  18397. (if (and (not uncompiled)
  18398. (file-exists-p (concat f ".elc")))
  18399. (load (concat f ".elc") nil nil 'nosuffix)
  18400. (load (concat f ".el") nil nil 'nosuffix))))
  18401. files)
  18402. (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
  18403. (org-version nil 'full 'message))
  18404. ;;;###autoload
  18405. (defun org-customize ()
  18406. "Call the customize function with org as argument."
  18407. (interactive)
  18408. (org-load-modules-maybe)
  18409. (org-require-autoloaded-modules)
  18410. (customize-browse 'org))
  18411. (defun org-create-customize-menu ()
  18412. "Create a full customization menu for Org-mode, insert it into the menu."
  18413. (interactive)
  18414. (org-load-modules-maybe)
  18415. (org-require-autoloaded-modules)
  18416. (if (fboundp 'customize-menu-create)
  18417. (progn
  18418. (easy-menu-change
  18419. '("Org") "Customize"
  18420. `(["Browse Org group" org-customize t]
  18421. "--"
  18422. ,(customize-menu-create 'org)
  18423. ["Set" Custom-set t]
  18424. ["Save" Custom-save t]
  18425. ["Reset to Current" Custom-reset-current t]
  18426. ["Reset to Saved" Custom-reset-saved t]
  18427. ["Reset to Standard Settings" Custom-reset-standard t]))
  18428. (message "\"Org\"-menu now contains full customization menu"))
  18429. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  18430. ;;;; Miscellaneous stuff
  18431. ;;; Generally useful functions
  18432. (defun org-get-at-bol (property)
  18433. "Get text property PROPERTY at beginning of line."
  18434. (get-text-property (point-at-bol) property))
  18435. (defun org-find-text-property-in-string (prop s)
  18436. "Return the first non-nil value of property PROP in string S."
  18437. (or (get-text-property 0 prop s)
  18438. (get-text-property (or (next-single-property-change 0 prop s) 0)
  18439. prop s)))
  18440. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  18441. "Display the given MESSAGE as a warning."
  18442. (if (fboundp 'display-warning)
  18443. (display-warning 'org message
  18444. (if (featurep 'xemacs) 'warning :warning))
  18445. (let ((buf (get-buffer-create "*Org warnings*")))
  18446. (with-current-buffer buf
  18447. (goto-char (point-max))
  18448. (insert "Warning (Org): " message)
  18449. (unless (bolp)
  18450. (newline)))
  18451. (display-buffer buf)
  18452. (sit-for 0))))
  18453. (defun org-eval (form)
  18454. "Eval FORM and return result."
  18455. (condition-case error
  18456. (eval form)
  18457. (error (format "%%![Error: %s]" error))))
  18458. (defun org-in-clocktable-p ()
  18459. "Check if the cursor is in a clocktable."
  18460. (let ((pos (point)) start)
  18461. (save-excursion
  18462. (end-of-line 1)
  18463. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  18464. (setq start (match-beginning 0))
  18465. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  18466. (>= (match-end 0) pos)
  18467. start))))
  18468. (defun org-in-commented-line ()
  18469. "Is point in a line starting with `#'?"
  18470. (equal (char-after (point-at-bol)) ?#))
  18471. (defun org-in-indented-comment-line ()
  18472. "Is point in a line starting with `#' after some white space?"
  18473. (save-excursion
  18474. (save-match-data
  18475. (goto-char (point-at-bol))
  18476. (looking-at "[ \t]*#"))))
  18477. (defun org-in-verbatim-emphasis ()
  18478. (save-match-data
  18479. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  18480. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  18481. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  18482. (if (and marker (marker-buffer marker)
  18483. (buffer-live-p (marker-buffer marker)))
  18484. (progn
  18485. (org-pop-to-buffer-same-window (marker-buffer marker))
  18486. (if (or (> marker (point-max)) (< marker (point-min)))
  18487. (widen))
  18488. (goto-char marker)
  18489. (org-show-context 'org-goto))
  18490. (if bookmark
  18491. (bookmark-jump bookmark)
  18492. (error "Cannot find location"))))
  18493. (defun org-quote-csv-field (s)
  18494. "Quote field for inclusion in CSV material."
  18495. (if (string-match "[\",]" s)
  18496. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  18497. s))
  18498. (defun org-force-self-insert (N)
  18499. "Needed to enforce self-insert under remapping."
  18500. (interactive "p")
  18501. (self-insert-command N))
  18502. (defun org-string-width (s)
  18503. "Compute width of string, ignoring invisible characters.
  18504. This ignores character with invisibility property `org-link', and also
  18505. characters with property `org-cwidth', because these will become invisible
  18506. upon the next fontification round."
  18507. (let (b l)
  18508. (when (or (eq t buffer-invisibility-spec)
  18509. (assq 'org-link buffer-invisibility-spec))
  18510. (while (setq b (text-property-any 0 (length s)
  18511. 'invisible 'org-link s))
  18512. (setq s (concat (substring s 0 b)
  18513. (substring s (or (next-single-property-change
  18514. b 'invisible s) (length s)))))))
  18515. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  18516. (setq s (concat (substring s 0 b)
  18517. (substring s (or (next-single-property-change
  18518. b 'org-cwidth s) (length s))))))
  18519. (setq l (string-width s) b -1)
  18520. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  18521. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  18522. l))
  18523. (defun org-shorten-string (s maxlength)
  18524. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  18525. If the string is shorter or has length MAXLENGTH, just return the
  18526. original string. If it is longer, the functions finds a space in the
  18527. string, breaks this string off at that locations and adds three dots
  18528. as ellipsis. Including the ellipsis, the string will not be longer
  18529. than MAXLENGTH. If finding a good breaking point in the string does
  18530. not work, the string is just chopped off in the middle of a word
  18531. if necessary."
  18532. (if (<= (length s) maxlength)
  18533. s
  18534. (let* ((n (max (- maxlength 4) 1))
  18535. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  18536. (if (string-match re s)
  18537. (concat (match-string 1 s) "...")
  18538. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  18539. (defun org-get-indentation (&optional line)
  18540. "Get the indentation of the current line, interpreting tabs.
  18541. When LINE is given, assume it represents a line and compute its indentation."
  18542. (if line
  18543. (if (string-match "^ *" (org-remove-tabs line))
  18544. (match-end 0))
  18545. (save-excursion
  18546. (beginning-of-line 1)
  18547. (skip-chars-forward " \t")
  18548. (current-column))))
  18549. (defun org-get-string-indentation (s)
  18550. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  18551. (let ((n -1) (i 0) (w tab-width) c)
  18552. (catch 'exit
  18553. (while (< (setq n (1+ n)) (length s))
  18554. (setq c (aref s n))
  18555. (cond ((= c ?\ ) (setq i (1+ i)))
  18556. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  18557. (t (throw 'exit t)))))
  18558. i))
  18559. (defun org-remove-tabs (s &optional width)
  18560. "Replace tabulators in S with spaces.
  18561. Assumes that s is a single line, starting in column 0."
  18562. (setq width (or width tab-width))
  18563. (while (string-match "\t" s)
  18564. (setq s (replace-match
  18565. (make-string
  18566. (- (* width (/ (+ (match-beginning 0) width) width))
  18567. (match-beginning 0)) ?\ )
  18568. t t s)))
  18569. s)
  18570. (defun org-fix-indentation (line ind)
  18571. "Fix indentation in LINE.
  18572. IND is a cons cell with target and minimum indentation.
  18573. If the current indentation in LINE is smaller than the minimum,
  18574. leave it alone. If it is larger than ind, set it to the target."
  18575. (let* ((l (org-remove-tabs line))
  18576. (i (org-get-indentation l))
  18577. (i1 (car ind)) (i2 (cdr ind)))
  18578. (if (>= i i2) (setq l (substring line i2)))
  18579. (if (> i1 0)
  18580. (concat (make-string i1 ?\ ) l)
  18581. l)))
  18582. (defun org-remove-indentation (code &optional n)
  18583. "Remove the maximum common indentation from the lines in CODE.
  18584. N may optionally be the number of spaces to remove."
  18585. (with-temp-buffer
  18586. (insert code)
  18587. (org-do-remove-indentation n)
  18588. (buffer-string)))
  18589. (defun org-do-remove-indentation (&optional n)
  18590. "Remove the maximum common indentation from the buffer."
  18591. (untabify (point-min) (point-max))
  18592. (let ((min 10000) re)
  18593. (if n
  18594. (setq min n)
  18595. (goto-char (point-min))
  18596. (while (re-search-forward "^ *[^ \n]" nil t)
  18597. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  18598. (unless (or (= min 0) (= min 10000))
  18599. (setq re (format "^ \\{%d\\}" min))
  18600. (goto-char (point-min))
  18601. (while (re-search-forward re nil t)
  18602. (replace-match "")
  18603. (end-of-line 1))
  18604. min)))
  18605. (defun org-fill-template (template alist)
  18606. "Find each %key of ALIST in TEMPLATE and replace it."
  18607. (let ((case-fold-search nil)
  18608. entry key value)
  18609. (setq alist (sort (copy-sequence alist)
  18610. (lambda (a b) (< (length (car a)) (length (car b))))))
  18611. (while (setq entry (pop alist))
  18612. (setq template
  18613. (replace-regexp-in-string
  18614. (concat "%" (regexp-quote (car entry)))
  18615. (or (cdr entry) "") template t t)))
  18616. template))
  18617. (defun org-base-buffer (buffer)
  18618. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  18619. (if (not buffer)
  18620. buffer
  18621. (or (buffer-base-buffer buffer)
  18622. buffer)))
  18623. (defun org-trim (s)
  18624. "Remove whitespace at beginning and end of string."
  18625. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  18626. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  18627. s)
  18628. (defun org-wrap (string &optional width lines)
  18629. "Wrap string to either a number of lines, or a width in characters.
  18630. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  18631. that costs. If there is a word longer than WIDTH, the text is actually
  18632. wrapped to the length of that word.
  18633. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  18634. many lines, whatever width that takes.
  18635. The return value is a list of lines, without newlines at the end."
  18636. (let* ((words (org-split-string string "[ \t\n]+"))
  18637. (maxword (apply 'max (mapcar 'org-string-width words)))
  18638. w ll)
  18639. (cond (width
  18640. (org-do-wrap words (max maxword width)))
  18641. (lines
  18642. (setq w maxword)
  18643. (setq ll (org-do-wrap words maxword))
  18644. (if (<= (length ll) lines)
  18645. ll
  18646. (setq ll words)
  18647. (while (> (length ll) lines)
  18648. (setq w (1+ w))
  18649. (setq ll (org-do-wrap words w)))
  18650. ll))
  18651. (t (error "Cannot wrap this")))))
  18652. (defun org-do-wrap (words width)
  18653. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  18654. (let (lines line)
  18655. (while words
  18656. (setq line (pop words))
  18657. (while (and words (< (+ (length line) (length (car words))) width))
  18658. (setq line (concat line " " (pop words))))
  18659. (setq lines (push line lines)))
  18660. (nreverse lines)))
  18661. (defun org-split-string (string &optional separators)
  18662. "Splits STRING into substrings at SEPARATORS.
  18663. No empty strings are returned if there are matches at the beginning
  18664. and end of string."
  18665. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  18666. (start 0)
  18667. notfirst
  18668. (list nil))
  18669. (while (and (string-match rexp string
  18670. (if (and notfirst
  18671. (= start (match-beginning 0))
  18672. (< start (length string)))
  18673. (1+ start) start))
  18674. (< (match-beginning 0) (length string)))
  18675. (setq notfirst t)
  18676. (or (eq (match-beginning 0) 0)
  18677. (and (eq (match-beginning 0) (match-end 0))
  18678. (eq (match-beginning 0) start))
  18679. (setq list
  18680. (cons (substring string start (match-beginning 0))
  18681. list)))
  18682. (setq start (match-end 0)))
  18683. (or (eq start (length string))
  18684. (setq list
  18685. (cons (substring string start)
  18686. list)))
  18687. (nreverse list)))
  18688. (defun org-quote-vert (s)
  18689. "Replace \"|\" with \"\\vert\"."
  18690. (while (string-match "|" s)
  18691. (setq s (replace-match "\\vert" t t s)))
  18692. s)
  18693. (defun org-uuidgen-p (s)
  18694. "Is S an ID created by UUIDGEN?"
  18695. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  18696. (defun org-in-src-block-p nil
  18697. "Whether point is in a code source block."
  18698. (let (ov)
  18699. (when (setq ov (overlays-at (point)))
  18700. (memq 'org-block-background
  18701. (overlay-properties
  18702. (car ov))))))
  18703. (defun org-context ()
  18704. "Return a list of contexts of the current cursor position.
  18705. If several contexts apply, all are returned.
  18706. Each context entry is a list with a symbol naming the context, and
  18707. two positions indicating start and end of the context. Possible
  18708. contexts are:
  18709. :headline anywhere in a headline
  18710. :headline-stars on the leading stars in a headline
  18711. :todo-keyword on a TODO keyword (including DONE) in a headline
  18712. :tags on the TAGS in a headline
  18713. :priority on the priority cookie in a headline
  18714. :item on the first line of a plain list item
  18715. :item-bullet on the bullet/number of a plain list item
  18716. :checkbox on the checkbox in a plain list item
  18717. :table in an org-mode table
  18718. :table-special on a special filed in a table
  18719. :table-table in a table.el table
  18720. :clocktable in a clocktable
  18721. :src-block in a source block
  18722. :link on a hyperlink
  18723. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  18724. :target on a <<target>>
  18725. :radio-target on a <<<radio-target>>>
  18726. :latex-fragment on a LaTeX fragment
  18727. :latex-preview on a LaTeX fragment with overlaid preview image
  18728. This function expects the position to be visible because it uses font-lock
  18729. faces as a help to recognize the following contexts: :table-special, :link,
  18730. and :keyword."
  18731. (let* ((f (get-text-property (point) 'face))
  18732. (faces (if (listp f) f (list f)))
  18733. (case-fold-search t)
  18734. (p (point)) clist o)
  18735. ;; First the large context
  18736. (cond
  18737. ((org-at-heading-p t)
  18738. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  18739. (when (progn
  18740. (beginning-of-line 1)
  18741. (looking-at org-todo-line-tags-regexp))
  18742. (push (org-point-in-group p 1 :headline-stars) clist)
  18743. (push (org-point-in-group p 2 :todo-keyword) clist)
  18744. (push (org-point-in-group p 4 :tags) clist))
  18745. (goto-char p)
  18746. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  18747. (if (looking-at "\\[#[A-Z0-9]\\]")
  18748. (push (org-point-in-group p 0 :priority) clist)))
  18749. ((org-at-item-p)
  18750. (push (org-point-in-group p 2 :item-bullet) clist)
  18751. (push (list :item (point-at-bol)
  18752. (save-excursion (org-end-of-item) (point)))
  18753. clist)
  18754. (and (org-at-item-checkbox-p)
  18755. (push (org-point-in-group p 0 :checkbox) clist)))
  18756. ((org-at-table-p)
  18757. (push (list :table (org-table-begin) (org-table-end)) clist)
  18758. (if (memq 'org-formula faces)
  18759. (push (list :table-special
  18760. (previous-single-property-change p 'face)
  18761. (next-single-property-change p 'face)) clist)))
  18762. ((org-at-table-p 'any)
  18763. (push (list :table-table) clist)))
  18764. (goto-char p)
  18765. (let ((case-fold-search t))
  18766. ;; New the "medium" contexts: clocktables, source blocks
  18767. (cond ((org-in-clocktable-p)
  18768. (push (list :clocktable
  18769. (and (or (looking-at "#\\+BEGIN: clocktable")
  18770. (search-backward "#+BEGIN: clocktable" nil t))
  18771. (match-beginning 0))
  18772. (and (re-search-forward "#\\+END:?" nil t)
  18773. (match-end 0))) clist))
  18774. ((org-in-src-block-p)
  18775. (push (list :src-block
  18776. (and (or (looking-at "#\\+BEGIN_SRC")
  18777. (search-backward "#+BEGIN_SRC" nil t))
  18778. (match-beginning 0))
  18779. (and (search-forward "#+END_SRC" nil t)
  18780. (match-beginning 0))) clist))))
  18781. (goto-char p)
  18782. ;; Now the small context
  18783. (cond
  18784. ((org-at-timestamp-p)
  18785. (push (org-point-in-group p 0 :timestamp) clist))
  18786. ((memq 'org-link faces)
  18787. (push (list :link
  18788. (previous-single-property-change p 'face)
  18789. (next-single-property-change p 'face)) clist))
  18790. ((memq 'org-special-keyword faces)
  18791. (push (list :keyword
  18792. (previous-single-property-change p 'face)
  18793. (next-single-property-change p 'face)) clist))
  18794. ((org-at-target-p)
  18795. (push (org-point-in-group p 0 :target) clist)
  18796. (goto-char (1- (match-beginning 0)))
  18797. (if (looking-at org-radio-target-regexp)
  18798. (push (org-point-in-group p 0 :radio-target) clist))
  18799. (goto-char p))
  18800. ((setq o (car (delq nil
  18801. (mapcar
  18802. (lambda (x)
  18803. (if (memq x org-latex-fragment-image-overlays) x))
  18804. (overlays-at (point))))))
  18805. (push (list :latex-fragment
  18806. (overlay-start o) (overlay-end o)) clist)
  18807. (push (list :latex-preview
  18808. (overlay-start o) (overlay-end o)) clist))
  18809. ((org-inside-LaTeX-fragment-p)
  18810. ;; FIXME: positions wrong.
  18811. (push (list :latex-fragment (point) (point)) clist)))
  18812. (setq clist (nreverse (delq nil clist)))
  18813. clist))
  18814. ;; FIXME: Compare with at-regexp-p Do we need both?
  18815. (defun org-in-regexp (re &optional nlines visually)
  18816. "Check if point is inside a match of regexp.
  18817. Normally only the current line is checked, but you can include NLINES extra
  18818. lines both before and after point into the search.
  18819. If VISUALLY is set, require that the cursor is not after the match but
  18820. really on, so that the block visually is on the match."
  18821. (catch 'exit
  18822. (let ((pos (point))
  18823. (eol (point-at-eol (+ 1 (or nlines 0))))
  18824. (inc (if visually 1 0)))
  18825. (save-excursion
  18826. (beginning-of-line (- 1 (or nlines 0)))
  18827. (while (re-search-forward re eol t)
  18828. (if (and (<= (match-beginning 0) pos)
  18829. (>= (+ inc (match-end 0)) pos))
  18830. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  18831. (defun org-at-regexp-p (regexp)
  18832. "Is point inside a match of REGEXP in the current line?"
  18833. (catch 'exit
  18834. (save-excursion
  18835. (let ((pos (point)) (end (point-at-eol)))
  18836. (beginning-of-line 1)
  18837. (while (re-search-forward regexp end t)
  18838. (if (and (<= (match-beginning 0) pos)
  18839. (>= (match-end 0) pos))
  18840. (throw 'exit t)))
  18841. nil))))
  18842. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  18843. "Non-nil when point is between matches of START-RE and END-RE.
  18844. Also return a non-nil value when point is on one of the matches.
  18845. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  18846. buffer positions. Default values are the positions of headlines
  18847. surrounding the point.
  18848. The functions returns a cons cell whose car (resp. cdr) is the
  18849. position before START-RE (resp. after END-RE)."
  18850. (save-match-data
  18851. (let ((pos (point))
  18852. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  18853. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  18854. beg end)
  18855. (save-excursion
  18856. ;; Point is on a block when on START-RE or if START-RE can be
  18857. ;; found before it...
  18858. (and (or (org-at-regexp-p start-re)
  18859. (re-search-backward start-re limit-up t))
  18860. (setq beg (match-beginning 0))
  18861. ;; ... and END-RE after it...
  18862. (goto-char (match-end 0))
  18863. (re-search-forward end-re limit-down t)
  18864. (> (setq end (match-end 0)) pos)
  18865. ;; ... without another START-RE in-between.
  18866. (goto-char (match-beginning 0))
  18867. (not (re-search-backward start-re (1+ beg) t))
  18868. ;; Return value.
  18869. (cons beg end))))))
  18870. (defun org-in-block-p (names)
  18871. "Non-nil when point belongs to a block whose name belongs to NAMES.
  18872. NAMES is a list of strings containing names of blocks.
  18873. Return first block name matched, or nil. Beware that in case of
  18874. nested blocks, the returned name may not belong to the closest
  18875. block from point."
  18876. (save-match-data
  18877. (catch 'exit
  18878. (let ((case-fold-search t)
  18879. (lim-up (save-excursion (outline-previous-heading)))
  18880. (lim-down (save-excursion (outline-next-heading))))
  18881. (mapc (lambda (name)
  18882. (let ((n (regexp-quote name)))
  18883. (when (org-between-regexps-p
  18884. (concat "^[ \t]*#\\+begin_" n)
  18885. (concat "^[ \t]*#\\+end_" n)
  18886. lim-up lim-down)
  18887. (throw 'exit n))))
  18888. names))
  18889. nil)))
  18890. (defun org-occur-in-agenda-files (regexp &optional nlines)
  18891. "Call `multi-occur' with buffers for all agenda files."
  18892. (interactive "sOrg-files matching: \np")
  18893. (let* ((files (org-agenda-files))
  18894. (tnames (mapcar 'file-truename files))
  18895. (extra org-agenda-text-search-extra-files)
  18896. f)
  18897. (when (eq (car extra) 'agenda-archives)
  18898. (setq extra (cdr extra))
  18899. (setq files (org-add-archive-files files)))
  18900. (while (setq f (pop extra))
  18901. (unless (member (file-truename f) tnames)
  18902. (add-to-list 'files f 'append)
  18903. (add-to-list 'tnames (file-truename f) 'append)))
  18904. (multi-occur
  18905. (mapcar (lambda (x)
  18906. (with-current-buffer
  18907. (or (get-file-buffer x) (find-file-noselect x))
  18908. (widen)
  18909. (current-buffer)))
  18910. files)
  18911. regexp)))
  18912. (if (boundp 'occur-mode-find-occurrence-hook)
  18913. ;; Emacs 23
  18914. (add-hook 'occur-mode-find-occurrence-hook
  18915. (lambda ()
  18916. (when (derived-mode-p 'org-mode)
  18917. (org-reveal))))
  18918. ;; Emacs 22
  18919. (defadvice occur-mode-goto-occurrence
  18920. (after org-occur-reveal activate)
  18921. (and (derived-mode-p 'org-mode) (org-reveal)))
  18922. (defadvice occur-mode-goto-occurrence-other-window
  18923. (after org-occur-reveal activate)
  18924. (and (derived-mode-p 'org-mode) (org-reveal)))
  18925. (defadvice occur-mode-display-occurrence
  18926. (after org-occur-reveal activate)
  18927. (when (derived-mode-p 'org-mode)
  18928. (let ((pos (occur-mode-find-occurrence)))
  18929. (with-current-buffer (marker-buffer pos)
  18930. (save-excursion
  18931. (goto-char pos)
  18932. (org-reveal)))))))
  18933. (defun org-occur-link-in-agenda-files ()
  18934. "Create a link and search for it in the agendas.
  18935. The link is not stored in `org-stored-links', it is just created
  18936. for the search purpose."
  18937. (interactive)
  18938. (let ((link (condition-case nil
  18939. (org-store-link nil)
  18940. (error "Unable to create a link to here"))))
  18941. (org-occur-in-agenda-files (regexp-quote link))))
  18942. (defun org-uniquify (list)
  18943. "Remove duplicate elements from LIST."
  18944. (let (res)
  18945. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  18946. res))
  18947. (defun org-delete-all (elts list)
  18948. "Remove all elements in ELTS from LIST."
  18949. (while elts
  18950. (setq list (delete (pop elts) list)))
  18951. list)
  18952. (defun org-count (cl-item cl-seq)
  18953. "Count the number of occurrences of ITEM in SEQ.
  18954. Taken from `count' in cl-seq.el with all keyword arguments removed."
  18955. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  18956. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  18957. (while (< cl-start cl-end)
  18958. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  18959. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  18960. (setq cl-start (1+ cl-start)))
  18961. cl-count))
  18962. (defun org-remove-if (predicate seq)
  18963. "Remove everything from SEQ that fulfills PREDICATE."
  18964. (let (res e)
  18965. (while seq
  18966. (setq e (pop seq))
  18967. (if (not (funcall predicate e)) (push e res)))
  18968. (nreverse res)))
  18969. (defun org-remove-if-not (predicate seq)
  18970. "Remove everything from SEQ that does not fulfill PREDICATE."
  18971. (let (res e)
  18972. (while seq
  18973. (setq e (pop seq))
  18974. (if (funcall predicate e) (push e res)))
  18975. (nreverse res)))
  18976. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  18977. "Reduce two-argument FUNCTION across SEQ.
  18978. Taken from `reduce' in cl-seq.el with all keyword arguments but
  18979. \":initial-value\" removed."
  18980. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  18981. (cadr (memq :initial-value cl-keys)))
  18982. (cl-seq (pop cl-seq))
  18983. (t (funcall cl-func)))))
  18984. (while cl-seq
  18985. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  18986. cl-accum))
  18987. (defun org-back-over-empty-lines ()
  18988. "Move backwards over whitespace, to the beginning of the first empty line.
  18989. Returns the number of empty lines passed."
  18990. (let ((pos (point)))
  18991. (if (cdr (assoc 'heading org-blank-before-new-entry))
  18992. (skip-chars-backward " \t\n\r")
  18993. (unless (eobp)
  18994. (forward-line -1)))
  18995. (beginning-of-line 2)
  18996. (goto-char (min (point) pos))
  18997. (count-lines (point) pos)))
  18998. (defun org-skip-whitespace ()
  18999. (skip-chars-forward " \t\n\r"))
  19000. (defun org-point-in-group (point group &optional context)
  19001. "Check if POINT is in match-group GROUP.
  19002. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  19003. match. If the match group does not exist or point is not inside it,
  19004. return nil."
  19005. (and (match-beginning group)
  19006. (>= point (match-beginning group))
  19007. (<= point (match-end group))
  19008. (if context
  19009. (list context (match-beginning group) (match-end group))
  19010. t)))
  19011. (defun org-switch-to-buffer-other-window (&rest args)
  19012. "Switch to buffer in a second window on the current frame.
  19013. In particular, do not allow pop-up frames.
  19014. Returns the newly created buffer."
  19015. (let (pop-up-frames special-display-buffer-names special-display-regexps
  19016. special-display-function)
  19017. (apply 'switch-to-buffer-other-window args)))
  19018. (defun org-combine-plists (&rest plists)
  19019. "Create a single property list from all plists in PLISTS.
  19020. The process starts by copying the first list, and then setting properties
  19021. from the other lists. Settings in the last list are the most significant
  19022. ones and overrule settings in the other lists."
  19023. (let ((rtn (copy-sequence (pop plists)))
  19024. p v ls)
  19025. (while plists
  19026. (setq ls (pop plists))
  19027. (while ls
  19028. (setq p (pop ls) v (pop ls))
  19029. (setq rtn (plist-put rtn p v))))
  19030. rtn))
  19031. (defun org-replace-escapes (string table)
  19032. "Replace %-escapes in STRING with values in TABLE.
  19033. TABLE is an association list with keys like \"%a\" and string values.
  19034. The sequences in STRING may contain normal field width and padding information,
  19035. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  19036. so values can contain further %-escapes if they are define later in TABLE."
  19037. (let ((tbl (copy-alist table))
  19038. (case-fold-search nil)
  19039. (pchg 0)
  19040. e re rpl)
  19041. (while (setq e (pop tbl))
  19042. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  19043. (when (and (cdr e) (string-match re (cdr e)))
  19044. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  19045. (safe "SREF"))
  19046. (add-text-properties 0 3 (list 'sref sref) safe)
  19047. (setcdr e (replace-match safe t t (cdr e)))))
  19048. (while (string-match re string)
  19049. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  19050. (cdr e)))
  19051. (setq string (replace-match rpl t t string))))
  19052. (while (setq pchg (next-property-change pchg string))
  19053. (let ((sref (get-text-property pchg 'sref string)))
  19054. (when (and sref (string-match "SREF" string pchg))
  19055. (setq string (replace-match sref t t string)))))
  19056. string))
  19057. (defun org-sublist (list start end)
  19058. "Return a section of LIST, from START to END.
  19059. Counting starts at 1."
  19060. (let (rtn (c start))
  19061. (setq list (nthcdr (1- start) list))
  19062. (while (and list (<= c end))
  19063. (push (pop list) rtn)
  19064. (setq c (1+ c)))
  19065. (nreverse rtn)))
  19066. (defun org-find-base-buffer-visiting (file)
  19067. "Like `find-buffer-visiting' but always return the base buffer and
  19068. not an indirect buffer."
  19069. (let ((buf (or (get-file-buffer file)
  19070. (find-buffer-visiting file))))
  19071. (if buf
  19072. (or (buffer-base-buffer buf) buf)
  19073. nil)))
  19074. (defun org-image-file-name-regexp (&optional extensions)
  19075. "Return regexp matching the file names of images.
  19076. If EXTENSIONS is given, only match these."
  19077. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  19078. (image-file-name-regexp)
  19079. (let ((image-file-name-extensions
  19080. (or extensions
  19081. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  19082. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  19083. (concat "\\."
  19084. (regexp-opt (nconc (mapcar 'upcase
  19085. image-file-name-extensions)
  19086. image-file-name-extensions)
  19087. t)
  19088. "\\'"))))
  19089. (defun org-file-image-p (file &optional extensions)
  19090. "Return non-nil if FILE is an image."
  19091. (save-match-data
  19092. (string-match (org-image-file-name-regexp extensions) file)))
  19093. (defun org-get-cursor-date ()
  19094. "Return the date at cursor in as a time.
  19095. This works in the calendar and in the agenda, anywhere else it just
  19096. returns the current time."
  19097. (let (date day defd)
  19098. (cond
  19099. ((eq major-mode 'calendar-mode)
  19100. (setq date (calendar-cursor-to-date)
  19101. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  19102. ((eq major-mode 'org-agenda-mode)
  19103. (setq day (get-text-property (point) 'day))
  19104. (if day
  19105. (setq date (calendar-gregorian-from-absolute day)
  19106. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  19107. (nth 2 date))))))
  19108. (or defd (current-time))))
  19109. (defun org-mark-subtree (&optional up)
  19110. "Mark the current subtree.
  19111. This puts point at the start of the current subtree, and mark at
  19112. the end. If a numeric prefix UP is given, move up into the
  19113. hierarchy of headlines by UP levels before marking the subtree."
  19114. (interactive "P")
  19115. (org-with-limited-levels
  19116. (cond ((org-at-heading-p) (beginning-of-line))
  19117. ((org-before-first-heading-p) (error "Not in a subtree"))
  19118. (t (outline-previous-visible-heading 1))))
  19119. (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
  19120. (if (org-called-interactively-p 'any)
  19121. (call-interactively 'org-mark-element)
  19122. (org-mark-element)))
  19123. ;;; Macros
  19124. ;; Macros are expanded with `org-macro-replace-all', which relies
  19125. ;; internally on `org-macro-expand'.
  19126. ;; Templates for expansion are stored in the buffer-local variable
  19127. ;; `org-macro-templates'. This variable is updated by
  19128. ;; `org-macro-initialize-templates'.
  19129. (defvar org-macro-templates nil
  19130. "Alist containing all macro templates in current buffer.
  19131. Associations are in the shape of (NAME . TEMPLATE) where NAME
  19132. stands for macro's name and template for its replacement value,
  19133. both as strings. This is an internal variable. Do not set it
  19134. directly, use instead:
  19135. #+MACRO: name template")
  19136. (make-variable-buffer-local 'org-macro-templates)
  19137. (defun org-macro-expand (macro)
  19138. "Return expanded MACRO, as a string.
  19139. MACRO is an object, obtained, for example, with
  19140. `org-element-context'. Return nil if no template was found."
  19141. (let ((template
  19142. (cdr (assoc-string (org-element-property :key macro)
  19143. org-macro-templates
  19144. ;; Macro names are case-insensitive.
  19145. t))))
  19146. (when template
  19147. (let ((value (replace-regexp-in-string
  19148. "\\$[0-9]+"
  19149. (lambda (arg)
  19150. (or (nth (1- (string-to-number (substring arg 1)))
  19151. (org-element-property :args macro))
  19152. ;; No argument provided: remove
  19153. ;; place-holder.
  19154. ""))
  19155. template)))
  19156. ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
  19157. (when (string-match "\\`(eval\\>" value)
  19158. (setq value (eval (read value))))
  19159. ;; Return string.
  19160. (format "%s" (or value ""))))))
  19161. (defun org-macro-replace-all ()
  19162. "Replace all macros in current buffer by their expansion."
  19163. (save-excursion
  19164. (goto-char (point-min))
  19165. (while (re-search-forward "{{{[-A-Za-z0-9_]" nil t)
  19166. (let ((object (org-element-context)))
  19167. (when (eq (org-element-type object) 'macro)
  19168. (let ((value (org-macro-expand object)))
  19169. (when value
  19170. (delete-region
  19171. (org-element-property :begin object)
  19172. ;; Preserve white spaces after the macro.
  19173. (progn (goto-char (org-element-property :end object))
  19174. (skip-chars-backward " \t")
  19175. (point)))
  19176. ;; Leave point before replacement in case of recursive
  19177. ;; expansions.
  19178. (save-excursion (insert value)))))))))
  19179. (defun org-macro-initialize-templates ()
  19180. "Collect macro templates defined in current buffer.
  19181. Templates are stored in buffer-local variable
  19182. `org-macro-templates'. In addition to buffer-defined macros, the
  19183. function installs the following ones: \"property\", \"date\",
  19184. \"time\". and, if appropriate, \"input-file\" and
  19185. \"modification-time\"."
  19186. (let ((case-fold-search t)
  19187. (set-template
  19188. (lambda (cell)
  19189. ;; Add CELL to `org-macro-templates' if there's no
  19190. ;; association matching its name already. Otherwise,
  19191. ;; replace old association with the new one in that
  19192. ;; variable.
  19193. (let ((old-template (assoc (car cell) org-macro-templates)))
  19194. (if old-template (setcdr old-template (cdr cell))
  19195. (push cell org-macro-templates))))))
  19196. ;; Install buffer-local macros.
  19197. (org-with-wide-buffer
  19198. (goto-char (point-min))
  19199. (while (re-search-forward "^[ \t]*#\\+MACRO:" nil t)
  19200. (let ((element (org-element-at-point)))
  19201. (when (eq (org-element-type element) 'keyword)
  19202. (let ((value (org-element-property :value element)))
  19203. (when (string-match "^\\(.*?\\)\\(?:\\s-+\\(.*\\)\\)?\\s-*$" value)
  19204. (funcall set-template
  19205. (cons (match-string 1 value)
  19206. (or (match-string 2 value) "")))))))))
  19207. ;; Install hard-coded macros.
  19208. (mapc (lambda (cell) (funcall set-template cell))
  19209. (list
  19210. (cons "property" "(eval (org-entry-get nil \"$1\" 'selective))")
  19211. (cons "date" "(eval (format-time-string \"$1\"))")
  19212. (cons "time" "(eval (format-time-string \"$1\"))")))
  19213. (let ((visited-file (buffer-file-name (buffer-base-buffer))))
  19214. (when (and visited-file (file-exists-p visited-file))
  19215. (mapc (lambda (cell) (funcall set-template cell))
  19216. (list
  19217. (cons "input-file" (file-name-nondirectory visited-file))
  19218. (cons "modification-time"
  19219. (format "(eval (format-time-string \"$1\" '%s))"
  19220. (prin1-to-string
  19221. (nth 5 (file-attributes visited-file)))))))))))
  19222. ;;; Indentation
  19223. (defun org-indent-line ()
  19224. "Indent line depending on context."
  19225. (interactive)
  19226. (let* ((pos (point))
  19227. (itemp (org-at-item-p))
  19228. (case-fold-search t)
  19229. (org-drawer-regexp (or org-drawer-regexp "\000"))
  19230. (inline-task-p (and (featurep 'org-inlinetask)
  19231. (org-inlinetask-in-task-p)))
  19232. (inline-re (and inline-task-p
  19233. (org-inlinetask-outline-regexp)))
  19234. column)
  19235. (if (and orgstruct-is-++ (eq pos (point)))
  19236. (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
  19237. (indent-according-to-mode))
  19238. (beginning-of-line 1)
  19239. (cond
  19240. ;; Headings
  19241. ((looking-at org-outline-regexp) (setq column 0))
  19242. ;; Included files
  19243. ((looking-at "#\\+include:") (setq column 0))
  19244. ;; Footnote definition
  19245. ((looking-at org-footnote-definition-re) (setq column 0))
  19246. ;; Literal examples
  19247. ((looking-at "[ \t]*:\\( \\|$\\)")
  19248. (setq column (org-get-indentation))) ; do nothing
  19249. ;; Lists
  19250. ((ignore-errors (goto-char (org-in-item-p)))
  19251. (setq column (if itemp
  19252. (org-get-indentation)
  19253. (org-list-item-body-column (point))))
  19254. (goto-char pos))
  19255. ;; Drawers
  19256. ((and (looking-at "[ \t]*:END:")
  19257. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  19258. (save-excursion
  19259. (goto-char (1- (match-beginning 1)))
  19260. (setq column (current-column))))
  19261. ;; Special blocks
  19262. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  19263. (save-excursion
  19264. (re-search-backward
  19265. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  19266. (setq column (org-get-indentation (match-string 0))))
  19267. ((and (not (looking-at "[ \t]*#\\+begin_"))
  19268. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  19269. (save-excursion
  19270. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  19271. (setq column
  19272. (cond ((equal (downcase (match-string 1)) "src")
  19273. ;; src blocks: let `org-edit-src-exit' handle them
  19274. (org-get-indentation))
  19275. ((equal (downcase (match-string 1)) "example")
  19276. (max (org-get-indentation)
  19277. (org-get-indentation (match-string 0))))
  19278. (t
  19279. (org-get-indentation (match-string 0))))))
  19280. ;; This line has nothing special, look at the previous relevant
  19281. ;; line to compute indentation
  19282. (t
  19283. (beginning-of-line 0)
  19284. (while (and (not (bobp))
  19285. (not (looking-at org-drawer-regexp))
  19286. ;; When point started in an inline task, do not move
  19287. ;; above task starting line.
  19288. (not (and inline-task-p (looking-at inline-re)))
  19289. ;; Skip drawers, blocks, empty lines, verbatim,
  19290. ;; comments, tables, footnotes definitions, lists,
  19291. ;; inline tasks.
  19292. (or (and (looking-at "[ \t]*:END:")
  19293. (re-search-backward org-drawer-regexp nil t))
  19294. (and (looking-at "[ \t]*#\\+end_")
  19295. (re-search-backward "[ \t]*#\\+begin_"nil t))
  19296. (looking-at "[ \t]*[\n:#|]")
  19297. (looking-at org-footnote-definition-re)
  19298. (and (ignore-errors (goto-char (org-in-item-p)))
  19299. (goto-char
  19300. (org-list-get-top-point (org-list-struct))))
  19301. (and (not inline-task-p)
  19302. (featurep 'org-inlinetask)
  19303. (org-inlinetask-in-task-p)
  19304. (or (org-inlinetask-goto-beginning) t))))
  19305. (beginning-of-line 0))
  19306. (cond
  19307. ;; There was an heading above.
  19308. ((looking-at "\\*+[ \t]+")
  19309. (if (not org-adapt-indentation)
  19310. (setq column 0)
  19311. (goto-char (match-end 0))
  19312. (setq column (current-column))))
  19313. ;; A drawer had started and is unfinished
  19314. ((looking-at org-drawer-regexp)
  19315. (goto-char (1- (match-beginning 1)))
  19316. (setq column (current-column)))
  19317. ;; Else, nothing noticeable found: get indentation and go on.
  19318. (t (setq column (org-get-indentation))))))
  19319. ;; Now apply indentation and move cursor accordingly
  19320. (goto-char pos)
  19321. (if (<= (current-column) (current-indentation))
  19322. (org-indent-line-to column)
  19323. (save-excursion (org-indent-line-to column)))
  19324. ;; Special polishing for properties, see `org-property-format'
  19325. (setq column (current-column))
  19326. (beginning-of-line 1)
  19327. (if (looking-at
  19328. "\\([ \t]*\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  19329. (replace-match (concat (match-string 1)
  19330. (format org-property-format
  19331. (match-string 2) (match-string 3)))
  19332. t t))
  19333. (org-move-to-column column))))
  19334. (defun org-indent-drawer ()
  19335. "Indent the drawer at point."
  19336. (interactive)
  19337. (let ((p (point))
  19338. (e (and (save-excursion (re-search-forward ":END:" nil t))
  19339. (match-end 0)))
  19340. (folded
  19341. (save-excursion
  19342. (end-of-line)
  19343. (when (overlays-at (point))
  19344. (member 'invisible (overlay-properties
  19345. (car (overlays-at (point)))))))))
  19346. (when folded (org-cycle))
  19347. (indent-for-tab-command)
  19348. (while (and (move-beginning-of-line 2) (< (point) e))
  19349. (indent-for-tab-command))
  19350. (goto-char p)
  19351. (when folded (org-cycle)))
  19352. (message "Drawer at point indented"))
  19353. (defun org-indent-block ()
  19354. "Indent the block at point."
  19355. (interactive)
  19356. (let ((p (point))
  19357. (case-fold-search t)
  19358. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  19359. (match-end 0)))
  19360. (folded
  19361. (save-excursion
  19362. (end-of-line)
  19363. (when (overlays-at (point))
  19364. (member 'invisible (overlay-properties
  19365. (car (overlays-at (point)))))))))
  19366. (when folded (org-cycle))
  19367. (indent-for-tab-command)
  19368. (while (and (move-beginning-of-line 2) (< (point) e))
  19369. (indent-for-tab-command))
  19370. (goto-char p)
  19371. (when folded (org-cycle)))
  19372. (message "Block at point indented"))
  19373. (defun org-indent-region (start end)
  19374. "Indent region."
  19375. (interactive "r")
  19376. (save-excursion
  19377. (let ((line-end (org-current-line end)))
  19378. (goto-char start)
  19379. (while (< (org-current-line) line-end)
  19380. (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
  19381. (t (call-interactively 'org-indent-line)))
  19382. (move-beginning-of-line 2)))))
  19383. ;;; Filling
  19384. ;; We use our own fill-paragraph and auto-fill functions.
  19385. ;; `org-fill-paragraph' relies on adaptive filling and context
  19386. ;; checking. Appropriate `fill-prefix' is computed with
  19387. ;; `org-adaptive-fill-function'.
  19388. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  19389. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  19390. ;; `org-adaptive-fill-function' value. Internally,
  19391. ;; `org-comment-line-break-function' breaks the line.
  19392. ;; `org-setup-filling' installs filling and auto-filling related
  19393. ;; variables during `org-mode' initialization.
  19394. (defun org-setup-filling ()
  19395. (interactive)
  19396. ;; Prevent auto-fill from inserting unwanted new items.
  19397. (when (boundp 'fill-nobreak-predicate)
  19398. (org-set-local
  19399. 'fill-nobreak-predicate
  19400. (org-uniquify
  19401. (append fill-nobreak-predicate
  19402. '(org-fill-paragraph-separate-nobreak-p
  19403. org-fill-line-break-nobreak-p)))))
  19404. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  19405. (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
  19406. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  19407. (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
  19408. (defvar org-element-paragraph-separate) ; org-element.el
  19409. (defun org-fill-paragraph-separate-nobreak-p ()
  19410. "Non-nil when a line break at point would insert a new item."
  19411. (looking-at (substring org-element-paragraph-separate 1)))
  19412. (defun org-fill-line-break-nobreak-p ()
  19413. "Non-nil when a line break at point would create an Org line break."
  19414. (save-excursion
  19415. (skip-chars-backward "[ \t]")
  19416. (skip-chars-backward "\\\\")
  19417. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  19418. (declare-function message-in-body-p "message" ())
  19419. (defvar org-element--affiliated-re) ; From org-element.el
  19420. (defun org-adaptive-fill-function ()
  19421. "Compute a fill prefix for the current line.
  19422. Return fill prefix, as a string, or nil if current line isn't
  19423. meant to be filled."
  19424. (org-with-wide-buffer
  19425. (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
  19426. ;; FIXME: This is really the job of orgstruct++-mode
  19427. (let* ((p (line-beginning-position))
  19428. (element (save-excursion (beginning-of-line)
  19429. (org-element-at-point)))
  19430. (type (org-element-type element))
  19431. (post-affiliated
  19432. (save-excursion
  19433. (goto-char (org-element-property :begin element))
  19434. (while (looking-at org-element--affiliated-re) (forward-line))
  19435. (point))))
  19436. (unless (< p post-affiliated)
  19437. (case type
  19438. (comment (looking-at "[ \t]*# ?") (match-string 0))
  19439. (footnote-definition "")
  19440. ((item plain-list)
  19441. (make-string (org-list-item-body-column post-affiliated) ? ))
  19442. (paragraph
  19443. ;; Fill prefix is usually the same as the current line,
  19444. ;; except if the paragraph is at the beginning of an item.
  19445. (let ((parent (org-element-property :parent element)))
  19446. (cond ((eq (org-element-type parent) 'item)
  19447. (make-string (org-list-item-body-column
  19448. (org-element-property :begin parent))
  19449. ? ))
  19450. ((save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  19451. (match-string 0))
  19452. (t ""))))
  19453. (comment-block
  19454. ;; Only fill contents if P is within block boundaries.
  19455. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  19456. (forward-line)
  19457. (point)))
  19458. (cend (save-excursion
  19459. (goto-char (org-element-property :end element))
  19460. (skip-chars-backward " \r\t\n")
  19461. (line-beginning-position))))
  19462. (when (and (>= p cbeg) (< p cend))
  19463. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  19464. (match-string 0)
  19465. ""))))))))))
  19466. (declare-function message-goto-body "message" ())
  19467. (defvar message-cite-prefix-regexp) ; From message.el
  19468. (defvar org-element-all-objects) ; From org-element.el
  19469. (defun org-fill-paragraph (&optional justify)
  19470. "Fill element at point, when applicable.
  19471. This function only applies to comment blocks, comments, example
  19472. blocks and paragraphs. Also, as a special case, re-align table
  19473. when point is at one.
  19474. If JUSTIFY is non-nil (interactively, with prefix argument),
  19475. justify as well. If `sentence-end-double-space' is non-nil, then
  19476. period followed by one space does not end a sentence, so don't
  19477. break a line there. The variable `fill-column' controls the
  19478. width for filling.
  19479. For convenience, when point is at a plain list, an item or
  19480. a footnote definition, try to fill the first paragraph within."
  19481. ;; Falls back on message-fill-paragraph when necessary
  19482. (interactive)
  19483. (if (and (derived-mode-p 'message-mode)
  19484. (or (not (message-in-body-p))
  19485. (save-excursion (move-beginning-of-line 1)
  19486. (looking-at message-cite-prefix-regexp))))
  19487. (let ((fill-paragraph-function
  19488. (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
  19489. (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
  19490. (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
  19491. (paragraph-separate
  19492. (cadadr (assoc 'paragraph-separate org-fb-vars))))
  19493. (fill-paragraph nil))
  19494. (save-excursion
  19495. ;; Move to end of line in order to get the first paragraph
  19496. ;; within a plain list or a footnote definition.
  19497. (end-of-line)
  19498. (let ((element (org-element-at-point)))
  19499. ;; First check if point is in a blank line at the beginning of
  19500. ;; the buffer. In that case, ignore filling.
  19501. (if (< (point) (org-element-property :begin element)) t
  19502. (case (org-element-type element)
  19503. ;; Align Org tables, leave table.el tables as-is.
  19504. (table-row (org-table-align) t)
  19505. (table
  19506. (when (eq (org-element-property :type element) 'org)
  19507. (org-table-align))
  19508. t)
  19509. (paragraph
  19510. ;; Paragraphs may contain `line-break' type objects.
  19511. (let ((beg (max (point-min)
  19512. (org-element-property :contents-begin element)))
  19513. (end (min (point-max)
  19514. (org-element-property :contents-end element))))
  19515. ;; Do nothing if point is at an affiliated keyword.
  19516. (if (< (point) beg) t
  19517. (when (derived-mode-p 'message-mode)
  19518. ;; In `message-mode', do not fill following
  19519. ;; citation in current paragraph nor text before
  19520. ;; message body.
  19521. (let ((body-start (save-excursion (message-goto-body))))
  19522. (when body-start (setq beg (max body-start beg))))
  19523. (when (save-excursion
  19524. (re-search-forward
  19525. (concat "^" message-cite-prefix-regexp) end t))
  19526. (setq end (match-beginning 0))))
  19527. ;; Fill paragraph, taking line breaks into
  19528. ;; consideration. For that, slice the paragraph
  19529. ;; using line breaks as separators, and fill the
  19530. ;; parts in reverse order to avoid messing with
  19531. ;; markers.
  19532. (save-excursion
  19533. (goto-char end)
  19534. (mapc
  19535. (lambda (pos)
  19536. (fill-region-as-paragraph pos (point) justify)
  19537. (goto-char pos))
  19538. ;; Find the list of ending positions for line
  19539. ;; breaks in the current paragraph. Add paragraph
  19540. ;; beginning to include first slice.
  19541. (nreverse
  19542. (cons
  19543. beg
  19544. (org-element-map
  19545. (org-element--parse-objects
  19546. beg end nil org-element-all-objects)
  19547. 'line-break
  19548. (lambda (lb) (org-element-property :end lb)))))))
  19549. t)))
  19550. ;; Contents of `comment-block' type elements should be
  19551. ;; filled as plain text, but only if point is within block
  19552. ;; markers.
  19553. (comment-block
  19554. (let* ((case-fold-search t)
  19555. (beg (save-excursion
  19556. (goto-char (org-element-property :begin element))
  19557. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  19558. (forward-line)
  19559. (point)))
  19560. (end (save-excursion
  19561. (goto-char (org-element-property :end element))
  19562. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  19563. (line-beginning-position))))
  19564. (when (and (>= (point) beg) (< (point) end))
  19565. (fill-region-as-paragraph
  19566. (save-excursion
  19567. (end-of-line)
  19568. (re-search-backward "^[ \t]*$" beg 'move)
  19569. (line-beginning-position))
  19570. (save-excursion
  19571. (beginning-of-line)
  19572. (re-search-forward "^[ \t]*$" end 'move)
  19573. (line-beginning-position))
  19574. justify)))
  19575. t)
  19576. ;; Fill comments.
  19577. (comment (fill-comment-paragraph justify))
  19578. ;; Ignore every other element.
  19579. (otherwise t)))))))
  19580. (defun org-auto-fill-function ()
  19581. "Auto-fill function."
  19582. ;; Check if auto-filling is meaningful.
  19583. (let ((fc (current-fill-column)))
  19584. (when (and fc (> (current-column) fc))
  19585. (let ((fill-prefix (org-adaptive-fill-function)))
  19586. (when fill-prefix (do-auto-fill))))))
  19587. (defun org-comment-line-break-function (&optional soft)
  19588. "Break line at point and indent, continuing comment if within one.
  19589. The inserted newline is marked hard if variable
  19590. `use-hard-newlines' is true, unless optional argument SOFT is
  19591. non-nil."
  19592. (if soft (insert-and-inherit ?\n) (newline 1))
  19593. (save-excursion (forward-char -1) (delete-horizontal-space))
  19594. (delete-horizontal-space)
  19595. (indent-to-left-margin)
  19596. (insert-before-markers-and-inherit fill-prefix))
  19597. ;;; Comments
  19598. ;; Org comments syntax is quite complex. It requires the entire line
  19599. ;; to be just a comment. Also, even with the right syntax at the
  19600. ;; beginning of line, some some elements (i.e. verse-block or
  19601. ;; example-block) don't accept comments. Usual Emacs comment commands
  19602. ;; cannot cope with those requirements. Therefore, Org replaces them.
  19603. ;; Org still relies on `comment-dwim', but cannot trust
  19604. ;; `comment-only-p'. So, `comment-region-function' and
  19605. ;; `uncomment-region-function' both point
  19606. ;; to`org-comment-or-uncomment-region'. Eventually,
  19607. ;; `org-insert-comment' takes care of insertion of comments at the
  19608. ;; beginning of line.
  19609. ;; `org-setup-comments-handling' install comments related variables
  19610. ;; during `org-mode' initialization.
  19611. (defun org-setup-comments-handling ()
  19612. (interactive)
  19613. (org-set-local 'comment-use-syntax nil)
  19614. (org-set-local 'comment-start "# ")
  19615. (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  19616. (org-set-local 'comment-insert-comment-function 'org-insert-comment)
  19617. (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
  19618. (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
  19619. (defun org-insert-comment ()
  19620. "Insert an empty comment above current line.
  19621. If the line is empty, insert comment at its beginning."
  19622. (beginning-of-line)
  19623. (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
  19624. (org-indent-line)
  19625. (insert "# "))
  19626. (defvar comment-empty-lines) ; From newcomment.el.
  19627. (defun org-comment-or-uncomment-region (beg end &rest ignore)
  19628. "Comment or uncomment each non-blank line in the region.
  19629. Uncomment each non-blank line between BEG and END if it only
  19630. contains commented lines. Otherwise, comment them."
  19631. (save-restriction
  19632. ;; Restrict region
  19633. (narrow-to-region (save-excursion (goto-char beg)
  19634. (skip-chars-forward " \r\t\n" end)
  19635. (line-beginning-position))
  19636. (save-excursion (goto-char end)
  19637. (skip-chars-backward " \r\t\n" beg)
  19638. (line-end-position)))
  19639. (let ((uncommentp
  19640. ;; UNCOMMENTP is non-nil when every non blank line between
  19641. ;; BEG and END is a comment.
  19642. (save-excursion
  19643. (goto-char (point-min))
  19644. (while (and (not (eobp))
  19645. (let ((element (org-element-at-point)))
  19646. (and (eq (org-element-type element) 'comment)
  19647. (goto-char (min (point-max)
  19648. (org-element-property
  19649. :end element)))))))
  19650. (eobp))))
  19651. (if uncommentp
  19652. ;; Only blank lines and comments in region: uncomment it.
  19653. (save-excursion
  19654. (goto-char (point-min))
  19655. (while (not (eobp))
  19656. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  19657. (replace-match "" nil nil nil 1))
  19658. (forward-line)))
  19659. ;; Comment each line in region.
  19660. (let ((min-indent (point-max)))
  19661. ;; First find the minimum indentation across all lines.
  19662. (save-excursion
  19663. (goto-char (point-min))
  19664. (while (and (not (eobp)) (not (zerop min-indent)))
  19665. (unless (looking-at "[ \t]*$")
  19666. (setq min-indent (min min-indent (current-indentation))))
  19667. (forward-line)))
  19668. ;; Then loop over all lines.
  19669. (save-excursion
  19670. (goto-char (point-min))
  19671. (while (not (eobp))
  19672. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  19673. (org-move-to-column min-indent t)
  19674. (insert comment-start))
  19675. (forward-line))))))))
  19676. ;;; Other stuff.
  19677. (defun org-toggle-fixed-width-section (arg)
  19678. "Toggle the fixed-width export.
  19679. If there is no active region, the QUOTE keyword at the current headline is
  19680. inserted or removed. When present, it causes the text between this headline
  19681. and the next to be exported as fixed-width text, and unmodified.
  19682. If there is an active region, this command adds or removes a colon as the
  19683. first character of this line. If the first character of a line is a colon,
  19684. this line is also exported in fixed-width font."
  19685. (interactive "P")
  19686. (let* ((cc 0)
  19687. (regionp (org-region-active-p))
  19688. (beg (if regionp (region-beginning) (point)))
  19689. (end (if regionp (region-end)))
  19690. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  19691. (case-fold-search nil)
  19692. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  19693. off)
  19694. (if regionp
  19695. (save-excursion
  19696. (goto-char beg)
  19697. (setq cc (current-column))
  19698. (beginning-of-line 1)
  19699. (setq off (looking-at re))
  19700. (while (> nlines 0)
  19701. (setq nlines (1- nlines))
  19702. (beginning-of-line 1)
  19703. (cond
  19704. (arg
  19705. (org-move-to-column cc t)
  19706. (insert ": \n")
  19707. (forward-line -1))
  19708. ((and off (looking-at re))
  19709. (replace-match "" t t nil 1))
  19710. ((not off) (org-move-to-column cc t) (insert ": ")))
  19711. (forward-line 1)))
  19712. (save-excursion
  19713. (org-back-to-heading)
  19714. (cond
  19715. ((looking-at (format org-heading-keyword-regexp-format
  19716. org-quote-string))
  19717. (goto-char (match-end 1))
  19718. (looking-at (concat " +" org-quote-string))
  19719. (replace-match "" t t)
  19720. (when (eolp) (insert " ")))
  19721. ((looking-at org-outline-regexp)
  19722. (goto-char (match-end 0))
  19723. (insert org-quote-string " ")))))))
  19724. (defun org-reftex-citation ()
  19725. "Use reftex-citation to insert a citation into the buffer.
  19726. This looks for a line like
  19727. #+BIBLIOGRAPHY: foo plain option:-d
  19728. and derives from it that foo.bib is the bibliography file relevant
  19729. for this document. It then installs the necessary environment for RefTeX
  19730. to work in this buffer and calls `reftex-citation' to insert a citation
  19731. into the buffer.
  19732. Export of such citations to both LaTeX and HTML is handled by the contributed
  19733. package org-exp-bibtex by Taru Karttunen."
  19734. (interactive)
  19735. (let ((reftex-docstruct-symbol 'rds)
  19736. (reftex-cite-format "\\cite{%l}")
  19737. rds bib)
  19738. (save-excursion
  19739. (save-restriction
  19740. (widen)
  19741. (let ((case-fold-search t)
  19742. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  19743. (if (not (save-excursion
  19744. (or (re-search-forward re nil t)
  19745. (re-search-backward re nil t))))
  19746. (error "No bibliography defined in file")
  19747. (setq bib (concat (match-string 1) ".bib")
  19748. rds (list (list 'bib bib)))))))
  19749. (call-interactively 'reftex-citation)))
  19750. ;;;; Functions extending outline functionality
  19751. (defun org-beginning-of-line (&optional arg)
  19752. "Go to the beginning of the current line. If that is invisible, continue
  19753. to a visible line beginning. This makes the function of C-a more intuitive.
  19754. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19755. first attempt, and only move to after the tags when the cursor is already
  19756. beyond the end of the headline."
  19757. (interactive "P")
  19758. (let ((pos (point))
  19759. (special (if (consp org-special-ctrl-a/e)
  19760. (car org-special-ctrl-a/e)
  19761. org-special-ctrl-a/e))
  19762. refpos)
  19763. (if (org-bound-and-true-p line-move-visual)
  19764. (beginning-of-visual-line 1)
  19765. (beginning-of-line 1))
  19766. (if (and arg (fboundp 'move-beginning-of-line))
  19767. (call-interactively 'move-beginning-of-line)
  19768. (if (bobp)
  19769. nil
  19770. (backward-char 1)
  19771. (if (org-truely-invisible-p)
  19772. (while (and (not (bobp)) (org-truely-invisible-p))
  19773. (backward-char 1)
  19774. (beginning-of-line 1))
  19775. (forward-char 1))))
  19776. (when special
  19777. (cond
  19778. ((and (looking-at org-complex-heading-regexp)
  19779. (= (char-after (match-end 1)) ?\ ))
  19780. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  19781. (point-at-eol)))
  19782. (goto-char
  19783. (if (eq special t)
  19784. (cond ((> pos refpos) refpos)
  19785. ((= pos (point)) refpos)
  19786. (t (point)))
  19787. (cond ((> pos (point)) (point))
  19788. ((not (eq last-command this-command)) (point))
  19789. (t refpos)))))
  19790. ((org-at-item-p)
  19791. ;; Being at an item and not looking at an the item means point
  19792. ;; was previously moved to beginning of a visual line, which
  19793. ;; doesn't contain the item. Therefore, do nothing special,
  19794. ;; just stay here.
  19795. (when (looking-at org-list-full-item-re)
  19796. ;; Set special position at first white space character after
  19797. ;; bullet, and check-box, if any.
  19798. (let ((after-bullet
  19799. (let ((box (match-end 3)))
  19800. (if (not box) (match-end 1)
  19801. (let ((after (char-after box)))
  19802. (if (and after (= after ? )) (1+ box) box))))))
  19803. ;; Special case: Move point to special position when
  19804. ;; currently after it or at beginning of line.
  19805. (if (eq special t)
  19806. (when (or (> pos after-bullet) (= (point) pos))
  19807. (goto-char after-bullet))
  19808. ;; Reversed case: Move point to special position when
  19809. ;; point was already at beginning of line and command is
  19810. ;; repeated.
  19811. (when (and (= (point) pos) (eq last-command this-command))
  19812. (goto-char after-bullet))))))))
  19813. (org-no-warnings
  19814. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19815. (defun org-end-of-line (&optional arg)
  19816. "Go to the end of the line.
  19817. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19818. first attempt, and only move to after the tags when the cursor is already
  19819. beyond the end of the headline."
  19820. (interactive "P")
  19821. (let ((special (if (consp org-special-ctrl-a/e)
  19822. (cdr org-special-ctrl-a/e)
  19823. org-special-ctrl-a/e)))
  19824. (cond
  19825. ((or (not special) arg
  19826. (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
  19827. (call-interactively
  19828. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19829. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19830. (t 'end-of-line))))
  19831. ((org-at-heading-p)
  19832. (let ((pos (point)))
  19833. (beginning-of-line 1)
  19834. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  19835. (if (eq special t)
  19836. (if (or (< pos (match-beginning 1))
  19837. (= pos (match-end 0)))
  19838. (goto-char (match-beginning 1))
  19839. (goto-char (match-end 0)))
  19840. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  19841. (goto-char (match-end 0))
  19842. (goto-char (match-beginning 1))))
  19843. (call-interactively (if (fboundp 'move-end-of-line)
  19844. 'move-end-of-line
  19845. 'end-of-line)))))
  19846. ((org-at-drawer-p)
  19847. (move-end-of-line 1)
  19848. (when (overlays-at (1- (point))) (backward-char 1)))
  19849. ;; At an item: Move before any hidden text.
  19850. (t (call-interactively
  19851. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19852. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19853. (t 'end-of-line)))))
  19854. (org-no-warnings
  19855. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19856. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  19857. (define-key org-mode-map "\C-e" 'org-end-of-line)
  19858. (defun org-backward-sentence (&optional arg)
  19859. "Go to beginning of sentence, or beginning of table field.
  19860. This will call `backward-sentence' or `org-table-beginning-of-field',
  19861. depending on context."
  19862. (interactive "P")
  19863. (cond
  19864. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  19865. (t (call-interactively 'backward-sentence))))
  19866. (defun org-forward-sentence (&optional arg)
  19867. "Go to end of sentence, or end of table field.
  19868. This will call `forward-sentence' or `org-table-end-of-field',
  19869. depending on context."
  19870. (interactive "P")
  19871. (cond
  19872. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  19873. (t (call-interactively 'forward-sentence))))
  19874. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  19875. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  19876. (defun org-kill-line (&optional arg)
  19877. "Kill line, to tags or end of line."
  19878. (interactive "P")
  19879. (cond
  19880. ((or (not org-special-ctrl-k)
  19881. (bolp)
  19882. (not (org-at-heading-p)))
  19883. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  19884. org-ctrl-k-protect-subtree)
  19885. (if (or (eq org-ctrl-k-protect-subtree 'error)
  19886. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  19887. (error "C-k aborted - would kill hidden subtree")))
  19888. (call-interactively
  19889. (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
  19890. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  19891. (kill-region (point) (match-beginning 1))
  19892. (org-set-tags nil t))
  19893. (t (kill-region (point) (point-at-eol)))))
  19894. (define-key org-mode-map "\C-k" 'org-kill-line)
  19895. (defun org-yank (&optional arg)
  19896. "Yank. If the kill is a subtree, treat it specially.
  19897. This command will look at the current kill and check if is a single
  19898. subtree, or a series of subtrees[1]. If it passes the test, and if the
  19899. cursor is at the beginning of a line or after the stars of a currently
  19900. empty headline, then the yank is handled specially. How exactly depends
  19901. on the value of the following variables, both set by default.
  19902. org-yank-folded-subtrees
  19903. When set, the subtree(s) will be folded after insertion, but only
  19904. if doing so would now swallow text after the yanked text.
  19905. org-yank-adjusted-subtrees
  19906. When set, the subtree will be promoted or demoted in order to
  19907. fit into the local outline tree structure, which means that the level
  19908. will be adjusted so that it becomes the smaller one of the two
  19909. *visible* surrounding headings.
  19910. Any prefix to this command will cause `yank' to be called directly with
  19911. no special treatment. In particular, a simple \\[universal-argument] prefix \
  19912. will just
  19913. plainly yank the text as it is.
  19914. \[1] The test checks if the first non-white line is a heading
  19915. and if there are no other headings with fewer stars."
  19916. (interactive "P")
  19917. (org-yank-generic 'yank arg))
  19918. (defun org-yank-generic (command arg)
  19919. "Perform some yank-like command.
  19920. This function implements the behavior described in the `org-yank'
  19921. documentation. However, it has been generalized to work for any
  19922. interactive command with similar behavior."
  19923. ;; pretend to be command COMMAND
  19924. (setq this-command command)
  19925. (if arg
  19926. (call-interactively command)
  19927. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  19928. (and (org-kill-is-subtree-p)
  19929. (or (bolp)
  19930. (and (looking-at "[ \t]*$")
  19931. (string-match
  19932. "\\`\\*+\\'"
  19933. (buffer-substring (point-at-bol) (point)))))))
  19934. swallowp)
  19935. (cond
  19936. ((and subtreep org-yank-folded-subtrees)
  19937. (let ((beg (point))
  19938. end)
  19939. (if (and subtreep org-yank-adjusted-subtrees)
  19940. (org-paste-subtree nil nil 'for-yank)
  19941. (call-interactively command))
  19942. (setq end (point))
  19943. (goto-char beg)
  19944. (when (and (bolp) subtreep
  19945. (not (setq swallowp
  19946. (org-yank-folding-would-swallow-text beg end))))
  19947. (org-with-limited-levels
  19948. (or (looking-at org-outline-regexp)
  19949. (re-search-forward org-outline-regexp-bol end t))
  19950. (while (and (< (point) end) (looking-at org-outline-regexp))
  19951. (hide-subtree)
  19952. (org-cycle-show-empty-lines 'folded)
  19953. (condition-case nil
  19954. (outline-forward-same-level 1)
  19955. (error (goto-char end))))))
  19956. (when swallowp
  19957. (message
  19958. "Inserted text not folded because that would swallow text"))
  19959. (goto-char end)
  19960. (skip-chars-forward " \t\n\r")
  19961. (beginning-of-line 1)
  19962. (push-mark beg 'nomsg)))
  19963. ((and subtreep org-yank-adjusted-subtrees)
  19964. (let ((beg (point-at-bol)))
  19965. (org-paste-subtree nil nil 'for-yank)
  19966. (push-mark beg 'nomsg)))
  19967. (t
  19968. (call-interactively command))))))
  19969. (defun org-yank-folding-would-swallow-text (beg end)
  19970. "Would hide-subtree at BEG swallow any text after END?"
  19971. (let (level)
  19972. (org-with-limited-levels
  19973. (save-excursion
  19974. (goto-char beg)
  19975. (when (or (looking-at org-outline-regexp)
  19976. (re-search-forward org-outline-regexp-bol end t))
  19977. (setq level (org-outline-level)))
  19978. (goto-char end)
  19979. (skip-chars-forward " \t\r\n\v\f")
  19980. (if (or (eobp)
  19981. (and (bolp) (looking-at org-outline-regexp)
  19982. (<= (org-outline-level) level)))
  19983. nil ; Nothing would be swallowed
  19984. t))))) ; something would swallow
  19985. (define-key org-mode-map "\C-y" 'org-yank)
  19986. (defun org-truely-invisible-p ()
  19987. "Check if point is at a character currently not visible.
  19988. This version does not only check the character property, but also
  19989. `visible-mode'."
  19990. ;; Early versions of noutline don't have `outline-invisible-p'.
  19991. (if (org-bound-and-true-p visible-mode)
  19992. nil
  19993. (outline-invisible-p)))
  19994. (defun org-invisible-p2 ()
  19995. "Check if point is at a character currently not visible."
  19996. (save-excursion
  19997. (if (and (eolp) (not (bobp))) (backward-char 1))
  19998. ;; Early versions of noutline don't have `outline-invisible-p'.
  19999. (outline-invisible-p)))
  20000. (defun org-back-to-heading (&optional invisible-ok)
  20001. "Call `outline-back-to-heading', but provide a better error message."
  20002. (condition-case nil
  20003. (outline-back-to-heading invisible-ok)
  20004. (error (error "Before first headline at position %d in buffer %s"
  20005. (point) (current-buffer)))))
  20006. (defun org-before-first-heading-p ()
  20007. "Before first heading?"
  20008. (save-excursion
  20009. (end-of-line)
  20010. (null (re-search-backward org-outline-regexp-bol nil t))))
  20011. (defun org-at-heading-p (&optional ignored)
  20012. (outline-on-heading-p t))
  20013. ;; Compatibility alias with Org versions < 7.8.03
  20014. (defalias 'org-on-heading-p 'org-at-heading-p)
  20015. (defun org-at-comment-p nil
  20016. "Is cursor in a line starting with a # character?"
  20017. (save-excursion
  20018. (beginning-of-line)
  20019. (looking-at "^#")))
  20020. (defun org-at-drawer-p nil
  20021. "Is cursor at a drawer keyword?"
  20022. (save-excursion
  20023. (move-beginning-of-line 1)
  20024. (looking-at org-drawer-regexp)))
  20025. (defun org-at-block-p nil
  20026. "Is cursor at a block keyword?"
  20027. (save-excursion
  20028. (move-beginning-of-line 1)
  20029. (looking-at org-block-regexp)))
  20030. (defun org-point-at-end-of-empty-headline ()
  20031. "If point is at the end of an empty headline, return t, else nil.
  20032. If the heading only contains a TODO keyword, it is still still considered
  20033. empty."
  20034. (and (looking-at "[ \t]*$")
  20035. (when org-todo-line-regexp
  20036. (save-excursion
  20037. (beginning-of-line 1)
  20038. (let ((case-fold-search nil))
  20039. (looking-at org-todo-line-regexp)
  20040. (string= (match-string 3) ""))))))
  20041. (defun org-at-heading-or-item-p ()
  20042. (or (org-at-heading-p) (org-at-item-p)))
  20043. (defun org-at-target-p ()
  20044. (or (org-in-regexp org-radio-target-regexp)
  20045. (org-in-regexp org-target-regexp)))
  20046. ;; Compatibility alias with Org versions < 7.8.03
  20047. (defalias 'org-on-target-p 'org-at-target-p)
  20048. (defun org-up-heading-all (arg)
  20049. "Move to the heading line of which the present line is a subheading.
  20050. This function considers both visible and invisible heading lines.
  20051. With argument, move up ARG levels."
  20052. (if (fboundp 'outline-up-heading-all)
  20053. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  20054. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  20055. (defun org-up-heading-safe ()
  20056. "Move to the heading line of which the present line is a subheading.
  20057. This version will not throw an error. It will return the level of the
  20058. headline found, or nil if no higher level is found.
  20059. Also, this function will be a lot faster than `outline-up-heading',
  20060. because it relies on stars being the outline starters. This can really
  20061. make a significant difference in outlines with very many siblings."
  20062. (let (start-level re)
  20063. (org-back-to-heading t)
  20064. (setq start-level (funcall outline-level))
  20065. (if (equal start-level 1)
  20066. nil
  20067. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  20068. (if (re-search-backward re nil t)
  20069. (funcall outline-level)))))
  20070. (defun org-first-sibling-p ()
  20071. "Is this heading the first child of its parents?"
  20072. (interactive)
  20073. (let ((re org-outline-regexp-bol)
  20074. level l)
  20075. (unless (org-at-heading-p t)
  20076. (error "Not at a heading"))
  20077. (setq level (funcall outline-level))
  20078. (save-excursion
  20079. (if (not (re-search-backward re nil t))
  20080. t
  20081. (setq l (funcall outline-level))
  20082. (< l level)))))
  20083. (defun org-goto-sibling (&optional previous)
  20084. "Goto the next sibling, even if it is invisible.
  20085. When PREVIOUS is set, go to the previous sibling instead. Returns t
  20086. when a sibling was found. When none is found, return nil and don't
  20087. move point."
  20088. (let ((fun (if previous 're-search-backward 're-search-forward))
  20089. (pos (point))
  20090. (re org-outline-regexp-bol)
  20091. level l)
  20092. (when (condition-case nil (org-back-to-heading t) (error nil))
  20093. (setq level (funcall outline-level))
  20094. (catch 'exit
  20095. (or previous (forward-char 1))
  20096. (while (funcall fun re nil t)
  20097. (setq l (funcall outline-level))
  20098. (when (< l level) (goto-char pos) (throw 'exit nil))
  20099. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  20100. (goto-char pos)
  20101. nil))))
  20102. (defun org-show-siblings ()
  20103. "Show all siblings of the current headline."
  20104. (save-excursion
  20105. (while (org-goto-sibling) (org-flag-heading nil)))
  20106. (save-excursion
  20107. (while (org-goto-sibling 'previous)
  20108. (org-flag-heading nil))))
  20109. (defun org-goto-first-child ()
  20110. "Goto the first child, even if it is invisible.
  20111. Return t when a child was found. Otherwise don't move point and
  20112. return nil."
  20113. (let (level (pos (point)) (re org-outline-regexp-bol))
  20114. (when (condition-case nil (org-back-to-heading t) (error nil))
  20115. (setq level (outline-level))
  20116. (forward-char 1)
  20117. (if (and (re-search-forward re nil t) (> (outline-level) level))
  20118. (progn (goto-char (match-beginning 0)) t)
  20119. (goto-char pos) nil))))
  20120. (defun org-show-hidden-entry ()
  20121. "Show an entry where even the heading is hidden."
  20122. (save-excursion
  20123. (org-show-entry)))
  20124. (defun org-flag-heading (flag &optional entry)
  20125. "Flag the current heading. FLAG non-nil means make invisible.
  20126. When ENTRY is non-nil, show the entire entry."
  20127. (save-excursion
  20128. (org-back-to-heading t)
  20129. ;; Check if we should show the entire entry
  20130. (if entry
  20131. (progn
  20132. (org-show-entry)
  20133. (save-excursion
  20134. (and (outline-next-heading)
  20135. (org-flag-heading nil))))
  20136. (outline-flag-region (max (point-min) (1- (point)))
  20137. (save-excursion (outline-end-of-heading) (point))
  20138. flag))))
  20139. (defun org-get-next-sibling ()
  20140. "Move to next heading of the same level, and return point.
  20141. If there is no such heading, return nil.
  20142. This is like outline-next-sibling, but invisible headings are ok."
  20143. (let ((level (funcall outline-level)))
  20144. (outline-next-heading)
  20145. (while (and (not (eobp)) (> (funcall outline-level) level))
  20146. (outline-next-heading))
  20147. (if (or (eobp) (< (funcall outline-level) level))
  20148. nil
  20149. (point))))
  20150. (defun org-get-last-sibling ()
  20151. "Move to previous heading of the same level, and return point.
  20152. If there is no such heading, return nil."
  20153. (let ((opoint (point))
  20154. (level (funcall outline-level)))
  20155. (outline-previous-heading)
  20156. (when (and (/= (point) opoint) (outline-on-heading-p t))
  20157. (while (and (> (funcall outline-level) level)
  20158. (not (bobp)))
  20159. (outline-previous-heading))
  20160. (if (< (funcall outline-level) level)
  20161. nil
  20162. (point)))))
  20163. (defun org-end-of-subtree (&optional invisible-ok to-heading)
  20164. "Goto to the end of a subtree."
  20165. ;; This contains an exact copy of the original function, but it uses
  20166. ;; `org-back-to-heading', to make it work also in invisible
  20167. ;; trees. And is uses an invisible-ok argument.
  20168. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  20169. ;; Furthermore, when used inside Org, finding the end of a large subtree
  20170. ;; with many children and grandchildren etc, this can be much faster
  20171. ;; than the outline version.
  20172. (org-back-to-heading invisible-ok)
  20173. (let ((first t)
  20174. (level (funcall outline-level)))
  20175. (if (and (derived-mode-p 'org-mode) (< level 1000))
  20176. ;; A true heading (not a plain list item), in Org-mode
  20177. ;; This means we can easily find the end by looking
  20178. ;; only for the right number of stars. Using a regexp to do
  20179. ;; this is so much faster than using a Lisp loop.
  20180. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  20181. (forward-char 1)
  20182. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  20183. ;; something else, do it the slow way
  20184. (while (and (not (eobp))
  20185. (or first (> (funcall outline-level) level)))
  20186. (setq first nil)
  20187. (outline-next-heading)))
  20188. (unless to-heading
  20189. (if (memq (preceding-char) '(?\n ?\^M))
  20190. (progn
  20191. ;; Go to end of line before heading
  20192. (forward-char -1)
  20193. (if (memq (preceding-char) '(?\n ?\^M))
  20194. ;; leave blank line before heading
  20195. (forward-char -1))))))
  20196. (point))
  20197. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  20198. "Use Org version in org-mode, for dramatic speed-up."
  20199. (if (derived-mode-p 'org-mode)
  20200. (progn
  20201. (org-end-of-subtree nil t)
  20202. (unless (eobp) (backward-char 1)))
  20203. ad-do-it))
  20204. (defun org-end-of-meta-data-and-drawers ()
  20205. "Jump to the first text after meta data and drawers in the current entry.
  20206. This will move over empty lines, lines with planning time stamps,
  20207. clocking lines, and drawers."
  20208. (org-back-to-heading t)
  20209. (let ((end (save-excursion (outline-next-heading) (point)))
  20210. (re (concat "\\(" org-drawer-regexp "\\)"
  20211. "\\|" "[ \t]*" org-keyword-time-regexp)))
  20212. (forward-line 1)
  20213. (while (re-search-forward re end t)
  20214. (if (not (match-end 1))
  20215. ;; empty or planning line
  20216. (forward-line 1)
  20217. ;; a drawer, find the end
  20218. (re-search-forward "^[ \t]*:END:" end 'move)
  20219. (forward-line 1)))
  20220. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  20221. (point)))
  20222. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  20223. "Move forward to the arg'th subheading at same level as this one.
  20224. Stop at the first and last subheadings of a superior heading.
  20225. Normally this only looks at visible headings, but when INVISIBLE-OK is
  20226. non-nil it will also look at invisible ones."
  20227. (interactive "p")
  20228. (org-back-to-heading invisible-ok)
  20229. (org-at-heading-p)
  20230. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20231. (re (format "^\\*\\{1,%d\\} " level))
  20232. l)
  20233. (forward-char 1)
  20234. (while (> arg 0)
  20235. (while (and (re-search-forward re nil 'move)
  20236. (setq l (- (match-end 0) (match-beginning 0) 1))
  20237. (= l level)
  20238. (not invisible-ok)
  20239. (progn (backward-char 1) (outline-invisible-p)))
  20240. (if (< l level) (setq arg 1)))
  20241. (setq arg (1- arg)))
  20242. (beginning-of-line 1)))
  20243. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  20244. "Move backward to the arg'th subheading at same level as this one.
  20245. Stop at the first and last subheadings of a superior heading."
  20246. (interactive "p")
  20247. (org-back-to-heading)
  20248. (org-at-heading-p)
  20249. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20250. (re (format "^\\*\\{1,%d\\} " level))
  20251. l)
  20252. (while (> arg 0)
  20253. (while (and (re-search-backward re nil 'move)
  20254. (setq l (- (match-end 0) (match-beginning 0) 1))
  20255. (= l level)
  20256. (not invisible-ok)
  20257. (outline-invisible-p))
  20258. (if (< l level) (setq arg 1)))
  20259. (setq arg (1- arg)))))
  20260. (defun org-forward-element ()
  20261. "Move forward by one element.
  20262. Move to the next element at the same level, when possible."
  20263. (interactive)
  20264. (cond ((eobp) (error "Cannot move further down"))
  20265. ((org-with-limited-levels (org-at-heading-p))
  20266. (let ((origin (point)))
  20267. (org-forward-heading-same-level 1)
  20268. (unless (org-with-limited-levels (org-at-heading-p))
  20269. (goto-char origin)
  20270. (error "Cannot move further down"))))
  20271. (t
  20272. (let* ((elem (org-element-at-point))
  20273. (end (org-element-property :end elem))
  20274. (parent (org-element-property :parent elem)))
  20275. (if (and parent (= (org-element-property :contents-end parent) end))
  20276. (goto-char (org-element-property :end parent))
  20277. (goto-char end))))))
  20278. (defun org-backward-element ()
  20279. "Move backward by one element.
  20280. Move to the previous element at the same level, when possible."
  20281. (interactive)
  20282. (cond ((bobp) (error "Cannot move further up"))
  20283. ((org-with-limited-levels (org-at-heading-p))
  20284. ;; At an headline, move to the previous one, if any, or stay
  20285. ;; here.
  20286. (let ((origin (point)))
  20287. (org-backward-heading-same-level 1)
  20288. (unless (org-with-limited-levels (org-at-heading-p))
  20289. (goto-char origin)
  20290. (error "Cannot move further up"))))
  20291. (t
  20292. (let* ((trail (org-element-at-point 'keep-trail))
  20293. (elem (car trail))
  20294. (prev-elem (nth 1 trail))
  20295. (beg (org-element-property :begin elem)))
  20296. (cond
  20297. ;; Move to beginning of current element if point isn't
  20298. ;; there already.
  20299. ((/= (point) beg) (goto-char beg))
  20300. (prev-elem (goto-char (org-element-property :begin prev-elem)))
  20301. ((org-before-first-heading-p) (goto-char (point-min)))
  20302. (t (org-back-to-heading)))))))
  20303. (defun org-up-element ()
  20304. "Move to upper element."
  20305. (interactive)
  20306. (if (org-with-limited-levels (org-at-heading-p))
  20307. (unless (org-up-heading-safe) (error "No surrounding element"))
  20308. (let* ((elem (org-element-at-point))
  20309. (parent (org-element-property :parent elem)))
  20310. (if parent (goto-char (org-element-property :begin parent))
  20311. (if (org-with-limited-levels (org-before-first-heading-p))
  20312. (error "No surrounding element")
  20313. (org-with-limited-levels (org-back-to-heading)))))))
  20314. (defvar org-element-greater-elements)
  20315. (defun org-down-element ()
  20316. "Move to inner element."
  20317. (interactive)
  20318. (let ((element (org-element-at-point)))
  20319. (cond
  20320. ((memq (org-element-type element) '(plain-list table))
  20321. (goto-char (org-element-property :contents-begin element))
  20322. (forward-char))
  20323. ((memq (org-element-type element) org-element-greater-elements)
  20324. ;; If contents are hidden, first disclose them.
  20325. (when (org-element-property :hiddenp element) (org-cycle))
  20326. (goto-char (or (org-element-property :contents-begin element)
  20327. (error "No content for this element"))))
  20328. (t (error "No inner element")))))
  20329. (defun org-drag-element-backward ()
  20330. "Move backward element at point."
  20331. (interactive)
  20332. (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
  20333. (let* ((trail (org-element-at-point 'keep-trail))
  20334. (elem (car trail))
  20335. (prev-elem (nth 1 trail)))
  20336. ;; Error out if no previous element or previous element is
  20337. ;; a parent of the current one.
  20338. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  20339. (error "Cannot drag element backward")
  20340. (let ((pos (point)))
  20341. (org-element-swap-A-B prev-elem elem)
  20342. (goto-char (+ (org-element-property :begin prev-elem)
  20343. (- pos (org-element-property :begin elem)))))))))
  20344. (defun org-drag-element-forward ()
  20345. "Move forward element at point."
  20346. (interactive)
  20347. (let* ((pos (point))
  20348. (elem (org-element-at-point)))
  20349. (when (= (point-max) (org-element-property :end elem))
  20350. (error "Cannot drag element forward"))
  20351. (goto-char (org-element-property :end elem))
  20352. (let ((next-elem (org-element-at-point)))
  20353. (when (or (org-element-nested-p elem next-elem)
  20354. (and (eq (org-element-type next-elem) 'headline)
  20355. (not (eq (org-element-type elem) 'headline))))
  20356. (goto-char pos)
  20357. (error "Cannot drag element forward"))
  20358. ;; Compute new position of point: it's shifted by NEXT-ELEM
  20359. ;; body's length (without final blanks) and by the length of
  20360. ;; blanks between ELEM and NEXT-ELEM.
  20361. (let ((size-next (- (save-excursion
  20362. (goto-char (org-element-property :end next-elem))
  20363. (skip-chars-backward " \r\t\n")
  20364. (forward-line)
  20365. ;; Small correction if buffer doesn't end
  20366. ;; with a newline character.
  20367. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  20368. (org-element-property :begin next-elem)))
  20369. (size-blank (- (org-element-property :end elem)
  20370. (save-excursion
  20371. (goto-char (org-element-property :end elem))
  20372. (skip-chars-backward " \r\t\n")
  20373. (forward-line)
  20374. (point)))))
  20375. (org-element-swap-A-B elem next-elem)
  20376. (goto-char (+ pos size-next size-blank))))))
  20377. (defun org-mark-element ()
  20378. "Put point at beginning of this element, mark at end.
  20379. Interactively, if this command is repeated or (in Transient Mark
  20380. mode) if the mark is active, it marks the next element after the
  20381. ones already marked."
  20382. (interactive)
  20383. (let (deactivate-mark)
  20384. (if (and (org-called-interactively-p 'any)
  20385. (or (and (eq last-command this-command) (mark t))
  20386. (and transient-mark-mode mark-active)))
  20387. (set-mark
  20388. (save-excursion
  20389. (goto-char (mark))
  20390. (goto-char (org-element-property :end (org-element-at-point)))))
  20391. (let ((element (org-element-at-point)))
  20392. (end-of-line)
  20393. (push-mark (org-element-property :end element) t t)
  20394. (goto-char (org-element-property :begin element))))))
  20395. (defun org-narrow-to-element ()
  20396. "Narrow buffer to current element."
  20397. (interactive)
  20398. (let ((elem (org-element-at-point)))
  20399. (cond
  20400. ((eq (car elem) 'headline)
  20401. (narrow-to-region
  20402. (org-element-property :begin elem)
  20403. (org-element-property :end elem)))
  20404. ((memq (car elem) org-element-greater-elements)
  20405. (narrow-to-region
  20406. (org-element-property :contents-begin elem)
  20407. (org-element-property :contents-end elem)))
  20408. (t
  20409. (narrow-to-region
  20410. (org-element-property :begin elem)
  20411. (org-element-property :end elem))))))
  20412. (defun org-transpose-element ()
  20413. "Transpose current and previous elements, keeping blank lines between.
  20414. Point is moved after both elements."
  20415. (interactive)
  20416. (org-skip-whitespace)
  20417. (let ((end (org-element-property :end (org-element-at-point))))
  20418. (org-drag-element-backward)
  20419. (goto-char end)))
  20420. (defun org-unindent-buffer ()
  20421. "Un-indent the visible part of the buffer.
  20422. Relative indentation (between items, inside blocks, etc.) isn't
  20423. modified."
  20424. (interactive)
  20425. (unless (eq major-mode 'org-mode)
  20426. (error "Cannot un-indent a buffer not in Org mode"))
  20427. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  20428. unindent-tree ; For byte-compiler.
  20429. (unindent-tree
  20430. (function
  20431. (lambda (contents)
  20432. (mapc
  20433. (lambda (element)
  20434. (if (memq (org-element-type element) '(headline section))
  20435. (funcall unindent-tree (org-element-contents element))
  20436. (save-excursion
  20437. (save-restriction
  20438. (narrow-to-region
  20439. (org-element-property :begin element)
  20440. (org-element-property :end element))
  20441. (org-do-remove-indentation)))))
  20442. (reverse contents))))))
  20443. (funcall unindent-tree (org-element-contents parse-tree))))
  20444. (defun org-show-subtree ()
  20445. "Show everything after this heading at deeper levels."
  20446. (interactive)
  20447. (outline-flag-region
  20448. (point)
  20449. (save-excursion
  20450. (org-end-of-subtree t t))
  20451. nil))
  20452. (defun org-show-entry ()
  20453. "Show the body directly following this heading.
  20454. Show the heading too, if it is currently invisible."
  20455. (interactive)
  20456. (save-excursion
  20457. (condition-case nil
  20458. (progn
  20459. (org-back-to-heading t)
  20460. (outline-flag-region
  20461. (max (point-min) (1- (point)))
  20462. (save-excursion
  20463. (if (re-search-forward
  20464. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  20465. (match-beginning 1)
  20466. (point-max)))
  20467. nil)
  20468. (org-cycle-hide-drawers 'children))
  20469. (error nil))))
  20470. (defun org-make-options-regexp (kwds &optional extra)
  20471. "Make a regular expression for keyword lines."
  20472. (concat
  20473. "^#\\+\\("
  20474. (mapconcat 'regexp-quote kwds "\\|")
  20475. (if extra (concat "\\|" extra))
  20476. "\\):[ \t]*\\(.*\\)"))
  20477. ;; Make isearch reveal the necessary context
  20478. (defun org-isearch-end ()
  20479. "Reveal context after isearch exits."
  20480. (when isearch-success ; only if search was successful
  20481. (if (featurep 'xemacs)
  20482. ;; Under XEmacs, the hook is run in the correct place,
  20483. ;; we directly show the context.
  20484. (org-show-context 'isearch)
  20485. ;; In Emacs the hook runs *before* restoring the overlays.
  20486. ;; So we have to use a one-time post-command-hook to do this.
  20487. ;; (Emacs 22 has a special variable, see function `org-mode')
  20488. (unless (and (boundp 'isearch-mode-end-hook-quit)
  20489. isearch-mode-end-hook-quit)
  20490. ;; Only when the isearch was not quitted.
  20491. (org-add-hook 'post-command-hook 'org-isearch-post-command
  20492. 'append 'local)))))
  20493. (defun org-isearch-post-command ()
  20494. "Remove self from hook, and show context."
  20495. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  20496. (org-show-context 'isearch))
  20497. ;;;; Integration with and fixes for other packages
  20498. ;;; Imenu support
  20499. (defvar org-imenu-markers nil
  20500. "All markers currently used by Imenu.")
  20501. (make-variable-buffer-local 'org-imenu-markers)
  20502. (defun org-imenu-new-marker (&optional pos)
  20503. "Return a new marker for use by Imenu, and remember the marker."
  20504. (let ((m (make-marker)))
  20505. (move-marker m (or pos (point)))
  20506. (push m org-imenu-markers)
  20507. m))
  20508. (defun org-imenu-get-tree ()
  20509. "Produce the index for Imenu."
  20510. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  20511. (setq org-imenu-markers nil)
  20512. (let* ((n org-imenu-depth)
  20513. (re (concat "^" (org-get-limited-outline-regexp)))
  20514. (subs (make-vector (1+ n) nil))
  20515. (last-level 0)
  20516. m level head)
  20517. (save-excursion
  20518. (save-restriction
  20519. (widen)
  20520. (goto-char (point-max))
  20521. (while (re-search-backward re nil t)
  20522. (setq level (org-reduced-level (funcall outline-level)))
  20523. (when (and (<= level n)
  20524. (looking-at org-complex-heading-regexp))
  20525. (setq head (org-link-display-format
  20526. (org-match-string-no-properties 4))
  20527. m (org-imenu-new-marker))
  20528. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  20529. (if (>= level last-level)
  20530. (push (cons head m) (aref subs level))
  20531. (push (cons head (aref subs (1+ level))) (aref subs level))
  20532. (loop for i from (1+ level) to n do (aset subs i nil)))
  20533. (setq last-level level)))))
  20534. (aref subs 1)))
  20535. (eval-after-load "imenu"
  20536. '(progn
  20537. (add-hook 'imenu-after-jump-hook
  20538. (lambda ()
  20539. (if (derived-mode-p 'org-mode)
  20540. (org-show-context 'org-goto))))))
  20541. (defun org-link-display-format (link)
  20542. "Replace a link with either the description, or the link target
  20543. if no description is present"
  20544. (save-match-data
  20545. (if (string-match org-bracket-link-analytic-regexp link)
  20546. (replace-match (if (match-end 5)
  20547. (match-string 5 link)
  20548. (concat (match-string 1 link)
  20549. (match-string 3 link)))
  20550. nil t link)
  20551. link)))
  20552. (defun org-toggle-link-display ()
  20553. "Toggle the literal or descriptive display of links."
  20554. (interactive)
  20555. (if org-descriptive-links
  20556. (progn (org-remove-from-invisibility-spec '(org-link))
  20557. (org-restart-font-lock)
  20558. (setq org-descriptive-links nil))
  20559. (progn (add-to-invisibility-spec '(org-link))
  20560. (org-restart-font-lock)
  20561. (setq org-descriptive-links t))))
  20562. ;; Speedbar support
  20563. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  20564. "Overlay marking the agenda restriction line in speedbar.")
  20565. (overlay-put org-speedbar-restriction-lock-overlay
  20566. 'face 'org-agenda-restriction-lock)
  20567. (overlay-put org-speedbar-restriction-lock-overlay
  20568. 'help-echo "Agendas are currently limited to this item.")
  20569. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  20570. (defun org-speedbar-set-agenda-restriction ()
  20571. "Restrict future agenda commands to the location at point in speedbar.
  20572. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  20573. (interactive)
  20574. (require 'org-agenda)
  20575. (let (p m tp np dir txt)
  20576. (cond
  20577. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20578. 'org-imenu t))
  20579. (setq m (get-text-property p 'org-imenu-marker))
  20580. (with-current-buffer (marker-buffer m)
  20581. (goto-char m)
  20582. (org-agenda-set-restriction-lock 'subtree)))
  20583. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20584. 'speedbar-function 'speedbar-find-file))
  20585. (setq tp (previous-single-property-change
  20586. (1+ p) 'speedbar-function)
  20587. np (next-single-property-change
  20588. tp 'speedbar-function)
  20589. dir (speedbar-line-directory)
  20590. txt (buffer-substring-no-properties (or tp (point-min))
  20591. (or np (point-max))))
  20592. (with-current-buffer (find-file-noselect
  20593. (let ((default-directory dir))
  20594. (expand-file-name txt)))
  20595. (unless (derived-mode-p 'org-mode)
  20596. (error "Cannot restrict to non-Org-mode file"))
  20597. (org-agenda-set-restriction-lock 'file)))
  20598. (t (error "Don't know how to restrict Org-mode's agenda")))
  20599. (move-overlay org-speedbar-restriction-lock-overlay
  20600. (point-at-bol) (point-at-eol))
  20601. (setq current-prefix-arg nil)
  20602. (org-agenda-maybe-redo)))
  20603. (eval-after-load "speedbar"
  20604. '(progn
  20605. (speedbar-add-supported-extension ".org")
  20606. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  20607. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  20608. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  20609. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  20610. (add-hook 'speedbar-visiting-tag-hook
  20611. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  20612. ;;; Fixes and Hacks for problems with other packages
  20613. ;; Make flyspell not check words in links, to not mess up our keymap
  20614. (defun org-mode-flyspell-verify ()
  20615. "Don't let flyspell put overlays at active buttons, or on
  20616. {todo,all-time,additional-option-like}-keywords."
  20617. (let ((pos (max (1- (point)) (point-min)))
  20618. (word (thing-at-point 'word)))
  20619. (and (not (get-text-property pos 'keymap))
  20620. (not (get-text-property pos 'org-no-flyspell))
  20621. (not (member word org-todo-keywords-1))
  20622. (not (member word org-all-time-keywords))
  20623. (not (member word org-options-keywords))
  20624. (not (member word (mapcar 'car org-startup-options)))
  20625. (not (member word org-additional-option-like-keywords-for-flyspell)))))
  20626. (defun org-remove-flyspell-overlays-in (beg end)
  20627. "Remove flyspell overlays in region."
  20628. (and (org-bound-and-true-p flyspell-mode)
  20629. (fboundp 'flyspell-delete-region-overlays)
  20630. (flyspell-delete-region-overlays beg end))
  20631. (add-text-properties beg end '(org-no-flyspell t)))
  20632. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  20633. (eval-after-load "bookmark"
  20634. '(if (boundp 'bookmark-after-jump-hook)
  20635. ;; We can use the hook
  20636. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  20637. ;; Hook not available, use advice
  20638. (defadvice bookmark-jump (after org-make-visible activate)
  20639. "Make the position visible."
  20640. (org-bookmark-jump-unhide))))
  20641. ;; Make sure saveplace shows the location if it was hidden
  20642. (eval-after-load "saveplace"
  20643. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  20644. "Make the position visible."
  20645. (org-bookmark-jump-unhide)))
  20646. ;; Make sure ecb shows the location if it was hidden
  20647. (eval-after-load "ecb"
  20648. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  20649. "Make hierarchy visible when jumping into location from ECB tree buffer."
  20650. (if (derived-mode-p 'org-mode)
  20651. (org-show-context))))
  20652. (defun org-bookmark-jump-unhide ()
  20653. "Unhide the current position, to show the bookmark location."
  20654. (and (derived-mode-p 'org-mode)
  20655. (or (outline-invisible-p)
  20656. (save-excursion (goto-char (max (point-min) (1- (point))))
  20657. (outline-invisible-p)))
  20658. (org-show-context 'bookmark-jump)))
  20659. ;; Make session.el ignore our circular variable
  20660. (eval-after-load "session"
  20661. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  20662. ;;;; Experimental code
  20663. (defun org-closed-in-range ()
  20664. "Sparse tree of items closed in a certain time range.
  20665. Still experimental, may disappear in the future."
  20666. (interactive)
  20667. ;; Get the time interval from the user.
  20668. (let* ((time1 (org-float-time
  20669. (org-read-date nil 'to-time nil "Starting date: ")))
  20670. (time2 (org-float-time
  20671. (org-read-date nil 'to-time nil "End date:")))
  20672. ;; callback function
  20673. (callback (lambda ()
  20674. (let ((time
  20675. (org-float-time
  20676. (apply 'encode-time
  20677. (org-parse-time-string
  20678. (match-string 1))))))
  20679. ;; check if time in interval
  20680. (and (>= time time1) (<= time time2))))))
  20681. ;; make tree, check each match with the callback
  20682. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  20683. ;;;; Finish up
  20684. (provide 'org)
  20685. (run-hooks 'org-load-hook)
  20686. ;;; org.el ends here