org.el 853 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636
  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. ;; `org-outline-regexp' ought to be a defconst but is let-binding in
  74. ;; some places -- e.g. see the macro org-with-limited-levels.
  75. ;;
  76. ;; In Org buffers, the value of `outline-regexp' is that of
  77. ;; `org-outline-regexp'. The only function still directly relying on
  78. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  79. ;; job when `orgstruct-mode' is active.
  80. (defvar org-outline-regexp "\\*+ "
  81. "Regexp to match Org headlines.")
  82. (defvar org-outline-regexp-bol "^\\*+ "
  83. "Regexp to match Org headlines.
  84. This is similar to `org-outline-regexp' but additionally makes
  85. sure that we are at the beginning of the line.")
  86. (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  87. "Matches an headline, putting stars and text into groups.
  88. Stars are put in group 1 and the trimmed body in group 2.")
  89. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  90. (when (fboundp 'defvaralias)
  91. (unless (boundp 'calendar-view-holidays-initially-flag)
  92. (defvaralias 'calendar-view-holidays-initially-flag
  93. 'view-calendar-holidays-initially))
  94. (unless (boundp 'calendar-view-diary-initially-flag)
  95. (defvaralias 'calendar-view-diary-initially-flag
  96. 'view-diary-entries-initially))
  97. (unless (boundp 'diary-fancy-buffer)
  98. (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
  99. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  100. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  101. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  102. (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
  103. (declare-function org-at-clock-log-p "org-clock" ())
  104. (declare-function org-clock-get-last-clock-out-time "org-clock" ())
  105. (declare-function org-clock-timestamps-up "org-clock" ())
  106. (declare-function org-clock-timestamps-down "org-clock" ())
  107. (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
  108. ;; load languages based on value of `org-babel-load-languages'
  109. (defvar org-babel-load-languages)
  110. ;;;###autoload
  111. (defun org-babel-do-load-languages (sym value)
  112. "Load the languages defined in `org-babel-load-languages'."
  113. (set-default sym value)
  114. (mapc (lambda (pair)
  115. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  116. (if active
  117. (progn
  118. (require (intern (concat "ob-" lang))))
  119. (progn
  120. (funcall 'fmakunbound
  121. (intern (concat "org-babel-execute:" lang)))
  122. (funcall 'fmakunbound
  123. (intern (concat "org-babel-expand-body:" lang)))))))
  124. org-babel-load-languages))
  125. (defcustom org-babel-load-languages '((emacs-lisp . t))
  126. "Languages which can be evaluated in Org-mode buffers.
  127. This list can be used to load support for any of the languages
  128. below, note that each language will depend on a different set of
  129. system executables and/or Emacs modes. When a language is
  130. \"loaded\", then code blocks in that language can be evaluated
  131. with `org-babel-execute-src-block' bound by default to C-c
  132. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  133. be set to remove code block evaluation from the C-c C-c
  134. keybinding. By default only Emacs Lisp (which has no
  135. requirements) is loaded."
  136. :group 'org-babel
  137. :set 'org-babel-do-load-languages
  138. :version "24.1"
  139. :type '(alist :tag "Babel Languages"
  140. :key-type
  141. (choice
  142. (const :tag "Awk" awk)
  143. (const :tag "C" C)
  144. (const :tag "R" R)
  145. (const :tag "Asymptote" asymptote)
  146. (const :tag "Calc" calc)
  147. (const :tag "Clojure" clojure)
  148. (const :tag "CSS" css)
  149. (const :tag "Ditaa" ditaa)
  150. (const :tag "Dot" dot)
  151. (const :tag "Emacs Lisp" emacs-lisp)
  152. (const :tag "Fortran" fortran)
  153. (const :tag "Gnuplot" gnuplot)
  154. (const :tag "Haskell" haskell)
  155. (const :tag "IO" io)
  156. (const :tag "Java" java)
  157. (const :tag "Javascript" js)
  158. (const :tag "LaTeX" latex)
  159. (const :tag "Ledger" ledger)
  160. (const :tag "Lilypond" lilypond)
  161. (const :tag "Lisp" lisp)
  162. (const :tag "Maxima" maxima)
  163. (const :tag "Matlab" matlab)
  164. (const :tag "Mscgen" mscgen)
  165. (const :tag "Ocaml" ocaml)
  166. (const :tag "Octave" octave)
  167. (const :tag "Org" org)
  168. (const :tag "Perl" perl)
  169. (const :tag "Pico Lisp" picolisp)
  170. (const :tag "PlantUML" plantuml)
  171. (const :tag "Python" python)
  172. (const :tag "Ruby" ruby)
  173. (const :tag "Sass" sass)
  174. (const :tag "Scala" scala)
  175. (const :tag "Scheme" scheme)
  176. (const :tag "Screen" screen)
  177. (const :tag "Shell Script" sh)
  178. (const :tag "Shen" shen)
  179. (const :tag "Sql" sql)
  180. (const :tag "Sqlite" sqlite))
  181. :value-type (boolean :tag "Activate" :value t)))
  182. ;;;; Customization variables
  183. (defcustom org-clone-delete-id nil
  184. "Remove ID property of clones of a subtree.
  185. When non-nil, clones of a subtree don't inherit the ID property.
  186. Otherwise they inherit the ID property with a new unique
  187. identifier."
  188. :type 'boolean
  189. :version "24.1"
  190. :group 'org-id)
  191. ;;; Version
  192. (require 'org-compat)
  193. (org-check-version)
  194. ;;;###autoload
  195. (defun org-version (&optional here full message)
  196. "Show the org-mode version in the echo area.
  197. With prefix argument HERE, insert it at point.
  198. When FULL is non-nil, use a verbose version string.
  199. When MESSAGE is non-nil, display a message with the version."
  200. (interactive "P")
  201. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  202. (org-install-dir (ignore-errors (org-find-library-dir "org-install.el")))
  203. (org-trash (or
  204. (and (fboundp 'org-release) (fboundp 'org-git-version))
  205. (load (concat org-dir "org-version.el")
  206. 'noerror 'nomessage 'nosuffix)))
  207. (org-version (org-release))
  208. (git-version (org-git-version))
  209. (version (format "Org-mode version %s (%s @ %s)"
  210. org-version
  211. git-version
  212. (if org-install-dir
  213. (if (string= org-dir org-install-dir)
  214. org-install-dir
  215. (concat "mixed installation! " org-install-dir " and " org-dir))
  216. "org-install.el can not be found!")))
  217. (_version (if full version org-version)))
  218. (if (org-called-interactively-p 'interactive)
  219. (if here
  220. (insert version)
  221. (message version))
  222. (if message (message _version))
  223. _version)))
  224. (defconst org-version (org-version))
  225. ;;; Compatibility constants
  226. ;;; The custom variables
  227. (defgroup org nil
  228. "Outline-based notes management and organizer."
  229. :tag "Org"
  230. :group 'outlines
  231. :group 'calendar)
  232. (defcustom org-mode-hook nil
  233. "Mode hook for Org-mode, run after the mode was turned on."
  234. :group 'org
  235. :type 'hook)
  236. (defcustom org-load-hook nil
  237. "Hook that is run after org.el has been loaded."
  238. :group 'org
  239. :type 'hook)
  240. (defcustom org-log-buffer-setup-hook nil
  241. "Hook that is run after an Org log buffer is created."
  242. :group 'org
  243. :version "24.1"
  244. :type 'hook)
  245. (defvar org-modules) ; defined below
  246. (defvar org-modules-loaded nil
  247. "Have the modules been loaded already?")
  248. (defun org-load-modules-maybe (&optional force)
  249. "Load all extensions listed in `org-modules'."
  250. (when (or force (not org-modules-loaded))
  251. (mapc (lambda (ext)
  252. (condition-case nil (require ext)
  253. (error (message "Problems while trying to load feature `%s'" ext))))
  254. org-modules)
  255. (setq org-modules-loaded t)))
  256. (defun org-set-modules (var value)
  257. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  258. (set var value)
  259. (when (featurep 'org)
  260. (org-load-modules-maybe 'force)))
  261. (when (org-bound-and-true-p org-modules)
  262. (let ((a (member 'org-infojs org-modules)))
  263. (and a (setcar a 'org-jsinfo))))
  264. (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
  265. "Modules that should always be loaded together with org.el.
  266. If a description starts with <C>, the file is not part of Emacs
  267. and loading it will require that you have downloaded and properly installed
  268. the org-mode distribution.
  269. You can also use this system to load external packages (i.e. neither Org
  270. core modules, nor modules from the CONTRIB directory). Just add symbols
  271. to the end of the list. If the package is called org-xyz.el, then you need
  272. to add the symbol `xyz', and the package must have a call to
  273. (provide 'org-xyz)"
  274. :group 'org
  275. :set 'org-set-modules
  276. :type
  277. '(set :greedy t
  278. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  279. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  280. (const :tag " crypt: Encryption of subtrees" org-crypt)
  281. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  282. (const :tag " docview: Links to doc-view buffers" org-docview)
  283. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  284. (const :tag " id: Global IDs for identifying entries" org-id)
  285. (const :tag " info: Links to Info nodes" org-info)
  286. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  287. (const :tag " habit: Track your consistency with habits" org-habit)
  288. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  289. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  290. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  291. (const :tag " mew Links to Mew folders/messages" org-mew)
  292. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  293. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  294. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  295. (const :tag " special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  296. (const :tag " vm: Links to VM folders/messages" org-vm)
  297. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  298. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  299. (const :tag " mouse: Additional mouse support" org-mouse)
  300. (const :tag " TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  301. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  302. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  303. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  304. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  305. (const :tag "C collector: Collect properties into tables" org-collector)
  306. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  307. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  308. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  309. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  310. (const :tag "C eval: Include command output as text" org-eval)
  311. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  312. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  313. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  314. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  315. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  316. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  317. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  318. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  319. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  320. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  321. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  322. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  323. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  324. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  325. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  326. (const :tag "C registry: A registry for Org-mode links" org-registry)
  327. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  328. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  329. (const :tag "C secretary: Team management with org-mode" org-secretary)
  330. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  331. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  332. (const :tag "C track: Keep up with Org-mode development" org-track)
  333. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  334. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  335. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  336. (defcustom org-support-shift-select nil
  337. "Non-nil means make shift-cursor commands select text when possible.
  338. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  339. start selecting a region, or enlarge regions started in this way.
  340. In Org-mode, in special contexts, these same keys are used for
  341. other purposes, important enough to compete with shift selection.
  342. Org tries to balance these needs by supporting `shift-select-mode'
  343. outside these special contexts, under control of this variable.
  344. The default of this variable is nil, to avoid confusing behavior. Shifted
  345. cursor keys will then execute Org commands in the following contexts:
  346. - on a headline, changing TODO state (left/right) and priority (up/down)
  347. - on a time stamp, changing the time
  348. - in a plain list item, changing the bullet type
  349. - in a property definition line, switching between allowed values
  350. - in the BEGIN line of a clock table (changing the time block).
  351. Outside these contexts, the commands will throw an error.
  352. When this variable is t and the cursor is not in a special
  353. context, Org-mode will support shift-selection for making and
  354. enlarging regions. To make this more effective, the bullet
  355. cycling will no longer happen anywhere in an item line, but only
  356. if the cursor is exactly on the bullet.
  357. If you set this variable to the symbol `always', then the keys
  358. will not be special in headlines, property lines, and item lines,
  359. to make shift selection work there as well. If this is what you
  360. want, you can use the following alternative commands: `C-c C-t'
  361. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  362. can be used to switch TODO sets, `C-c -' to cycle item bullet
  363. types, and properties can be edited by hand or in column view.
  364. However, when the cursor is on a timestamp, shift-cursor commands
  365. will still edit the time stamp - this is just too good to give up.
  366. XEmacs user should have this variable set to nil, because
  367. `shift-select-mode' is in Emacs 23 or later only."
  368. :group 'org
  369. :type '(choice
  370. (const :tag "Never" nil)
  371. (const :tag "When outside special context" t)
  372. (const :tag "Everywhere except timestamps" always)))
  373. (defcustom org-loop-over-headlines-in-active-region nil
  374. "Shall some commands act upon headlines in the active region?
  375. When set to `t', some commands will be performed in all headlines
  376. within the active region.
  377. When set to `start-level', some commands will be performed in all
  378. headlines within the active region, provided that these headlines
  379. are of the same level than the first one.
  380. When set to a string, those commands will be performed on the
  381. matching headlines within the active region. Such string must be
  382. a tags/property/todo match as it is used in the agenda tags view.
  383. The list of commands is: `org-schedule', `org-deadline',
  384. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  385. `org-archive-to-archive-sibling'. The archiving commands skip
  386. already archived entries."
  387. :type '(choice (const :tag "Don't loop" nil)
  388. (const :tag "All headlines in active region" t)
  389. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  390. (string :tag "Tags/Property/Todo matcher"))
  391. :version "24.1"
  392. :group 'org-todo
  393. :group 'org-archive)
  394. (defgroup org-startup nil
  395. "Options concerning startup of Org-mode."
  396. :tag "Org Startup"
  397. :group 'org)
  398. (defcustom org-startup-folded t
  399. "Non-nil means entering Org-mode will switch to OVERVIEW.
  400. This can also be configured on a per-file basis by adding one of
  401. the following lines anywhere in the buffer:
  402. #+STARTUP: fold (or `overview', this is equivalent)
  403. #+STARTUP: nofold (or `showall', this is equivalent)
  404. #+STARTUP: content
  405. #+STARTUP: showeverything"
  406. :group 'org-startup
  407. :type '(choice
  408. (const :tag "nofold: show all" nil)
  409. (const :tag "fold: overview" t)
  410. (const :tag "content: all headlines" content)
  411. (const :tag "show everything, even drawers" showeverything)))
  412. (defcustom org-startup-truncated t
  413. "Non-nil means entering Org-mode will set `truncate-lines'.
  414. This is useful since some lines containing links can be very long and
  415. uninteresting. Also tables look terrible when wrapped."
  416. :group 'org-startup
  417. :type 'boolean)
  418. (defcustom org-startup-indented nil
  419. "Non-nil means turn on `org-indent-mode' on startup.
  420. This can also be configured on a per-file basis by adding one of
  421. the following lines anywhere in the buffer:
  422. #+STARTUP: indent
  423. #+STARTUP: noindent"
  424. :group 'org-structure
  425. :type '(choice
  426. (const :tag "Not" nil)
  427. (const :tag "Globally (slow on startup in large files)" t)))
  428. (defcustom org-use-sub-superscripts t
  429. "Non-nil means interpret \"_\" and \"^\" for export.
  430. When this option is turned on, you can use TeX-like syntax for sub- and
  431. superscripts. Several characters after \"_\" or \"^\" will be
  432. considered as a single item - so grouping with {} is normally not
  433. needed. For example, the following things will be parsed as single
  434. sub- or superscripts.
  435. 10^24 or 10^tau several digits will be considered 1 item.
  436. 10^-12 or 10^-tau a leading sign with digits or a word
  437. x^2-y^3 will be read as x^2 - y^3, because items are
  438. terminated by almost any nonword/nondigit char.
  439. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  440. Still, ambiguity is possible - so when in doubt use {} to enclose the
  441. sub/superscript. If you set this variable to the symbol `{}',
  442. the braces are *required* in order to trigger interpretations as
  443. sub/superscript. This can be helpful in documents that need \"_\"
  444. frequently in plain text.
  445. Not all export backends support this, but HTML does.
  446. This option can also be set with the #+OPTIONS line, e.g. \"^:nil\"."
  447. :group 'org-startup
  448. :group 'org-export-translation
  449. :version "24.1"
  450. :type '(choice
  451. (const :tag "Always interpret" t)
  452. (const :tag "Only with braces" {})
  453. (const :tag "Never interpret" nil)))
  454. (if (fboundp 'defvaralias)
  455. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
  456. (defcustom org-startup-with-beamer-mode nil
  457. "Non-nil means turn on `org-beamer-mode' on startup.
  458. This can also be configured on a per-file basis by adding one of
  459. the following lines anywhere in the buffer:
  460. #+STARTUP: beamer"
  461. :group 'org-startup
  462. :version "24.1"
  463. :type 'boolean)
  464. (defcustom org-startup-align-all-tables nil
  465. "Non-nil means align all tables when visiting a file.
  466. This is useful when the column width in tables is forced with <N> cookies
  467. in table fields. Such tables will look correct only after the first re-align.
  468. This can also be configured on a per-file basis by adding one of
  469. the following lines anywhere in the buffer:
  470. #+STARTUP: align
  471. #+STARTUP: noalign"
  472. :group 'org-startup
  473. :type 'boolean)
  474. (defcustom org-startup-with-inline-images nil
  475. "Non-nil means show inline images when loading a new Org file.
  476. This can also be configured on a per-file basis by adding one of
  477. the following lines anywhere in the buffer:
  478. #+STARTUP: inlineimages
  479. #+STARTUP: noinlineimages"
  480. :group 'org-startup
  481. :version "24.1"
  482. :type 'boolean)
  483. (defcustom org-insert-mode-line-in-empty-file nil
  484. "Non-nil means insert the first line setting Org-mode in empty files.
  485. When the function `org-mode' is called interactively in an empty file, this
  486. normally means that the file name does not automatically trigger Org-mode.
  487. To ensure that the file will always be in Org-mode in the future, a
  488. line enforcing Org-mode will be inserted into the buffer, if this option
  489. has been set."
  490. :group 'org-startup
  491. :type 'boolean)
  492. (defcustom org-replace-disputed-keys nil
  493. "Non-nil means use alternative key bindings for some keys.
  494. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  495. These keys are also used by other packages like shift-selection-mode'
  496. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  497. If you want to use Org-mode together with one of these other modes,
  498. or more generally if you would like to move some Org-mode commands to
  499. other keys, set this variable and configure the keys with the variable
  500. `org-disputed-keys'.
  501. This option is only relevant at load-time of Org-mode, and must be set
  502. *before* org.el is loaded. Changing it requires a restart of Emacs to
  503. become effective."
  504. :group 'org-startup
  505. :type 'boolean)
  506. (defcustom org-use-extra-keys nil
  507. "Non-nil means use extra key sequence definitions for certain commands.
  508. This happens automatically if you run XEmacs or if `window-system'
  509. is nil. This variable lets you do the same manually. You must
  510. set it before loading org.
  511. Example: on Carbon Emacs 22 running graphically, with an external
  512. keyboard on a Powerbook, the default way of setting M-left might
  513. not work for either Alt or ESC. Setting this variable will make
  514. it work for ESC."
  515. :group 'org-startup
  516. :type 'boolean)
  517. (if (fboundp 'defvaralias)
  518. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  519. (defcustom org-disputed-keys
  520. '(([(shift up)] . [(meta p)])
  521. ([(shift down)] . [(meta n)])
  522. ([(shift left)] . [(meta -)])
  523. ([(shift right)] . [(meta +)])
  524. ([(control shift right)] . [(meta shift +)])
  525. ([(control shift left)] . [(meta shift -)]))
  526. "Keys for which Org-mode and other modes compete.
  527. This is an alist, cars are the default keys, second element specifies
  528. the alternative to use when `org-replace-disputed-keys' is t.
  529. Keys can be specified in any syntax supported by `define-key'.
  530. The value of this option takes effect only at Org-mode's startup,
  531. therefore you'll have to restart Emacs to apply it after changing."
  532. :group 'org-startup
  533. :type 'alist)
  534. (defun org-key (key)
  535. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  536. Or return the original if not disputed.
  537. Also apply the translations defined in `org-xemacs-key-equivalents'."
  538. (when org-replace-disputed-keys
  539. (let* ((nkey (key-description key))
  540. (x (org-find-if (lambda (x)
  541. (equal (key-description (car x)) nkey))
  542. org-disputed-keys)))
  543. (setq key (if x (cdr x) key))))
  544. (when (featurep 'xemacs)
  545. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  546. key)
  547. (defun org-find-if (predicate seq)
  548. (catch 'exit
  549. (while seq
  550. (if (funcall predicate (car seq))
  551. (throw 'exit (car seq))
  552. (pop seq)))))
  553. (defun org-defkey (keymap key def)
  554. "Define a key, possibly translated, as returned by `org-key'."
  555. (define-key keymap (org-key key) def))
  556. (defcustom org-ellipsis nil
  557. "The ellipsis to use in the Org-mode outline.
  558. When nil, just use the standard three dots. When a string, use that instead,
  559. When a face, use the standard 3 dots, but with the specified face.
  560. The change affects only Org-mode (which will then use its own display table).
  561. Changing this requires executing `M-x org-mode' in a buffer to become
  562. effective."
  563. :group 'org-startup
  564. :type '(choice (const :tag "Default" nil)
  565. (face :tag "Face" :value org-warning)
  566. (string :tag "String" :value "...#")))
  567. (defvar org-display-table nil
  568. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  569. (defgroup org-keywords nil
  570. "Keywords in Org-mode."
  571. :tag "Org Keywords"
  572. :group 'org)
  573. (defcustom org-deadline-string "DEADLINE:"
  574. "String to mark deadline entries.
  575. A deadline is this string, followed by a time stamp. Should be a word,
  576. terminated by a colon. You can insert a schedule keyword and
  577. a timestamp with \\[org-deadline].
  578. Changes become only effective after restarting Emacs."
  579. :group 'org-keywords
  580. :type 'string)
  581. (defcustom org-scheduled-string "SCHEDULED:"
  582. "String to mark scheduled TODO entries.
  583. A schedule is this string, followed by a time stamp. Should be a word,
  584. terminated by a colon. You can insert a schedule keyword and
  585. a timestamp with \\[org-schedule].
  586. Changes become only effective after restarting Emacs."
  587. :group 'org-keywords
  588. :type 'string)
  589. (defcustom org-closed-string "CLOSED:"
  590. "String used as the prefix for timestamps logging closing a TODO entry."
  591. :group 'org-keywords
  592. :type 'string)
  593. (defcustom org-clock-string "CLOCK:"
  594. "String used as prefix for timestamps clocking work hours on an item."
  595. :group 'org-keywords
  596. :type 'string)
  597. (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
  598. org-scheduled-string "\\|"
  599. org-deadline-string "\\|"
  600. org-closed-string "\\|"
  601. org-clock-string "\\)")
  602. "Matches a line with planning or clock info.")
  603. (defcustom org-comment-string "COMMENT"
  604. "Entries starting with this keyword will never be exported.
  605. An entry can be toggled between COMMENT and normal with
  606. \\[org-toggle-comment].
  607. Changes become only effective after restarting Emacs."
  608. :group 'org-keywords
  609. :type 'string)
  610. (defcustom org-quote-string "QUOTE"
  611. "Entries starting with this keyword will be exported in fixed-width font.
  612. Quoting applies only to the text in the entry following the headline, and does
  613. not extend beyond the next headline, even if that is lower level.
  614. An entry can be toggled between QUOTE and normal with
  615. \\[org-toggle-fixed-width-section]."
  616. :group 'org-keywords
  617. :type 'string)
  618. (defconst org-repeat-re
  619. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  620. "Regular expression for specifying repeated events.
  621. After a match, group 1 contains the repeat expression.")
  622. (defgroup org-structure nil
  623. "Options concerning the general structure of Org-mode files."
  624. :tag "Org Structure"
  625. :group 'org)
  626. (defgroup org-reveal-location nil
  627. "Options about how to make context of a location visible."
  628. :tag "Org Reveal Location"
  629. :group 'org-structure)
  630. (defconst org-context-choice
  631. '(choice
  632. (const :tag "Always" t)
  633. (const :tag "Never" nil)
  634. (repeat :greedy t :tag "Individual contexts"
  635. (cons
  636. (choice :tag "Context"
  637. (const agenda)
  638. (const org-goto)
  639. (const occur-tree)
  640. (const tags-tree)
  641. (const link-search)
  642. (const mark-goto)
  643. (const bookmark-jump)
  644. (const isearch)
  645. (const default))
  646. (boolean))))
  647. "Contexts for the reveal options.")
  648. (defcustom org-show-hierarchy-above '((default . t))
  649. "Non-nil means show full hierarchy when revealing a location.
  650. Org-mode often shows locations in an org-mode file which might have
  651. been invisible before. When this is set, the hierarchy of headings
  652. above the exposed location is shown.
  653. Turning this off for example for sparse trees makes them very compact.
  654. Instead of t, this can also be an alist specifying this option for different
  655. contexts. Valid contexts are
  656. agenda when exposing an entry from the agenda
  657. org-goto when using the command `org-goto' on key C-c C-j
  658. occur-tree when using the command `org-occur' on key C-c /
  659. tags-tree when constructing a sparse tree based on tags matches
  660. link-search when exposing search matches associated with a link
  661. mark-goto when exposing the jump goal of a mark
  662. bookmark-jump when exposing a bookmark location
  663. isearch when exiting from an incremental search
  664. default default for all contexts not set explicitly"
  665. :group 'org-reveal-location
  666. :type org-context-choice)
  667. (defcustom org-show-following-heading '((default . nil))
  668. "Non-nil means show following heading when revealing a location.
  669. Org-mode often shows locations in an org-mode file which might have
  670. been invisible before. When this is set, the heading following the
  671. match is shown.
  672. Turning this off for example for sparse trees makes them very compact,
  673. but makes it harder to edit the location of the match. In such a case,
  674. use the command \\[org-reveal] to show more context.
  675. Instead of t, this can also be an alist specifying this option for different
  676. contexts. See `org-show-hierarchy-above' for valid contexts."
  677. :group 'org-reveal-location
  678. :type org-context-choice)
  679. (defcustom org-show-siblings '((default . nil) (isearch t))
  680. "Non-nil means show all sibling heading when revealing a location.
  681. Org-mode often shows locations in an org-mode file which might have
  682. been invisible before. When this is set, the sibling of the current entry
  683. heading are all made visible. If `org-show-hierarchy-above' is t,
  684. the same happens on each level of the hierarchy above the current entry.
  685. By default this is on for the isearch context, off for all other contexts.
  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-entry-below '((default . nil))
  694. "Non-nil means show the entry below a headline 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 text below the headline that is
  697. exposed is also shown.
  698. By default this is off for all contexts.
  699. Instead of t, this can also be an alist specifying this option for different
  700. contexts. See `org-show-hierarchy-above' for valid contexts."
  701. :group 'org-reveal-location
  702. :type org-context-choice)
  703. (defcustom org-indirect-buffer-display 'other-window
  704. "How should indirect tree buffers be displayed?
  705. This applies to indirect buffers created with the commands
  706. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  707. Valid values are:
  708. current-window Display in the current window
  709. other-window Just display in another window.
  710. dedicated-frame Create one new frame, and re-use it each time.
  711. new-frame Make a new frame each time. Note that in this case
  712. previously-made indirect buffers are kept, and you need to
  713. kill these buffers yourself."
  714. :group 'org-structure
  715. :group 'org-agenda-windows
  716. :type '(choice
  717. (const :tag "In current window" current-window)
  718. (const :tag "In current frame, other window" other-window)
  719. (const :tag "Each time a new frame" new-frame)
  720. (const :tag "One dedicated frame" dedicated-frame)))
  721. (defcustom org-use-speed-commands nil
  722. "Non-nil means activate single letter commands at beginning of a headline.
  723. This may also be a function to test for appropriate locations where speed
  724. commands should be active."
  725. :group 'org-structure
  726. :type '(choice
  727. (const :tag "Never" nil)
  728. (const :tag "At beginning of headline stars" t)
  729. (function)))
  730. (defcustom org-speed-commands-user nil
  731. "Alist of additional speed commands.
  732. This list will be checked before `org-speed-commands-default'
  733. when the variable `org-use-speed-commands' is non-nil
  734. and when the cursor is at the beginning of a headline.
  735. The car if each entry is a string with a single letter, which must
  736. be assigned to `self-insert-command' in the global map.
  737. The cdr is either a command to be called interactively, a function
  738. to be called, or a form to be evaluated.
  739. An entry that is just a list with a single string will be interpreted
  740. as a descriptive headline that will be added when listing the speed
  741. commands in the Help buffer using the `?' speed command."
  742. :group 'org-structure
  743. :type '(repeat :value ("k" . ignore)
  744. (choice :value ("k" . ignore)
  745. (list :tag "Descriptive Headline" (string :tag "Headline"))
  746. (cons :tag "Letter and Command"
  747. (string :tag "Command letter")
  748. (choice
  749. (function)
  750. (sexp))))))
  751. (defgroup org-cycle nil
  752. "Options concerning visibility cycling in Org-mode."
  753. :tag "Org Cycle"
  754. :group 'org-structure)
  755. (defcustom org-cycle-skip-children-state-if-no-children t
  756. "Non-nil means skip CHILDREN state in entries that don't have any."
  757. :group 'org-cycle
  758. :type 'boolean)
  759. (defcustom org-cycle-max-level nil
  760. "Maximum level which should still be subject to visibility cycling.
  761. Levels higher than this will, for cycling, be treated as text, not a headline.
  762. When `org-odd-levels-only' is set, a value of N in this variable actually
  763. means 2N-1 stars as the limiting headline.
  764. When nil, cycle all levels.
  765. Note that the limiting level of cycling is also influenced by
  766. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  767. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  768. than its value."
  769. :group 'org-cycle
  770. :type '(choice
  771. (const :tag "No limit" nil)
  772. (integer :tag "Maximum level")))
  773. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  774. "Names of drawers. Drawers are not opened by cycling on the headline above.
  775. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  776. this:
  777. :DRAWERNAME:
  778. .....
  779. :END:
  780. The drawer \"PROPERTIES\" is special for capturing properties through
  781. the property API.
  782. Drawers can be defined on the per-file basis with a line like:
  783. #+DRAWERS: HIDDEN STATE PROPERTIES"
  784. :group 'org-structure
  785. :group 'org-cycle
  786. :type '(repeat (string :tag "Drawer Name")))
  787. (defcustom org-hide-block-startup nil
  788. "Non-nil means entering Org-mode will fold all blocks.
  789. This can also be set in on a per-file basis with
  790. #+STARTUP: hideblocks
  791. #+STARTUP: showblocks"
  792. :group 'org-startup
  793. :group 'org-cycle
  794. :type 'boolean)
  795. (defcustom org-cycle-global-at-bob nil
  796. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  797. This makes it possible to do global cycling without having to use S-TAB or
  798. \\[universal-argument] TAB. For this special case to work, the first line \
  799. of the buffer
  800. must not be a headline - it may be empty or some other text. When used in
  801. this way, `org-cycle-hook' is disables temporarily, to make sure the
  802. cursor stays at the beginning of the buffer.
  803. When this option is nil, don't do anything special at the beginning
  804. of the buffer."
  805. :group 'org-cycle
  806. :type 'boolean)
  807. (defcustom org-cycle-level-after-item/entry-creation t
  808. "Non-nil means cycle entry level or item indentation in new empty entries.
  809. When the cursor is at the end of an empty headline, i.e with only stars
  810. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  811. and then all possible ancestor states, before returning to the original state.
  812. This makes data entry extremely fast: M-RET to create a new headline,
  813. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  814. When the cursor is at the end of an empty plain list item, one TAB will
  815. make it a subitem, two or more tabs will back up to make this an item
  816. higher up in the item hierarchy."
  817. :group 'org-cycle
  818. :type 'boolean)
  819. (defcustom org-cycle-emulate-tab t
  820. "Where should `org-cycle' emulate TAB.
  821. nil Never
  822. white Only in completely white lines
  823. whitestart Only at the beginning of lines, before the first non-white char
  824. t Everywhere except in headlines
  825. exc-hl-bol Everywhere except at the start of a headline
  826. If TAB is used in a place where it does not emulate TAB, the current subtree
  827. visibility is cycled."
  828. :group 'org-cycle
  829. :type '(choice (const :tag "Never" nil)
  830. (const :tag "Only in completely white lines" white)
  831. (const :tag "Before first char in a line" whitestart)
  832. (const :tag "Everywhere except in headlines" t)
  833. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  834. ))
  835. (defcustom org-cycle-separator-lines 2
  836. "Number of empty lines needed to keep an empty line between collapsed trees.
  837. If you leave an empty line between the end of a subtree and the following
  838. headline, this empty line is hidden when the subtree is folded.
  839. Org-mode will leave (exactly) one empty line visible if the number of
  840. empty lines is equal or larger to the number given in this variable.
  841. So the default 2 means at least 2 empty lines after the end of a subtree
  842. are needed to produce free space between a collapsed subtree and the
  843. following headline.
  844. If the number is negative, and the number of empty lines is at least -N,
  845. all empty lines are shown.
  846. Special case: when 0, never leave empty lines in collapsed view."
  847. :group 'org-cycle
  848. :type 'integer)
  849. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  850. (defcustom org-pre-cycle-hook nil
  851. "Hook that is run before visibility cycling is happening.
  852. The function(s) in this hook must accept a single argument which indicates
  853. the new state that will be set right after running this hook. The
  854. argument is a symbol. Before a global state change, it can have the values
  855. `overview', `content', or `all'. Before a local state change, it can have
  856. the values `folded', `children', or `subtree'."
  857. :group 'org-cycle
  858. :type 'hook)
  859. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  860. org-cycle-hide-drawers
  861. org-cycle-show-empty-lines
  862. org-optimize-window-after-visibility-change)
  863. "Hook that is run after `org-cycle' has changed the buffer visibility.
  864. The function(s) in this hook must accept a single argument which indicates
  865. the new state that was set by the most recent `org-cycle' command. The
  866. argument is a symbol. After a global state change, it can have the values
  867. `overview', `contents', or `all'. After a local state change, it can have
  868. the values `folded', `children', or `subtree'."
  869. :group 'org-cycle
  870. :type 'hook)
  871. (defgroup org-edit-structure nil
  872. "Options concerning structure editing in Org-mode."
  873. :tag "Org Edit Structure"
  874. :group 'org-structure)
  875. (defcustom org-odd-levels-only nil
  876. "Non-nil means skip even levels and only use odd levels for the outline.
  877. This has the effect that two stars are being added/taken away in
  878. promotion/demotion commands. It also influences how levels are
  879. handled by the exporters.
  880. Changing it requires restart of `font-lock-mode' to become effective
  881. for fontification also in regions already fontified.
  882. You may also set this on a per-file basis by adding one of the following
  883. lines to the buffer:
  884. #+STARTUP: odd
  885. #+STARTUP: oddeven"
  886. :group 'org-edit-structure
  887. :group 'org-appearance
  888. :type 'boolean)
  889. (defcustom org-adapt-indentation t
  890. "Non-nil means adapt indentation to outline node level.
  891. When this variable is set, Org assumes that you write outlines by
  892. indenting text in each node to align with the headline (after the stars).
  893. The following issues are influenced by this variable:
  894. - When this is set and the *entire* text in an entry is indented, the
  895. indentation is increased by one space in a demotion command, and
  896. decreased by one in a promotion command. If any line in the entry
  897. body starts with text at column 0, indentation is not changed at all.
  898. - Property drawers and planning information is inserted indented when
  899. this variable s set. When nil, they will not be indented.
  900. - TAB indents a line relative to context. The lines below a headline
  901. will be indented when this variable is set.
  902. Note that this is all about true indentation, by adding and removing
  903. space characters. See also `org-indent.el' which does level-dependent
  904. indentation in a virtual way, i.e. at display time in Emacs."
  905. :group 'org-edit-structure
  906. :type 'boolean)
  907. (defcustom org-special-ctrl-a/e nil
  908. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  909. When t, `C-a' will bring back the cursor to the beginning of the
  910. headline text, i.e. after the stars and after a possible TODO
  911. keyword. In an item, this will be the position after bullet and
  912. check-box, if any. When the cursor is already at that position,
  913. another `C-a' will bring it to the beginning of the line.
  914. `C-e' will jump to the end of the headline, ignoring the presence
  915. of tags in the headline. A second `C-e' will then jump to the
  916. true end of the line, after any tags. This also means that, when
  917. this variable is non-nil, `C-e' also will never jump beyond the
  918. end of the heading of a folded section, i.e. not after the
  919. ellipses.
  920. When set to the symbol `reversed', the first `C-a' or `C-e' works
  921. normally, going to the true line boundary first. Only a directly
  922. following, identical keypress will bring the cursor to the
  923. special positions.
  924. This may also be a cons cell where the behavior for `C-a' and
  925. `C-e' is set separately."
  926. :group 'org-edit-structure
  927. :type '(choice
  928. (const :tag "off" nil)
  929. (const :tag "on: after stars/bullet and before tags first" t)
  930. (const :tag "reversed: true line boundary first" reversed)
  931. (cons :tag "Set C-a and C-e separately"
  932. (choice :tag "Special C-a"
  933. (const :tag "off" nil)
  934. (const :tag "on: after stars/bullet first" t)
  935. (const :tag "reversed: before stars/bullet first" reversed))
  936. (choice :tag "Special C-e"
  937. (const :tag "off" nil)
  938. (const :tag "on: before tags first" t)
  939. (const :tag "reversed: after tags first" reversed)))))
  940. (if (fboundp 'defvaralias)
  941. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  942. (defcustom org-special-ctrl-k nil
  943. "Non-nil means `C-k' will behave specially in headlines.
  944. When nil, `C-k' will call the default `kill-line' command.
  945. When t, the following will happen while the cursor is in the headline:
  946. - When the cursor is at the beginning of a headline, kill the entire
  947. line and possible the folded subtree below the line.
  948. - When in the middle of the headline text, kill the headline up to the tags.
  949. - When after the headline text, kill the tags."
  950. :group 'org-edit-structure
  951. :type 'boolean)
  952. (defcustom org-ctrl-k-protect-subtree nil
  953. "Non-nil means, do not delete a hidden subtree with C-k.
  954. When set to the symbol `error', simply throw an error when C-k is
  955. used to kill (part-of) a headline that has hidden text behind it.
  956. Any other non-nil value will result in a query to the user, if it is
  957. OK to kill that hidden subtree. When nil, kill without remorse."
  958. :group 'org-edit-structure
  959. :version "24.1"
  960. :type '(choice
  961. (const :tag "Do not protect hidden subtrees" nil)
  962. (const :tag "Protect hidden subtrees with a security query" t)
  963. (const :tag "Never kill a hidden subtree with C-k" error)))
  964. (defcustom org-catch-invisible-edits nil
  965. "Check if in invisible region before inserting or deleting a character.
  966. Valid values are:
  967. nil Do not check, so just do invisible edits.
  968. error Throw an error and do nothing.
  969. show Make point visible, and do the requested edit.
  970. show-and-error Make point visible, then throw an error and abort the edit.
  971. smart Make point visible, and do insertion/deletion if it is
  972. adjacent to visible text and the change feels predictable.
  973. Never delete a previously invisible character or add in the
  974. middle or right after an invisible region. Basically, this
  975. allows insertion and backward-delete right before ellipses.
  976. FIXME: maybe in this case we should not even show?"
  977. :group 'org-edit-structure
  978. :version "24.1"
  979. :type '(choice
  980. (const :tag "Do not check" nil)
  981. (const :tag "Throw error when trying to edit" error)
  982. (const :tag "Unhide, but do not do the edit" show-and-error)
  983. (const :tag "Show invisible part and do the edit" show)
  984. (const :tag "Be smart and do the right thing" smart)))
  985. (defcustom org-yank-folded-subtrees t
  986. "Non-nil means when yanking subtrees, fold them.
  987. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  988. it starts with a heading and all other headings in it are either children
  989. or siblings, then fold all the subtrees. However, do this only if no
  990. text after the yank would be swallowed into a folded tree by this action."
  991. :group 'org-edit-structure
  992. :type 'boolean)
  993. (defcustom org-yank-adjusted-subtrees nil
  994. "Non-nil means when yanking subtrees, adjust the level.
  995. With this setting, `org-paste-subtree' is used to insert the subtree, see
  996. this function for details."
  997. :group 'org-edit-structure
  998. :type 'boolean)
  999. (defcustom org-M-RET-may-split-line '((default . t))
  1000. "Non-nil means M-RET will split the line at the cursor position.
  1001. When nil, it will go to the end of the line before making a
  1002. new line.
  1003. You may also set this option in a different way for different
  1004. contexts. Valid contexts are:
  1005. headline when creating a new headline
  1006. item when creating a new item
  1007. table in a table field
  1008. default the value to be used for all contexts not explicitly
  1009. customized"
  1010. :group 'org-structure
  1011. :group 'org-table
  1012. :type '(choice
  1013. (const :tag "Always" t)
  1014. (const :tag "Never" nil)
  1015. (repeat :greedy t :tag "Individual contexts"
  1016. (cons
  1017. (choice :tag "Context"
  1018. (const headline)
  1019. (const item)
  1020. (const table)
  1021. (const default))
  1022. (boolean)))))
  1023. (defcustom org-insert-heading-respect-content nil
  1024. "Non-nil means insert new headings after the current subtree.
  1025. When nil, the new heading is created directly after the current line.
  1026. The commands \\[org-insert-heading-respect-content] and
  1027. \\[org-insert-todo-heading-respect-content] turn this variable on
  1028. for the duration of the command."
  1029. :group 'org-structure
  1030. :type 'boolean)
  1031. (defcustom org-blank-before-new-entry '((heading . auto)
  1032. (plain-list-item . auto))
  1033. "Should `org-insert-heading' leave a blank line before new heading/item?
  1034. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1035. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1036. which case Org will look at the surrounding headings/items and try to
  1037. make an intelligent decision whether to insert a blank line or not.
  1038. For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
  1039. set, the setting here is ignored and no empty line is inserted, to avoid
  1040. breaking the list structure."
  1041. :group 'org-edit-structure
  1042. :type '(list
  1043. (cons (const heading)
  1044. (choice (const :tag "Never" nil)
  1045. (const :tag "Always" t)
  1046. (const :tag "Auto" auto)))
  1047. (cons (const plain-list-item)
  1048. (choice (const :tag "Never" nil)
  1049. (const :tag "Always" t)
  1050. (const :tag "Auto" auto)))))
  1051. (defcustom org-insert-heading-hook nil
  1052. "Hook being run after inserting a new heading."
  1053. :group 'org-edit-structure
  1054. :type 'hook)
  1055. (defcustom org-enable-fixed-width-editor t
  1056. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1057. This currently only means they are never auto-wrapped.
  1058. When nil, such lines will be treated like ordinary lines.
  1059. See also the QUOTE keyword."
  1060. :group 'org-edit-structure
  1061. :type 'boolean)
  1062. (defcustom org-goto-auto-isearch t
  1063. "Non-nil means typing characters in `org-goto' starts incremental search."
  1064. :group 'org-edit-structure
  1065. :type 'boolean)
  1066. (defgroup org-sparse-trees nil
  1067. "Options concerning sparse trees in Org-mode."
  1068. :tag "Org Sparse Trees"
  1069. :group 'org-structure)
  1070. (defcustom org-highlight-sparse-tree-matches t
  1071. "Non-nil means highlight all matches that define a sparse tree.
  1072. The highlights will automatically disappear the next time the buffer is
  1073. changed by an edit command."
  1074. :group 'org-sparse-trees
  1075. :type 'boolean)
  1076. (defcustom org-remove-highlights-with-change t
  1077. "Non-nil means any change to the buffer will remove temporary highlights.
  1078. Such highlights are created by `org-occur' and `org-clock-display'.
  1079. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1080. The highlights created by `org-preview-latex-fragment' always need
  1081. `C-c C-c' to be removed."
  1082. :group 'org-sparse-trees
  1083. :group 'org-time
  1084. :type 'boolean)
  1085. (defcustom org-occur-hook '(org-first-headline-recenter)
  1086. "Hook that is run after `org-occur' has constructed a sparse tree.
  1087. This can be used to recenter the window to show as much of the structure
  1088. as possible."
  1089. :group 'org-sparse-trees
  1090. :type 'hook)
  1091. (defgroup org-imenu-and-speedbar nil
  1092. "Options concerning imenu and speedbar in Org-mode."
  1093. :tag "Org Imenu and Speedbar"
  1094. :group 'org-structure)
  1095. (defcustom org-imenu-depth 2
  1096. "The maximum level for Imenu access to Org-mode headlines.
  1097. This also applied for speedbar access."
  1098. :group 'org-imenu-and-speedbar
  1099. :type 'integer)
  1100. (defgroup org-table nil
  1101. "Options concerning tables in Org-mode."
  1102. :tag "Org Table"
  1103. :group 'org)
  1104. (defcustom org-enable-table-editor 'optimized
  1105. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1106. When nil, such lines will be treated like ordinary lines.
  1107. When equal to the symbol `optimized', the table editor will be optimized to
  1108. do the following:
  1109. - Automatic overwrite mode in front of whitespace in table fields.
  1110. This makes the structure of the table stay in tact as long as the edited
  1111. field does not exceed the column width.
  1112. - Minimize the number of realigns. Normally, the table is aligned each time
  1113. TAB or RET are pressed to move to another field. With optimization this
  1114. happens only if changes to a field might have changed the column width.
  1115. Optimization requires replacing the functions `self-insert-command',
  1116. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1117. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1118. very good at guessing when a re-align will be necessary, but you can always
  1119. force one with \\[org-ctrl-c-ctrl-c].
  1120. If you would like to use the optimized version in Org-mode, but the
  1121. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1122. This variable can be used to turn on and off the table editor during a session,
  1123. but in order to toggle optimization, a restart is required.
  1124. See also the variable `org-table-auto-blank-field'."
  1125. :group 'org-table
  1126. :type '(choice
  1127. (const :tag "off" nil)
  1128. (const :tag "on" t)
  1129. (const :tag "on, optimized" optimized)))
  1130. (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
  1131. (version<= emacs-version "24.1"))
  1132. "Non-nil means cluster self-insert commands for undo when possible.
  1133. If this is set, then, like in the Emacs command loop, 20 consecutive
  1134. characters will be undone together.
  1135. This is configurable, because there is some impact on typing performance."
  1136. :group 'org-table
  1137. :type 'boolean)
  1138. (defcustom org-table-tab-recognizes-table.el t
  1139. "Non-nil means TAB will automatically notice a table.el table.
  1140. When it sees such a table, it moves point into it and - if necessary -
  1141. calls `table-recognize-table'."
  1142. :group 'org-table-editing
  1143. :type 'boolean)
  1144. (defgroup org-link nil
  1145. "Options concerning links in Org-mode."
  1146. :tag "Org Link"
  1147. :group 'org)
  1148. (defvar org-link-abbrev-alist-local nil
  1149. "Buffer-local version of `org-link-abbrev-alist', which see.
  1150. The value of this is taken from the #+LINK lines.")
  1151. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1152. (defcustom org-link-abbrev-alist nil
  1153. "Alist of link abbreviations.
  1154. The car of each element is a string, to be replaced at the start of a link.
  1155. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1156. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1157. [[linkkey:tag][description]]
  1158. The 'linkkey' must be a word word, starting with a letter, followed
  1159. by letters, numbers, '-' or '_'.
  1160. If REPLACE is a string, the tag will simply be appended to create the link.
  1161. If the string contains \"%s\", the tag will be inserted there. If the string
  1162. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1163. at that point (see the function `url-hexify-string'). If the string contains
  1164. the specifier \"%(my-function)\", then the custom function `my-function' will
  1165. be invoked: this function takes the tag as its only argument and must return
  1166. a string.
  1167. REPLACE may also be a function that will be called with the tag as the
  1168. only argument to create the link, which should be returned as a string.
  1169. See the manual for examples."
  1170. :group 'org-link
  1171. :type '(repeat
  1172. (cons
  1173. (string :tag "Protocol")
  1174. (choice
  1175. (string :tag "Format")
  1176. (function)))))
  1177. (defcustom org-descriptive-links t
  1178. "Non-nil means Org will display descriptive links.
  1179. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1180. \"Org Website\", hiding the link itself and just displaying its
  1181. description. When set to `nil', Org will display the full links
  1182. literally.
  1183. You can interactively set the value of this variable by calling
  1184. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1185. :group 'org-link
  1186. :type 'boolean)
  1187. (defcustom org-link-file-path-type 'adaptive
  1188. "How the path name in file links should be stored.
  1189. Valid values are:
  1190. relative Relative to the current directory, i.e. the directory of the file
  1191. into which the link is being inserted.
  1192. absolute Absolute path, if possible with ~ for home directory.
  1193. noabbrev Absolute path, no abbreviation of home directory.
  1194. adaptive Use relative path for files in the current directory and sub-
  1195. directories of it. For other files, use an absolute path."
  1196. :group 'org-link
  1197. :type '(choice
  1198. (const relative)
  1199. (const absolute)
  1200. (const noabbrev)
  1201. (const adaptive)))
  1202. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1203. "Types of links that should be activated in Org-mode files.
  1204. This is a list of symbols, each leading to the activation of a certain link
  1205. type. In principle, it does not hurt to turn on most link types - there may
  1206. be a small gain when turning off unused link types. The types are:
  1207. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1208. angle Links in angular brackets that may contain whitespace like
  1209. <bbdb:Carsten Dominik>.
  1210. plain Plain links in normal text, no whitespace, like http://google.com.
  1211. radio Text that is matched by a radio target, see manual for details.
  1212. tag Tag settings in a headline (link to tag search).
  1213. date Time stamps (link to calendar).
  1214. footnote Footnote labels.
  1215. Changing this variable requires a restart of Emacs to become effective."
  1216. :group 'org-link
  1217. :type '(set :greedy t
  1218. (const :tag "Double bracket links" bracket)
  1219. (const :tag "Angular bracket links" angle)
  1220. (const :tag "Plain text links" plain)
  1221. (const :tag "Radio target matches" radio)
  1222. (const :tag "Tags" tag)
  1223. (const :tag "Timestamps" date)
  1224. (const :tag "Footnotes" footnote)))
  1225. (defcustom org-make-link-description-function nil
  1226. "Function to use to generate link descriptions from links.
  1227. If nil the link location will be used. This function must take
  1228. two parameters; the first is the link and the second the
  1229. description `org-insert-link' has generated, and should return the
  1230. description to use."
  1231. :group 'org-link
  1232. :type 'function)
  1233. (defgroup org-link-store nil
  1234. "Options concerning storing links in Org-mode."
  1235. :tag "Org Store Link"
  1236. :group 'org-link)
  1237. (defcustom org-url-hexify-p t
  1238. "When non-nil, hexify URL when creating a link."
  1239. :type 'boolean
  1240. ;; :version "24.3"
  1241. :group 'org-link-store)
  1242. (defcustom org-email-link-description-format "Email %c: %.30s"
  1243. "Format of the description part of a link to an email or usenet message.
  1244. The following %-escapes will be replaced by corresponding information:
  1245. %F full \"From\" field
  1246. %f name, taken from \"From\" field, address if no name
  1247. %T full \"To\" field
  1248. %t first name in \"To\" field, address if no name
  1249. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1250. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1251. %s subject
  1252. %d date
  1253. %m message-id.
  1254. You may use normal field width specification between the % and the letter.
  1255. This is for example useful to limit the length of the subject.
  1256. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1257. :group 'org-link-store
  1258. :type 'string)
  1259. (defcustom org-from-is-user-regexp
  1260. (let (r1 r2)
  1261. (when (and user-mail-address (not (string= user-mail-address "")))
  1262. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1263. (when (and user-full-name (not (string= user-full-name "")))
  1264. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1265. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1266. "Regexp matched against the \"From:\" header of an email or usenet message.
  1267. It should match if the message is from the user him/herself."
  1268. :group 'org-link-store
  1269. :type 'regexp)
  1270. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1271. "Non-nil means storing a link to an Org file will use entry IDs.
  1272. Note that before this variable is even considered, org-id must be loaded,
  1273. so please customize `org-modules' and turn it on.
  1274. The variable can have the following values:
  1275. t Create an ID if needed to make a link to the current entry.
  1276. create-if-interactive
  1277. If `org-store-link' is called directly (interactively, as a user
  1278. command), do create an ID to support the link. But when doing the
  1279. job for capture, only use the ID if it already exists. The
  1280. purpose of this setting is to avoid proliferation of unwanted
  1281. IDs, just because you happen to be in an Org file when you
  1282. call `org-capture' that automatically and preemptively creates a
  1283. link. If you do want to get an ID link in a capture template to
  1284. an entry not having an ID, create it first by explicitly creating
  1285. a link to it, using `C-c C-l' first.
  1286. create-if-interactive-and-no-custom-id
  1287. Like create-if-interactive, but do not create an ID if there is
  1288. a CUSTOM_ID property defined in the entry. This is the default.
  1289. use-existing
  1290. Use existing ID, do not create one.
  1291. nil Never use an ID to make a link, instead link using a text search for
  1292. the headline text."
  1293. :group 'org-link-store
  1294. :type '(choice
  1295. (const :tag "Create ID to make link" t)
  1296. (const :tag "Create if storing link interactively"
  1297. create-if-interactive)
  1298. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1299. create-if-interactive-and-no-custom-id)
  1300. (const :tag "Only use existing" use-existing)
  1301. (const :tag "Do not use ID to create link" nil)))
  1302. (defcustom org-context-in-file-links t
  1303. "Non-nil means file links from `org-store-link' contain context.
  1304. A search string will be added to the file name with :: as separator and
  1305. used to find the context when the link is activated by the command
  1306. `org-open-at-point'. When this option is t, the entire active region
  1307. will be placed in the search string of the file link. If set to a
  1308. positive integer, only the first n lines of context will be stored.
  1309. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1310. negates this setting for the duration of the command."
  1311. :group 'org-link-store
  1312. :type '(choice boolean integer))
  1313. (defcustom org-keep-stored-link-after-insertion nil
  1314. "Non-nil means keep link in list for entire session.
  1315. The command `org-store-link' adds a link pointing to the current
  1316. location to an internal list. These links accumulate during a session.
  1317. The command `org-insert-link' can be used to insert links into any
  1318. Org-mode file (offering completion for all stored links). When this
  1319. option is nil, every link which has been inserted once using \\[org-insert-link]
  1320. will be removed from the list, to make completing the unused links
  1321. more efficient."
  1322. :group 'org-link-store
  1323. :type 'boolean)
  1324. (defgroup org-link-follow nil
  1325. "Options concerning following links in Org-mode."
  1326. :tag "Org Follow Link"
  1327. :group 'org-link)
  1328. (defcustom org-link-translation-function nil
  1329. "Function to translate links with different syntax to Org syntax.
  1330. This can be used to translate links created for example by the Planner
  1331. or emacs-wiki packages to Org syntax.
  1332. The function must accept two parameters, a TYPE containing the link
  1333. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1334. which is everything after the link protocol. It should return a cons
  1335. with possibly modified values of type and path.
  1336. Org contains a function for this, so if you set this variable to
  1337. `org-translate-link-from-planner', you should be able follow many
  1338. links created by planner."
  1339. :group 'org-link-follow
  1340. :type 'function)
  1341. (defcustom org-follow-link-hook nil
  1342. "Hook that is run after a link has been followed."
  1343. :group 'org-link-follow
  1344. :type 'hook)
  1345. (defcustom org-tab-follows-link nil
  1346. "Non-nil means on links TAB will follow the link.
  1347. Needs to be set before org.el is loaded.
  1348. This really should not be used, it does not make sense, and the
  1349. implementation is bad."
  1350. :group 'org-link-follow
  1351. :type 'boolean)
  1352. (defcustom org-return-follows-link nil
  1353. "Non-nil means on links RET will follow the link."
  1354. :group 'org-link-follow
  1355. :type 'boolean)
  1356. (defcustom org-mouse-1-follows-link
  1357. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1358. "Non-nil means mouse-1 on a link will follow the link.
  1359. A longer mouse click will still set point. Does not work on XEmacs.
  1360. Needs to be set before org.el is loaded."
  1361. :group 'org-link-follow
  1362. :type 'boolean)
  1363. (defcustom org-mark-ring-length 4
  1364. "Number of different positions to be recorded in the ring.
  1365. Changing this requires a restart of Emacs to work correctly."
  1366. :group 'org-link-follow
  1367. :type 'integer)
  1368. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1369. "Non-nil means internal links in Org files must exactly match a headline.
  1370. When nil, the link search tries to match a phrase with all words
  1371. in the search text."
  1372. :group 'org-link-follow
  1373. :version "24.1"
  1374. :type '(choice
  1375. (const :tag "Use fuzzy text search" nil)
  1376. (const :tag "Match only exact headline" t)
  1377. (const :tag "Match exact headline or query to create it"
  1378. query-to-create)))
  1379. (defcustom org-link-frame-setup
  1380. '((vm . vm-visit-folder-other-frame)
  1381. (vm-imap . vm-visit-imap-folder-other-frame)
  1382. (gnus . org-gnus-no-new-news)
  1383. (file . find-file-other-window)
  1384. (wl . wl-other-frame))
  1385. "Setup the frame configuration for following links.
  1386. When following a link with Emacs, it may often be useful to display
  1387. this link in another window or frame. This variable can be used to
  1388. set this up for the different types of links.
  1389. For VM, use any of
  1390. `vm-visit-folder'
  1391. `vm-visit-folder-other-window'
  1392. `vm-visit-folder-other-frame'
  1393. For Gnus, use any of
  1394. `gnus'
  1395. `gnus-other-frame'
  1396. `org-gnus-no-new-news'
  1397. For FILE, use any of
  1398. `find-file'
  1399. `find-file-other-window'
  1400. `find-file-other-frame'
  1401. For Wanderlust use any of
  1402. `wl'
  1403. `wl-other-frame'
  1404. For the calendar, use the variable `calendar-setup'.
  1405. For BBDB, it is currently only possible to display the matches in
  1406. another window."
  1407. :group 'org-link-follow
  1408. :type '(list
  1409. (cons (const vm)
  1410. (choice
  1411. (const vm-visit-folder)
  1412. (const vm-visit-folder-other-window)
  1413. (const vm-visit-folder-other-frame)))
  1414. (cons (const gnus)
  1415. (choice
  1416. (const gnus)
  1417. (const gnus-other-frame)
  1418. (const org-gnus-no-new-news)))
  1419. (cons (const file)
  1420. (choice
  1421. (const find-file)
  1422. (const find-file-other-window)
  1423. (const find-file-other-frame)))
  1424. (cons (const wl)
  1425. (choice
  1426. (const wl)
  1427. (const wl-other-frame)))))
  1428. (defcustom org-display-internal-link-with-indirect-buffer nil
  1429. "Non-nil means use indirect buffer to display infile links.
  1430. Activating internal links (from one location in a file to another location
  1431. in the same file) normally just jumps to the location. When the link is
  1432. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1433. is displayed in
  1434. another window. When this option is set, the other window actually displays
  1435. an indirect buffer clone of the current buffer, to avoid any visibility
  1436. changes to the current buffer."
  1437. :group 'org-link-follow
  1438. :type 'boolean)
  1439. (defcustom org-open-non-existing-files nil
  1440. "Non-nil means `org-open-file' will open non-existing files.
  1441. When nil, an error will be generated.
  1442. This variable applies only to external applications because they
  1443. might choke on non-existing files. If the link is to a file that
  1444. will be opened in Emacs, the variable is ignored."
  1445. :group 'org-link-follow
  1446. :type 'boolean)
  1447. (defcustom org-open-directory-means-index-dot-org nil
  1448. "Non-nil means a link to a directory really means to index.org.
  1449. When nil, following a directory link will run dired or open a finder/explorer
  1450. window on that directory."
  1451. :group 'org-link-follow
  1452. :type 'boolean)
  1453. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1454. "Function and arguments to call for following mailto links.
  1455. This is a list with the first element being a Lisp function, and the
  1456. remaining elements being arguments to the function. In string arguments,
  1457. %a will be replaced by the address, and %s will be replaced by the subject
  1458. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1459. :group 'org-link-follow
  1460. :type '(choice
  1461. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1462. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1463. (const :tag "message-mail" (message-mail "%a" "%s"))
  1464. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1465. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1466. "Non-nil means ask for confirmation before executing shell links.
  1467. Shell links can be dangerous: just think about a link
  1468. [[shell:rm -rf ~/*][Google Search]]
  1469. This link would show up in your Org-mode document as \"Google Search\",
  1470. but really it would remove your entire home directory.
  1471. Therefore we advise against setting this variable to nil.
  1472. Just change it to `y-or-n-p' if you want to confirm with a
  1473. single keystroke rather than having to type \"yes\"."
  1474. :group 'org-link-follow
  1475. :type '(choice
  1476. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1477. (const :tag "with y-or-n (faster)" y-or-n-p)
  1478. (const :tag "no confirmation (dangerous)" nil)))
  1479. (put 'org-confirm-shell-link-function
  1480. 'safe-local-variable
  1481. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1482. (defcustom org-confirm-shell-link-not-regexp ""
  1483. "A regexp to skip confirmation for shell links."
  1484. :group 'org-link-follow
  1485. :version "24.1"
  1486. :type 'regexp)
  1487. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1488. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1489. Elisp links can be dangerous: just think about a link
  1490. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1491. This link would show up in your Org-mode document as \"Google Search\",
  1492. but really it would remove your entire home directory.
  1493. Therefore we advise against setting this variable to nil.
  1494. Just change it to `y-or-n-p' if you want to confirm with a
  1495. single keystroke rather than having to type \"yes\"."
  1496. :group 'org-link-follow
  1497. :type '(choice
  1498. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1499. (const :tag "with y-or-n (faster)" y-or-n-p)
  1500. (const :tag "no confirmation (dangerous)" nil)))
  1501. (put 'org-confirm-shell-link-function
  1502. 'safe-local-variable
  1503. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1504. (defcustom org-confirm-elisp-link-not-regexp ""
  1505. "A regexp to skip confirmation for Elisp links."
  1506. :group 'org-link-follow
  1507. :version "24.1"
  1508. :type 'regexp)
  1509. (defconst org-file-apps-defaults-gnu
  1510. '((remote . emacs)
  1511. (system . mailcap)
  1512. (t . mailcap))
  1513. "Default file applications on a UNIX or GNU/Linux system.
  1514. See `org-file-apps'.")
  1515. (defconst org-file-apps-defaults-macosx
  1516. '((remote . emacs)
  1517. (t . "open %s")
  1518. (system . "open %s")
  1519. ("ps.gz" . "gv %s")
  1520. ("eps.gz" . "gv %s")
  1521. ("dvi" . "xdvi %s")
  1522. ("fig" . "xfig %s"))
  1523. "Default file applications on a MacOS X system.
  1524. The system \"open\" is known as a default, but we use X11 applications
  1525. for some files for which the OS does not have a good default.
  1526. See `org-file-apps'.")
  1527. (defconst org-file-apps-defaults-windowsnt
  1528. (list
  1529. '(remote . emacs)
  1530. (cons t
  1531. (list (if (featurep 'xemacs)
  1532. 'mswindows-shell-execute
  1533. 'w32-shell-execute)
  1534. "open" 'file))
  1535. (cons 'system
  1536. (list (if (featurep 'xemacs)
  1537. 'mswindows-shell-execute
  1538. 'w32-shell-execute)
  1539. "open" 'file)))
  1540. "Default file applications on a Windows NT system.
  1541. The system \"open\" is used for most files.
  1542. See `org-file-apps'.")
  1543. (defcustom org-file-apps
  1544. '(
  1545. (auto-mode . emacs)
  1546. ("\\.mm\\'" . default)
  1547. ("\\.x?html?\\'" . default)
  1548. ("\\.pdf\\'" . default)
  1549. )
  1550. "External applications for opening `file:path' items in a document.
  1551. Org-mode uses system defaults for different file types, but
  1552. you can use this variable to set the application for a given file
  1553. extension. The entries in this list are cons cells where the car identifies
  1554. files and the cdr the corresponding command. Possible values for the
  1555. file identifier are
  1556. \"string\" A string as a file identifier can be interpreted in different
  1557. ways, depending on its contents:
  1558. - Alphanumeric characters only:
  1559. Match links with this file extension.
  1560. Example: (\"pdf\" . \"evince %s\")
  1561. to open PDFs with evince.
  1562. - Regular expression: Match links where the
  1563. filename matches the regexp. If you want to
  1564. use groups here, use shy groups.
  1565. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1566. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1567. to open *.html and *.xhtml with firefox.
  1568. - Regular expression which contains (non-shy) groups:
  1569. Match links where the whole link, including \"::\", and
  1570. anything after that, matches the regexp.
  1571. In a custom command string, %1, %2, etc. are replaced with
  1572. the parts of the link that were matched by the groups.
  1573. For backwards compatibility, if a command string is given
  1574. that does not use any of the group matches, this case is
  1575. handled identically to the second one (i.e. match against
  1576. file name only).
  1577. In a custom lisp form, you can access the group matches with
  1578. (match-string n link).
  1579. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1580. to open [[file:document.pdf::5]] with evince at page 5.
  1581. `directory' Matches a directory
  1582. `remote' Matches a remote file, accessible through tramp or efs.
  1583. Remote files most likely should be visited through Emacs
  1584. because external applications cannot handle such paths.
  1585. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1586. so all files Emacs knows how to handle. Using this with
  1587. command `emacs' will open most files in Emacs. Beware that this
  1588. will also open html files inside Emacs, unless you add
  1589. (\"html\" . default) to the list as well.
  1590. t Default for files not matched by any of the other options.
  1591. `system' The system command to open files, like `open' on Windows
  1592. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1593. that will be selected if you call `C-c C-o' with a double
  1594. \\[universal-argument] \\[universal-argument] prefix.
  1595. Possible values for the command are:
  1596. `emacs' The file will be visited by the current Emacs process.
  1597. `default' Use the default application for this file type, which is the
  1598. association for t in the list, most likely in the system-specific
  1599. part.
  1600. This can be used to overrule an unwanted setting in the
  1601. system-specific variable.
  1602. `system' Use the system command for opening files, like \"open\".
  1603. This command is specified by the entry whose car is `system'.
  1604. Most likely, the system-specific version of this variable
  1605. does define this command, but you can overrule/replace it
  1606. here.
  1607. string A command to be executed by a shell; %s will be replaced
  1608. by the path to the file.
  1609. sexp A Lisp form which will be evaluated. The file path will
  1610. be available in the Lisp variable `file'.
  1611. For more examples, see the system specific constants
  1612. `org-file-apps-defaults-macosx'
  1613. `org-file-apps-defaults-windowsnt'
  1614. `org-file-apps-defaults-gnu'."
  1615. :group 'org-link-follow
  1616. :type '(repeat
  1617. (cons (choice :value ""
  1618. (string :tag "Extension")
  1619. (const :tag "System command to open files" system)
  1620. (const :tag "Default for unrecognized files" t)
  1621. (const :tag "Remote file" remote)
  1622. (const :tag "Links to a directory" directory)
  1623. (const :tag "Any files that have Emacs modes"
  1624. auto-mode))
  1625. (choice :value ""
  1626. (const :tag "Visit with Emacs" emacs)
  1627. (const :tag "Use default" default)
  1628. (const :tag "Use the system command" system)
  1629. (string :tag "Command")
  1630. (sexp :tag "Lisp form")))))
  1631. (defcustom org-doi-server-url "http://dx.doi.org/"
  1632. "The URL of the DOI server."
  1633. :type 'string
  1634. ;; :version "24.3"
  1635. :group 'org-link-follow)
  1636. (defgroup org-refile nil
  1637. "Options concerning refiling entries in Org-mode."
  1638. :tag "Org Refile"
  1639. :group 'org)
  1640. (defcustom org-directory "~/org"
  1641. "Directory with org files.
  1642. This is just a default location to look for Org files. There is no need
  1643. at all to put your files into this directory. It is only used in the
  1644. following situations:
  1645. 1. When a capture template specifies a target file that is not an
  1646. absolute path. The path will then be interpreted relative to
  1647. `org-directory'
  1648. 2. When a capture note is filed away in an interactive way (when exiting the
  1649. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1650. with `org-directory' as the default path."
  1651. :group 'org-refile
  1652. :group 'org-remember
  1653. :group 'org-capture
  1654. :type 'directory)
  1655. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1656. "Default target for storing notes.
  1657. Used as a fall back file for org-remember.el and org-capture.el, for
  1658. templates that do not specify a target file."
  1659. :group 'org-refile
  1660. :group 'org-remember
  1661. :group 'org-capture
  1662. :type '(choice
  1663. (const :tag "Default from remember-data-file" nil)
  1664. file))
  1665. (defcustom org-goto-interface 'outline
  1666. "The default interface to be used for `org-goto'.
  1667. Allowed values are:
  1668. outline The interface shows an outline of the relevant file
  1669. and the correct heading is found by moving through
  1670. the outline or by searching with incremental search.
  1671. outline-path-completion Headlines in the current buffer are offered via
  1672. completion. This is the interface also used by
  1673. the refile command."
  1674. :group 'org-refile
  1675. :type '(choice
  1676. (const :tag "Outline" outline)
  1677. (const :tag "Outline-path-completion" outline-path-completion)))
  1678. (defcustom org-goto-max-level 5
  1679. "Maximum target level when running `org-goto' with refile interface."
  1680. :group 'org-refile
  1681. :type 'integer)
  1682. (defcustom org-reverse-note-order nil
  1683. "Non-nil means store new notes at the beginning of a file or entry.
  1684. When nil, new notes will be filed to the end of a file or entry.
  1685. This can also be a list with cons cells of regular expressions that
  1686. are matched against file names, and values."
  1687. :group 'org-remember
  1688. :group 'org-capture
  1689. :group 'org-refile
  1690. :type '(choice
  1691. (const :tag "Reverse always" t)
  1692. (const :tag "Reverse never" nil)
  1693. (repeat :tag "By file name regexp"
  1694. (cons regexp boolean))))
  1695. (defcustom org-log-refile nil
  1696. "Information to record when a task is refiled.
  1697. Possible values are:
  1698. nil Don't add anything
  1699. time Add a time stamp to the task
  1700. note Prompt for a note and add it with template `org-log-note-headings'
  1701. This option can also be set with on a per-file-basis with
  1702. #+STARTUP: nologrefile
  1703. #+STARTUP: logrefile
  1704. #+STARTUP: lognoterefile
  1705. You can have local logging settings for a subtree by setting the LOGGING
  1706. property to one or more of these keywords.
  1707. When bulk-refiling from the agenda, the value `note' is forbidden and
  1708. will temporarily be changed to `time'."
  1709. :group 'org-refile
  1710. :group 'org-progress
  1711. :version "24.1"
  1712. :type '(choice
  1713. (const :tag "No logging" nil)
  1714. (const :tag "Record timestamp" time)
  1715. (const :tag "Record timestamp with note." note)))
  1716. (defcustom org-refile-targets nil
  1717. "Targets for refiling entries with \\[org-refile].
  1718. This is a list of cons cells. Each cell contains:
  1719. - a specification of the files to be considered, either a list of files,
  1720. or a symbol whose function or variable value will be used to retrieve
  1721. a file name or a list of file names. If you use `org-agenda-files' for
  1722. that, all agenda files will be scanned for targets. Nil means consider
  1723. headings in the current buffer.
  1724. - A specification of how to find candidate refile targets. This may be
  1725. any of:
  1726. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1727. This tag has to be present in all target headlines, inheritance will
  1728. not be considered.
  1729. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1730. todo keyword.
  1731. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1732. headlines that are refiling targets.
  1733. - a cons cell (:level . N). Any headline of level N is considered a target.
  1734. Note that, when `org-odd-levels-only' is set, level corresponds to
  1735. order in hierarchy, not to the number of stars.
  1736. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1737. Note that, when `org-odd-levels-only' is set, level corresponds to
  1738. order in hierarchy, not to the number of stars.
  1739. Each element of this list generates a set of possible targets.
  1740. The union of these sets is presented (with completion) to
  1741. the user by `org-refile'.
  1742. You can set the variable `org-refile-target-verify-function' to a function
  1743. to verify each headline found by the simple criteria above.
  1744. When this variable is nil, all top-level headlines in the current buffer
  1745. are used, equivalent to the value `((nil . (:level . 1))'."
  1746. :group 'org-refile
  1747. :type '(repeat
  1748. (cons
  1749. (choice :value org-agenda-files
  1750. (const :tag "All agenda files" org-agenda-files)
  1751. (const :tag "Current buffer" nil)
  1752. (function) (variable) (file))
  1753. (choice :tag "Identify target headline by"
  1754. (cons :tag "Specific tag" (const :value :tag) (string))
  1755. (cons :tag "TODO keyword" (const :value :todo) (string))
  1756. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1757. (cons :tag "Level number" (const :value :level) (integer))
  1758. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1759. (defcustom org-refile-target-verify-function nil
  1760. "Function to verify if the headline at point should be a refile target.
  1761. The function will be called without arguments, with point at the
  1762. beginning of the headline. It should return t and leave point
  1763. where it is if the headline is a valid target for refiling.
  1764. If the target should not be selected, the function must return nil.
  1765. In addition to this, it may move point to a place from where the search
  1766. should be continued. For example, the function may decide that the entire
  1767. subtree of the current entry should be excluded and move point to the end
  1768. of the subtree."
  1769. :group 'org-refile
  1770. :type 'function)
  1771. (defcustom org-refile-use-cache nil
  1772. "Non-nil means cache refile targets to speed up the process.
  1773. The cache for a particular file will be updated automatically when
  1774. the buffer has been killed, or when any of the marker used for flagging
  1775. refile targets no longer points at a live buffer.
  1776. If you have added new entries to a buffer that might themselves be targets,
  1777. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1778. find that easier, `C-u C-u C-u C-c C-w'."
  1779. :group 'org-refile
  1780. :version "24.1"
  1781. :type 'boolean)
  1782. (defcustom org-refile-use-outline-path nil
  1783. "Non-nil means provide refile targets as paths.
  1784. So a level 3 headline will be available as level1/level2/level3.
  1785. When the value is `file', also include the file name (without directory)
  1786. into the path. In this case, you can also stop the completion after
  1787. the file name, to get entries inserted as top level in the file.
  1788. When `full-file-path', include the full file path."
  1789. :group 'org-refile
  1790. :type '(choice
  1791. (const :tag "Not" nil)
  1792. (const :tag "Yes" t)
  1793. (const :tag "Start with file name" file)
  1794. (const :tag "Start with full file path" full-file-path)))
  1795. (defcustom org-outline-path-complete-in-steps t
  1796. "Non-nil means complete the outline path in hierarchical steps.
  1797. When Org-mode uses the refile interface to select an outline path
  1798. \(see variable `org-refile-use-outline-path'), the completion of
  1799. the path can be done is a single go, or if can be done in steps down
  1800. the headline hierarchy. Going in steps is probably the best if you
  1801. do not use a special completion package like `ido' or `icicles'.
  1802. However, when using these packages, going in one step can be very
  1803. fast, while still showing the whole path to the entry."
  1804. :group 'org-refile
  1805. :type 'boolean)
  1806. (defcustom org-refile-allow-creating-parent-nodes nil
  1807. "Non-nil means allow to create new nodes as refile targets.
  1808. New nodes are then created by adding \"/new node name\" to the completion
  1809. of an existing node. When the value of this variable is `confirm',
  1810. new node creation must be confirmed by the user (recommended)
  1811. When nil, the completion must match an existing entry.
  1812. Note that, if the new heading is not seen by the criteria
  1813. listed in `org-refile-targets', multiple instances of the same
  1814. heading would be created by trying again to file under the new
  1815. heading."
  1816. :group 'org-refile
  1817. :type '(choice
  1818. (const :tag "Never" nil)
  1819. (const :tag "Always" t)
  1820. (const :tag "Prompt for confirmation" confirm)))
  1821. (defcustom org-refile-active-region-within-subtree nil
  1822. "Non-nil means also refile active region within a subtree.
  1823. By default `org-refile' doesn't allow refiling regions if they
  1824. don't contain a set of subtrees, but it might be convenient to
  1825. do so sometimes: in that case, the first line of the region is
  1826. converted to a headline before refiling."
  1827. :group 'org-refile
  1828. :version "24.1"
  1829. :type 'boolean)
  1830. (defgroup org-todo nil
  1831. "Options concerning TODO items in Org-mode."
  1832. :tag "Org TODO"
  1833. :group 'org)
  1834. (defgroup org-progress nil
  1835. "Options concerning Progress logging in Org-mode."
  1836. :tag "Org Progress"
  1837. :group 'org-time)
  1838. (defvar org-todo-interpretation-widgets
  1839. '((:tag "Sequence (cycling hits every state)" sequence)
  1840. (:tag "Type (cycling directly to DONE)" type))
  1841. "The available interpretation symbols for customizing `org-todo-keywords'.
  1842. Interested libraries should add to this list.")
  1843. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1844. "List of TODO entry keyword sequences and their interpretation.
  1845. \\<org-mode-map>This is a list of sequences.
  1846. Each sequence starts with a symbol, either `sequence' or `type',
  1847. indicating if the keywords should be interpreted as a sequence of
  1848. action steps, or as different types of TODO items. The first
  1849. keywords are states requiring action - these states will select a headline
  1850. for inclusion into the global TODO list Org-mode produces. If one of
  1851. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1852. signify that no further action is necessary. If \"|\" is not found,
  1853. the last keyword is treated as the only DONE state of the sequence.
  1854. The command \\[org-todo] cycles an entry through these states, and one
  1855. additional state where no keyword is present. For details about this
  1856. cycling, see the manual.
  1857. TODO keywords and interpretation can also be set on a per-file basis with
  1858. the special #+SEQ_TODO and #+TYP_TODO lines.
  1859. Each keyword can optionally specify a character for fast state selection
  1860. \(in combination with the variable `org-use-fast-todo-selection')
  1861. and specifiers for state change logging, using the same syntax that
  1862. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  1863. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1864. indicates to record a time stamp each time this state is selected.
  1865. Each keyword may also specify if a timestamp or a note should be
  1866. recorded when entering or leaving the state, by adding additional
  1867. characters in the parenthesis after the keyword. This looks like this:
  1868. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1869. record only the time of the state change. With X and Y being either
  1870. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1871. Y when leaving the state if and only if the *target* state does not
  1872. define X. You may omit any of the fast-selection key or X or /Y,
  1873. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1874. For backward compatibility, this variable may also be just a list
  1875. of keywords. In this case the interpretation (sequence or type) will be
  1876. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1877. :group 'org-todo
  1878. :group 'org-keywords
  1879. :type '(choice
  1880. (repeat :tag "Old syntax, just keywords"
  1881. (string :tag "Keyword"))
  1882. (repeat :tag "New syntax"
  1883. (cons
  1884. (choice
  1885. :tag "Interpretation"
  1886. ;;Quick and dirty way to see
  1887. ;;`org-todo-interpretations'. This takes the
  1888. ;;place of item arguments
  1889. :convert-widget
  1890. (lambda (widget)
  1891. (widget-put widget
  1892. :args (mapcar
  1893. #'(lambda (x)
  1894. (widget-convert
  1895. (cons 'const x)))
  1896. org-todo-interpretation-widgets))
  1897. widget))
  1898. (repeat
  1899. (string :tag "Keyword"))))))
  1900. (defvar org-todo-keywords-1 nil
  1901. "All TODO and DONE keywords active in a buffer.")
  1902. (make-variable-buffer-local 'org-todo-keywords-1)
  1903. (defvar org-todo-keywords-for-agenda nil)
  1904. (defvar org-done-keywords-for-agenda nil)
  1905. (defvar org-drawers-for-agenda nil)
  1906. (defvar org-todo-keyword-alist-for-agenda nil)
  1907. (defvar org-tag-alist-for-agenda nil)
  1908. (defvar org-agenda-contributing-files nil)
  1909. (defvar org-not-done-keywords nil)
  1910. (make-variable-buffer-local 'org-not-done-keywords)
  1911. (defvar org-done-keywords nil)
  1912. (make-variable-buffer-local 'org-done-keywords)
  1913. (defvar org-todo-heads nil)
  1914. (make-variable-buffer-local 'org-todo-heads)
  1915. (defvar org-todo-sets nil)
  1916. (make-variable-buffer-local 'org-todo-sets)
  1917. (defvar org-todo-log-states nil)
  1918. (make-variable-buffer-local 'org-todo-log-states)
  1919. (defvar org-todo-kwd-alist nil)
  1920. (make-variable-buffer-local 'org-todo-kwd-alist)
  1921. (defvar org-todo-key-alist nil)
  1922. (make-variable-buffer-local 'org-todo-key-alist)
  1923. (defvar org-todo-key-trigger nil)
  1924. (make-variable-buffer-local 'org-todo-key-trigger)
  1925. (defcustom org-todo-interpretation 'sequence
  1926. "Controls how TODO keywords are interpreted.
  1927. This variable is in principle obsolete and is only used for
  1928. backward compatibility, if the interpretation of todo keywords is
  1929. not given already in `org-todo-keywords'. See that variable for
  1930. more information."
  1931. :group 'org-todo
  1932. :group 'org-keywords
  1933. :type '(choice (const sequence)
  1934. (const type)))
  1935. (defcustom org-use-fast-todo-selection t
  1936. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1937. This variable describes if and under what circumstances the cycling
  1938. mechanism for TODO keywords will be replaced by a single-key, direct
  1939. selection scheme.
  1940. When nil, fast selection is never used.
  1941. When the symbol `prefix', it will be used when `org-todo' is called
  1942. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  1943. `C-u t' in an agenda buffer.
  1944. When t, fast selection is used by default. In this case, the prefix
  1945. argument forces cycling instead.
  1946. In all cases, the special interface is only used if access keys have
  1947. actually been assigned by the user, i.e. if keywords in the configuration
  1948. are followed by a letter in parenthesis, like TODO(t)."
  1949. :group 'org-todo
  1950. :type '(choice
  1951. (const :tag "Never" nil)
  1952. (const :tag "By default" t)
  1953. (const :tag "Only with C-u C-c C-t" prefix)))
  1954. (defcustom org-provide-todo-statistics t
  1955. "Non-nil means update todo statistics after insert and toggle.
  1956. ALL-HEADLINES means update todo statistics by including headlines
  1957. with no TODO keyword as well, counting them as not done.
  1958. A list of TODO keywords means the same, but skip keywords that are
  1959. not in this list.
  1960. When this is set, todo statistics is updated in the parent of the
  1961. current entry each time a todo state is changed."
  1962. :group 'org-todo
  1963. :type '(choice
  1964. (const :tag "Yes, only for TODO entries" t)
  1965. (const :tag "Yes, including all entries" 'all-headlines)
  1966. (repeat :tag "Yes, for TODOs in this list"
  1967. (string :tag "TODO keyword"))
  1968. (other :tag "No TODO statistics" nil)))
  1969. (defcustom org-hierarchical-todo-statistics t
  1970. "Non-nil means TODO statistics covers just direct children.
  1971. When nil, all entries in the subtree are considered.
  1972. This has only an effect if `org-provide-todo-statistics' is set.
  1973. To set this to nil for only a single subtree, use a COOKIE_DATA
  1974. property and include the word \"recursive\" into the value."
  1975. :group 'org-todo
  1976. :type 'boolean)
  1977. (defcustom org-after-todo-state-change-hook nil
  1978. "Hook which is run after the state of a TODO item was changed.
  1979. The new state (a string with a TODO keyword, or nil) is available in the
  1980. Lisp variable `org-state'."
  1981. :group 'org-todo
  1982. :type 'hook)
  1983. (defvar org-blocker-hook nil
  1984. "Hook for functions that are allowed to block a state change.
  1985. Each function gets as its single argument a property list, see
  1986. `org-trigger-hook' for more information about this list.
  1987. If any of the functions in this hook returns nil, the state change
  1988. is blocked.")
  1989. (defvar org-trigger-hook nil
  1990. "Hook for functions that are triggered by a state change.
  1991. Each function gets as its single argument a property list with at least
  1992. the following elements:
  1993. (:type type-of-change :position pos-at-entry-start
  1994. :from old-state :to new-state)
  1995. Depending on the type, more properties may be present.
  1996. This mechanism is currently implemented for:
  1997. TODO state changes
  1998. ------------------
  1999. :type todo-state-change
  2000. :from previous state (keyword as a string), or nil, or a symbol
  2001. 'todo' or 'done', to indicate the general type of state.
  2002. :to new state, like in :from")
  2003. (defcustom org-enforce-todo-dependencies nil
  2004. "Non-nil means undone TODO entries will block switching the parent to DONE.
  2005. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  2006. be blocked if any prior sibling is not yet done.
  2007. Finally, if the parent is blocked because of ordered siblings of its own,
  2008. the child will also be blocked."
  2009. :set (lambda (var val)
  2010. (set var val)
  2011. (if val
  2012. (add-hook 'org-blocker-hook
  2013. 'org-block-todo-from-children-or-siblings-or-parent)
  2014. (remove-hook 'org-blocker-hook
  2015. 'org-block-todo-from-children-or-siblings-or-parent)))
  2016. :group 'org-todo
  2017. :type 'boolean)
  2018. (defcustom org-enforce-todo-checkbox-dependencies nil
  2019. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2020. When this is nil, checkboxes have no influence on switching TODO states.
  2021. When non-nil, you first need to check off all check boxes before the TODO
  2022. entry can be switched to DONE.
  2023. This variable needs to be set before org.el is loaded, and you need to
  2024. restart Emacs after a change to make the change effective. The only way
  2025. to change is while Emacs is running is through the customize interface."
  2026. :set (lambda (var val)
  2027. (set var val)
  2028. (if val
  2029. (add-hook 'org-blocker-hook
  2030. 'org-block-todo-from-checkboxes)
  2031. (remove-hook 'org-blocker-hook
  2032. 'org-block-todo-from-checkboxes)))
  2033. :group 'org-todo
  2034. :type 'boolean)
  2035. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2036. "Non-nil means inserting a TODO heading is treated as state change.
  2037. So when the command \\[org-insert-todo-heading] is used, state change
  2038. logging will apply if appropriate. When nil, the new TODO item will
  2039. be inserted directly, and no logging will take place."
  2040. :group 'org-todo
  2041. :type 'boolean)
  2042. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2043. "Non-nil means switching TODO states with S-cursor counts as state change.
  2044. This is the default behavior. However, setting this to nil allows a
  2045. convenient way to select a TODO state and bypass any logging associated
  2046. with that."
  2047. :group 'org-todo
  2048. :type 'boolean)
  2049. (defcustom org-todo-state-tags-triggers nil
  2050. "Tag changes that should be triggered by TODO state changes.
  2051. This is a list. Each entry is
  2052. (state-change (tag . flag) .......)
  2053. State-change can be a string with a state, and empty string to indicate the
  2054. state that has no TODO keyword, or it can be one of the symbols `todo'
  2055. or `done', meaning any not-done or done state, respectively."
  2056. :group 'org-todo
  2057. :group 'org-tags
  2058. :type '(repeat
  2059. (cons (choice :tag "When changing to"
  2060. (const :tag "Not-done state" todo)
  2061. (const :tag "Done state" done)
  2062. (string :tag "State"))
  2063. (repeat
  2064. (cons :tag "Tag action"
  2065. (string :tag "Tag")
  2066. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2067. (defcustom org-log-done nil
  2068. "Information to record when a task moves to the DONE state.
  2069. Possible values are:
  2070. nil Don't add anything, just change the keyword
  2071. time Add a time stamp to the task
  2072. note Prompt for a note and add it with template `org-log-note-headings'
  2073. This option can also be set with on a per-file-basis with
  2074. #+STARTUP: nologdone
  2075. #+STARTUP: logdone
  2076. #+STARTUP: lognotedone
  2077. You can have local logging settings for a subtree by setting the LOGGING
  2078. property to one or more of these keywords."
  2079. :group 'org-todo
  2080. :group 'org-progress
  2081. :type '(choice
  2082. (const :tag "No logging" nil)
  2083. (const :tag "Record CLOSED timestamp" time)
  2084. (const :tag "Record CLOSED timestamp with note." note)))
  2085. ;; Normalize old uses of org-log-done.
  2086. (cond
  2087. ((eq org-log-done t) (setq org-log-done 'time))
  2088. ((and (listp org-log-done) (memq 'done org-log-done))
  2089. (setq org-log-done 'note)))
  2090. (defcustom org-log-reschedule nil
  2091. "Information to record when the scheduling date of a tasks is modified.
  2092. Possible values are:
  2093. nil Don't add anything, just change the date
  2094. time Add a time stamp to the task
  2095. note Prompt for a note and add it with template `org-log-note-headings'
  2096. This option can also be set with on a per-file-basis with
  2097. #+STARTUP: nologreschedule
  2098. #+STARTUP: logreschedule
  2099. #+STARTUP: lognotereschedule"
  2100. :group 'org-todo
  2101. :group 'org-progress
  2102. :type '(choice
  2103. (const :tag "No logging" nil)
  2104. (const :tag "Record timestamp" time)
  2105. (const :tag "Record timestamp with note." note)))
  2106. (defcustom org-log-redeadline nil
  2107. "Information to record when the deadline date of a tasks is modified.
  2108. Possible values are:
  2109. nil Don't add anything, just change the date
  2110. time Add a time stamp to the task
  2111. note Prompt for a note and add it with template `org-log-note-headings'
  2112. This option can also be set with on a per-file-basis with
  2113. #+STARTUP: nologredeadline
  2114. #+STARTUP: logredeadline
  2115. #+STARTUP: lognoteredeadline
  2116. You can have local logging settings for a subtree by setting the LOGGING
  2117. property to one or more of these keywords."
  2118. :group 'org-todo
  2119. :group 'org-progress
  2120. :type '(choice
  2121. (const :tag "No logging" nil)
  2122. (const :tag "Record timestamp" time)
  2123. (const :tag "Record timestamp with note." note)))
  2124. (defcustom org-log-note-clock-out nil
  2125. "Non-nil means record a note when clocking out of an item.
  2126. This can also be configured on a per-file basis by adding one of
  2127. the following lines anywhere in the buffer:
  2128. #+STARTUP: lognoteclock-out
  2129. #+STARTUP: nolognoteclock-out"
  2130. :group 'org-todo
  2131. :group 'org-progress
  2132. :type 'boolean)
  2133. (defcustom org-log-done-with-time t
  2134. "Non-nil means the CLOSED time stamp will contain date and time.
  2135. When nil, only the date will be recorded."
  2136. :group 'org-progress
  2137. :type 'boolean)
  2138. (defcustom org-log-note-headings
  2139. '((done . "CLOSING NOTE %t")
  2140. (state . "State %-12s from %-12S %t")
  2141. (note . "Note taken on %t")
  2142. (reschedule . "Rescheduled from %S on %t")
  2143. (delschedule . "Not scheduled, was %S on %t")
  2144. (redeadline . "New deadline from %S on %t")
  2145. (deldeadline . "Removed deadline, was %S on %t")
  2146. (refile . "Refiled on %t")
  2147. (clock-out . ""))
  2148. "Headings for notes added to entries.
  2149. The value is an alist, with the car being a symbol indicating the note
  2150. context, and the cdr is the heading to be used. The heading may also be the
  2151. empty string.
  2152. %t in the heading will be replaced by a time stamp.
  2153. %T will be an active time stamp instead the default inactive one
  2154. %d will be replaced by a short-format time stamp.
  2155. %D will be replaced by an active short-format time stamp.
  2156. %s will be replaced by the new TODO state, in double quotes.
  2157. %S will be replaced by the old TODO state, in double quotes.
  2158. %u will be replaced by the user name.
  2159. %U will be replaced by the full user name.
  2160. In fact, it is not a good idea to change the `state' entry, because
  2161. agenda log mode depends on the format of these entries."
  2162. :group 'org-todo
  2163. :group 'org-progress
  2164. :type '(list :greedy t
  2165. (cons (const :tag "Heading when closing an item" done) string)
  2166. (cons (const :tag
  2167. "Heading when changing todo state (todo sequence only)"
  2168. state) string)
  2169. (cons (const :tag "Heading when just taking a note" note) string)
  2170. (cons (const :tag "Heading when clocking out" clock-out) string)
  2171. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2172. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2173. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2174. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2175. (cons (const :tag "Heading when refiling" refile) string)))
  2176. (unless (assq 'note org-log-note-headings)
  2177. (push '(note . "%t") org-log-note-headings))
  2178. (defcustom org-log-into-drawer nil
  2179. "Non-nil means insert state change notes and time stamps into a drawer.
  2180. When nil, state changes notes will be inserted after the headline and
  2181. any scheduling and clock lines, but not inside a drawer.
  2182. The value of this variable should be the name of the drawer to use.
  2183. LOGBOOK is proposed as the default drawer for this purpose, you can
  2184. also set this to a string to define the drawer of your choice.
  2185. A value of t is also allowed, representing \"LOGBOOK\".
  2186. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2187. will be ignored.
  2188. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2189. a subtree."
  2190. :group 'org-todo
  2191. :group 'org-progress
  2192. :type '(choice
  2193. (const :tag "Not into a drawer" nil)
  2194. (const :tag "LOGBOOK" t)
  2195. (string :tag "Other")))
  2196. (if (fboundp 'defvaralias)
  2197. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  2198. (defun org-log-into-drawer ()
  2199. "Return the value of `org-log-into-drawer', but let properties overrule.
  2200. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2201. used instead of the default value."
  2202. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
  2203. (cond
  2204. ((or (not p) (equal p "nil")) org-log-into-drawer)
  2205. ((equal p "t") "LOGBOOK")
  2206. (t p))))
  2207. (defcustom org-log-state-notes-insert-after-drawers nil
  2208. "Non-nil means insert state change notes after any drawers in entry.
  2209. Only the drawers that *immediately* follow the headline and the
  2210. deadline/scheduled line are skipped.
  2211. When nil, insert notes right after the heading and perhaps the line
  2212. with deadline/scheduling if present.
  2213. This variable will have no effect if `org-log-into-drawer' is
  2214. set."
  2215. :group 'org-todo
  2216. :group 'org-progress
  2217. :type 'boolean)
  2218. (defcustom org-log-states-order-reversed t
  2219. "Non-nil means the latest state note will be directly after heading.
  2220. When nil, the state change notes will be ordered according to time."
  2221. :group 'org-todo
  2222. :group 'org-progress
  2223. :type 'boolean)
  2224. (defcustom org-todo-repeat-to-state nil
  2225. "The TODO state to which a repeater should return the repeating task.
  2226. By default this is the first task in a TODO sequence, or the previous state
  2227. in a TODO_TYP set. But you can specify another task here.
  2228. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2229. :group 'org-todo
  2230. :version "24.1"
  2231. :type '(choice (const :tag "Head of sequence" nil)
  2232. (string :tag "Specific state")))
  2233. (defcustom org-log-repeat 'time
  2234. "Non-nil means record moving through the DONE state when triggering repeat.
  2235. An auto-repeating task is immediately switched back to TODO when
  2236. marked DONE. If you are not logging state changes (by adding \"@\"
  2237. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2238. record a closing note, there will be no record of the task moving
  2239. through DONE. This variable forces taking a note anyway.
  2240. nil Don't force a record
  2241. time Record a time stamp
  2242. note Prompt for a note and add it with template `org-log-note-headings'
  2243. This option can also be set with on a per-file-basis with
  2244. #+STARTUP: nologrepeat
  2245. #+STARTUP: logrepeat
  2246. #+STARTUP: lognoterepeat
  2247. You can have local logging settings for a subtree by setting the LOGGING
  2248. property to one or more of these keywords."
  2249. :group 'org-todo
  2250. :group 'org-progress
  2251. :type '(choice
  2252. (const :tag "Don't force a record" nil)
  2253. (const :tag "Force recording the DONE state" time)
  2254. (const :tag "Force recording a note with the DONE state" note)))
  2255. (defgroup org-priorities nil
  2256. "Priorities in Org-mode."
  2257. :tag "Org Priorities"
  2258. :group 'org-todo)
  2259. (defcustom org-enable-priority-commands t
  2260. "Non-nil means priority commands are active.
  2261. When nil, these commands will be disabled, so that you never accidentally
  2262. set a priority."
  2263. :group 'org-priorities
  2264. :type 'boolean)
  2265. (defcustom org-highest-priority ?A
  2266. "The highest priority of TODO items. A character like ?A, ?B etc.
  2267. Must have a smaller ASCII number than `org-lowest-priority'."
  2268. :group 'org-priorities
  2269. :type 'character)
  2270. (defcustom org-lowest-priority ?C
  2271. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2272. Must have a larger ASCII number than `org-highest-priority'."
  2273. :group 'org-priorities
  2274. :type 'character)
  2275. (defcustom org-default-priority ?B
  2276. "The default priority of TODO items.
  2277. This is the priority an item gets if no explicit priority is given.
  2278. When starting to cycle on an empty priority the first step in the cycle
  2279. depends on `org-priority-start-cycle-with-default'. The resulting first
  2280. step priority must not exceed the range from `org-highest-priority' to
  2281. `org-lowest-priority' which means that `org-default-priority' has to be
  2282. in this range exclusive or inclusive the range boundaries. Else the
  2283. first step refuses to set the default and the second will fall back
  2284. to (depending on the command used) the highest or lowest priority."
  2285. :group 'org-priorities
  2286. :type 'character)
  2287. (defcustom org-priority-start-cycle-with-default t
  2288. "Non-nil means start with default priority when starting to cycle.
  2289. When this is nil, the first step in the cycle will be (depending on the
  2290. command used) one higher or lower than the default priority.
  2291. See also `org-default-priority'."
  2292. :group 'org-priorities
  2293. :type 'boolean)
  2294. (defcustom org-get-priority-function nil
  2295. "Function to extract the priority from a string.
  2296. The string is normally the headline. If this is nil Org computes the
  2297. priority from the priority cookie like [#A] in the headline. It returns
  2298. an integer, increasing by 1000 for each priority level.
  2299. The user can set a different function here, which should take a string
  2300. as an argument and return the numeric priority."
  2301. :group 'org-priorities
  2302. :version "24.1"
  2303. :type 'function)
  2304. (defgroup org-time nil
  2305. "Options concerning time stamps and deadlines in Org-mode."
  2306. :tag "Org Time"
  2307. :group 'org)
  2308. (defcustom org-insert-labeled-timestamps-at-point nil
  2309. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2310. When nil, these labeled time stamps are forces into the second line of an
  2311. entry, just after the headline. When scheduling from the global TODO list,
  2312. the time stamp will always be forced into the second line."
  2313. :group 'org-time
  2314. :type 'boolean)
  2315. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2316. "Formats for `format-time-string' which are used for time stamps.
  2317. It is not recommended to change this constant.")
  2318. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2319. "Number of minutes to round time stamps to.
  2320. These are two values, the first applies when first creating a time stamp.
  2321. The second applies when changing it with the commands `S-up' and `S-down'.
  2322. When changing the time stamp, this means that it will change in steps
  2323. of N minutes, as given by the second value.
  2324. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2325. numbers should be factors of 60, so for example 5, 10, 15.
  2326. When this is larger than 1, you can still force an exact time stamp by using
  2327. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2328. and by using a prefix arg to `S-up/down' to specify the exact number
  2329. of minutes to shift."
  2330. :group 'org-time
  2331. :get #'(lambda (var) ; Make sure both elements are there
  2332. (if (integerp (default-value var))
  2333. (list (default-value var) 5)
  2334. (default-value var)))
  2335. :type '(list
  2336. (integer :tag "when inserting times")
  2337. (integer :tag "when modifying times")))
  2338. ;; Normalize old customizations of this variable.
  2339. (when (integerp org-time-stamp-rounding-minutes)
  2340. (setq org-time-stamp-rounding-minutes
  2341. (list org-time-stamp-rounding-minutes
  2342. org-time-stamp-rounding-minutes)))
  2343. (defcustom org-display-custom-times nil
  2344. "Non-nil means overlay custom formats over all time stamps.
  2345. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2346. To turn this on on a per-file basis, insert anywhere in the file:
  2347. #+STARTUP: customtime"
  2348. :group 'org-time
  2349. :set 'set-default
  2350. :type 'sexp)
  2351. (make-variable-buffer-local 'org-display-custom-times)
  2352. (defcustom org-time-stamp-custom-formats
  2353. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2354. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2355. These are overlaid over the default ISO format if the variable
  2356. `org-display-custom-times' is set. Time like %H:%M should be at the
  2357. end of the second format. The custom formats are also honored by export
  2358. commands, if custom time display is turned on at the time of export."
  2359. :group 'org-time
  2360. :type 'sexp)
  2361. (defun org-time-stamp-format (&optional long inactive)
  2362. "Get the right format for a time string."
  2363. (let ((f (if long (cdr org-time-stamp-formats)
  2364. (car org-time-stamp-formats))))
  2365. (if inactive
  2366. (concat "[" (substring f 1 -1) "]")
  2367. f)))
  2368. (defcustom org-time-clocksum-format "%d:%02d"
  2369. "The format string used when creating CLOCKSUM lines.
  2370. This is also used when org-mode generates a time duration."
  2371. :group 'org-time
  2372. :type 'string)
  2373. (defcustom org-time-clocksum-use-fractional nil
  2374. "If non-nil, \\[org-clock-display] uses fractional times.
  2375. org-mode generates a time duration."
  2376. :group 'org-time
  2377. :type 'boolean)
  2378. (defcustom org-time-clocksum-fractional-format "%.2f"
  2379. "The format string used when creating CLOCKSUM lines, or when
  2380. org-mode generates a time duration."
  2381. :group 'org-time
  2382. :type 'string)
  2383. (defcustom org-deadline-warning-days 14
  2384. "No. of days before expiration during which a deadline becomes active.
  2385. This variable governs the display in sparse trees and in the agenda.
  2386. When 0 or negative, it means use this number (the absolute value of it)
  2387. even if a deadline has a different individual lead time specified.
  2388. Custom commands can set this variable in the options section."
  2389. :group 'org-time
  2390. :group 'org-agenda-daily/weekly
  2391. :type 'integer)
  2392. (defcustom org-read-date-prefer-future t
  2393. "Non-nil means assume future for incomplete date input from user.
  2394. This affects the following situations:
  2395. 1. The user gives a month but not a year.
  2396. For example, if it is April and you enter \"feb 2\", this will be read
  2397. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2398. 2. The user gives a day, but no month.
  2399. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2400. read this as the third of *next* month. However, if you enter \"17\",
  2401. it will be considered as *this* month.
  2402. If you set this variable to the symbol `time', then also the following
  2403. will work:
  2404. 3. If the user gives a time.
  2405. If the time is before now, it will be interpreted as tomorrow.
  2406. Currently none of this works for ISO week specifications.
  2407. When this option is nil, the current day, month and year will always be
  2408. used as defaults.
  2409. See also `org-agenda-jump-prefer-future'."
  2410. :group 'org-time
  2411. :type '(choice
  2412. (const :tag "Never" nil)
  2413. (const :tag "Check month and day" t)
  2414. (const :tag "Check month, day, and time" time)))
  2415. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2416. "Should the agenda jump command prefer the future for incomplete dates?
  2417. The default is to do the same as configured in `org-read-date-prefer-future'.
  2418. But you can also set a deviating value here.
  2419. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2420. :group 'org-agenda
  2421. :group 'org-time
  2422. :version "24.1"
  2423. :type '(choice
  2424. (const :tag "Use org-read-date-prefer-future"
  2425. org-read-date-prefer-future)
  2426. (const :tag "Never" nil)
  2427. (const :tag "Always" t)))
  2428. (defcustom org-read-date-force-compatible-dates t
  2429. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2430. Depending on the system Emacs is running on, certain dates cannot
  2431. be represented with the type used internally to represent time.
  2432. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2433. correctly. Some systems allow for earlier dates, some for later,
  2434. some for both. One way to find out it to insert any date into an
  2435. Org buffer, putting the cursor on the year and hitting S-up and
  2436. S-down to test the range.
  2437. When this variable is set to t, the date/time prompt will not let
  2438. you specify dates outside the 1970-2037 range, so it is certain that
  2439. these dates will work in whatever version of Emacs you are
  2440. running, and also that you can move a file from one Emacs implementation
  2441. to another. WHenever Org is forcing the year for you, it will display
  2442. a message and beep.
  2443. When this variable is nil, Org will check if the date is
  2444. representable in the specific Emacs implementation you are using.
  2445. If not, it will force a year, usually the current year, and beep
  2446. to remind you. Currently this setting is not recommended because
  2447. the likelihood that you will open your Org files in an Emacs that
  2448. has limited date range is not negligible.
  2449. A workaround for this problem is to use diary sexp dates for time
  2450. stamps outside of this range."
  2451. :group 'org-time
  2452. :version "24.1"
  2453. :type 'boolean)
  2454. (defcustom org-read-date-display-live t
  2455. "Non-nil means display current interpretation of date prompt live.
  2456. This display will be in an overlay, in the minibuffer."
  2457. :group 'org-time
  2458. :type 'boolean)
  2459. (defcustom org-read-date-popup-calendar t
  2460. "Non-nil means pop up a calendar when prompting for a date.
  2461. In the calendar, the date can be selected with mouse-1. However, the
  2462. minibuffer will also be active, and you can simply enter the date as well.
  2463. When nil, only the minibuffer will be available."
  2464. :group 'org-time
  2465. :type 'boolean)
  2466. (if (fboundp 'defvaralias)
  2467. (defvaralias 'org-popup-calendar-for-date-prompt
  2468. 'org-read-date-popup-calendar))
  2469. (defcustom org-read-date-minibuffer-setup-hook nil
  2470. "Hook to be used to set up keys for the date/time interface.
  2471. Add key definitions to `minibuffer-local-map', which will be a temporary
  2472. copy."
  2473. :group 'org-time
  2474. :type 'hook)
  2475. (defcustom org-extend-today-until 0
  2476. "The hour when your day really ends. Must be an integer.
  2477. This has influence for the following applications:
  2478. - When switching the agenda to \"today\". It it is still earlier than
  2479. the time given here, the day recognized as TODAY is actually yesterday.
  2480. - When a date is read from the user and it is still before the time given
  2481. here, the current date and time will be assumed to be yesterday, 23:59.
  2482. Also, timestamps inserted in capture templates follow this rule.
  2483. IMPORTANT: This is a feature whose implementation is and likely will
  2484. remain incomplete. Really, it is only here because past midnight seems to
  2485. be the favorite working time of John Wiegley :-)"
  2486. :group 'org-time
  2487. :type 'integer)
  2488. (defcustom org-use-effective-time nil
  2489. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2490. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2491. \"effective time\" of any timestamps between midnight and 8am will be
  2492. 23:59 of the previous day."
  2493. :group 'org-time
  2494. :version "24.1"
  2495. :type 'boolean)
  2496. (defcustom org-use-last-clock-out-time-as-effective-time nil
  2497. "When non-nil, use the last clock out time for `org-todo'.
  2498. Note that this option has precedence over the combined use of
  2499. `org-use-effective-time' and `org-extend-today-until'."
  2500. :group 'org-time
  2501. ;; :version "24.3"
  2502. :type 'boolean)
  2503. (defcustom org-edit-timestamp-down-means-later nil
  2504. "Non-nil means S-down will increase the time in a time stamp.
  2505. When nil, S-up will increase."
  2506. :group 'org-time
  2507. :type 'boolean)
  2508. (defcustom org-calendar-follow-timestamp-change t
  2509. "Non-nil means make the calendar window follow timestamp changes.
  2510. When a timestamp is modified and the calendar window is visible, it will be
  2511. moved to the new date."
  2512. :group 'org-time
  2513. :type 'boolean)
  2514. (defgroup org-tags nil
  2515. "Options concerning tags in Org-mode."
  2516. :tag "Org Tags"
  2517. :group 'org)
  2518. (defcustom org-tag-alist nil
  2519. "List of tags allowed in Org-mode files.
  2520. When this list is nil, Org-mode will base TAG input on what is already in the
  2521. buffer.
  2522. The value of this variable is an alist, the car of each entry must be a
  2523. keyword as a string, the cdr may be a character that is used to select
  2524. that tag through the fast-tag-selection interface.
  2525. See the manual for details."
  2526. :group 'org-tags
  2527. :type '(repeat
  2528. (choice
  2529. (cons (string :tag "Tag name")
  2530. (character :tag "Access char"))
  2531. (list :tag "Start radio group"
  2532. (const :startgroup)
  2533. (option (string :tag "Group description")))
  2534. (list :tag "End radio group"
  2535. (const :endgroup)
  2536. (option (string :tag "Group description")))
  2537. (const :tag "New line" (:newline)))))
  2538. (defcustom org-tag-persistent-alist nil
  2539. "List of tags that will always appear in all Org-mode files.
  2540. This is in addition to any in buffer settings or customizations
  2541. of `org-tag-alist'.
  2542. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2543. The value of this variable is an alist, the car of each entry must be a
  2544. keyword as a string, the cdr may be a character that is used to select
  2545. that tag through the fast-tag-selection interface.
  2546. See the manual for details.
  2547. To disable these tags on a per-file basis, insert anywhere in the file:
  2548. #+STARTUP: noptag"
  2549. :group 'org-tags
  2550. :type '(repeat
  2551. (choice
  2552. (cons (string :tag "Tag name")
  2553. (character :tag "Access char"))
  2554. (const :tag "Start radio group" (:startgroup))
  2555. (const :tag "End radio group" (:endgroup))
  2556. (const :tag "New line" (:newline)))))
  2557. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2558. "If non-nil, always offer completion for all tags of all agenda files.
  2559. Instead of customizing this variable directly, you might want to
  2560. set it locally for capture buffers, because there no list of
  2561. tags in that file can be created dynamically (there are none).
  2562. (add-hook 'org-capture-mode-hook
  2563. (lambda ()
  2564. (set (make-local-variable
  2565. 'org-complete-tags-always-offer-all-agenda-tags)
  2566. t)))"
  2567. :group 'org-tags
  2568. :version "24.1"
  2569. :type 'boolean)
  2570. (defvar org-file-tags nil
  2571. "List of tags that can be inherited by all entries in the file.
  2572. The tags will be inherited if the variable `org-use-tag-inheritance'
  2573. says they should be.
  2574. This variable is populated from #+FILETAGS lines.")
  2575. (defcustom org-use-fast-tag-selection 'auto
  2576. "Non-nil means use fast tag selection scheme.
  2577. This is a special interface to select and deselect tags with single keys.
  2578. When nil, fast selection is never used.
  2579. When the symbol `auto', fast selection is used if and only if selection
  2580. characters for tags have been configured, either through the variable
  2581. `org-tag-alist' or through a #+TAGS line in the buffer.
  2582. When t, fast selection is always used and selection keys are assigned
  2583. automatically if necessary."
  2584. :group 'org-tags
  2585. :type '(choice
  2586. (const :tag "Always" t)
  2587. (const :tag "Never" nil)
  2588. (const :tag "When selection characters are configured" 'auto)))
  2589. (defcustom org-fast-tag-selection-single-key nil
  2590. "Non-nil means fast tag selection exits after first change.
  2591. When nil, you have to press RET to exit it.
  2592. During fast tag selection, you can toggle this flag with `C-c'.
  2593. This variable can also have the value `expert'. In this case, the window
  2594. displaying the tags menu is not even shown, until you press C-c again."
  2595. :group 'org-tags
  2596. :type '(choice
  2597. (const :tag "No" nil)
  2598. (const :tag "Yes" t)
  2599. (const :tag "Expert" expert)))
  2600. (defvar org-fast-tag-selection-include-todo nil
  2601. "Non-nil means fast tags selection interface will also offer TODO states.
  2602. This is an undocumented feature, you should not rely on it.")
  2603. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2604. "The column to which tags should be indented in a headline.
  2605. If this number is positive, it specifies the column. If it is negative,
  2606. it means that the tags should be flushright to that column. For example,
  2607. -80 works well for a normal 80 character screen.
  2608. When 0, place tags directly after headline text, with only one space in
  2609. between."
  2610. :group 'org-tags
  2611. :type 'integer)
  2612. (defcustom org-auto-align-tags t
  2613. "Non-nil keeps tags aligned when modifying headlines.
  2614. Some operations (i.e. demoting) change the length of a headline and
  2615. therefore shift the tags around. With this option turned on, after
  2616. each such operation the tags are again aligned to `org-tags-column'."
  2617. :group 'org-tags
  2618. :type 'boolean)
  2619. (defcustom org-use-tag-inheritance t
  2620. "Non-nil means tags in levels apply also for sublevels.
  2621. When nil, only the tags directly given in a specific line apply there.
  2622. This may also be a list of tags that should be inherited, or a regexp that
  2623. matches tags that should be inherited. Additional control is possible
  2624. with the variable `org-tags-exclude-from-inheritance' which gives an
  2625. explicit list of tags to be excluded from inheritance., even if the value of
  2626. `org-use-tag-inheritance' would select it for inheritance.
  2627. If this option is t, a match early-on in a tree can lead to a large
  2628. number of matches in the subtree when constructing the agenda or creating
  2629. a sparse tree. If you only want to see the first match in a tree during
  2630. a search, check out the variable `org-tags-match-list-sublevels'."
  2631. :group 'org-tags
  2632. :type '(choice
  2633. (const :tag "Not" nil)
  2634. (const :tag "Always" t)
  2635. (repeat :tag "Specific tags" (string :tag "Tag"))
  2636. (regexp :tag "Tags matched by regexp")))
  2637. (defcustom org-tags-exclude-from-inheritance nil
  2638. "List of tags that should never be inherited.
  2639. This is a way to exclude a few tags from inheritance. For way to do
  2640. the opposite, to actively allow inheritance for selected tags,
  2641. see the variable `org-use-tag-inheritance'."
  2642. :group 'org-tags
  2643. :type '(repeat (string :tag "Tag")))
  2644. (defun org-tag-inherit-p (tag)
  2645. "Check if TAG is one that should be inherited."
  2646. (cond
  2647. ((member tag org-tags-exclude-from-inheritance) nil)
  2648. ((eq org-use-tag-inheritance t) t)
  2649. ((not org-use-tag-inheritance) nil)
  2650. ((stringp org-use-tag-inheritance)
  2651. (string-match org-use-tag-inheritance tag))
  2652. ((listp org-use-tag-inheritance)
  2653. (member tag org-use-tag-inheritance))
  2654. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2655. (defcustom org-tags-match-list-sublevels t
  2656. "Non-nil means list also sublevels of headlines matching a search.
  2657. This variable applies to tags/property searches, and also to stuck
  2658. projects because this search is based on a tags match as well.
  2659. When set to the symbol `indented', sublevels are indented with
  2660. leading dots.
  2661. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2662. the sublevels of a headline matching a tag search often also match
  2663. the same search. Listing all of them can create very long lists.
  2664. Setting this variable to nil causes subtrees of a match to be skipped.
  2665. This variable is semi-obsolete and probably should always be true. It
  2666. is better to limit inheritance to certain tags using the variables
  2667. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2668. :group 'org-tags
  2669. :type '(choice
  2670. (const :tag "No, don't list them" nil)
  2671. (const :tag "Yes, do list them" t)
  2672. (const :tag "List them, indented with leading dots" indented)))
  2673. (defcustom org-tags-sort-function nil
  2674. "When set, tags are sorted using this function as a comparator."
  2675. :group 'org-tags
  2676. :type '(choice
  2677. (const :tag "No sorting" nil)
  2678. (const :tag "Alphabetical" string<)
  2679. (const :tag "Reverse alphabetical" string>)
  2680. (function :tag "Custom function" nil)))
  2681. (defvar org-tags-history nil
  2682. "History of minibuffer reads for tags.")
  2683. (defvar org-last-tags-completion-table nil
  2684. "The last used completion table for tags.")
  2685. (defvar org-after-tags-change-hook nil
  2686. "Hook that is run after the tags in a line have changed.")
  2687. (defgroup org-properties nil
  2688. "Options concerning properties in Org-mode."
  2689. :tag "Org Properties"
  2690. :group 'org)
  2691. (defcustom org-property-format "%-10s %s"
  2692. "How property key/value pairs should be formatted by `indent-line'.
  2693. When `indent-line' hits a property definition, it will format the line
  2694. according to this format, mainly to make sure that the values are
  2695. lined-up with respect to each other."
  2696. :group 'org-properties
  2697. :type 'string)
  2698. (defcustom org-properties-postprocess-alist nil
  2699. "Alist of properties and functions to adjust inserted values.
  2700. Elements of this alist must be of the form
  2701. ([string] [function])
  2702. where [string] must be a property name and [function] must be a
  2703. lambda expression: this lambda expression must take one argument,
  2704. the value to adjust, and return the new value as a string.
  2705. For example, this element will allow the property \"Remaining\"
  2706. to be updated wrt the relation between the \"Effort\" property
  2707. and the clock summary:
  2708. ((\"Remaining\" (lambda(value)
  2709. (let ((clocksum (org-clock-sum-current-item))
  2710. (effort (org-duration-string-to-minutes
  2711. (org-entry-get (point) \"Effort\"))))
  2712. (org-minutes-to-hh:mm-string (- effort clocksum))))))"
  2713. :group 'org-properties
  2714. :version "24.1"
  2715. :type '(alist :key-type (string :tag "Property")
  2716. :value-type (function :tag "Function")))
  2717. (defcustom org-use-property-inheritance nil
  2718. "Non-nil means properties apply also for sublevels.
  2719. This setting is chiefly used during property searches. Turning it on can
  2720. cause significant overhead when doing a search, which is why it is not
  2721. on by default.
  2722. When nil, only the properties directly given in the current entry count.
  2723. When t, every property is inherited. The value may also be a list of
  2724. properties that should have inheritance, or a regular expression matching
  2725. properties that should be inherited.
  2726. However, note that some special properties use inheritance under special
  2727. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2728. and the properties ending in \"_ALL\" when they are used as descriptor
  2729. for valid values of a property.
  2730. Note for programmers:
  2731. When querying an entry with `org-entry-get', you can control if inheritance
  2732. should be used. By default, `org-entry-get' looks only at the local
  2733. properties. You can request inheritance by setting the inherit argument
  2734. to t (to force inheritance) or to `selective' (to respect the setting
  2735. in this variable)."
  2736. :group 'org-properties
  2737. :type '(choice
  2738. (const :tag "Not" nil)
  2739. (const :tag "Always" t)
  2740. (repeat :tag "Specific properties" (string :tag "Property"))
  2741. (regexp :tag "Properties matched by regexp")))
  2742. (defun org-property-inherit-p (property)
  2743. "Check if PROPERTY is one that should be inherited."
  2744. (cond
  2745. ((eq org-use-property-inheritance t) t)
  2746. ((not org-use-property-inheritance) nil)
  2747. ((stringp org-use-property-inheritance)
  2748. (string-match org-use-property-inheritance property))
  2749. ((listp org-use-property-inheritance)
  2750. (member property org-use-property-inheritance))
  2751. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2752. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2753. "The default column format, if no other format has been defined.
  2754. This variable can be set on the per-file basis by inserting a line
  2755. #+COLUMNS: %25ITEM ....."
  2756. :group 'org-properties
  2757. :type 'string)
  2758. (defcustom org-columns-ellipses ".."
  2759. "The ellipses to be used when a field in column view is truncated.
  2760. When this is the empty string, as many characters as possible are shown,
  2761. but then there will be no visual indication that the field has been truncated.
  2762. When this is a string of length N, the last N characters of a truncated
  2763. field are replaced by this string. If the column is narrower than the
  2764. ellipses string, only part of the ellipses string will be shown."
  2765. :group 'org-properties
  2766. :type 'string)
  2767. (defcustom org-columns-modify-value-for-display-function nil
  2768. "Function that modifies values for display in column view.
  2769. For example, it can be used to cut out a certain part from a time stamp.
  2770. The function must take 2 arguments:
  2771. column-title The title of the column (*not* the property name)
  2772. value The value that should be modified.
  2773. The function should return the value that should be displayed,
  2774. or nil if the normal value should be used."
  2775. :group 'org-properties
  2776. :type 'function)
  2777. (defcustom org-effort-property "Effort"
  2778. "The property that is being used to keep track of effort estimates.
  2779. Effort estimates given in this property need to have the format H:MM."
  2780. :group 'org-properties
  2781. :group 'org-progress
  2782. :type '(string :tag "Property"))
  2783. (defconst org-global-properties-fixed
  2784. '(("VISIBILITY_ALL" . "folded children content all")
  2785. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2786. "List of property/value pairs that can be inherited by any entry.
  2787. These are fixed values, for the preset properties. The user variable
  2788. that can be used to add to this list is `org-global-properties'.
  2789. The entries in this list are cons cells where the car is a property
  2790. name and cdr is a string with the value. If the value represents
  2791. multiple items like an \"_ALL\" property, separate the items by
  2792. spaces.")
  2793. (defcustom org-global-properties nil
  2794. "List of property/value pairs that can be inherited by any entry.
  2795. This list will be combined with the constant `org-global-properties-fixed'.
  2796. The entries in this list are cons cells where the car is a property
  2797. name and cdr is a string with the value.
  2798. You can set buffer-local values for the same purpose in the variable
  2799. `org-file-properties' this by adding lines like
  2800. #+PROPERTY: NAME VALUE"
  2801. :group 'org-properties
  2802. :type '(repeat
  2803. (cons (string :tag "Property")
  2804. (string :tag "Value"))))
  2805. (defvar org-file-properties nil
  2806. "List of property/value pairs that can be inherited by any entry.
  2807. Valid for the current buffer.
  2808. This variable is populated from #+PROPERTY lines.")
  2809. (make-variable-buffer-local 'org-file-properties)
  2810. (defgroup org-agenda nil
  2811. "Options concerning agenda views in Org-mode."
  2812. :tag "Org Agenda"
  2813. :group 'org)
  2814. (defvar org-category nil
  2815. "Variable used by org files to set a category for agenda display.
  2816. Such files should use a file variable to set it, for example
  2817. # -*- mode: org; org-category: \"ELisp\"
  2818. or contain a special line
  2819. #+CATEGORY: ELisp
  2820. If the file does not specify a category, then file's base name
  2821. is used instead.")
  2822. (make-variable-buffer-local 'org-category)
  2823. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  2824. (defcustom org-agenda-files nil
  2825. "The files to be used for agenda display.
  2826. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2827. \\[org-remove-file]. You can also use customize to edit the list.
  2828. If an entry is a directory, all files in that directory that are matched by
  2829. `org-agenda-file-regexp' will be part of the file list.
  2830. If the value of the variable is not a list but a single file name, then
  2831. the list of agenda files is actually stored and maintained in that file, one
  2832. agenda file per line. In this file paths can be given relative to
  2833. `org-directory'. Tilde expansion and environment variable substitution
  2834. are also made."
  2835. :group 'org-agenda
  2836. :type '(choice
  2837. (repeat :tag "List of files and directories" file)
  2838. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2839. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2840. "Regular expression to match files for `org-agenda-files'.
  2841. If any element in the list in that variable contains a directory instead
  2842. of a normal file, all files in that directory that are matched by this
  2843. regular expression will be included."
  2844. :group 'org-agenda
  2845. :type 'regexp)
  2846. (defcustom org-agenda-text-search-extra-files nil
  2847. "List of extra files to be searched by text search commands.
  2848. These files will be search in addition to the agenda files by the
  2849. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2850. Note that these files will only be searched for text search commands,
  2851. not for the other agenda views like todo lists, tag searches or the weekly
  2852. agenda. This variable is intended to list notes and possibly archive files
  2853. that should also be searched by these two commands.
  2854. In fact, if the first element in the list is the symbol `agenda-archives',
  2855. than all archive files of all agenda files will be added to the search
  2856. scope."
  2857. :group 'org-agenda
  2858. :type '(set :greedy t
  2859. (const :tag "Agenda Archives" agenda-archives)
  2860. (repeat :inline t (file))))
  2861. (if (fboundp 'defvaralias)
  2862. (defvaralias 'org-agenda-multi-occur-extra-files
  2863. 'org-agenda-text-search-extra-files))
  2864. (defcustom org-agenda-skip-unavailable-files nil
  2865. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2866. A nil value means to remove them, after a query, from the list."
  2867. :group 'org-agenda
  2868. :type 'boolean)
  2869. (defcustom org-calendar-to-agenda-key [?c]
  2870. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2871. The command `org-calendar-goto-agenda' will be bound to this key. The
  2872. default is the character `c' because then `c' can be used to switch back and
  2873. forth between agenda and calendar."
  2874. :group 'org-agenda
  2875. :type 'sexp)
  2876. (defcustom org-calendar-agenda-action-key [?k]
  2877. "The key to be installed in `calendar-mode-map' for agenda-action.
  2878. The command `org-agenda-action' will be bound to this key. The
  2879. default is the character `k' because we use the same key in the agenda."
  2880. :group 'org-agenda
  2881. :type 'sexp)
  2882. (defcustom org-calendar-insert-diary-entry-key [?i]
  2883. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2884. This option is irrelevant until `org-agenda-diary-file' has been configured
  2885. to point to an Org-mode file. When that is the case, the command
  2886. `org-agenda-diary-entry' will be bound to the key given here, by default
  2887. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2888. if you want to continue doing this, you need to change this to a different
  2889. key."
  2890. :group 'org-agenda
  2891. :type 'sexp)
  2892. (defcustom org-agenda-diary-file 'diary-file
  2893. "File to which to add new entries with the `i' key in agenda and calendar.
  2894. When this is the symbol `diary-file', the functionality in the Emacs
  2895. calendar will be used to add entries to the `diary-file'. But when this
  2896. points to a file, `org-agenda-diary-entry' will be used instead."
  2897. :group 'org-agenda
  2898. :type '(choice
  2899. (const :tag "The standard Emacs diary file" diary-file)
  2900. (file :tag "Special Org file diary entries")))
  2901. (eval-after-load "calendar"
  2902. '(progn
  2903. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2904. 'org-calendar-goto-agenda)
  2905. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2906. 'org-agenda-action)
  2907. (add-hook 'calendar-mode-hook
  2908. (lambda ()
  2909. (unless (eq org-agenda-diary-file 'diary-file)
  2910. (define-key calendar-mode-map
  2911. org-calendar-insert-diary-entry-key
  2912. 'org-agenda-diary-entry))))))
  2913. (defgroup org-latex nil
  2914. "Options for embedding LaTeX code into Org-mode."
  2915. :tag "Org LaTeX"
  2916. :group 'org)
  2917. (defcustom org-format-latex-options
  2918. '(:foreground default :background default :scale 1.0
  2919. :html-foreground "Black" :html-background "Transparent"
  2920. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2921. "Options for creating images from LaTeX fragments.
  2922. This is a property list with the following properties:
  2923. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2924. `default' means use the foreground of the default face.
  2925. `auto' means use the foreground from the text face.
  2926. :background the background color, or \"Transparent\".
  2927. `default' means use the background of the default face.
  2928. `auto' means use the background from the text face.
  2929. :scale a scaling factor for the size of the images, to get more pixels
  2930. :html-foreground, :html-background, :html-scale
  2931. the same numbers for HTML export.
  2932. :matchers a list indicating which matchers should be used to
  2933. find LaTeX fragments. Valid members of this list are:
  2934. \"begin\" find environments
  2935. \"$1\" find single characters surrounded by $.$
  2936. \"$\" find math expressions surrounded by $...$
  2937. \"$$\" find math expressions surrounded by $$....$$
  2938. \"\\(\" find math expressions surrounded by \\(...\\)
  2939. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2940. :group 'org-latex
  2941. :type 'plist)
  2942. (defcustom org-format-latex-signal-error t
  2943. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2944. When nil, just push out a message."
  2945. :group 'org-latex
  2946. :version "24.1"
  2947. :type 'boolean)
  2948. (defcustom org-latex-to-mathml-jar-file nil
  2949. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  2950. Use this to specify additional executable file say a jar file.
  2951. When using MathToWeb as the converter, specify the full-path to
  2952. your mathtoweb.jar file."
  2953. :group 'org-latex
  2954. :version "24.1"
  2955. :type '(choice
  2956. (const :tag "None" nil)
  2957. (file :tag "JAR file" :must-match t)))
  2958. (defcustom org-latex-to-mathml-convert-command nil
  2959. "Command to convert LaTeX fragments to MathML.
  2960. Replace format-specifiers in the command as noted below and use
  2961. `shell-command' to convert LaTeX to MathML.
  2962. %j: Executable file in fully expanded form as specified by
  2963. `org-latex-to-mathml-jar-file'.
  2964. %I: Input LaTeX file in fully expanded form
  2965. %o: Output MathML file
  2966. This command is used by `org-create-math-formula'.
  2967. When using MathToWeb as the converter, set this to
  2968. \"java -jar %j -unicode -force -df %o %I\"."
  2969. :group 'org-latex
  2970. :version "24.1"
  2971. :type '(choice
  2972. (const :tag "None" nil)
  2973. (string :tag "\nShell command")))
  2974. (defcustom org-latex-create-formula-image-program 'dvipng
  2975. "Program to convert LaTeX fragments with.
  2976. dvipng Process the LaTeX fragments to dvi file, then convert
  2977. dvi files to png files using dvipng.
  2978. This will also include processing of non-math environments.
  2979. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  2980. to convert pdf files to png files"
  2981. :group 'org-latex
  2982. :version "24.1"
  2983. :type '(choice
  2984. (const :tag "dvipng" dvipng)
  2985. (const :tag "imagemagick" imagemagick)))
  2986. (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
  2987. "Path to store latex preview images. A relative path here creates many
  2988. directories relative to the processed org files paths. An absolute path
  2989. puts all preview images at the same place."
  2990. :group 'org-latex
  2991. ;; :version "24.3"
  2992. :type 'string)
  2993. (defun org-format-latex-mathml-available-p ()
  2994. "Return t if `org-latex-to-mathml-convert-command' is usable."
  2995. (save-match-data
  2996. (when (and (boundp 'org-latex-to-mathml-convert-command)
  2997. org-latex-to-mathml-convert-command)
  2998. (let ((executable (car (split-string
  2999. org-latex-to-mathml-convert-command))))
  3000. (when (executable-find executable)
  3001. (if (string-match
  3002. "%j" org-latex-to-mathml-convert-command)
  3003. (file-readable-p org-latex-to-mathml-jar-file)
  3004. t))))))
  3005. (defcustom org-format-latex-header "\\documentclass{article}
  3006. \\usepackage[usenames]{color}
  3007. \\usepackage{amsmath}
  3008. \\usepackage[mathscr]{eucal}
  3009. \\pagestyle{empty} % do not remove
  3010. \[PACKAGES]
  3011. \[DEFAULT-PACKAGES]
  3012. % The settings below are copied from fullpage.sty
  3013. \\setlength{\\textwidth}{\\paperwidth}
  3014. \\addtolength{\\textwidth}{-3cm}
  3015. \\setlength{\\oddsidemargin}{1.5cm}
  3016. \\addtolength{\\oddsidemargin}{-2.54cm}
  3017. \\setlength{\\evensidemargin}{\\oddsidemargin}
  3018. \\setlength{\\textheight}{\\paperheight}
  3019. \\addtolength{\\textheight}{-\\headheight}
  3020. \\addtolength{\\textheight}{-\\headsep}
  3021. \\addtolength{\\textheight}{-\\footskip}
  3022. \\addtolength{\\textheight}{-3cm}
  3023. \\setlength{\\topmargin}{1.5cm}
  3024. \\addtolength{\\topmargin}{-2.54cm}"
  3025. "The document header used for processing LaTeX fragments.
  3026. It is imperative that this header make sure that no page number
  3027. appears on the page. The package defined in the variables
  3028. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  3029. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  3030. will be appended."
  3031. :group 'org-latex
  3032. :type 'string)
  3033. (defvar org-format-latex-header-extra nil)
  3034. (defun org-set-packages-alist (var val)
  3035. "Set the packages alist and make sure it has 3 elements per entry."
  3036. (set var (mapcar (lambda (x)
  3037. (if (and (consp x) (= (length x) 2))
  3038. (list (car x) (nth 1 x) t)
  3039. x))
  3040. val)))
  3041. (defun org-get-packages-alist (var)
  3042. "Get the packages alist and make sure it has 3 elements per entry."
  3043. (mapcar (lambda (x)
  3044. (if (and (consp x) (= (length x) 2))
  3045. (list (car x) (nth 1 x) t)
  3046. x))
  3047. (default-value var)))
  3048. ;; The following variables are defined here because is it also used
  3049. ;; when formatting latex fragments. Originally it was part of the
  3050. ;; LaTeX exporter, which is why the name includes "export".
  3051. (defcustom org-export-latex-default-packages-alist
  3052. '(("AUTO" "inputenc" t)
  3053. ("T1" "fontenc" t)
  3054. ("" "fixltx2e" nil)
  3055. ("" "graphicx" t)
  3056. ("" "longtable" nil)
  3057. ("" "float" nil)
  3058. ("" "wrapfig" nil)
  3059. ("" "soul" t)
  3060. ("" "textcomp" t)
  3061. ("" "marvosym" t)
  3062. ("" "wasysym" t)
  3063. ("" "latexsym" t)
  3064. ("" "amssymb" t)
  3065. ("" "hyperref" nil)
  3066. "\\tolerance=1000"
  3067. )
  3068. "Alist of default packages to be inserted in the header.
  3069. Change this only if one of the packages here causes an incompatibility
  3070. with another package you are using.
  3071. The packages in this list are needed by one part or another of Org-mode
  3072. to function properly.
  3073. - inputenc, fontenc: for basic font and character selection
  3074. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  3075. for interpreting the entities in `org-entities'. You can skip some of these
  3076. packages if you don't use any of the symbols in it.
  3077. - graphicx: for including images
  3078. - float, wrapfig: for figure placement
  3079. - longtable: for long tables
  3080. - hyperref: for cross references
  3081. Therefore you should not modify this variable unless you know what you
  3082. are doing. The one reason to change it anyway is that you might be loading
  3083. some other package that conflicts with one of the default packages.
  3084. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  3085. If SNIPPET-FLAG is t, the package also needs to be included when
  3086. compiling LaTeX snippets into images for inclusion into HTML."
  3087. :group 'org-export-latex
  3088. :set 'org-set-packages-alist
  3089. :get 'org-get-packages-alist
  3090. :version "24.1"
  3091. :type '(repeat
  3092. (choice
  3093. (list :tag "options/package pair"
  3094. (string :tag "options")
  3095. (string :tag "package")
  3096. (boolean :tag "Snippet"))
  3097. (string :tag "A line of LaTeX"))))
  3098. (defcustom org-export-latex-packages-alist nil
  3099. "Alist of packages to be inserted in every LaTeX header.
  3100. These will be inserted after `org-export-latex-default-packages-alist'.
  3101. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  3102. SNIPPET-FLAG, when t, indicates that this package is also needed when
  3103. turning LaTeX snippets into images for inclusion into HTML.
  3104. Make sure that you only list packages here which:
  3105. - you want in every file
  3106. - do not conflict with the default packages in
  3107. `org-export-latex-default-packages-alist'
  3108. - do not conflict with the setup in `org-format-latex-header'."
  3109. :group 'org-export-latex
  3110. :set 'org-set-packages-alist
  3111. :get 'org-get-packages-alist
  3112. :type '(repeat
  3113. (choice
  3114. (list :tag "options/package pair"
  3115. (string :tag "options")
  3116. (string :tag "package")
  3117. (boolean :tag "Snippet"))
  3118. (string :tag "A line of LaTeX"))))
  3119. (defgroup org-appearance nil
  3120. "Settings for Org-mode appearance."
  3121. :tag "Org Appearance"
  3122. :group 'org)
  3123. (defcustom org-level-color-stars-only nil
  3124. "Non-nil means fontify only the stars in each headline.
  3125. When nil, the entire headline is fontified.
  3126. Changing it requires restart of `font-lock-mode' to become effective
  3127. also in regions already fontified."
  3128. :group 'org-appearance
  3129. :type 'boolean)
  3130. (defcustom org-hide-leading-stars nil
  3131. "Non-nil means hide the first N-1 stars in a headline.
  3132. This works by using the face `org-hide' for these stars. This
  3133. face is white for a light background, and black for a dark
  3134. background. You may have to customize the face `org-hide' to
  3135. make this work.
  3136. Changing it requires restart of `font-lock-mode' to become effective
  3137. also in regions already fontified.
  3138. You may also set this on a per-file basis by adding one of the following
  3139. lines to the buffer:
  3140. #+STARTUP: hidestars
  3141. #+STARTUP: showstars"
  3142. :group 'org-appearance
  3143. :type 'boolean)
  3144. (defcustom org-hidden-keywords nil
  3145. "List of symbols corresponding to keywords to be hidden the org buffer.
  3146. For example, a value '(title) for this list will make the document's title
  3147. appear in the buffer without the initial #+TITLE: keyword."
  3148. :group 'org-appearance
  3149. :version "24.1"
  3150. :type '(set (const :tag "#+AUTHOR" author)
  3151. (const :tag "#+DATE" date)
  3152. (const :tag "#+EMAIL" email)
  3153. (const :tag "#+TITLE" title)))
  3154. (defcustom org-custom-properties nil
  3155. "List of properties (as strings) with a special meaning.
  3156. The default use of these custom properties is to let the user
  3157. hide them with `org-toggle-custom-properties-visibility'."
  3158. :group 'org-properties
  3159. :group 'org-appearance
  3160. ;; :version "24.3"
  3161. :type '(repeat (string :tag "Property Name")))
  3162. (defcustom org-fontify-done-headline nil
  3163. "Non-nil means change the face of a headline if it is marked DONE.
  3164. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3165. When this is non-nil, the headline after the keyword is set to the
  3166. `org-headline-done' as an additional indication."
  3167. :group 'org-appearance
  3168. :type 'boolean)
  3169. (defcustom org-fontify-emphasized-text t
  3170. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3171. Changing this variable requires a restart of Emacs to take effect."
  3172. :group 'org-appearance
  3173. :type 'boolean)
  3174. (defcustom org-fontify-whole-heading-line nil
  3175. "Non-nil means fontify the whole line for headings.
  3176. This is useful when setting a background color for the
  3177. org-level-* faces."
  3178. :group 'org-appearance
  3179. :type 'boolean)
  3180. (defcustom org-highlight-latex-fragments-and-specials nil
  3181. "Non-nil means fontify what is treated specially by the exporters."
  3182. :group 'org-appearance
  3183. :type 'boolean)
  3184. (defcustom org-hide-emphasis-markers nil
  3185. "Non-nil mean font-lock should hide the emphasis marker characters."
  3186. :group 'org-appearance
  3187. :type 'boolean)
  3188. (defcustom org-pretty-entities nil
  3189. "Non-nil means show entities as UTF8 characters.
  3190. When nil, the \\name form remains in the buffer."
  3191. :group 'org-appearance
  3192. :version "24.1"
  3193. :type 'boolean)
  3194. (defcustom org-pretty-entities-include-sub-superscripts t
  3195. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3196. :group 'org-appearance
  3197. :version "24.1"
  3198. :type 'boolean)
  3199. (defvar org-emph-re nil
  3200. "Regular expression for matching emphasis.
  3201. After a match, the match groups contain these elements:
  3202. 0 The match of the full regular expression, including the characters
  3203. before and after the proper match
  3204. 1 The character before the proper match, or empty at beginning of line
  3205. 2 The proper match, including the leading and trailing markers
  3206. 3 The leading marker like * or /, indicating the type of highlighting
  3207. 4 The text between the emphasis markers, not including the markers
  3208. 5 The character after the match, empty at the end of a line")
  3209. (defvar org-verbatim-re nil
  3210. "Regular expression for matching verbatim text.")
  3211. (defvar org-emphasis-regexp-components) ; defined just below
  3212. (defvar org-emphasis-alist) ; defined just below
  3213. (defun org-set-emph-re (var val)
  3214. "Set variable and compute the emphasis regular expression."
  3215. (set var val)
  3216. (when (and (boundp 'org-emphasis-alist)
  3217. (boundp 'org-emphasis-regexp-components)
  3218. org-emphasis-alist org-emphasis-regexp-components)
  3219. (let* ((e org-emphasis-regexp-components)
  3220. (pre (car e))
  3221. (post (nth 1 e))
  3222. (border (nth 2 e))
  3223. (body (nth 3 e))
  3224. (nl (nth 4 e))
  3225. (body1 (concat body "*?"))
  3226. (markers (mapconcat 'car org-emphasis-alist ""))
  3227. (vmarkers (mapconcat
  3228. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  3229. org-emphasis-alist "")))
  3230. ;; make sure special characters appear at the right position in the class
  3231. (if (string-match "\\^" markers)
  3232. (setq markers (concat (replace-match "" t t markers) "^")))
  3233. (if (string-match "-" markers)
  3234. (setq markers (concat (replace-match "" t t markers) "-")))
  3235. (if (string-match "\\^" vmarkers)
  3236. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3237. (if (string-match "-" vmarkers)
  3238. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3239. (if (> nl 0)
  3240. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3241. (int-to-string nl) "\\}")))
  3242. ;; Make the regexp
  3243. (setq org-emph-re
  3244. (concat "\\([" pre "]\\|^\\)"
  3245. "\\("
  3246. "\\([" markers "]\\)"
  3247. "\\("
  3248. "[^" border "]\\|"
  3249. "[^" border "]"
  3250. body1
  3251. "[^" border "]"
  3252. "\\)"
  3253. "\\3\\)"
  3254. "\\([" post "]\\|$\\)"))
  3255. (setq org-verbatim-re
  3256. (concat "\\([" pre "]\\|^\\)"
  3257. "\\("
  3258. "\\([" vmarkers "]\\)"
  3259. "\\("
  3260. "[^" border "]\\|"
  3261. "[^" border "]"
  3262. body1
  3263. "[^" border "]"
  3264. "\\)"
  3265. "\\3\\)"
  3266. "\\([" post "]\\|$\\)")))))
  3267. (defcustom org-emphasis-regexp-components
  3268. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3269. "Components used to build the regular expression for emphasis.
  3270. This is a list with five entries. Terminology: In an emphasis string
  3271. like \" *strong word* \", we call the initial space PREMATCH, the final
  3272. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3273. and \"trong wor\" is the body. The different components in this variable
  3274. specify what is allowed/forbidden in each part:
  3275. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3276. post Chars allowed as postmatch. End of line will be allowed too.
  3277. border The chars *forbidden* as border characters.
  3278. body-regexp A regexp like \".\" to match a body character. Don't use
  3279. non-shy groups here, and don't allow newline here.
  3280. newline The maximum number of newlines allowed in an emphasis exp.
  3281. Use customize to modify this, or restart Emacs after changing it."
  3282. :group 'org-appearance
  3283. :set 'org-set-emph-re
  3284. :type '(list
  3285. (sexp :tag "Allowed chars in pre ")
  3286. (sexp :tag "Allowed chars in post ")
  3287. (sexp :tag "Forbidden chars in border ")
  3288. (sexp :tag "Regexp for body ")
  3289. (integer :tag "number of newlines allowed")
  3290. (option (boolean :tag "Please ignore this button"))))
  3291. (defcustom org-emphasis-alist
  3292. `(("*" bold "<b>" "</b>")
  3293. ("/" italic "<i>" "</i>")
  3294. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  3295. ("=" org-code "<code>" "</code>" verbatim)
  3296. ("~" org-verbatim "<code>" "</code>" verbatim)
  3297. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  3298. "<del>" "</del>")
  3299. )
  3300. "Special syntax for emphasized text.
  3301. Text starting and ending with a special character will be emphasized, for
  3302. example *bold*, _underlined_ and /italic/. This variable sets the marker
  3303. characters, the face to be used by font-lock for highlighting in Org-mode
  3304. Emacs buffers, and the HTML tags to be used for this.
  3305. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  3306. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  3307. Use customize to modify this, or restart Emacs after changing it."
  3308. :group 'org-appearance
  3309. :set 'org-set-emph-re
  3310. :type '(repeat
  3311. (list
  3312. (string :tag "Marker character")
  3313. (choice
  3314. (face :tag "Font-lock-face")
  3315. (plist :tag "Face property list"))
  3316. (string :tag "HTML start tag")
  3317. (string :tag "HTML end tag")
  3318. (option (const verbatim)))))
  3319. (defvar org-protecting-blocks
  3320. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  3321. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3322. This is needed for font-lock setup.")
  3323. ;;; Miscellaneous options
  3324. (defgroup org-completion nil
  3325. "Completion in Org-mode."
  3326. :tag "Org Completion"
  3327. :group 'org)
  3328. (defcustom org-completion-use-ido nil
  3329. "Non-nil means use ido completion wherever possible.
  3330. Note that `ido-mode' must be active for this variable to be relevant.
  3331. If you decide to turn this variable on, you might well want to turn off
  3332. `org-outline-path-complete-in-steps'.
  3333. See also `org-completion-use-iswitchb'."
  3334. :group 'org-completion
  3335. :type 'boolean)
  3336. (defcustom org-completion-use-iswitchb nil
  3337. "Non-nil means use iswitchb completion wherever possible.
  3338. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3339. If you decide to turn this variable on, you might well want to turn off
  3340. `org-outline-path-complete-in-steps'.
  3341. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3342. :group 'org-completion
  3343. :type 'boolean)
  3344. (defcustom org-completion-fallback-command 'hippie-expand
  3345. "The expansion command called by \\[pcomplete] in normal context.
  3346. Normal means, no org-mode-specific context."
  3347. :group 'org-completion
  3348. :type 'function)
  3349. ;;; Functions and variables from their packages
  3350. ;; Declared here to avoid compiler warnings
  3351. ;; XEmacs only
  3352. (defvar outline-mode-menu-heading)
  3353. (defvar outline-mode-menu-show)
  3354. (defvar outline-mode-menu-hide)
  3355. (defvar zmacs-regions) ; XEmacs regions
  3356. ;; Emacs only
  3357. (defvar mark-active)
  3358. ;; Various packages
  3359. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3360. (declare-function calendar-forward-day "cal-move" (arg))
  3361. (declare-function calendar-goto-date "cal-move" (date))
  3362. (declare-function calendar-goto-today "cal-move" ())
  3363. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3364. (defvar calc-embedded-close-formula)
  3365. (defvar calc-embedded-open-formula)
  3366. (declare-function cdlatex-tab "ext:cdlatex" ())
  3367. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3368. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3369. (defvar font-lock-unfontify-region-function)
  3370. (declare-function iswitchb-read-buffer "iswitchb"
  3371. (prompt &optional default require-match start matches-set))
  3372. (defvar iswitchb-temp-buflist)
  3373. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3374. (defvar org-agenda-tags-todo-honor-ignore-options)
  3375. (declare-function org-agenda-skip "org-agenda" ())
  3376. (declare-function
  3377. org-agenda-format-item "org-agenda"
  3378. (extra txt &optional level category tags dotime noprefix remove-re habitp))
  3379. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3380. (declare-function org-agenda-change-all-lines "org-agenda"
  3381. (newhead hdmarker &optional fixface just-this))
  3382. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3383. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3384. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3385. (beg end))
  3386. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3387. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3388. "org-agenda" (&optional end))
  3389. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3390. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3391. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3392. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3393. (declare-function org-indent-mode "org-indent" (&optional arg))
  3394. (declare-function parse-time-string "parse-time" (string))
  3395. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3396. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3397. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3398. (defvar remember-data-file)
  3399. (defvar texmathp-why)
  3400. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3401. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3402. (defvar w3m-current-url)
  3403. (defvar w3m-current-title)
  3404. (defvar org-latex-regexps)
  3405. ;;; Autoload and prepare some org modules
  3406. ;; Some table stuff that needs to be defined here, because it is used
  3407. ;; by the functions setting up org-mode or checking for table context.
  3408. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3409. "Detect an org-type or table-type table.")
  3410. (defconst org-table-line-regexp "^[ \t]*|"
  3411. "Detect an org-type table line.")
  3412. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3413. "Detect an org-type table line.")
  3414. (defconst org-table-hline-regexp "^[ \t]*|-"
  3415. "Detect an org-type table hline.")
  3416. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3417. "Detect a table-type table hline.")
  3418. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3419. "Detect the first line outside a table when searching from within it.
  3420. This works for both table types.")
  3421. ;; Autoload the functions in org-table.el that are needed by functions here.
  3422. (eval-and-compile
  3423. (org-autoload "org-table"
  3424. '(org-table-align org-table-begin org-table-blank-field
  3425. org-table-convert org-table-convert-region org-table-copy-down
  3426. org-table-copy-region org-table-create
  3427. org-table-create-or-convert-from-region
  3428. org-table-create-with-table.el org-table-current-dline
  3429. org-table-cut-region org-table-delete-column org-table-edit-field
  3430. org-table-edit-formulas org-table-end org-table-eval-formula
  3431. org-table-export org-table-field-info
  3432. org-table-get-stored-formulas org-table-goto-column
  3433. org-table-hline-and-move org-table-import org-table-insert-column
  3434. org-table-insert-hline org-table-insert-row org-table-iterate
  3435. org-table-justify-field-maybe org-table-kill-row
  3436. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  3437. org-table-move-column org-table-move-column-left
  3438. org-table-move-column-right org-table-move-row
  3439. org-table-move-row-down org-table-move-row-up
  3440. org-table-next-field org-table-next-row org-table-paste-rectangle
  3441. org-table-previous-field org-table-recalculate
  3442. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  3443. org-table-toggle-coordinate-overlays
  3444. org-table-toggle-formula-debugger org-table-wrap-region
  3445. orgtbl-mode turn-on-orgtbl org-table-to-lisp
  3446. orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
  3447. orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
  3448. (defun org-at-table-p (&optional table-type)
  3449. "Return t if the cursor is inside an org-type table.
  3450. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3451. (if org-enable-table-editor
  3452. (save-excursion
  3453. (beginning-of-line 1)
  3454. (looking-at (if table-type org-table-any-line-regexp
  3455. org-table-line-regexp)))
  3456. nil))
  3457. (defsubst org-table-p () (org-at-table-p))
  3458. (defun org-at-table.el-p ()
  3459. "Return t if and only if we are at a table.el table."
  3460. (and (org-at-table-p 'any)
  3461. (save-excursion
  3462. (goto-char (org-table-begin 'any))
  3463. (looking-at org-table1-hline-regexp))))
  3464. (defun org-table-recognize-table.el ()
  3465. "If there is a table.el table nearby, recognize it and move into it."
  3466. (if org-table-tab-recognizes-table.el
  3467. (if (org-at-table.el-p)
  3468. (progn
  3469. (beginning-of-line 1)
  3470. (if (looking-at org-table-dataline-regexp)
  3471. nil
  3472. (if (looking-at org-table1-hline-regexp)
  3473. (progn
  3474. (beginning-of-line 2)
  3475. (if (looking-at org-table-any-border-regexp)
  3476. (beginning-of-line -1)))))
  3477. (if (re-search-forward "|" (org-table-end t) t)
  3478. (progn
  3479. (require 'table)
  3480. (if (table--at-cell-p (point))
  3481. t
  3482. (message "recognizing table.el table...")
  3483. (table-recognize-table)
  3484. (message "recognizing table.el table...done")))
  3485. (error "This should not happen"))
  3486. t)
  3487. nil)
  3488. nil))
  3489. (defun org-at-table-hline-p ()
  3490. "Return t if the cursor is inside a hline in a table."
  3491. (if org-enable-table-editor
  3492. (save-excursion
  3493. (beginning-of-line 1)
  3494. (looking-at org-table-hline-regexp))
  3495. nil))
  3496. (defvar org-table-clean-did-remove-column nil)
  3497. (defun org-table-map-tables (function &optional quietly)
  3498. "Apply FUNCTION to the start of all tables in the buffer."
  3499. (save-excursion
  3500. (save-restriction
  3501. (widen)
  3502. (goto-char (point-min))
  3503. (while (re-search-forward org-table-any-line-regexp nil t)
  3504. (unless quietly
  3505. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3506. (beginning-of-line 1)
  3507. (when (and (looking-at org-table-line-regexp)
  3508. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3509. (not (org-in-block-p '("src" "example"))))
  3510. (save-excursion (funcall function))
  3511. (or (looking-at org-table-line-regexp)
  3512. (forward-char 1)))
  3513. (re-search-forward org-table-any-border-regexp nil 1))))
  3514. (unless quietly (message "Mapping tables: done")))
  3515. ;; Declare and autoload functions from org-exp.el & Co
  3516. (declare-function org-default-export-plist "org-exp")
  3517. (declare-function org-infile-export-plist "org-exp")
  3518. (declare-function org-get-current-options "org-exp")
  3519. (eval-and-compile
  3520. (org-autoload "org-exp"
  3521. '(org-export org-export-visible
  3522. org-insert-export-options-template
  3523. org-table-clean-before-export))
  3524. (org-autoload "org-ascii"
  3525. '(org-export-as-ascii org-export-ascii-preprocess
  3526. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3527. org-export-region-as-ascii))
  3528. (org-autoload "org-latex"
  3529. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3530. org-replace-region-by-latex org-export-region-as-latex
  3531. org-export-as-latex org-export-as-pdf
  3532. org-export-as-pdf-and-open))
  3533. (org-autoload "org-html"
  3534. '(org-export-as-html-and-open
  3535. org-export-as-html-batch org-export-as-html-to-buffer
  3536. org-replace-region-by-html org-export-region-as-html
  3537. org-export-as-html))
  3538. (org-autoload "org-docbook"
  3539. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3540. org-replace-region-by-docbook org-export-region-as-docbook
  3541. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3542. org-export-as-docbook))
  3543. (org-autoload "org-icalendar"
  3544. '(org-export-icalendar-this-file
  3545. org-export-icalendar-all-agenda-files
  3546. org-export-icalendar-combine-agenda-files))
  3547. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3548. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3549. ;; Declare and autoload functions from org-agenda.el
  3550. (eval-and-compile
  3551. (org-autoload "org-agenda"
  3552. '(org-agenda org-agenda-list org-search-view
  3553. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3554. org-diary org-agenda-to-appt
  3555. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3556. ;; Autoload org-remember
  3557. (eval-and-compile
  3558. (org-autoload "org-remember"
  3559. '(org-remember-insinuate org-remember-annotation
  3560. org-remember-apply-template org-remember org-remember-handler)))
  3561. (eval-and-compile
  3562. (org-autoload "org-capture"
  3563. '(org-capture org-capture-insert-template-here
  3564. org-capture-import-remember-templates)))
  3565. ;; Autoload org-clock.el
  3566. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3567. (beg end))
  3568. (declare-function org-clock-update-mode-line "org-clock" ())
  3569. (declare-function org-resolve-clocks "org-clock"
  3570. (&optional also-non-dangling-p prompt last-valid))
  3571. (defvar org-clock-start-time)
  3572. (defvar org-clock-marker (make-marker)
  3573. "Marker recording the last clock-in.")
  3574. (defvar org-clock-hd-marker (make-marker)
  3575. "Marker recording the last clock-in, but the headline position.")
  3576. (defvar org-clock-heading ""
  3577. "The heading of the current clock entry.")
  3578. (defun org-clock-is-active ()
  3579. "Return non-nil if clock is currently running.
  3580. The return value is actually the clock marker."
  3581. (marker-buffer org-clock-marker))
  3582. (eval-and-compile
  3583. (org-autoload
  3584. "org-clock"
  3585. '(org-clock-in org-clock-out org-clock-cancel
  3586. org-clock-goto org-clock-sum org-clock-display
  3587. org-clock-remove-overlays org-clock-report
  3588. org-clocktable-shift org-dblock-write:clocktable
  3589. org-get-clocktable org-resolve-clocks)))
  3590. (defun org-clock-update-time-maybe ()
  3591. "If this is a CLOCK line, update it and return t.
  3592. Otherwise, return nil."
  3593. (interactive)
  3594. (save-excursion
  3595. (beginning-of-line 1)
  3596. (skip-chars-forward " \t")
  3597. (when (looking-at org-clock-string)
  3598. (let ((re (concat "[ \t]*" org-clock-string
  3599. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3600. "\\([ \t]*=>.*\\)?\\)?"))
  3601. ts te h m s neg)
  3602. (cond
  3603. ((not (looking-at re))
  3604. nil)
  3605. ((not (match-end 2))
  3606. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3607. (> org-clock-marker (point))
  3608. (<= org-clock-marker (point-at-eol)))
  3609. ;; The clock is running here
  3610. (setq org-clock-start-time
  3611. (apply 'encode-time
  3612. (org-parse-time-string (match-string 1))))
  3613. (org-clock-update-mode-line)))
  3614. (t
  3615. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3616. (end-of-line 1)
  3617. (setq ts (match-string 1)
  3618. te (match-string 3))
  3619. (setq s (- (org-float-time
  3620. (apply 'encode-time (org-parse-time-string te)))
  3621. (org-float-time
  3622. (apply 'encode-time (org-parse-time-string ts))))
  3623. neg (< s 0)
  3624. s (abs s)
  3625. h (floor (/ s 3600))
  3626. s (- s (* 3600 h))
  3627. m (floor (/ s 60))
  3628. s (- s (* 60 s)))
  3629. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3630. t))))))
  3631. (defun org-check-running-clock ()
  3632. "Check if the current buffer contains the running clock.
  3633. If yes, offer to stop it and to save the buffer with the changes."
  3634. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3635. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3636. (buffer-name))))
  3637. (org-clock-out)
  3638. (when (y-or-n-p "Save changed buffer?")
  3639. (save-buffer))))
  3640. (defun org-clocktable-try-shift (dir n)
  3641. "Check if this line starts a clock table, if yes, shift the time block."
  3642. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3643. (org-clocktable-shift dir n)))
  3644. ;; Autoload org-timer.el
  3645. (eval-and-compile
  3646. (org-autoload
  3647. "org-timer"
  3648. '(org-timer-start org-timer org-timer-item
  3649. org-timer-change-times-in-region
  3650. org-timer-set-timer
  3651. org-timer-reset-timers
  3652. org-timer-show-remaining-time)))
  3653. ;; Autoload org-feed.el
  3654. (eval-and-compile
  3655. (org-autoload
  3656. "org-feed"
  3657. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3658. ;; Autoload org-indent.el
  3659. ;; Define the variable already here, to make sure we have it.
  3660. (defvar org-indent-mode nil
  3661. "Non-nil if Org-Indent mode is enabled.
  3662. Use the command `org-indent-mode' to change this variable.")
  3663. (eval-and-compile
  3664. (org-autoload
  3665. "org-indent"
  3666. '(org-indent-mode)))
  3667. ;; Autoload org-mobile.el
  3668. (eval-and-compile
  3669. (org-autoload
  3670. "org-mobile"
  3671. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3672. ;; Autoload archiving code
  3673. ;; The stuff that is needed for cycling and tags has to be defined here.
  3674. (defgroup org-archive nil
  3675. "Options concerning archiving in Org-mode."
  3676. :tag "Org Archive"
  3677. :group 'org-structure)
  3678. (defcustom org-archive-location "%s_archive::"
  3679. "The location where subtrees should be archived.
  3680. The value of this variable is a string, consisting of two parts,
  3681. separated by a double-colon. The first part is a filename and
  3682. the second part is a headline.
  3683. When the filename is omitted, archiving happens in the same file.
  3684. %s in the filename will be replaced by the current file
  3685. name (without the directory part). Archiving to a different file
  3686. is useful to keep archived entries from contributing to the
  3687. Org-mode Agenda.
  3688. The archived entries will be filed as subtrees of the specified
  3689. headline. When the headline is omitted, the subtrees are simply
  3690. filed away at the end of the file, as top-level entries. Also in
  3691. the heading you can use %s to represent the file name, this can be
  3692. useful when using the same archive for a number of different files.
  3693. Here are a few examples:
  3694. \"%s_archive::\"
  3695. If the current file is Projects.org, archive in file
  3696. Projects.org_archive, as top-level trees. This is the default.
  3697. \"::* Archived Tasks\"
  3698. Archive in the current file, under the top-level headline
  3699. \"* Archived Tasks\".
  3700. \"~/org/archive.org::\"
  3701. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3702. \"~/org/archive.org::* From %s\"
  3703. Archive in file ~/org/archive.org (absolute path), under headlines
  3704. \"From FILENAME\" where file name is the current file name.
  3705. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3706. The \"datetree/\" string is special, signifying to archive
  3707. items to the datetree. Items are placed in either the CLOSED
  3708. date of the item, or the current date if there is no CLOSED date.
  3709. The heading will be a subentry to the current date. There doesn't
  3710. need to be a heading, but there always needs to be a slash after
  3711. datetree. For example, to store archived items directly in the
  3712. datetree, use \"~/org/datetree.org::datetree/\".
  3713. \"basement::** Finished Tasks\"
  3714. Archive in file ./basement (relative path), as level 3 trees
  3715. below the level 2 heading \"** Finished Tasks\".
  3716. You may set this option on a per-file basis by adding to the buffer a
  3717. line like
  3718. #+ARCHIVE: basement::** Finished Tasks
  3719. You may also define it locally for a subtree by setting an ARCHIVE property
  3720. in the entry. If such a property is found in an entry, or anywhere up
  3721. the hierarchy, it will be used."
  3722. :group 'org-archive
  3723. :type 'string)
  3724. (defcustom org-archive-tag "ARCHIVE"
  3725. "The tag that marks a subtree as archived.
  3726. An archived subtree does not open during visibility cycling, and does
  3727. not contribute to the agenda listings.
  3728. After changing this, font-lock must be restarted in the relevant buffers to
  3729. get the proper fontification."
  3730. :group 'org-archive
  3731. :group 'org-keywords
  3732. :type 'string)
  3733. (defcustom org-agenda-skip-archived-trees t
  3734. "Non-nil means the agenda will skip any items located in archived trees.
  3735. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3736. variable is no longer recommended, you should leave it at the value t.
  3737. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3738. :group 'org-archive
  3739. :group 'org-agenda-skip
  3740. :type 'boolean)
  3741. (defcustom org-columns-skip-archived-trees t
  3742. "Non-nil means ignore archived trees when creating column view."
  3743. :group 'org-archive
  3744. :group 'org-properties
  3745. :type 'boolean)
  3746. (defcustom org-cycle-open-archived-trees nil
  3747. "Non-nil means `org-cycle' will open archived trees.
  3748. An archived tree is a tree marked with the tag ARCHIVE.
  3749. When nil, archived trees will stay folded. You can still open them with
  3750. normal outline commands like `show-all', but not with the cycling commands."
  3751. :group 'org-archive
  3752. :group 'org-cycle
  3753. :type 'boolean)
  3754. (defcustom org-sparse-tree-open-archived-trees nil
  3755. "Non-nil means sparse tree construction shows matches in archived trees.
  3756. When nil, matches in these trees are highlighted, but the trees are kept in
  3757. collapsed state."
  3758. :group 'org-archive
  3759. :group 'org-sparse-trees
  3760. :type 'boolean)
  3761. (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
  3762. "The default date type when building a sparse tree.
  3763. When this is nil, a date is a scheduled or a deadline timestamp.
  3764. Otherwise, these types are allowed:
  3765. all: all timestamps
  3766. active: only active timestamps (<...>)
  3767. inactive: only inactive timestamps (<...)
  3768. scheduled: only scheduled timestamps
  3769. deadline: only deadline timestamps"
  3770. :type '(choice (const :tag "Scheduled or deadline" 'scheduled-or-deadline)
  3771. (const :tag "All timestamps" all)
  3772. (const :tag "Only active timestamps" active)
  3773. (const :tag "Only inactive timestamps" inactive)
  3774. (const :tag "Only scheduled timestamps" scheduled)
  3775. (const :tag "Only deadline timestamps" deadline))
  3776. ;; :version "24.3"
  3777. :group 'org-sparse-trees)
  3778. (defun org-cycle-hide-archived-subtrees (state)
  3779. "Re-hide all archived subtrees after a visibility state change."
  3780. (when (and (not org-cycle-open-archived-trees)
  3781. (not (memq state '(overview folded))))
  3782. (save-excursion
  3783. (let* ((globalp (memq state '(contents all)))
  3784. (beg (if globalp (point-min) (point)))
  3785. (end (if globalp (point-max) (org-end-of-subtree t))))
  3786. (org-hide-archived-subtrees beg end)
  3787. (goto-char beg)
  3788. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3789. (message "%s" (substitute-command-keys
  3790. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3791. (defun org-force-cycle-archived ()
  3792. "Cycle subtree even if it is archived."
  3793. (interactive)
  3794. (setq this-command 'org-cycle)
  3795. (let ((org-cycle-open-archived-trees t))
  3796. (call-interactively 'org-cycle)))
  3797. (defun org-hide-archived-subtrees (beg end)
  3798. "Re-hide all archived subtrees after a visibility state change."
  3799. (save-excursion
  3800. (let* ((re (concat ":" org-archive-tag ":")))
  3801. (goto-char beg)
  3802. (while (re-search-forward re end t)
  3803. (when (org-at-heading-p)
  3804. (org-flag-subtree t)
  3805. (org-end-of-subtree t))))))
  3806. (declare-function outline-end-of-heading "outline" ())
  3807. (declare-function outline-flag-region "outline" (from to flag))
  3808. (defun org-flag-subtree (flag)
  3809. (save-excursion
  3810. (org-back-to-heading t)
  3811. (outline-end-of-heading)
  3812. (outline-flag-region (point)
  3813. (progn (org-end-of-subtree t) (point))
  3814. flag)))
  3815. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3816. (eval-and-compile
  3817. (org-autoload "org-archive"
  3818. '(org-add-archive-files org-archive-subtree
  3819. org-archive-to-archive-sibling org-toggle-archive-tag
  3820. org-archive-subtree-default
  3821. org-archive-subtree-default-with-confirmation)))
  3822. ;; Autoload Column View Code
  3823. (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
  3824. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  3825. (declare-function org-columns-compute "org-colview" (property))
  3826. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3827. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3828. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3829. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3830. ;; Autoload ID code
  3831. (declare-function org-id-store-link "org-id")
  3832. (declare-function org-id-locations-load "org-id")
  3833. (declare-function org-id-locations-save "org-id")
  3834. (defvar org-id-track-globally)
  3835. (org-autoload "org-id"
  3836. '(org-id-get-create org-id-new org-id-copy org-id-get
  3837. org-id-get-with-outline-path-completion
  3838. org-id-get-with-outline-drilling org-id-store-link
  3839. org-id-goto org-id-find org-id-store-link))
  3840. ;; Autoload Plotting Code
  3841. (org-autoload "org-plot"
  3842. '(org-plot/gnuplot))
  3843. ;;; Variables for pre-computed regular expressions, all buffer local
  3844. (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
  3845. "Matches first line of a hidden block.")
  3846. (make-variable-buffer-local 'org-drawer-regexp)
  3847. (defvar org-todo-regexp nil
  3848. "Matches any of the TODO state keywords.")
  3849. (make-variable-buffer-local 'org-todo-regexp)
  3850. (defvar org-not-done-regexp nil
  3851. "Matches any of the TODO state keywords except the last one.")
  3852. (make-variable-buffer-local 'org-not-done-regexp)
  3853. (defvar org-not-done-heading-regexp nil
  3854. "Matches a TODO headline that is not done.")
  3855. (make-variable-buffer-local 'org-not-done-regexp)
  3856. (defvar org-todo-line-regexp nil
  3857. "Matches a headline and puts TODO state into group 2 if present.")
  3858. (make-variable-buffer-local 'org-todo-line-regexp)
  3859. (defvar org-complex-heading-regexp nil
  3860. "Matches a headline and puts everything into groups:
  3861. group 1: the stars
  3862. group 2: The todo keyword, maybe
  3863. group 3: Priority cookie
  3864. group 4: True headline
  3865. group 5: Tags")
  3866. (make-variable-buffer-local 'org-complex-heading-regexp)
  3867. (defvar org-complex-heading-regexp-format nil
  3868. "Printf format to make regexp to match an exact headline.
  3869. This regexp will match the headline of any node which has the
  3870. exact headline text that is put into the format, but may have any
  3871. TODO state, priority and tags.")
  3872. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3873. (defvar org-todo-line-tags-regexp nil
  3874. "Matches a headline and puts TODO state into group 2 if present.
  3875. Also put tags into group 4 if tags are present.")
  3876. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3877. (defvar org-ds-keyword-length 12
  3878. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  3879. (make-variable-buffer-local 'org-ds-keyword-length)
  3880. (defvar org-deadline-regexp nil
  3881. "Matches the DEADLINE keyword.")
  3882. (make-variable-buffer-local 'org-deadline-regexp)
  3883. (defvar org-deadline-time-regexp nil
  3884. "Matches the DEADLINE keyword together with a time stamp.")
  3885. (make-variable-buffer-local 'org-deadline-time-regexp)
  3886. (defvar org-deadline-line-regexp nil
  3887. "Matches the DEADLINE keyword and the rest of the line.")
  3888. (make-variable-buffer-local 'org-deadline-line-regexp)
  3889. (defvar org-scheduled-regexp nil
  3890. "Matches the SCHEDULED keyword.")
  3891. (make-variable-buffer-local 'org-scheduled-regexp)
  3892. (defvar org-scheduled-time-regexp nil
  3893. "Matches the SCHEDULED keyword together with a time stamp.")
  3894. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3895. (defvar org-closed-time-regexp nil
  3896. "Matches the CLOSED keyword together with a time stamp.")
  3897. (make-variable-buffer-local 'org-closed-time-regexp)
  3898. (defvar org-keyword-time-regexp nil
  3899. "Matches any of the 4 keywords, together with the time stamp.")
  3900. (make-variable-buffer-local 'org-keyword-time-regexp)
  3901. (defvar org-keyword-time-not-clock-regexp nil
  3902. "Matches any of the 3 keywords, together with the time stamp.")
  3903. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3904. (defvar org-maybe-keyword-time-regexp nil
  3905. "Matches a timestamp, possibly preceded by a keyword.")
  3906. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3907. (defvar org-all-time-keywords nil
  3908. "List of time keywords.")
  3909. (make-variable-buffer-local 'org-all-time-keywords)
  3910. (defconst org-plain-time-of-day-regexp
  3911. (concat
  3912. "\\(\\<[012]?[0-9]"
  3913. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3914. "\\(--?"
  3915. "\\(\\<[012]?[0-9]"
  3916. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3917. "\\)?")
  3918. "Regular expression to match a plain time or time range.
  3919. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3920. groups carry important information:
  3921. 0 the full match
  3922. 1 the first time, range or not
  3923. 8 the second time, if it is a range.")
  3924. (defconst org-plain-time-extension-regexp
  3925. (concat
  3926. "\\(\\<[012]?[0-9]"
  3927. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3928. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3929. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3930. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3931. groups carry important information:
  3932. 0 the full match
  3933. 7 hours of duration
  3934. 9 minutes of duration")
  3935. (defconst org-stamp-time-of-day-regexp
  3936. (concat
  3937. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3938. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3939. "\\(--?"
  3940. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3941. "Regular expression to match a timestamp time or time range.
  3942. After a match, the following groups carry important information:
  3943. 0 the full match
  3944. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3945. 2 the first time, range or not
  3946. 4 the second time, if it is a range.")
  3947. (defconst org-startup-options
  3948. '(("fold" org-startup-folded t)
  3949. ("overview" org-startup-folded t)
  3950. ("nofold" org-startup-folded nil)
  3951. ("showall" org-startup-folded nil)
  3952. ("showeverything" org-startup-folded showeverything)
  3953. ("content" org-startup-folded content)
  3954. ("indent" org-startup-indented t)
  3955. ("noindent" org-startup-indented nil)
  3956. ("hidestars" org-hide-leading-stars t)
  3957. ("showstars" org-hide-leading-stars nil)
  3958. ("odd" org-odd-levels-only t)
  3959. ("oddeven" org-odd-levels-only nil)
  3960. ("align" org-startup-align-all-tables t)
  3961. ("noalign" org-startup-align-all-tables nil)
  3962. ("inlineimages" org-startup-with-inline-images t)
  3963. ("noinlineimages" org-startup-with-inline-images nil)
  3964. ("customtime" org-display-custom-times t)
  3965. ("logdone" org-log-done time)
  3966. ("lognotedone" org-log-done note)
  3967. ("nologdone" org-log-done nil)
  3968. ("lognoteclock-out" org-log-note-clock-out t)
  3969. ("nolognoteclock-out" org-log-note-clock-out nil)
  3970. ("logrepeat" org-log-repeat state)
  3971. ("lognoterepeat" org-log-repeat note)
  3972. ("nologrepeat" org-log-repeat nil)
  3973. ("logreschedule" org-log-reschedule time)
  3974. ("lognotereschedule" org-log-reschedule note)
  3975. ("nologreschedule" org-log-reschedule nil)
  3976. ("logredeadline" org-log-redeadline time)
  3977. ("lognoteredeadline" org-log-redeadline note)
  3978. ("nologredeadline" org-log-redeadline nil)
  3979. ("logrefile" org-log-refile time)
  3980. ("lognoterefile" org-log-refile note)
  3981. ("nologrefile" org-log-refile nil)
  3982. ("fninline" org-footnote-define-inline t)
  3983. ("nofninline" org-footnote-define-inline nil)
  3984. ("fnlocal" org-footnote-section nil)
  3985. ("fnauto" org-footnote-auto-label t)
  3986. ("fnprompt" org-footnote-auto-label nil)
  3987. ("fnconfirm" org-footnote-auto-label confirm)
  3988. ("fnplain" org-footnote-auto-label plain)
  3989. ("fnadjust" org-footnote-auto-adjust t)
  3990. ("nofnadjust" org-footnote-auto-adjust nil)
  3991. ("constcgs" constants-unit-system cgs)
  3992. ("constSI" constants-unit-system SI)
  3993. ("noptag" org-tag-persistent-alist nil)
  3994. ("hideblocks" org-hide-block-startup t)
  3995. ("nohideblocks" org-hide-block-startup nil)
  3996. ("beamer" org-startup-with-beamer-mode t)
  3997. ("entitiespretty" org-pretty-entities t)
  3998. ("entitiesplain" org-pretty-entities nil))
  3999. "Variable associated with STARTUP options for org-mode.
  4000. Each element is a list of three items: the startup options (as written
  4001. in the #+STARTUP line), the corresponding variable, and the value to set
  4002. this variable to if the option is found. An optional forth element PUSH
  4003. means to push this value onto the list in the variable.")
  4004. (defun org-update-property-plist (key val props)
  4005. "Update PROPS with KEY and VAL."
  4006. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  4007. (key (if appending (substring key 0 (- (length key) 1)) key))
  4008. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  4009. (previous (cdr (assoc key props))))
  4010. (if appending
  4011. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  4012. (cons (cons key val) remainder))))
  4013. (defconst org-block-regexp
  4014. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  4015. "Regular expression for hiding blocks.")
  4016. (defconst org-heading-keyword-regexp-format
  4017. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4018. "Printf format for a regexp matching an headline with some keyword.
  4019. This regexp will match the headline of any node which has the
  4020. exact keyword that is put into the format. The keyword isn't in
  4021. any group by default, but the stars and the body are.")
  4022. (defconst org-heading-keyword-maybe-regexp-format
  4023. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4024. "Printf format for a regexp matching an headline, possibly with some keyword.
  4025. This regexp can match any headline with the specified keyword, or
  4026. without a keyword. The keyword isn't in any group by default,
  4027. but the stars and the body are.")
  4028. (defun org-set-regexps-and-options ()
  4029. "Precompute regular expressions for current buffer."
  4030. (when (derived-mode-p 'org-mode)
  4031. (org-set-local 'org-todo-kwd-alist nil)
  4032. (org-set-local 'org-todo-key-alist nil)
  4033. (org-set-local 'org-todo-key-trigger nil)
  4034. (org-set-local 'org-todo-keywords-1 nil)
  4035. (org-set-local 'org-done-keywords nil)
  4036. (org-set-local 'org-todo-heads nil)
  4037. (org-set-local 'org-todo-sets nil)
  4038. (org-set-local 'org-todo-log-states nil)
  4039. (org-set-local 'org-file-properties nil)
  4040. (org-set-local 'org-file-tags nil)
  4041. (let ((re (org-make-options-regexp
  4042. '("CATEGORY" "TODO" "COLUMNS"
  4043. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  4044. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  4045. "OPTIONS")
  4046. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  4047. (splitre "[ \t]+")
  4048. (scripts org-use-sub-superscripts)
  4049. kwds kws0 kwsa key log value cat arch tags const links hw dws
  4050. tail sep kws1 prio props ftags drawers beamer-p
  4051. ext-setup-or-nil setup-contents (start 0))
  4052. (save-excursion
  4053. (save-restriction
  4054. (widen)
  4055. (goto-char (point-min))
  4056. (while (or (and ext-setup-or-nil
  4057. (string-match re ext-setup-or-nil start)
  4058. (setq start (match-end 0)))
  4059. (and (setq ext-setup-or-nil nil start 0)
  4060. (re-search-forward re nil t)))
  4061. (setq key (upcase (match-string 1 ext-setup-or-nil))
  4062. value (org-match-string-no-properties 2 ext-setup-or-nil))
  4063. (if (stringp value) (setq value (org-trim value)))
  4064. (cond
  4065. ((equal key "CATEGORY")
  4066. (setq cat value))
  4067. ((member key '("SEQ_TODO" "TODO"))
  4068. (push (cons 'sequence (org-split-string value splitre)) kwds))
  4069. ((equal key "TYP_TODO")
  4070. (push (cons 'type (org-split-string value splitre)) kwds))
  4071. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  4072. ;; general TODO-like setup
  4073. (push (cons (intern (downcase (match-string 1 key)))
  4074. (org-split-string value splitre)) kwds))
  4075. ((equal key "TAGS")
  4076. (setq tags (append tags (if tags '("\\n") nil)
  4077. (org-split-string value splitre))))
  4078. ((equal key "COLUMNS")
  4079. (org-set-local 'org-columns-default-format value))
  4080. ((equal key "LINK")
  4081. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4082. (push (cons (match-string 1 value)
  4083. (org-trim (match-string 2 value)))
  4084. links)))
  4085. ((equal key "PRIORITIES")
  4086. (setq prio (org-split-string value " +")))
  4087. ((equal key "PROPERTY")
  4088. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4089. (setq props (org-update-property-plist (match-string 1 value)
  4090. (match-string 2 value)
  4091. props))))
  4092. ((equal key "FILETAGS")
  4093. (when (string-match "\\S-" value)
  4094. (setq ftags
  4095. (append
  4096. ftags
  4097. (apply 'append
  4098. (mapcar (lambda (x) (org-split-string x ":"))
  4099. (org-split-string value)))))))
  4100. ((equal key "DRAWERS")
  4101. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  4102. ((equal key "CONSTANTS")
  4103. (setq const (append const (org-split-string value splitre))))
  4104. ((equal key "STARTUP")
  4105. (let ((opts (org-split-string value splitre))
  4106. l var val)
  4107. (while (setq l (pop opts))
  4108. (when (setq l (assoc l org-startup-options))
  4109. (setq var (nth 1 l) val (nth 2 l))
  4110. (if (not (nth 3 l))
  4111. (set (make-local-variable var) val)
  4112. (if (not (listp (symbol-value var)))
  4113. (set (make-local-variable var) nil))
  4114. (set (make-local-variable var) (symbol-value var))
  4115. (add-to-list var val))))))
  4116. ((equal key "ARCHIVE")
  4117. (setq arch value)
  4118. (remove-text-properties 0 (length arch)
  4119. '(face t fontified t) arch))
  4120. ((equal key "LATEX_CLASS")
  4121. (setq beamer-p (equal value "beamer")))
  4122. ((equal key "OPTIONS")
  4123. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  4124. (setq scripts (read (match-string 2 value)))))
  4125. ((equal key "SETUPFILE")
  4126. (setq setup-contents (org-file-contents
  4127. (expand-file-name
  4128. (org-remove-double-quotes value))
  4129. 'noerror))
  4130. (if (not ext-setup-or-nil)
  4131. (setq ext-setup-or-nil setup-contents start 0)
  4132. (setq ext-setup-or-nil
  4133. (concat (substring ext-setup-or-nil 0 start)
  4134. "\n" setup-contents "\n"
  4135. (substring ext-setup-or-nil start)))))))
  4136. ;; search for property blocks
  4137. (goto-char (point-min))
  4138. (while (re-search-forward org-block-regexp nil t)
  4139. (when (equal "PROPERTY" (upcase (match-string 1)))
  4140. (setq value (replace-regexp-in-string
  4141. "[\n\r]" " " (match-string 4)))
  4142. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4143. (setq props (org-update-property-plist (match-string 1 value)
  4144. (match-string 2 value)
  4145. props)))))))
  4146. (org-set-local 'org-use-sub-superscripts scripts)
  4147. (when cat
  4148. (org-set-local 'org-category (intern cat))
  4149. (push (cons "CATEGORY" cat) props))
  4150. (when prio
  4151. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  4152. (setq prio (mapcar 'string-to-char prio))
  4153. (org-set-local 'org-highest-priority (nth 0 prio))
  4154. (org-set-local 'org-lowest-priority (nth 1 prio))
  4155. (org-set-local 'org-default-priority (nth 2 prio)))
  4156. (and props (org-set-local 'org-file-properties (nreverse props)))
  4157. (and ftags (org-set-local 'org-file-tags
  4158. (mapcar 'org-add-prop-inherited ftags)))
  4159. (and drawers (org-set-local 'org-drawers drawers))
  4160. (and arch (org-set-local 'org-archive-location arch))
  4161. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4162. ;; Process the TODO keywords
  4163. (unless kwds
  4164. ;; Use the global values as if they had been given locally.
  4165. (setq kwds (default-value 'org-todo-keywords))
  4166. (if (stringp (car kwds))
  4167. (setq kwds (list (cons org-todo-interpretation
  4168. (default-value 'org-todo-keywords)))))
  4169. (setq kwds (reverse kwds)))
  4170. (setq kwds (nreverse kwds))
  4171. (let (inter kws kw)
  4172. (while (setq kws (pop kwds))
  4173. (let ((kws (or
  4174. (run-hook-with-args-until-success
  4175. 'org-todo-setup-filter-hook kws)
  4176. kws)))
  4177. (setq inter (pop kws) sep (member "|" kws)
  4178. kws0 (delete "|" (copy-sequence kws))
  4179. kwsa nil
  4180. kws1 (mapcar
  4181. (lambda (x)
  4182. ;; 1 2
  4183. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4184. (progn
  4185. (setq kw (match-string 1 x)
  4186. key (and (match-end 2) (match-string 2 x))
  4187. log (org-extract-log-state-settings x))
  4188. (push (cons kw (and key (string-to-char key))) kwsa)
  4189. (and log (push log org-todo-log-states))
  4190. kw)
  4191. (error "Invalid TODO keyword %s" x)))
  4192. kws0)
  4193. kwsa (if kwsa (append '((:startgroup))
  4194. (nreverse kwsa)
  4195. '((:endgroup))))
  4196. hw (car kws1)
  4197. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4198. tail (list inter hw (car dws) (org-last dws))))
  4199. (add-to-list 'org-todo-heads hw 'append)
  4200. (push kws1 org-todo-sets)
  4201. (setq org-done-keywords (append org-done-keywords dws nil))
  4202. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4203. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4204. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4205. (setq org-todo-sets (nreverse org-todo-sets)
  4206. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4207. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4208. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4209. ;; Process the constants
  4210. (when const
  4211. (let (e cst)
  4212. (while (setq e (pop const))
  4213. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  4214. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  4215. (setq org-table-formula-constants-local cst)))
  4216. ;; Process the tags.
  4217. (when tags
  4218. (let (e tgs)
  4219. (while (setq e (pop tags))
  4220. (cond
  4221. ((equal e "{") (push '(:startgroup) tgs))
  4222. ((equal e "}") (push '(:endgroup) tgs))
  4223. ((equal e "\\n") (push '(:newline) tgs))
  4224. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4225. (push (cons (match-string 1 e)
  4226. (string-to-char (match-string 2 e)))
  4227. tgs))
  4228. (t (push (list e) tgs))))
  4229. (org-set-local 'org-tag-alist nil)
  4230. (while (setq e (pop tgs))
  4231. (or (and (stringp (car e))
  4232. (assoc (car e) org-tag-alist))
  4233. (push e org-tag-alist)))))
  4234. ;; Compute the regular expressions and other local variables.
  4235. ;; Using `org-outline-regexp-bol' would complicate them much,
  4236. ;; because of the fixed white space at the end of that string.
  4237. (if (not org-done-keywords)
  4238. (setq org-done-keywords (and org-todo-keywords-1
  4239. (list (org-last org-todo-keywords-1)))))
  4240. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4241. (length org-scheduled-string)
  4242. (length org-clock-string)
  4243. (length org-closed-string)))
  4244. org-drawer-regexp
  4245. (concat "^[ \t]*:\\("
  4246. (mapconcat 'regexp-quote org-drawers "\\|")
  4247. "\\):[ \t]*$")
  4248. org-not-done-keywords
  4249. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4250. org-todo-regexp
  4251. (concat "\\("
  4252. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4253. "\\)")
  4254. org-not-done-regexp
  4255. (concat "\\("
  4256. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4257. "\\)")
  4258. org-not-done-heading-regexp
  4259. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4260. org-todo-line-regexp
  4261. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4262. org-complex-heading-regexp
  4263. (concat "^\\(\\*+\\)"
  4264. "\\(?: +" org-todo-regexp "\\)?"
  4265. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4266. "\\(?: +\\(.*?\\)\\)??"
  4267. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4268. "[ \t]*$")
  4269. org-complex-heading-regexp-format
  4270. (concat "^\\(\\*+\\)"
  4271. "\\(?: +" org-todo-regexp "\\)?"
  4272. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4273. "\\(?: +"
  4274. ;; Stats cookies can be stuck to body.
  4275. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4276. "\\(%s\\)"
  4277. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4278. "\\)"
  4279. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4280. "[ \t]*$")
  4281. org-todo-line-tags-regexp
  4282. (concat "^\\(\\*+\\)"
  4283. "\\(?: +" org-todo-regexp "\\)?"
  4284. "\\(?: +\\(.*?\\)\\)??"
  4285. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4286. "[ \t]*$")
  4287. org-deadline-regexp (concat "\\<" org-deadline-string)
  4288. org-deadline-time-regexp
  4289. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4290. org-deadline-line-regexp
  4291. (concat "\\<\\(" org-deadline-string "\\).*")
  4292. org-scheduled-regexp
  4293. (concat "\\<" org-scheduled-string)
  4294. org-scheduled-time-regexp
  4295. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4296. org-closed-time-regexp
  4297. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4298. org-keyword-time-regexp
  4299. (concat "\\<\\(" org-scheduled-string
  4300. "\\|" org-deadline-string
  4301. "\\|" org-closed-string
  4302. "\\|" org-clock-string "\\)"
  4303. " *[[<]\\([^]>]+\\)[]>]")
  4304. org-keyword-time-not-clock-regexp
  4305. (concat "\\<\\(" org-scheduled-string
  4306. "\\|" org-deadline-string
  4307. "\\|" org-closed-string
  4308. "\\)"
  4309. " *[[<]\\([^]>]+\\)[]>]")
  4310. org-maybe-keyword-time-regexp
  4311. (concat "\\(\\<\\(" org-scheduled-string
  4312. "\\|" org-deadline-string
  4313. "\\|" org-closed-string
  4314. "\\|" org-clock-string "\\)\\)?"
  4315. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4316. org-all-time-keywords
  4317. (mapcar (lambda (w) (substring w 0 -1))
  4318. (list org-scheduled-string org-deadline-string
  4319. org-clock-string org-closed-string))
  4320. )
  4321. (org-compute-latex-and-specials-regexp)
  4322. (org-set-font-lock-defaults))))
  4323. (defun org-file-contents (file &optional noerror)
  4324. "Return the contents of FILE, as a string."
  4325. (if (or (not file)
  4326. (not (file-readable-p file)))
  4327. (if noerror
  4328. (progn
  4329. (message "Cannot read file \"%s\"" file)
  4330. (ding) (sit-for 2)
  4331. "")
  4332. (error "Cannot read file \"%s\"" file))
  4333. (with-temp-buffer
  4334. (insert-file-contents file)
  4335. (buffer-string))))
  4336. (defun org-extract-log-state-settings (x)
  4337. "Extract the log state setting from a TODO keyword string.
  4338. This will extract info from a string like \"WAIT(w@/!)\"."
  4339. (let (kw key log1 log2)
  4340. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4341. (setq kw (match-string 1 x)
  4342. key (and (match-end 2) (match-string 2 x))
  4343. log1 (and (match-end 3) (match-string 3 x))
  4344. log2 (and (match-end 4) (match-string 4 x)))
  4345. (and (or log1 log2)
  4346. (list kw
  4347. (and log1 (if (equal log1 "!") 'time 'note))
  4348. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4349. (defun org-remove-keyword-keys (list)
  4350. "Remove a pair of parenthesis at the end of each string in LIST."
  4351. (mapcar (lambda (x)
  4352. (if (string-match "(.*)$" x)
  4353. (substring x 0 (match-beginning 0))
  4354. x))
  4355. list))
  4356. (defun org-assign-fast-keys (alist)
  4357. "Assign fast keys to a keyword-key alist.
  4358. Respect keys that are already there."
  4359. (let (new e (alt ?0))
  4360. (while (setq e (pop alist))
  4361. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  4362. (cdr e)) ;; Key already assigned.
  4363. (push e new)
  4364. (let ((clist (string-to-list (downcase (car e))))
  4365. (used (append new alist)))
  4366. (when (= (car clist) ?@)
  4367. (pop clist))
  4368. (while (and clist (rassoc (car clist) used))
  4369. (pop clist))
  4370. (unless clist
  4371. (while (rassoc alt used)
  4372. (incf alt)))
  4373. (push (cons (car e) (or (car clist) alt)) new))))
  4374. (nreverse new)))
  4375. ;;; Some variables used in various places
  4376. (defvar org-window-configuration nil
  4377. "Used in various places to store a window configuration.")
  4378. (defvar org-selected-window nil
  4379. "Used in various places to store a window configuration.")
  4380. (defvar org-finish-function nil
  4381. "Function to be called when `C-c C-c' is used.
  4382. This is for getting out of special buffers like capture.")
  4383. ;; FIXME: Occasionally check by commenting these, to make sure
  4384. ;; no other functions uses these, forgetting to let-bind them.
  4385. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4386. (defvar org-last-state)
  4387. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4388. ;; Defined somewhere in this file, but used before definition.
  4389. (defvar org-entities) ;; defined in org-entities.el
  4390. (defvar org-struct-menu)
  4391. (defvar org-org-menu)
  4392. (defvar org-tbl-menu)
  4393. ;;;; Define the Org-mode
  4394. ;; We use a before-change function to check if a table might need
  4395. ;; an update.
  4396. (defvar org-table-may-need-update t
  4397. "Indicates that a table might need an update.
  4398. This variable is set by `org-before-change-function'.
  4399. `org-table-align' sets it back to nil.")
  4400. (defun org-before-change-function (beg end)
  4401. "Every change indicates that a table might need an update."
  4402. (setq org-table-may-need-update t))
  4403. (defvar org-mode-map)
  4404. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4405. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4406. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4407. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4408. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4409. (defvar org-table-buffer-is-an nil)
  4410. (defvar bidi-paragraph-direction)
  4411. (defvar buffer-face-mode-face)
  4412. (require 'outline)
  4413. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4414. (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"))
  4415. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  4416. ;; Other stuff we need.
  4417. (require 'time-date)
  4418. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4419. (require 'easymenu)
  4420. (require 'overlay)
  4421. (require 'org-macs)
  4422. (require 'org-entities)
  4423. ;; (require 'org-compat) moved higher up in the file before it is first used
  4424. (require 'org-faces)
  4425. (require 'org-list)
  4426. (require 'org-pcomplete)
  4427. (require 'org-src)
  4428. (require 'org-footnote)
  4429. ;; babel
  4430. (require 'ob)
  4431. (require 'ob-table)
  4432. (require 'ob-lob)
  4433. (require 'ob-ref)
  4434. (require 'ob-tangle)
  4435. (require 'ob-comint)
  4436. (require 'ob-keys)
  4437. ;;;###autoload
  4438. (define-derived-mode org-mode outline-mode "Org"
  4439. "Outline-based notes management and organizer, alias
  4440. \"Carsten's outline-mode for keeping track of everything.\"
  4441. Org-mode develops organizational tasks around a NOTES file which
  4442. contains information about projects as plain text. Org-mode is
  4443. implemented on top of outline-mode, which is ideal to keep the content
  4444. of large files well structured. It supports ToDo items, deadlines and
  4445. time stamps, which magically appear in the diary listing of the Emacs
  4446. calendar. Tables are easily created with a built-in table editor.
  4447. Plain text URL-like links connect to websites, emails (VM), Usenet
  4448. messages (Gnus), BBDB entries, and any files related to the project.
  4449. For printing and sharing of notes, an Org-mode file (or a part of it)
  4450. can be exported as a structured ASCII or HTML file.
  4451. The following commands are available:
  4452. \\{org-mode-map}"
  4453. ;; Get rid of Outline menus, they are not needed
  4454. ;; Need to do this here because define-derived-mode sets up
  4455. ;; the keymap so late. Still, it is a waste to call this each time
  4456. ;; we switch another buffer into org-mode.
  4457. (if (featurep 'xemacs)
  4458. (when (boundp 'outline-mode-menu-heading)
  4459. ;; Assume this is Greg's port, it uses easymenu
  4460. (easy-menu-remove outline-mode-menu-heading)
  4461. (easy-menu-remove outline-mode-menu-show)
  4462. (easy-menu-remove outline-mode-menu-hide))
  4463. (define-key org-mode-map [menu-bar headings] 'undefined)
  4464. (define-key org-mode-map [menu-bar hide] 'undefined)
  4465. (define-key org-mode-map [menu-bar show] 'undefined))
  4466. (org-load-modules-maybe)
  4467. (easy-menu-add org-org-menu)
  4468. (easy-menu-add org-tbl-menu)
  4469. (org-install-agenda-files-menu)
  4470. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4471. (add-to-invisibility-spec '(org-cwidth))
  4472. (add-to-invisibility-spec '(org-hide-block . t))
  4473. (when (featurep 'xemacs)
  4474. (org-set-local 'line-move-ignore-invisible t))
  4475. (org-set-local 'outline-regexp org-outline-regexp)
  4476. (org-set-local 'outline-level 'org-outline-level)
  4477. (setq bidi-paragraph-direction 'left-to-right)
  4478. (when (and org-ellipsis
  4479. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4480. (fboundp 'make-glyph-code))
  4481. (unless org-display-table
  4482. (setq org-display-table (make-display-table)))
  4483. (set-display-table-slot
  4484. org-display-table 4
  4485. (vconcat (mapcar
  4486. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4487. org-ellipsis)))
  4488. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4489. (setq buffer-display-table org-display-table))
  4490. (org-set-regexps-and-options)
  4491. (when (and org-tag-faces (not org-tags-special-faces-re))
  4492. ;; tag faces set outside customize.... force initialization.
  4493. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4494. ;; Calc embedded
  4495. (org-set-local 'calc-embedded-open-mode "# ")
  4496. (modify-syntax-entry ?@ "w")
  4497. (modify-syntax-entry ?\" "\"")
  4498. (if org-startup-truncated (setq truncate-lines t))
  4499. (org-set-local 'font-lock-unfontify-region-function
  4500. 'org-unfontify-region)
  4501. ;; Activate before-change-function
  4502. (org-set-local 'org-table-may-need-update t)
  4503. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4504. 'local)
  4505. ;; Check for running clock before killing a buffer
  4506. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4507. ;; Initialize macros templates.
  4508. (org-macro-initialize-templates)
  4509. ;; Initialize radio targets.
  4510. (org-update-radio-target-regexp)
  4511. ;; Indentation.
  4512. (org-set-local 'indent-line-function 'org-indent-line)
  4513. (org-set-local 'indent-region-function 'org-indent-region)
  4514. ;; Filling and auto-filling.
  4515. (org-setup-filling)
  4516. ;; Comments.
  4517. (org-setup-comments-handling)
  4518. ;; Beginning/end of defun
  4519. (org-set-local 'beginning-of-defun-function 'org-back-to-heading)
  4520. (org-set-local 'end-of-defun-function (lambda () (interactive) (org-end-of-subtree nil t)))
  4521. ;; Next error for sparse trees
  4522. (org-set-local 'next-error-function 'org-occur-next-match)
  4523. ;; Make sure dependence stuff works reliably, even for users who set it
  4524. ;; too late :-(
  4525. (if org-enforce-todo-dependencies
  4526. (add-hook 'org-blocker-hook
  4527. 'org-block-todo-from-children-or-siblings-or-parent)
  4528. (remove-hook 'org-blocker-hook
  4529. 'org-block-todo-from-children-or-siblings-or-parent))
  4530. (if org-enforce-todo-checkbox-dependencies
  4531. (add-hook 'org-blocker-hook
  4532. 'org-block-todo-from-checkboxes)
  4533. (remove-hook 'org-blocker-hook
  4534. 'org-block-todo-from-checkboxes))
  4535. ;; Align options lines
  4536. (org-set-local
  4537. 'align-mode-rules-list
  4538. '((org-in-buffer-settings
  4539. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4540. (modes . '(org-mode)))))
  4541. ;; Imenu
  4542. (org-set-local 'imenu-create-index-function
  4543. 'org-imenu-get-tree)
  4544. ;; Make isearch reveal context
  4545. (if (or (featurep 'xemacs)
  4546. (not (boundp 'outline-isearch-open-invisible-function)))
  4547. ;; Emacs 21 and XEmacs make use of the hook
  4548. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4549. ;; Emacs 22 deals with this through a special variable
  4550. (org-set-local 'outline-isearch-open-invisible-function
  4551. (lambda (&rest ignore) (org-show-context 'isearch))))
  4552. ;; Turn on org-beamer-mode?
  4553. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  4554. ;; Setup the pcomplete hooks
  4555. (set (make-local-variable 'pcomplete-command-completion-function)
  4556. 'org-pcomplete-initial)
  4557. (set (make-local-variable 'pcomplete-command-name-function)
  4558. 'org-command-at-point)
  4559. (set (make-local-variable 'pcomplete-default-completion-function)
  4560. 'ignore)
  4561. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4562. 'org-parse-arguments)
  4563. (set (make-local-variable 'pcomplete-termination-string) "")
  4564. (when (>= emacs-major-version 23)
  4565. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4566. ;; If empty file that did not turn on org-mode automatically, make it to.
  4567. (if (and org-insert-mode-line-in-empty-file
  4568. (org-called-interactively-p 'any)
  4569. (= (point-min) (point-max)))
  4570. (insert "# -*- mode: org -*-\n\n"))
  4571. (unless org-inhibit-startup
  4572. (when org-startup-align-all-tables
  4573. (let ((bmp (buffer-modified-p)))
  4574. (org-table-map-tables 'org-table-align 'quietly)
  4575. (set-buffer-modified-p bmp)))
  4576. (when org-startup-with-inline-images
  4577. (org-display-inline-images))
  4578. (when org-startup-indented
  4579. (require 'org-indent)
  4580. (org-indent-mode 1))
  4581. (unless org-inhibit-startup-visibility-stuff
  4582. (org-set-startup-visibility)))
  4583. ;; Try to set org-hide correctly
  4584. (set-face-foreground
  4585. 'org-hide
  4586. (or (face-background 'default)
  4587. (face-background 'org-default)
  4588. (cdr (assoc 'background-color default-frame-alist))
  4589. (cdr (assoc 'background-color initial-frame-alist))
  4590. (cdr (assoc 'background-color window-system-default-frame-alist))
  4591. (face-foreground 'org-hide))))
  4592. (when (fboundp 'abbrev-table-put)
  4593. (abbrev-table-put org-mode-abbrev-table
  4594. :parents (list text-mode-abbrev-table)))
  4595. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4596. (defun org-current-time ()
  4597. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4598. (if (> (car org-time-stamp-rounding-minutes) 1)
  4599. (let ((r (car org-time-stamp-rounding-minutes))
  4600. (time (decode-time)))
  4601. (apply 'encode-time
  4602. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4603. (nthcdr 2 time))))
  4604. (current-time)))
  4605. (defun org-today ()
  4606. "Return today date, considering `org-extend-today-until'."
  4607. (time-to-days
  4608. (time-subtract (current-time)
  4609. (list 0 (* 3600 org-extend-today-until) 0))))
  4610. ;;;; Font-Lock stuff, including the activators
  4611. (defvar org-mouse-map (make-sparse-keymap))
  4612. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4613. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4614. (when org-mouse-1-follows-link
  4615. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4616. (when org-tab-follows-link
  4617. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4618. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4619. (require 'font-lock)
  4620. (defconst org-non-link-chars "]\t\n\r<>")
  4621. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4622. "shell" "elisp" "doi" "message"))
  4623. (defvar org-link-types-re nil
  4624. "Matches a link that has a url-like prefix like \"http:\"")
  4625. (defvar org-link-re-with-space nil
  4626. "Matches a link with spaces, optional angular brackets around it.")
  4627. (defvar org-link-re-with-space2 nil
  4628. "Matches a link with spaces, optional angular brackets around it.")
  4629. (defvar org-link-re-with-space3 nil
  4630. "Matches a link with spaces, only for internal part in bracket links.")
  4631. (defvar org-angle-link-re nil
  4632. "Matches link with angular brackets, spaces are allowed.")
  4633. (defvar org-plain-link-re nil
  4634. "Matches plain link, without spaces.")
  4635. (defvar org-bracket-link-regexp nil
  4636. "Matches a link in double brackets.")
  4637. (defvar org-bracket-link-analytic-regexp nil
  4638. "Regular expression used to analyze links.
  4639. Here is what the match groups contain after a match:
  4640. 1: http:
  4641. 2: http
  4642. 3: path
  4643. 4: [desc]
  4644. 5: desc")
  4645. (defvar org-bracket-link-analytic-regexp++ nil
  4646. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4647. (defvar org-any-link-re nil
  4648. "Regular expression matching any link.")
  4649. (defcustom org-match-sexp-depth 3
  4650. "Number of stacked braces for sub/superscript matching.
  4651. This has to be set before loading org.el to be effective."
  4652. :group 'org-export-translation ; ??????????????????????????/
  4653. :type 'integer)
  4654. (defun org-create-multibrace-regexp (left right n)
  4655. "Create a regular expression which will match a balanced sexp.
  4656. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4657. as single character strings.
  4658. The regexp returned will match the entire expression including the
  4659. delimiters. It will also define a single group which contains the
  4660. match except for the outermost delimiters. The maximum depth of
  4661. stacked delimiters is N. Escaping delimiters is not possible."
  4662. (let* ((nothing (concat "[^" left right "]*?"))
  4663. (or "\\|")
  4664. (re nothing)
  4665. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4666. (while (> n 1)
  4667. (setq n (1- n)
  4668. re (concat re or next)
  4669. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4670. (concat left "\\(" re "\\)" right)))
  4671. (defvar org-match-substring-regexp
  4672. (concat
  4673. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4674. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4675. "\\|"
  4676. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4677. "\\|"
  4678. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4679. "The regular expression matching a sub- or superscript.")
  4680. (defvar org-match-substring-with-braces-regexp
  4681. (concat
  4682. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4683. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4684. "\\)")
  4685. "The regular expression matching a sub- or superscript, forcing braces.")
  4686. (defun org-make-link-regexps ()
  4687. "Update the link regular expressions.
  4688. This should be called after the variable `org-link-types' has changed."
  4689. (setq org-link-types-re
  4690. (concat
  4691. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4692. org-link-re-with-space
  4693. (concat
  4694. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4695. "\\([^" org-non-link-chars " ]"
  4696. "[^" org-non-link-chars "]*"
  4697. "[^" org-non-link-chars " ]\\)>?")
  4698. org-link-re-with-space2
  4699. (concat
  4700. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4701. "\\([^" org-non-link-chars " ]"
  4702. "[^\t\n\r]*"
  4703. "[^" org-non-link-chars " ]\\)>?")
  4704. org-link-re-with-space3
  4705. (concat
  4706. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4707. "\\([^" org-non-link-chars " ]"
  4708. "[^\t\n\r]*\\)")
  4709. org-angle-link-re
  4710. (concat
  4711. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4712. "\\([^" org-non-link-chars " ]"
  4713. "[^" org-non-link-chars "]*"
  4714. "\\)>")
  4715. org-plain-link-re
  4716. (concat
  4717. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4718. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4719. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4720. org-bracket-link-regexp
  4721. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4722. org-bracket-link-analytic-regexp
  4723. (concat
  4724. "\\[\\["
  4725. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4726. "\\([^]]+\\)"
  4727. "\\]"
  4728. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4729. "\\]")
  4730. org-bracket-link-analytic-regexp++
  4731. (concat
  4732. "\\[\\["
  4733. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4734. "\\([^]]+\\)"
  4735. "\\]"
  4736. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4737. "\\]")
  4738. org-any-link-re
  4739. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4740. org-angle-link-re "\\)\\|\\("
  4741. org-plain-link-re "\\)")))
  4742. (org-make-link-regexps)
  4743. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  4744. "Regular expression for fast time stamp matching.")
  4745. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  4746. "Regular expression for fast time stamp matching.")
  4747. (defconst org-ts-regexp0
  4748. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4749. "Regular expression matching time strings for analysis.
  4750. This one does not require the space after the date, so it can be used
  4751. on a string that terminates immediately after the date.")
  4752. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4753. "Regular expression matching time strings for analysis.")
  4754. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4755. "Regular expression matching time stamps, with groups.")
  4756. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4757. "Regular expression matching time stamps (also [..]), with groups.")
  4758. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4759. "Regular expression matching a time stamp range.")
  4760. (defconst org-tr-regexp-both
  4761. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4762. "Regular expression matching a time stamp range.")
  4763. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4764. org-ts-regexp "\\)?")
  4765. "Regular expression matching a time stamp or time stamp range.")
  4766. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4767. org-ts-regexp-both "\\)?")
  4768. "Regular expression matching a time stamp or time stamp range.
  4769. The time stamps may be either active or inactive.")
  4770. (defvar org-emph-face nil)
  4771. (defun org-do-emphasis-faces (limit)
  4772. "Run through the buffer and add overlays to emphasized strings."
  4773. (let (rtn a)
  4774. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4775. (if (not (= (char-after (match-beginning 3))
  4776. (char-after (match-beginning 4))))
  4777. (progn
  4778. (setq rtn t)
  4779. (setq a (assoc (match-string 3) org-emphasis-alist))
  4780. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4781. 'face
  4782. (nth 1 a))
  4783. (and (nth 4 a)
  4784. (org-remove-flyspell-overlays-in
  4785. (match-beginning 0) (match-end 0)))
  4786. (add-text-properties (match-beginning 2) (match-end 2)
  4787. '(font-lock-multiline t org-emphasis t))
  4788. (when org-hide-emphasis-markers
  4789. (add-text-properties (match-end 4) (match-beginning 5)
  4790. '(invisible org-link))
  4791. (add-text-properties (match-beginning 3) (match-end 3)
  4792. '(invisible org-link)))))
  4793. (backward-char 1))
  4794. rtn))
  4795. (defun org-emphasize (&optional char)
  4796. "Insert or change an emphasis, i.e. a font like bold or italic.
  4797. If there is an active region, change that region to a new emphasis.
  4798. If there is no region, just insert the marker characters and position
  4799. the cursor between them.
  4800. CHAR should be either the marker character, or the first character of the
  4801. HTML tag associated with that emphasis. If CHAR is a space, the means
  4802. to remove the emphasis of the selected region.
  4803. If char is not given (for example in an interactive call) it
  4804. will be prompted for."
  4805. (interactive)
  4806. (let ((eal org-emphasis-alist) e det
  4807. (erc org-emphasis-regexp-components)
  4808. (prompt "")
  4809. (string "") beg end move tag c s)
  4810. (if (org-region-active-p)
  4811. (setq beg (region-beginning) end (region-end)
  4812. string (buffer-substring beg end))
  4813. (setq move t))
  4814. (while (setq e (pop eal))
  4815. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4816. c (aref tag 0))
  4817. (push (cons c (string-to-char (car e))) det)
  4818. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4819. (substring tag 1)))))
  4820. (setq det (nreverse det))
  4821. (unless char
  4822. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4823. (setq char (read-char-exclusive)))
  4824. (setq char (or (cdr (assoc char det)) char))
  4825. (if (equal char ?\ )
  4826. (setq s "" move nil)
  4827. (unless (assoc (char-to-string char) org-emphasis-alist)
  4828. (error "No such emphasis marker: \"%c\"" char))
  4829. (setq s (char-to-string char)))
  4830. (while (and (> (length string) 1)
  4831. (equal (substring string 0 1) (substring string -1))
  4832. (assoc (substring string 0 1) org-emphasis-alist))
  4833. (setq string (substring string 1 -1)))
  4834. (setq string (concat s string s))
  4835. (if beg (delete-region beg end))
  4836. (unless (or (bolp)
  4837. (string-match (concat "[" (nth 0 erc) "\n]")
  4838. (char-to-string (char-before (point)))))
  4839. (insert " "))
  4840. (unless (or (eobp)
  4841. (string-match (concat "[" (nth 1 erc) "\n]")
  4842. (char-to-string (char-after (point)))))
  4843. (insert " ") (backward-char 1))
  4844. (insert string)
  4845. (and move (backward-char 1))))
  4846. (defconst org-nonsticky-props
  4847. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4848. (defsubst org-rear-nonsticky-at (pos)
  4849. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4850. (defun org-activate-plain-links (limit)
  4851. "Run through the buffer and add overlays to links."
  4852. (catch 'exit
  4853. (let (f)
  4854. (when (re-search-forward (concat org-plain-link-re) limit t)
  4855. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4856. (setq f (get-text-property (match-beginning 0) 'face))
  4857. (if (or (eq f 'org-tag)
  4858. (and (listp f) (memq 'org-tag f)))
  4859. nil
  4860. (add-text-properties (match-beginning 0) (match-end 0)
  4861. (list 'mouse-face 'highlight
  4862. 'face 'org-link
  4863. 'keymap org-mouse-map))
  4864. (org-rear-nonsticky-at (match-end 0)))
  4865. t))))
  4866. (defun org-activate-code (limit)
  4867. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  4868. (progn
  4869. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4870. (remove-text-properties (match-beginning 0) (match-end 0)
  4871. '(display t invisible t intangible t))
  4872. t)))
  4873. (defcustom org-src-fontify-natively nil
  4874. "When non-nil, fontify code in code blocks."
  4875. :type 'boolean
  4876. :version "24.1"
  4877. :group 'org-appearance
  4878. :group 'org-babel)
  4879. (defcustom org-allow-promoting-top-level-subtree nil
  4880. "When non-nil, allow promoting a top level subtree.
  4881. The leading star of the top level headline will be replaced
  4882. by a #."
  4883. :type 'boolean
  4884. :version "24.1"
  4885. :group 'org-appearance)
  4886. (defun org-fontify-meta-lines-and-blocks (limit)
  4887. (condition-case nil
  4888. (org-fontify-meta-lines-and-blocks-1 limit)
  4889. (error (message "org-mode fontification error"))))
  4890. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  4891. "Fontify #+ lines and blocks, in the correct ways."
  4892. (let ((case-fold-search t))
  4893. (if (re-search-forward
  4894. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  4895. limit t)
  4896. (let ((beg (match-beginning 0))
  4897. (block-start (match-end 0))
  4898. (block-end nil)
  4899. (lang (match-string 7))
  4900. (beg1 (line-beginning-position 2))
  4901. (dc1 (downcase (match-string 2)))
  4902. (dc3 (downcase (match-string 3)))
  4903. end end1 quoting block-type ovl)
  4904. (cond
  4905. ((member dc1 '("+html:" "+ascii:" "+latex:" "+docbook:"))
  4906. ;; a single line of backend-specific content
  4907. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4908. (remove-text-properties (match-beginning 0) (match-end 0)
  4909. '(display t invisible t intangible t))
  4910. (add-text-properties (match-beginning 1) (match-end 3)
  4911. '(font-lock-fontified t face org-meta-line))
  4912. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  4913. '(font-lock-fontified t face org-block))
  4914. ; for backend-specific code
  4915. t)
  4916. ((and (match-end 4) (equal dc3 "+begin"))
  4917. ;; Truly a block
  4918. (setq block-type (downcase (match-string 5))
  4919. quoting (member block-type org-protecting-blocks))
  4920. (when (re-search-forward
  4921. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4922. nil t) ;; on purpose, we look further than LIMIT
  4923. (setq end (min (point-max) (match-end 0))
  4924. end1 (min (point-max) (1- (match-beginning 0))))
  4925. (setq block-end (match-beginning 0))
  4926. (when quoting
  4927. (remove-text-properties beg end
  4928. '(display t invisible t intangible t)))
  4929. (add-text-properties
  4930. beg end
  4931. '(font-lock-fontified t font-lock-multiline t))
  4932. (add-text-properties beg beg1 '(face org-meta-line))
  4933. (add-text-properties end1 (min (point-max) (1+ end))
  4934. '(face org-meta-line)) ; for end_src
  4935. (cond
  4936. ((and lang (not (string= lang "")) org-src-fontify-natively)
  4937. (org-src-font-lock-fontify-block lang block-start block-end)
  4938. ;; remove old background overlays
  4939. (mapc (lambda (ov)
  4940. (if (eq (overlay-get ov 'face) 'org-block-background)
  4941. (delete-overlay ov)))
  4942. (overlays-at (/ (+ beg1 block-end) 2)))
  4943. ;; add a background overlay
  4944. (setq ovl (make-overlay beg1 block-end))
  4945. (overlay-put ovl 'face 'org-block-background)
  4946. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  4947. (quoting
  4948. (add-text-properties beg1 (min (point-max) (1+ end1))
  4949. '(face org-block))) ; end of source block
  4950. ((not org-fontify-quote-and-verse-blocks))
  4951. ((string= block-type "quote")
  4952. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  4953. ((string= block-type "verse")
  4954. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  4955. (add-text-properties beg beg1 '(face org-block-begin-line))
  4956. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  4957. '(face org-block-end-line))
  4958. t))
  4959. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  4960. (add-text-properties
  4961. beg (match-end 3)
  4962. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4963. '(font-lock-fontified t invisible t)
  4964. '(font-lock-fontified t face org-document-info-keyword)))
  4965. (add-text-properties
  4966. (match-beginning 6) (match-end 6)
  4967. (if (string-equal dc1 "+title:")
  4968. '(font-lock-fontified t face org-document-title)
  4969. '(font-lock-fontified t face org-document-info))))
  4970. ((or (equal dc1 "+results")
  4971. (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
  4972. "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
  4973. "+call:" "+header:" "+headers:" "+name:"))
  4974. (and (match-end 4) (equal dc3 "+attr")))
  4975. (add-text-properties
  4976. beg (match-end 0)
  4977. '(font-lock-fontified t face org-meta-line))
  4978. t)
  4979. ((member dc3 '(" " ""))
  4980. (add-text-properties
  4981. beg (match-end 0)
  4982. '(font-lock-fontified t face font-lock-comment-face)))
  4983. ((not (member (char-after beg) '(?\ ?\t)))
  4984. ;; just any other in-buffer setting, but not indented
  4985. (add-text-properties
  4986. beg (match-end 0)
  4987. '(font-lock-fontified t face org-meta-line))
  4988. t)
  4989. (t nil))))))
  4990. (defun org-strip-protective-commas (beg end)
  4991. "Strip protective commas between BEG and END in the current buffer."
  4992. (interactive "r")
  4993. (save-excursion
  4994. (save-match-data
  4995. (goto-char beg)
  4996. (let ((front-line (save-excursion
  4997. (re-search-forward
  4998. "[^[:space:]]" end t)
  4999. (goto-char (match-beginning 0))
  5000. (current-column))))
  5001. (while (re-search-forward "^[ \t]*\\(,\\)\\([*]\\|#\\)" end t)
  5002. (goto-char (match-beginning 1))
  5003. (when (= (current-column) front-line)
  5004. (replace-match "" nil nil nil 1)))))))
  5005. (defun org-activate-angle-links (limit)
  5006. "Run through the buffer and add overlays to links."
  5007. (if (re-search-forward org-angle-link-re limit t)
  5008. (progn
  5009. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5010. (add-text-properties (match-beginning 0) (match-end 0)
  5011. (list 'mouse-face 'highlight
  5012. 'keymap org-mouse-map))
  5013. (org-rear-nonsticky-at (match-end 0))
  5014. t)))
  5015. (defun org-activate-footnote-links (limit)
  5016. "Run through the buffer and add overlays to footnotes."
  5017. (let ((fn (org-footnote-next-reference-or-definition limit)))
  5018. (when fn
  5019. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  5020. (org-remove-flyspell-overlays-in beg end)
  5021. (add-text-properties beg end
  5022. (list 'mouse-face 'highlight
  5023. 'keymap org-mouse-map
  5024. 'help-echo
  5025. (if (= (point-at-bol) beg)
  5026. "Footnote definition"
  5027. "Footnote reference")
  5028. 'font-lock-fontified t
  5029. 'font-lock-multiline t
  5030. 'face 'org-footnote))))))
  5031. (defun org-activate-bracket-links (limit)
  5032. "Run through the buffer and add overlays to bracketed links."
  5033. (if (re-search-forward org-bracket-link-regexp limit t)
  5034. (let* ((help (concat "LINK: "
  5035. (org-match-string-no-properties 1)))
  5036. ;; FIXME: above we should remove the escapes.
  5037. ;; but that requires another match, protecting match data,
  5038. ;; a lot of overhead for font-lock.
  5039. (ip (org-maybe-intangible
  5040. (list 'invisible 'org-link
  5041. 'keymap org-mouse-map 'mouse-face 'highlight
  5042. 'font-lock-multiline t 'help-echo help)))
  5043. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  5044. 'font-lock-multiline t 'help-echo help)))
  5045. ;; We need to remove the invisible property here. Table narrowing
  5046. ;; may have made some of this invisible.
  5047. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5048. (remove-text-properties (match-beginning 0) (match-end 0)
  5049. '(invisible nil))
  5050. (if (match-end 3)
  5051. (progn
  5052. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  5053. (org-rear-nonsticky-at (match-beginning 3))
  5054. (add-text-properties (match-beginning 3) (match-end 3) vp)
  5055. (org-rear-nonsticky-at (match-end 3))
  5056. (add-text-properties (match-end 3) (match-end 0) ip)
  5057. (org-rear-nonsticky-at (match-end 0)))
  5058. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  5059. (org-rear-nonsticky-at (match-beginning 1))
  5060. (add-text-properties (match-beginning 1) (match-end 1) vp)
  5061. (org-rear-nonsticky-at (match-end 1))
  5062. (add-text-properties (match-end 1) (match-end 0) ip)
  5063. (org-rear-nonsticky-at (match-end 0)))
  5064. t)))
  5065. (defun org-activate-dates (limit)
  5066. "Run through the buffer and add overlays to dates."
  5067. (if (re-search-forward org-tsr-regexp-both limit t)
  5068. (progn
  5069. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5070. (add-text-properties (match-beginning 0) (match-end 0)
  5071. (list 'mouse-face 'highlight
  5072. 'keymap org-mouse-map))
  5073. (org-rear-nonsticky-at (match-end 0))
  5074. (when org-display-custom-times
  5075. (if (match-end 3)
  5076. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5077. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5078. t)))
  5079. (defvar org-target-link-regexp nil
  5080. "Regular expression matching radio targets in plain text.")
  5081. (make-variable-buffer-local 'org-target-link-regexp)
  5082. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  5083. "Regular expression matching a link target.")
  5084. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  5085. "Regular expression matching a radio target.")
  5086. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  5087. "Regular expression matching any target.")
  5088. (defun org-activate-target-links (limit)
  5089. "Run through the buffer and add overlays to target matches."
  5090. (when org-target-link-regexp
  5091. (let ((case-fold-search t))
  5092. (if (re-search-forward org-target-link-regexp limit t)
  5093. (progn
  5094. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5095. (add-text-properties (match-beginning 0) (match-end 0)
  5096. (list 'mouse-face 'highlight
  5097. 'keymap org-mouse-map
  5098. 'help-echo "Radio target link"
  5099. 'org-linked-text t))
  5100. (org-rear-nonsticky-at (match-end 0))
  5101. t)))))
  5102. (defun org-update-radio-target-regexp ()
  5103. "Find all radio targets in this file and update the regular expression."
  5104. (interactive)
  5105. (when (memq 'radio org-activate-links)
  5106. (setq org-target-link-regexp
  5107. (org-make-target-link-regexp (org-all-targets 'radio)))
  5108. (org-restart-font-lock)))
  5109. (defun org-hide-wide-columns (limit)
  5110. (let (s e)
  5111. (setq s (text-property-any (point) (or limit (point-max))
  5112. 'org-cwidth t))
  5113. (when s
  5114. (setq e (next-single-property-change s 'org-cwidth))
  5115. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5116. (goto-char e)
  5117. t)))
  5118. (defvar org-latex-and-specials-regexp nil
  5119. "Regular expression for highlighting export special stuff.")
  5120. (defvar org-match-substring-regexp)
  5121. (defvar org-match-substring-with-braces-regexp)
  5122. ;; This should be with the exporter code, but we also use if for font-locking
  5123. (defconst org-export-html-special-string-regexps
  5124. '(("\\\\-" . "&shy;")
  5125. ("---\\([^-]\\)" . "&mdash;\\1")
  5126. ("--\\([^-]\\)" . "&ndash;\\1")
  5127. ("\\.\\.\\." . "&hellip;"))
  5128. "Regular expressions for special string conversion.")
  5129. (defun org-compute-latex-and-specials-regexp ()
  5130. "Compute regular expression for stuff treated specially by exporters."
  5131. (if (not org-highlight-latex-fragments-and-specials)
  5132. (org-set-local 'org-latex-and-specials-regexp nil)
  5133. (require 'org-exp)
  5134. (let*
  5135. ((matchers (plist-get org-format-latex-options :matchers))
  5136. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  5137. org-latex-regexps)))
  5138. (org-export-allow-BIND nil)
  5139. (options (org-combine-plists (org-default-export-plist)
  5140. (org-infile-export-plist)))
  5141. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  5142. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  5143. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  5144. (org-export-html-expand (plist-get options :expand-quoted-html))
  5145. (org-export-with-special-strings (plist-get options :special-strings))
  5146. (re-sub
  5147. (cond
  5148. ((equal org-export-with-sub-superscripts '{})
  5149. (list org-match-substring-with-braces-regexp))
  5150. (org-export-with-sub-superscripts
  5151. (list org-match-substring-regexp))))
  5152. (re-latex
  5153. (if org-export-with-LaTeX-fragments
  5154. (mapcar (lambda (x) (nth 1 x)) latexs)))
  5155. (re-macros
  5156. (if org-export-with-TeX-macros
  5157. (list (concat "\\\\"
  5158. (regexp-opt
  5159. (append
  5160. (delq nil
  5161. (mapcar 'car-safe
  5162. (append org-entities-user
  5163. org-entities)))
  5164. (if (boundp 'org-latex-entities)
  5165. (mapcar (lambda (x)
  5166. (or (car-safe x) x))
  5167. org-latex-entities)
  5168. nil))
  5169. 'words))) ; FIXME
  5170. ))
  5171. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  5172. (re-special (if org-export-with-special-strings
  5173. (mapcar (lambda (x) (car x))
  5174. org-export-html-special-string-regexps)))
  5175. (re-rest
  5176. (delq nil
  5177. (list
  5178. (if org-export-html-expand "@<[^>\n]+>")
  5179. ))))
  5180. (org-set-local
  5181. 'org-latex-and-specials-regexp
  5182. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  5183. re-rest) "\\|")))))
  5184. (defun org-do-latex-and-special-faces (limit)
  5185. "Run through the buffer and add overlays to links."
  5186. (when org-latex-and-specials-regexp
  5187. (let (rtn d)
  5188. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  5189. limit t))
  5190. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5191. 'face))
  5192. '(org-code org-verbatim underline)))
  5193. (progn
  5194. (setq rtn t
  5195. d (cond ((member (char-after (1+ (match-beginning 0)))
  5196. '(?_ ?^)) 1)
  5197. (t 0)))
  5198. (font-lock-prepend-text-property
  5199. (+ d (match-beginning 0)) (match-end 0)
  5200. 'face 'org-latex-and-export-specials)
  5201. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  5202. '(font-lock-multiline t)))))
  5203. rtn)))
  5204. (defun org-restart-font-lock ()
  5205. "Restart `font-lock-mode', to force refontification."
  5206. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5207. (font-lock-mode -1)
  5208. (font-lock-mode 1)))
  5209. (defun org-all-targets (&optional radio)
  5210. "Return a list of all targets in this file.
  5211. With optional argument RADIO, only find radio targets."
  5212. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  5213. rtn)
  5214. (save-excursion
  5215. (goto-char (point-min))
  5216. (while (re-search-forward re nil t)
  5217. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  5218. rtn)))
  5219. (defun org-make-target-link-regexp (targets)
  5220. "Make regular expression matching all strings in TARGETS.
  5221. The regular expression finds the targets also if there is a line break
  5222. between words."
  5223. (and targets
  5224. (concat
  5225. "\\<\\("
  5226. (mapconcat
  5227. (lambda (x)
  5228. (setq x (regexp-quote x))
  5229. (while (string-match " +" x)
  5230. (setq x (replace-match "\\s-+" t t x)))
  5231. x)
  5232. targets
  5233. "\\|")
  5234. "\\)\\>")))
  5235. (defun org-activate-tags (limit)
  5236. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5237. (progn
  5238. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5239. (add-text-properties (match-beginning 1) (match-end 1)
  5240. (list 'mouse-face 'highlight
  5241. 'keymap org-mouse-map))
  5242. (org-rear-nonsticky-at (match-end 1))
  5243. t)))
  5244. (defun org-outline-level ()
  5245. "Compute the outline level of the heading at point.
  5246. If this is called at a normal headline, the level is the number of stars.
  5247. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5248. (save-excursion
  5249. (if (not (condition-case nil
  5250. (org-back-to-heading t)
  5251. (error nil)))
  5252. 0
  5253. (looking-at org-outline-regexp)
  5254. (1- (- (match-end 0) (match-beginning 0))))))
  5255. (defvar org-font-lock-keywords nil)
  5256. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  5257. "Regular expression matching a property line.")
  5258. (defvar org-font-lock-hook nil
  5259. "Functions to be called for special font lock stuff.")
  5260. (defvar org-font-lock-set-keywords-hook nil
  5261. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5262. This is called after `org-font-lock-extra-keywords' is defined, but before
  5263. it is installed to be used by font lock. This can be useful if something
  5264. needs to be inserted at a specific position in the font-lock sequence.")
  5265. (defun org-font-lock-hook (limit)
  5266. (run-hook-with-args 'org-font-lock-hook limit))
  5267. (defun org-set-font-lock-defaults ()
  5268. (let* ((em org-fontify-emphasized-text)
  5269. (lk org-activate-links)
  5270. (org-font-lock-extra-keywords
  5271. (list
  5272. ;; Call the hook
  5273. '(org-font-lock-hook)
  5274. ;; Headlines
  5275. `(,(if org-fontify-whole-heading-line
  5276. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5277. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5278. (1 (org-get-level-face 1))
  5279. (2 (org-get-level-face 2))
  5280. (3 (org-get-level-face 3)))
  5281. ;; Table lines
  5282. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5283. (1 'org-table t))
  5284. ;; Table internals
  5285. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5286. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5287. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5288. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5289. ;; Drawers
  5290. (list org-drawer-regexp '(0 'org-special-keyword t))
  5291. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5292. ;; Properties
  5293. (list org-property-re
  5294. '(1 'org-special-keyword t)
  5295. '(3 'org-property-value t))
  5296. ;; Links
  5297. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5298. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5299. (if (memq 'plain lk) '(org-activate-plain-links))
  5300. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5301. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5302. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5303. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5304. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5305. '(org-hide-wide-columns (0 nil append))
  5306. ;; TODO keyword
  5307. (list (format org-heading-keyword-regexp-format
  5308. org-todo-regexp)
  5309. '(2 (org-get-todo-face 2) t))
  5310. ;; DONE
  5311. (if org-fontify-done-headline
  5312. (list (format org-heading-keyword-regexp-format
  5313. (concat
  5314. "\\(?:"
  5315. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5316. "\\)"))
  5317. '(2 'org-headline-done t))
  5318. nil)
  5319. ;; Priorities
  5320. '(org-font-lock-add-priority-faces)
  5321. ;; Tags
  5322. '(org-font-lock-add-tag-faces)
  5323. ;; Special keywords
  5324. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5325. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5326. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5327. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5328. ;; Emphasis
  5329. (if em
  5330. (if (featurep 'xemacs)
  5331. '(org-do-emphasis-faces (0 nil append))
  5332. '(org-do-emphasis-faces)))
  5333. ;; Checkboxes
  5334. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5335. 1 'org-checkbox prepend)
  5336. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5337. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5338. (0 (org-get-checkbox-statistics-face) t)))
  5339. ;; Description list items
  5340. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5341. 1 'org-list-dt prepend)
  5342. ;; ARCHIVEd headings
  5343. (list (concat
  5344. org-outline-regexp-bol
  5345. "\\(.*:" org-archive-tag ":.*\\)")
  5346. '(1 'org-archived prepend))
  5347. ;; Specials
  5348. '(org-do-latex-and-special-faces)
  5349. '(org-fontify-entities)
  5350. '(org-raise-scripts)
  5351. ;; Code
  5352. '(org-activate-code (1 'org-code t))
  5353. ;; COMMENT
  5354. (list (format org-heading-keyword-regexp-format
  5355. (concat "\\("
  5356. org-comment-string "\\|" org-quote-string
  5357. "\\)"))
  5358. '(2 'org-special-keyword t))
  5359. ;; Blocks and meta lines
  5360. '(org-fontify-meta-lines-and-blocks)
  5361. )))
  5362. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5363. (run-hooks 'org-font-lock-set-keywords-hook)
  5364. ;; Now set the full font-lock-keywords
  5365. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5366. (org-set-local 'font-lock-defaults
  5367. '(org-font-lock-keywords t nil nil backward-paragraph))
  5368. (kill-local-variable 'font-lock-keywords) nil))
  5369. (defun org-toggle-pretty-entities ()
  5370. "Toggle the composition display of entities as UTF8 characters."
  5371. (interactive)
  5372. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5373. (org-restart-font-lock)
  5374. (if org-pretty-entities
  5375. (message "Entities are displayed as UTF8 characters")
  5376. (save-restriction
  5377. (widen)
  5378. (org-decompose-region (point-min) (point-max))
  5379. (message "Entities are displayed plain"))))
  5380. (defvar org-custom-properties-overlays nil
  5381. "List of overlays used for custom properties.")
  5382. (make-variable-buffer-local 'org-custom-properties-overlays)
  5383. (defun org-toggle-custom-properties-visibility ()
  5384. "Display or hide properties in `org-custom-properties'."
  5385. (interactive)
  5386. (if org-custom-properties-overlays
  5387. (progn (mapc 'delete-overlay org-custom-properties-overlays)
  5388. (setq org-custom-properties-overlays nil))
  5389. (unless (not org-custom-properties)
  5390. (save-excursion
  5391. (save-restriction
  5392. (widen)
  5393. (goto-char (point-min))
  5394. (while (re-search-forward org-property-re nil t)
  5395. (mapc (lambda(p)
  5396. (when (equal p (substring (match-string 1) 1 -1))
  5397. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5398. (overlay-put o 'invisible t)
  5399. (overlay-put o 'org-custom-property t)
  5400. (push o org-custom-properties-overlays))))
  5401. org-custom-properties)))))))
  5402. (defun org-fontify-entities (limit)
  5403. "Find an entity to fontify."
  5404. (let (ee)
  5405. (when org-pretty-entities
  5406. (catch 'match
  5407. (while (re-search-forward
  5408. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5409. limit t)
  5410. (if (and (not (org-in-indented-comment-line))
  5411. (setq ee (org-entity-get (match-string 1)))
  5412. (= (length (nth 6 ee)) 1))
  5413. (let*
  5414. ((end (if (equal (match-string 2) "{}")
  5415. (match-end 2)
  5416. (match-end 1))))
  5417. (add-text-properties
  5418. (match-beginning 0) end
  5419. (list 'font-lock-fontified t))
  5420. (compose-region (match-beginning 0) end
  5421. (nth 6 ee) nil)
  5422. (backward-char 1)
  5423. (throw 'match t))))
  5424. nil))))
  5425. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5426. "Fontify string S like in Org-mode."
  5427. (with-temp-buffer
  5428. (insert s)
  5429. (let ((org-odd-levels-only odd-levels))
  5430. (org-mode)
  5431. (font-lock-fontify-buffer)
  5432. (buffer-string))))
  5433. (defvar org-m nil)
  5434. (defvar org-l nil)
  5435. (defvar org-f nil)
  5436. (defun org-get-level-face (n)
  5437. "Get the right face for match N in font-lock matching of headlines."
  5438. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5439. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5440. (if org-cycle-level-faces
  5441. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5442. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5443. (cond
  5444. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5445. ((eq n 2) org-f)
  5446. (t (if org-level-color-stars-only nil org-f))))
  5447. (defun org-get-todo-face (kwd)
  5448. "Get the right face for a TODO keyword KWD.
  5449. If KWD is a number, get the corresponding match group."
  5450. (if (numberp kwd) (setq kwd (match-string kwd)))
  5451. (or (org-face-from-face-or-color
  5452. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5453. (and (member kwd org-done-keywords) 'org-done)
  5454. 'org-todo))
  5455. (defun org-face-from-face-or-color (context inherit face-or-color)
  5456. "Create a face list that inherits INHERIT, but sets the foreground color.
  5457. When FACE-OR-COLOR is not a string, just return it."
  5458. (if (stringp face-or-color)
  5459. (list :inherit inherit
  5460. (cdr (assoc context org-faces-easy-properties))
  5461. face-or-color)
  5462. face-or-color))
  5463. (defun org-font-lock-add-tag-faces (limit)
  5464. "Add the special tag faces."
  5465. (when (and org-tag-faces org-tags-special-faces-re)
  5466. (while (re-search-forward org-tags-special-faces-re limit t)
  5467. (add-text-properties (match-beginning 1) (match-end 1)
  5468. (list 'face (org-get-tag-face 1)
  5469. 'font-lock-fontified t))
  5470. (backward-char 1))))
  5471. (defun org-font-lock-add-priority-faces (limit)
  5472. "Add the special priority faces."
  5473. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5474. (when (save-match-data (org-at-heading-p))
  5475. (add-text-properties
  5476. (match-beginning 0) (match-end 0)
  5477. (list 'face (or (org-face-from-face-or-color
  5478. 'priority 'org-special-keyword
  5479. (cdr (assoc (char-after (match-beginning 1))
  5480. org-priority-faces)))
  5481. 'org-special-keyword)
  5482. 'font-lock-fontified t)))))
  5483. (defun org-get-tag-face (kwd)
  5484. "Get the right face for a TODO keyword KWD.
  5485. If KWD is a number, get the corresponding match group."
  5486. (if (numberp kwd) (setq kwd (match-string kwd)))
  5487. (or (org-face-from-face-or-color
  5488. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5489. 'org-tag))
  5490. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5491. "Remove fontification and activation overlays from links."
  5492. (font-lock-default-unfontify-region beg end)
  5493. (let* ((buffer-undo-list t)
  5494. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5495. (inhibit-modification-hooks t)
  5496. deactivate-mark buffer-file-name buffer-file-truename)
  5497. (org-decompose-region beg end)
  5498. (remove-text-properties beg end
  5499. '(mouse-face t keymap t org-linked-text t
  5500. invisible t intangible t
  5501. org-no-flyspell t org-emphasis t))
  5502. (org-remove-font-lock-display-properties beg end)))
  5503. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5504. ((raise 0.3) (height 0.7))
  5505. ((raise -0.5))
  5506. ((raise 0.5)))
  5507. "Display properties for showing superscripts and subscripts.")
  5508. (defun org-remove-font-lock-display-properties (beg end)
  5509. "Remove specific display properties that have been added by font lock.
  5510. The will remove the raise properties that are used to show superscripts
  5511. and subscripts."
  5512. (let (next prop)
  5513. (while (< beg end)
  5514. (setq next (next-single-property-change beg 'display nil end)
  5515. prop (get-text-property beg 'display))
  5516. (if (member prop org-script-display)
  5517. (put-text-property beg next 'display nil))
  5518. (setq beg next))))
  5519. (defun org-raise-scripts (limit)
  5520. "Add raise properties to sub/superscripts."
  5521. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5522. (if (re-search-forward
  5523. (if (eq org-use-sub-superscripts t)
  5524. org-match-substring-regexp
  5525. org-match-substring-with-braces-regexp)
  5526. limit t)
  5527. (let* ((pos (point)) table-p comment-p
  5528. (mpos (match-beginning 3))
  5529. (emph-p (get-text-property mpos 'org-emphasis))
  5530. (link-p (get-text-property mpos 'mouse-face))
  5531. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5532. (goto-char (point-at-bol))
  5533. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5534. comment-p (org-looking-at-p "[ \t]*#"))
  5535. (goto-char pos)
  5536. ;; FIXME: Should we go back one character here, for a_b^c
  5537. ;; (goto-char (1- pos)) ;????????????????????
  5538. (if (or comment-p emph-p link-p keyw-p)
  5539. t
  5540. (put-text-property (match-beginning 3) (match-end 0)
  5541. 'display
  5542. (if (equal (char-after (match-beginning 2)) ?^)
  5543. (nth (if table-p 3 1) org-script-display)
  5544. (nth (if table-p 2 0) org-script-display)))
  5545. (add-text-properties (match-beginning 2) (match-end 2)
  5546. (list 'invisible t
  5547. 'org-dwidth t 'org-dwidth-n 1))
  5548. (if (and (eq (char-after (match-beginning 3)) ?{)
  5549. (eq (char-before (match-end 3)) ?}))
  5550. (progn
  5551. (add-text-properties
  5552. (match-beginning 3) (1+ (match-beginning 3))
  5553. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5554. (add-text-properties
  5555. (1- (match-end 3)) (match-end 3)
  5556. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5557. t)))))
  5558. ;;;; Visibility cycling, including org-goto and indirect buffer
  5559. ;;; Cycling
  5560. (defvar org-cycle-global-status nil)
  5561. (make-variable-buffer-local 'org-cycle-global-status)
  5562. (defvar org-cycle-subtree-status nil)
  5563. (make-variable-buffer-local 'org-cycle-subtree-status)
  5564. ;;;###autoload
  5565. (defvar org-inlinetask-min-level)
  5566. (defun org-cycle (&optional arg)
  5567. "TAB-action and visibility cycling for Org-mode.
  5568. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5569. is outline visibility cycling, but it also invokes other actions
  5570. in special contexts.
  5571. - When this function is called with a prefix argument, rotate the entire
  5572. buffer through 3 states (global cycling)
  5573. 1. OVERVIEW: Show only top-level headlines.
  5574. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5575. 3. SHOW ALL: Show everything.
  5576. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5577. determined by the variable `org-startup-folded', and by any VISIBILITY
  5578. properties in the buffer.
  5579. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5580. including any drawers.
  5581. - When inside a table, re-align the table and move to the next field.
  5582. - When point is at the beginning of a headline, rotate the subtree started
  5583. by this line through 3 different states (local cycling)
  5584. 1. FOLDED: Only the main headline is shown.
  5585. 2. CHILDREN: The main headline and the direct children are shown.
  5586. From this state, you can move to one of the children
  5587. and zoom in further.
  5588. 3. SUBTREE: Show the entire subtree, including body text.
  5589. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5590. - When point is at the beginning of an empty headline and the variable
  5591. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5592. of the headline by demoting and promoting it to likely levels. This
  5593. speeds up creation document structure by pressing TAB once or several
  5594. times right after creating a new headline.
  5595. - When there is a numeric prefix, go up to a heading with level ARG, do
  5596. a `show-subtree' and return to the previous cursor position. If ARG
  5597. is negative, go up that many levels.
  5598. - When point is not at the beginning of a headline, execute the global
  5599. binding for TAB, which is re-indenting the line. See the option
  5600. `org-cycle-emulate-tab' for details.
  5601. - Special case: if point is at the beginning of the buffer and there is
  5602. no headline in line 1, this function will act as if called with prefix arg
  5603. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5604. But only if also the variable `org-cycle-global-at-bob' is t."
  5605. (interactive "P")
  5606. (org-load-modules-maybe)
  5607. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5608. (and org-cycle-level-after-item/entry-creation
  5609. (or (org-cycle-level)
  5610. (org-cycle-item-indentation))))
  5611. (let* ((limit-level
  5612. (or org-cycle-max-level
  5613. (and (boundp 'org-inlinetask-min-level)
  5614. org-inlinetask-min-level
  5615. (1- org-inlinetask-min-level))))
  5616. (nstars (and limit-level
  5617. (if org-odd-levels-only
  5618. (and limit-level (1- (* limit-level 2)))
  5619. limit-level)))
  5620. (org-outline-regexp
  5621. (if (not (derived-mode-p 'org-mode))
  5622. outline-regexp
  5623. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5624. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5625. (not (looking-at org-outline-regexp))))
  5626. (org-cycle-hook
  5627. (if bob-special
  5628. (delq 'org-optimize-window-after-visibility-change
  5629. (copy-sequence org-cycle-hook))
  5630. org-cycle-hook))
  5631. (pos (point)))
  5632. (if (or bob-special (equal arg '(4)))
  5633. ;; special case: use global cycling
  5634. (setq arg t))
  5635. (cond
  5636. ((equal arg '(16))
  5637. (setq last-command 'dummy)
  5638. (org-set-startup-visibility)
  5639. (message "Startup visibility, plus VISIBILITY properties"))
  5640. ((equal arg '(64))
  5641. (show-all)
  5642. (message "Entire buffer visible, including drawers"))
  5643. ;; Table: enter it or move to the next field.
  5644. ((org-at-table-p 'any)
  5645. (if (org-at-table.el-p)
  5646. (message "Use C-c ' to edit table.el tables")
  5647. (if arg (org-table-edit-field t)
  5648. (org-table-justify-field-maybe)
  5649. (call-interactively 'org-table-next-field))))
  5650. ((run-hook-with-args-until-success
  5651. 'org-tab-after-check-for-table-hook))
  5652. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5653. ((eq arg t) (org-cycle-internal-global))
  5654. ;; Drawers: delegate to `org-flag-drawer'.
  5655. ((and org-drawers org-drawer-regexp
  5656. (save-excursion
  5657. (beginning-of-line 1)
  5658. (looking-at org-drawer-regexp)))
  5659. (org-flag-drawer ; toggle block visibility
  5660. (not (get-char-property (match-end 0) 'invisible))))
  5661. ;; Show-subtree, ARG levels up from here.
  5662. ((integerp arg)
  5663. (save-excursion
  5664. (org-back-to-heading)
  5665. (outline-up-heading (if (< arg 0) (- arg)
  5666. (- (funcall outline-level) arg)))
  5667. (org-show-subtree)))
  5668. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5669. ((and (featurep 'org-inlinetask)
  5670. (org-inlinetask-at-task-p)
  5671. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5672. (org-inlinetask-toggle-visibility))
  5673. ((org-try-cdlatex-tab))
  5674. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5675. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5676. (save-excursion (beginning-of-line 1)
  5677. (looking-at org-outline-regexp)))
  5678. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5679. (org-cycle-internal-local))
  5680. ;; From there: TAB emulation and template completion.
  5681. (buffer-read-only (org-back-to-heading))
  5682. ((run-hook-with-args-until-success
  5683. 'org-tab-after-check-for-cycling-hook))
  5684. ((org-try-structure-completion))
  5685. ((run-hook-with-args-until-success
  5686. 'org-tab-before-tab-emulation-hook))
  5687. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5688. (or (not (bolp))
  5689. (not (looking-at org-outline-regexp))))
  5690. (call-interactively (global-key-binding "\t")))
  5691. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5692. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5693. (or (and (eq org-cycle-emulate-tab 'white)
  5694. (= (match-end 0) (point-at-eol)))
  5695. (and (eq org-cycle-emulate-tab 'whitestart)
  5696. (>= (match-end 0) pos))))
  5697. t
  5698. (eq org-cycle-emulate-tab t))
  5699. (call-interactively (global-key-binding "\t")))
  5700. (t (save-excursion
  5701. (org-back-to-heading)
  5702. (org-cycle)))))))
  5703. (defun org-cycle-internal-global ()
  5704. "Do the global cycling action."
  5705. ;; Hack to avoid display of messages for .org attachments in Gnus
  5706. (let ((ga (string-match "\\*fontification" (buffer-name))))
  5707. (cond
  5708. ((and (eq last-command this-command)
  5709. (eq org-cycle-global-status 'overview))
  5710. ;; We just created the overview - now do table of contents
  5711. ;; This can be slow in very large buffers, so indicate action
  5712. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5713. (unless ga (message "CONTENTS..."))
  5714. (org-content)
  5715. (unless ga (message "CONTENTS...done"))
  5716. (setq org-cycle-global-status 'contents)
  5717. (run-hook-with-args 'org-cycle-hook 'contents))
  5718. ((and (eq last-command this-command)
  5719. (eq org-cycle-global-status 'contents))
  5720. ;; We just showed the table of contents - now show everything
  5721. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5722. (show-all)
  5723. (unless ga (message "SHOW ALL"))
  5724. (setq org-cycle-global-status 'all)
  5725. (run-hook-with-args 'org-cycle-hook 'all))
  5726. (t
  5727. ;; Default action: go to overview
  5728. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5729. (org-overview)
  5730. (unless ga (message "OVERVIEW"))
  5731. (setq org-cycle-global-status 'overview)
  5732. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5733. (defun org-cycle-internal-local ()
  5734. "Do the local cycling action."
  5735. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5736. ;; First, determine end of headline (EOH), end of subtree or item
  5737. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5738. (save-excursion
  5739. (if (org-at-item-p)
  5740. (progn
  5741. (beginning-of-line)
  5742. (setq struct (org-list-struct))
  5743. (setq eoh (point-at-eol))
  5744. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5745. (setq has-children (org-list-has-child-p (point) struct)))
  5746. (org-back-to-heading)
  5747. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5748. (setq eos (save-excursion
  5749. (org-end-of-subtree t)
  5750. (unless (eobp)
  5751. (skip-chars-forward " \t\n"))
  5752. (if (eobp) (point) (1- (point)))))
  5753. (setq has-children
  5754. (or (save-excursion
  5755. (let ((level (funcall outline-level)))
  5756. (outline-next-heading)
  5757. (and (org-at-heading-p t)
  5758. (> (funcall outline-level) level))))
  5759. (save-excursion
  5760. (org-list-search-forward (org-item-beginning-re) eos t)))))
  5761. ;; Determine end invisible part of buffer (EOL)
  5762. (beginning-of-line 2)
  5763. ;; XEmacs doesn't have `next-single-char-property-change'
  5764. (if (featurep 'xemacs)
  5765. (while (and (not (eobp)) ;; this is like `next-line'
  5766. (get-char-property (1- (point)) 'invisible))
  5767. (beginning-of-line 2))
  5768. (while (and (not (eobp)) ;; this is like `next-line'
  5769. (get-char-property (1- (point)) 'invisible))
  5770. (goto-char (next-single-char-property-change (point) 'invisible))
  5771. (and (eolp) (beginning-of-line 2))))
  5772. (setq eol (point)))
  5773. ;; Find out what to do next and set `this-command'
  5774. (cond
  5775. ((= eos eoh)
  5776. ;; Nothing is hidden behind this heading
  5777. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5778. (message "EMPTY ENTRY")
  5779. (setq org-cycle-subtree-status nil)
  5780. (save-excursion
  5781. (goto-char eos)
  5782. (outline-next-heading)
  5783. (if (outline-invisible-p) (org-flag-heading nil))))
  5784. ((and (or (>= eol eos)
  5785. (not (string-match "\\S-" (buffer-substring eol eos))))
  5786. (or has-children
  5787. (not (setq children-skipped
  5788. org-cycle-skip-children-state-if-no-children))))
  5789. ;; Entire subtree is hidden in one line: children view
  5790. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5791. (if (org-at-item-p)
  5792. (org-list-set-item-visibility (point-at-bol) struct 'children)
  5793. (org-show-entry)
  5794. (org-with-limited-levels (show-children))
  5795. ;; FIXME: This slows down the func way too much.
  5796. ;; How keep drawers hidden in subtree anyway?
  5797. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  5798. ;; (org-cycle-hide-drawers 'subtree))
  5799. ;; Fold every list in subtree to top-level items.
  5800. (when (eq org-cycle-include-plain-lists 'integrate)
  5801. (save-excursion
  5802. (org-back-to-heading)
  5803. (while (org-list-search-forward (org-item-beginning-re) eos t)
  5804. (beginning-of-line 1)
  5805. (let* ((struct (org-list-struct))
  5806. (prevs (org-list-prevs-alist struct))
  5807. (end (org-list-get-bottom-point struct)))
  5808. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  5809. (org-list-get-all-items (point) struct prevs))
  5810. (goto-char end))))))
  5811. (message "CHILDREN")
  5812. (save-excursion
  5813. (goto-char eos)
  5814. (outline-next-heading)
  5815. (if (outline-invisible-p) (org-flag-heading nil)))
  5816. (setq org-cycle-subtree-status 'children)
  5817. (run-hook-with-args 'org-cycle-hook 'children))
  5818. ((or children-skipped
  5819. (and (eq last-command this-command)
  5820. (eq org-cycle-subtree-status 'children)))
  5821. ;; We just showed the children, or no children are there,
  5822. ;; now show everything.
  5823. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5824. (outline-flag-region eoh eos nil)
  5825. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5826. (setq org-cycle-subtree-status 'subtree)
  5827. (run-hook-with-args 'org-cycle-hook 'subtree))
  5828. (t
  5829. ;; Default action: hide the subtree.
  5830. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5831. (outline-flag-region eoh eos t)
  5832. (message "FOLDED")
  5833. (setq org-cycle-subtree-status 'folded)
  5834. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5835. ;;;###autoload
  5836. (defun org-global-cycle (&optional arg)
  5837. "Cycle the global visibility. For details see `org-cycle'.
  5838. With \\[universal-argument] prefix arg, switch to startup visibility.
  5839. With a numeric prefix, show all headlines up to that level."
  5840. (interactive "P")
  5841. (let ((org-cycle-include-plain-lists
  5842. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  5843. (cond
  5844. ((integerp arg)
  5845. (show-all)
  5846. (hide-sublevels arg)
  5847. (setq org-cycle-global-status 'contents))
  5848. ((equal arg '(4))
  5849. (org-set-startup-visibility)
  5850. (message "Startup visibility, plus VISIBILITY properties."))
  5851. (t
  5852. (org-cycle '(4))))))
  5853. (defun org-set-startup-visibility ()
  5854. "Set the visibility required by startup options and properties."
  5855. (cond
  5856. ((eq org-startup-folded t)
  5857. (org-cycle '(4)))
  5858. ((eq org-startup-folded 'content)
  5859. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5860. (org-cycle '(4)) (org-cycle '(4)))))
  5861. (unless (eq org-startup-folded 'showeverything)
  5862. (if org-hide-block-startup (org-hide-block-all))
  5863. (org-set-visibility-according-to-property 'no-cleanup)
  5864. (org-cycle-hide-archived-subtrees 'all)
  5865. (org-cycle-hide-drawers 'all)
  5866. (org-cycle-show-empty-lines t)))
  5867. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5868. "Switch subtree visibilities according to :VISIBILITY: property."
  5869. (interactive)
  5870. (let (org-show-entry-below state)
  5871. (save-excursion
  5872. (goto-char (point-min))
  5873. (while (re-search-forward
  5874. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5875. nil t)
  5876. (setq state (match-string 1))
  5877. (save-excursion
  5878. (org-back-to-heading t)
  5879. (hide-subtree)
  5880. (org-reveal)
  5881. (cond
  5882. ((equal state '("fold" "folded"))
  5883. (hide-subtree))
  5884. ((equal state "children")
  5885. (org-show-hidden-entry)
  5886. (show-children))
  5887. ((equal state "content")
  5888. (save-excursion
  5889. (save-restriction
  5890. (org-narrow-to-subtree)
  5891. (org-content))))
  5892. ((member state '("all" "showall"))
  5893. (show-subtree)))))
  5894. (unless no-cleanup
  5895. (org-cycle-hide-archived-subtrees 'all)
  5896. (org-cycle-hide-drawers 'all)
  5897. (org-cycle-show-empty-lines 'all)))))
  5898. ;; This function uses outline-regexp instead of the more fundamental
  5899. ;; org-outline-regexp so that org-cycle-global works outside of Org
  5900. ;; buffers, where outline-regexp is needed.
  5901. (defun org-overview ()
  5902. "Switch to overview mode, showing only top-level headlines.
  5903. Really, this shows all headlines with level equal or greater than the level
  5904. of the first headline in the buffer. This is important, because if the
  5905. first headline is not level one, then (hide-sublevels 1) gives confusing
  5906. results."
  5907. (interactive)
  5908. (let ((level (save-excursion
  5909. (goto-char (point-min))
  5910. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5911. (progn
  5912. (goto-char (match-beginning 0))
  5913. (funcall outline-level))))))
  5914. (and level (hide-sublevels level))))
  5915. (defun org-content (&optional arg)
  5916. "Show all headlines in the buffer, like a table of contents.
  5917. With numerical argument N, show content up to level N."
  5918. (interactive "P")
  5919. (save-excursion
  5920. ;; Visit all headings and show their offspring
  5921. (and (integerp arg) (org-overview))
  5922. (goto-char (point-max))
  5923. (catch 'exit
  5924. (while (and (progn (condition-case nil
  5925. (outline-previous-visible-heading 1)
  5926. (error (goto-char (point-min))))
  5927. t)
  5928. (looking-at org-outline-regexp))
  5929. (if (integerp arg)
  5930. (show-children (1- arg))
  5931. (show-branches))
  5932. (if (bobp) (throw 'exit nil))))))
  5933. (defun org-optimize-window-after-visibility-change (state)
  5934. "Adjust the window after a change in outline visibility.
  5935. This function is the default value of the hook `org-cycle-hook'."
  5936. (when (get-buffer-window (current-buffer))
  5937. (cond
  5938. ((eq state 'content) nil)
  5939. ((eq state 'all) nil)
  5940. ((eq state 'folded) nil)
  5941. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5942. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5943. (defun org-remove-empty-overlays-at (pos)
  5944. "Remove outline overlays that do not contain non-white stuff."
  5945. (mapc
  5946. (lambda (o)
  5947. (and (eq 'outline (overlay-get o 'invisible))
  5948. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5949. (overlay-end o))))
  5950. (delete-overlay o)))
  5951. (overlays-at pos)))
  5952. (defun org-clean-visibility-after-subtree-move ()
  5953. "Fix visibility issues after moving a subtree."
  5954. ;; First, find a reasonable region to look at:
  5955. ;; Start two siblings above, end three below
  5956. (let* ((beg (save-excursion
  5957. (and (org-get-last-sibling)
  5958. (org-get-last-sibling))
  5959. (point)))
  5960. (end (save-excursion
  5961. (and (org-get-next-sibling)
  5962. (org-get-next-sibling)
  5963. (org-get-next-sibling))
  5964. (if (org-at-heading-p)
  5965. (point-at-eol)
  5966. (point))))
  5967. (level (looking-at "\\*+"))
  5968. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5969. (save-excursion
  5970. (save-restriction
  5971. (narrow-to-region beg end)
  5972. (when re
  5973. ;; Properly fold already folded siblings
  5974. (goto-char (point-min))
  5975. (while (re-search-forward re nil t)
  5976. (if (and (not (outline-invisible-p))
  5977. (save-excursion
  5978. (goto-char (point-at-eol)) (outline-invisible-p)))
  5979. (hide-entry))))
  5980. (org-cycle-show-empty-lines 'overview)
  5981. (org-cycle-hide-drawers 'overview)))))
  5982. (defun org-cycle-show-empty-lines (state)
  5983. "Show empty lines above all visible headlines.
  5984. The region to be covered depends on STATE when called through
  5985. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5986. entire buffer covered. Note that an empty line is only shown if there
  5987. are at least `org-cycle-separator-lines' empty lines before the headline."
  5988. (when (not (= org-cycle-separator-lines 0))
  5989. (save-excursion
  5990. (let* ((n (abs org-cycle-separator-lines))
  5991. (re (cond
  5992. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5993. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5994. (t (let ((ns (number-to-string (- n 2))))
  5995. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5996. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5997. beg end b e)
  5998. (cond
  5999. ((memq state '(overview contents t))
  6000. (setq beg (point-min) end (point-max)))
  6001. ((memq state '(children folded))
  6002. (setq beg (point) end (progn (org-end-of-subtree t t)
  6003. (beginning-of-line 2)
  6004. (point)))))
  6005. (when beg
  6006. (goto-char beg)
  6007. (while (re-search-forward re end t)
  6008. (unless (get-char-property (match-end 1) 'invisible)
  6009. (setq e (match-end 1))
  6010. (if (< org-cycle-separator-lines 0)
  6011. (setq b (save-excursion
  6012. (goto-char (match-beginning 0))
  6013. (org-back-over-empty-lines)
  6014. (if (save-excursion
  6015. (goto-char (max (point-min) (1- (point))))
  6016. (org-at-heading-p))
  6017. (1- (point))
  6018. (point))))
  6019. (setq b (match-beginning 1)))
  6020. (outline-flag-region b e nil)))))))
  6021. ;; Never hide empty lines at the end of the file.
  6022. (save-excursion
  6023. (goto-char (point-max))
  6024. (outline-previous-heading)
  6025. (outline-end-of-heading)
  6026. (if (and (looking-at "[ \t\n]+")
  6027. (= (match-end 0) (point-max)))
  6028. (outline-flag-region (point) (match-end 0) nil))))
  6029. (defun org-show-empty-lines-in-parent ()
  6030. "Move to the parent and re-show empty lines before visible headlines."
  6031. (save-excursion
  6032. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  6033. (org-cycle-show-empty-lines context))))
  6034. (defun org-files-list ()
  6035. "Return `org-agenda-files' list, plus all open org-mode files.
  6036. This is useful for operations that need to scan all of a user's
  6037. open and agenda-wise Org files."
  6038. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  6039. (dolist (buf (buffer-list))
  6040. (with-current-buffer buf
  6041. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  6042. (let ((file (expand-file-name (buffer-file-name))))
  6043. (unless (member file files)
  6044. (push file files))))))
  6045. files))
  6046. (defsubst org-entry-beginning-position ()
  6047. "Return the beginning position of the current entry."
  6048. (save-excursion (outline-back-to-heading t) (point)))
  6049. (defsubst org-entry-end-position ()
  6050. "Return the end position of the current entry."
  6051. (save-excursion (outline-next-heading) (point)))
  6052. (defun org-cycle-hide-drawers (state)
  6053. "Re-hide all drawers after a visibility state change."
  6054. (when (and (derived-mode-p 'org-mode)
  6055. (not (memq state '(overview folded contents))))
  6056. (save-excursion
  6057. (let* ((globalp (memq state '(contents all)))
  6058. (beg (if globalp (point-min) (point)))
  6059. (end (if globalp (point-max)
  6060. (if (eq state 'children)
  6061. (save-excursion (outline-next-heading) (point))
  6062. (org-end-of-subtree t)))))
  6063. (goto-char beg)
  6064. (while (re-search-forward org-drawer-regexp end t)
  6065. (org-flag-drawer t))))))
  6066. (defun org-flag-drawer (flag)
  6067. "When FLAG is non-nil, hide the drawer we are within.
  6068. Otherwise make it visible."
  6069. (save-excursion
  6070. (beginning-of-line 1)
  6071. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  6072. (let ((b (match-end 0)))
  6073. (if (re-search-forward
  6074. "^[ \t]*:END:"
  6075. (save-excursion (outline-next-heading) (point)) t)
  6076. (outline-flag-region b (point-at-eol) flag)
  6077. (error ":END: line missing at position %s" b))))))
  6078. (defun org-subtree-end-visible-p ()
  6079. "Is the end of the current subtree visible?"
  6080. (pos-visible-in-window-p
  6081. (save-excursion (org-end-of-subtree t) (point))))
  6082. (defun org-first-headline-recenter (&optional N)
  6083. "Move cursor to the first headline and recenter the headline.
  6084. Optional argument N means put the headline into the Nth line of the window."
  6085. (goto-char (point-min))
  6086. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6087. (beginning-of-line)
  6088. (recenter (prefix-numeric-value N))))
  6089. ;;; Saving and restoring visibility
  6090. (defun org-outline-overlay-data (&optional use-markers)
  6091. "Return a list of the locations of all outline overlays.
  6092. These are overlays with the `invisible' property value `outline'.
  6093. The return value is a list of cons cells, with start and stop
  6094. positions for each overlay.
  6095. If USE-MARKERS is set, return the positions as markers."
  6096. (let (beg end)
  6097. (save-excursion
  6098. (save-restriction
  6099. (widen)
  6100. (delq nil
  6101. (mapcar (lambda (o)
  6102. (when (eq (overlay-get o 'invisible) 'outline)
  6103. (setq beg (overlay-start o)
  6104. end (overlay-end o))
  6105. (and beg end (> end beg)
  6106. (if use-markers
  6107. (cons (move-marker (make-marker) beg)
  6108. (move-marker (make-marker) end))
  6109. (cons beg end)))))
  6110. (overlays-in (point-min) (point-max))))))))
  6111. (defun org-set-outline-overlay-data (data)
  6112. "Create visibility overlays for all positions in DATA.
  6113. DATA should have been made by `org-outline-overlay-data'."
  6114. (let (o)
  6115. (save-excursion
  6116. (save-restriction
  6117. (widen)
  6118. (show-all)
  6119. (mapc (lambda (c)
  6120. (outline-flag-region (car c) (cdr c) t))
  6121. data)))))
  6122. ;;; Folding of blocks
  6123. (defvar org-hide-block-overlays nil
  6124. "Overlays hiding blocks.")
  6125. (make-variable-buffer-local 'org-hide-block-overlays)
  6126. (defun org-block-map (function &optional start end)
  6127. "Call FUNCTION at the head of all source blocks in the current buffer.
  6128. Optional arguments START and END can be used to limit the range."
  6129. (let ((start (or start (point-min)))
  6130. (end (or end (point-max))))
  6131. (save-excursion
  6132. (goto-char start)
  6133. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6134. (save-excursion
  6135. (save-match-data
  6136. (goto-char (match-beginning 0))
  6137. (funcall function)))))))
  6138. (defun org-hide-block-toggle-all ()
  6139. "Toggle the visibility of all blocks in the current buffer."
  6140. (org-block-map #'org-hide-block-toggle))
  6141. (defun org-hide-block-all ()
  6142. "Fold all blocks in the current buffer."
  6143. (interactive)
  6144. (org-show-block-all)
  6145. (org-block-map #'org-hide-block-toggle-maybe))
  6146. (defun org-show-block-all ()
  6147. "Unfold all blocks in the current buffer."
  6148. (interactive)
  6149. (mapc 'delete-overlay org-hide-block-overlays)
  6150. (setq org-hide-block-overlays nil))
  6151. (defun org-hide-block-toggle-maybe ()
  6152. "Toggle visibility of block at point."
  6153. (interactive)
  6154. (let ((case-fold-search t))
  6155. (if (save-excursion
  6156. (beginning-of-line 1)
  6157. (looking-at org-block-regexp))
  6158. (progn (org-hide-block-toggle)
  6159. t) ;; to signal that we took action
  6160. nil))) ;; to signal that we did not
  6161. (defun org-hide-block-toggle (&optional force)
  6162. "Toggle the visibility of the current block."
  6163. (interactive)
  6164. (save-excursion
  6165. (beginning-of-line)
  6166. (if (re-search-forward org-block-regexp nil t)
  6167. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6168. (end (match-end 0)) ;; end of entire body
  6169. ov)
  6170. (if (memq t (mapcar (lambda (overlay)
  6171. (eq (overlay-get overlay 'invisible)
  6172. 'org-hide-block))
  6173. (overlays-at start)))
  6174. (if (or (not force) (eq force 'off))
  6175. (mapc (lambda (ov)
  6176. (when (member ov org-hide-block-overlays)
  6177. (setq org-hide-block-overlays
  6178. (delq ov org-hide-block-overlays)))
  6179. (when (eq (overlay-get ov 'invisible)
  6180. 'org-hide-block)
  6181. (delete-overlay ov)))
  6182. (overlays-at start)))
  6183. (setq ov (make-overlay start end))
  6184. (overlay-put ov 'invisible 'org-hide-block)
  6185. ;; make the block accessible to isearch
  6186. (overlay-put
  6187. ov 'isearch-open-invisible
  6188. (lambda (ov)
  6189. (when (member ov org-hide-block-overlays)
  6190. (setq org-hide-block-overlays
  6191. (delq ov org-hide-block-overlays)))
  6192. (when (eq (overlay-get ov 'invisible)
  6193. 'org-hide-block)
  6194. (delete-overlay ov))))
  6195. (push ov org-hide-block-overlays)))
  6196. (error "Not looking at a source block"))))
  6197. ;; org-tab-after-check-for-cycling-hook
  6198. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6199. ;; Remove overlays when changing major mode
  6200. (add-hook 'org-mode-hook
  6201. (lambda () (org-add-hook 'change-major-mode-hook
  6202. 'org-show-block-all 'append 'local)))
  6203. ;;; Org-goto
  6204. (defvar org-goto-window-configuration nil)
  6205. (defvar org-goto-marker nil)
  6206. (defvar org-goto-map
  6207. (let ((map (make-sparse-keymap)))
  6208. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  6209. (while (setq cmd (pop cmds))
  6210. (substitute-key-definition cmd cmd map global-map)))
  6211. (suppress-keymap map)
  6212. (org-defkey map "\C-m" 'org-goto-ret)
  6213. (org-defkey map [(return)] 'org-goto-ret)
  6214. (org-defkey map [(left)] 'org-goto-left)
  6215. (org-defkey map [(right)] 'org-goto-right)
  6216. (org-defkey map [(control ?g)] 'org-goto-quit)
  6217. (org-defkey map "\C-i" 'org-cycle)
  6218. (org-defkey map [(tab)] 'org-cycle)
  6219. (org-defkey map [(down)] 'outline-next-visible-heading)
  6220. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6221. (if org-goto-auto-isearch
  6222. (if (fboundp 'define-key-after)
  6223. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6224. nil)
  6225. (org-defkey map "q" 'org-goto-quit)
  6226. (org-defkey map "n" 'outline-next-visible-heading)
  6227. (org-defkey map "p" 'outline-previous-visible-heading)
  6228. (org-defkey map "f" 'outline-forward-same-level)
  6229. (org-defkey map "b" 'outline-backward-same-level)
  6230. (org-defkey map "u" 'outline-up-heading))
  6231. (org-defkey map "/" 'org-occur)
  6232. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6233. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6234. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6235. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6236. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6237. map))
  6238. (defconst org-goto-help
  6239. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  6240. RET=jump to location [Q]uit and return to previous location
  6241. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6242. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6243. ;; FIXME: Docstring does not mention both interfaces
  6244. (defun org-goto (&optional alternative-interface)
  6245. "Look up a different location in the current file, keeping current visibility.
  6246. When you want look-up or go to a different location in a
  6247. document, the fastest way is often to fold the entire buffer and
  6248. then dive into the tree. This method has the disadvantage, that
  6249. the previous location will be folded, which may not be what you
  6250. want.
  6251. This command works around this by showing a copy of the current
  6252. buffer in an indirect buffer, in overview mode. You can dive
  6253. into the tree in that copy, use org-occur and incremental search
  6254. to find a location. When pressing RET or `Q', the command
  6255. returns to the original buffer in which the visibility is still
  6256. unchanged. After RET it will also jump to the location selected
  6257. in the indirect buffer and expose the headline hierarchy above.
  6258. With a prefix argument, use the alternative interface: e.g. if
  6259. `org-goto-interface' is 'outline use 'outline-path-completion."
  6260. (interactive "P")
  6261. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6262. (org-refile-use-outline-path t)
  6263. (org-refile-target-verify-function nil)
  6264. (interface
  6265. (if (not alternative-interface)
  6266. org-goto-interface
  6267. (if (eq org-goto-interface 'outline)
  6268. 'outline-path-completion
  6269. 'outline)))
  6270. (org-goto-start-pos (point))
  6271. (selected-point
  6272. (if (eq interface 'outline)
  6273. (car (org-get-location (current-buffer) org-goto-help))
  6274. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6275. (org-refile-check-position pa)
  6276. (nth 3 pa)))))
  6277. (if selected-point
  6278. (progn
  6279. (org-mark-ring-push org-goto-start-pos)
  6280. (goto-char selected-point)
  6281. (if (or (outline-invisible-p) (org-invisible-p2))
  6282. (org-show-context 'org-goto)))
  6283. (message "Quit"))))
  6284. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6285. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6286. (defvar org-goto-local-auto-isearch-map) ; defined below
  6287. (defun org-get-location (buf help)
  6288. "Let the user select a location in the Org-mode buffer BUF.
  6289. This function uses a recursive edit. It returns the selected position
  6290. or nil."
  6291. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6292. (isearch-hide-immediately nil)
  6293. (isearch-search-fun-function
  6294. (lambda () 'org-goto-local-search-headings))
  6295. (org-goto-selected-point org-goto-exit-command)
  6296. (pop-up-frames nil)
  6297. (special-display-buffer-names nil)
  6298. (special-display-regexps nil)
  6299. (special-display-function nil))
  6300. (save-excursion
  6301. (save-window-excursion
  6302. (delete-other-windows)
  6303. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6304. (org-pop-to-buffer-same-window
  6305. (condition-case nil
  6306. (make-indirect-buffer (current-buffer) "*org-goto*")
  6307. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6308. (with-output-to-temp-buffer "*Help*"
  6309. (princ help))
  6310. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  6311. (setq buffer-read-only nil)
  6312. (let ((org-startup-truncated t)
  6313. (org-startup-folded nil)
  6314. (org-startup-align-all-tables nil))
  6315. (org-mode)
  6316. (org-overview))
  6317. (setq buffer-read-only t)
  6318. (if (and (boundp 'org-goto-start-pos)
  6319. (integer-or-marker-p org-goto-start-pos))
  6320. (let ((org-show-hierarchy-above t)
  6321. (org-show-siblings t)
  6322. (org-show-following-heading t))
  6323. (goto-char org-goto-start-pos)
  6324. (and (outline-invisible-p) (org-show-context)))
  6325. (goto-char (point-min)))
  6326. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6327. (message "Select location and press RET")
  6328. (use-local-map org-goto-map)
  6329. (recursive-edit)
  6330. ))
  6331. (kill-buffer "*org-goto*")
  6332. (cons org-goto-selected-point org-goto-exit-command)))
  6333. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6334. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6335. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6336. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6337. (defun org-goto-local-search-headings (string bound noerror)
  6338. "Search and make sure that any matches are in headlines."
  6339. (catch 'return
  6340. (while (if isearch-forward
  6341. (search-forward string bound noerror)
  6342. (search-backward string bound noerror))
  6343. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6344. (and (member :headline context)
  6345. (not (member :tags context))))
  6346. (throw 'return (point))))))
  6347. (defun org-goto-local-auto-isearch ()
  6348. "Start isearch."
  6349. (interactive)
  6350. (goto-char (point-min))
  6351. (let ((keys (this-command-keys)))
  6352. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6353. (isearch-mode t)
  6354. (isearch-process-search-char (string-to-char keys)))))
  6355. (defun org-goto-ret (&optional arg)
  6356. "Finish `org-goto' by going to the new location."
  6357. (interactive "P")
  6358. (setq org-goto-selected-point (point)
  6359. org-goto-exit-command 'return)
  6360. (throw 'exit nil))
  6361. (defun org-goto-left ()
  6362. "Finish `org-goto' by going to the new location."
  6363. (interactive)
  6364. (if (org-at-heading-p)
  6365. (progn
  6366. (beginning-of-line 1)
  6367. (setq org-goto-selected-point (point)
  6368. org-goto-exit-command 'left)
  6369. (throw 'exit nil))
  6370. (error "Not on a heading")))
  6371. (defun org-goto-right ()
  6372. "Finish `org-goto' by going to the new location."
  6373. (interactive)
  6374. (if (org-at-heading-p)
  6375. (progn
  6376. (setq org-goto-selected-point (point)
  6377. org-goto-exit-command 'right)
  6378. (throw 'exit nil))
  6379. (error "Not on a heading")))
  6380. (defun org-goto-quit ()
  6381. "Finish `org-goto' without cursor motion."
  6382. (interactive)
  6383. (setq org-goto-selected-point nil)
  6384. (setq org-goto-exit-command 'quit)
  6385. (throw 'exit nil))
  6386. ;;; Indirect buffer display of subtrees
  6387. (defvar org-indirect-dedicated-frame nil
  6388. "This is the frame being used for indirect tree display.")
  6389. (defvar org-last-indirect-buffer nil)
  6390. (defun org-tree-to-indirect-buffer (&optional arg)
  6391. "Create indirect buffer and narrow it to current subtree.
  6392. With numerical prefix ARG, go up to this level and then take that tree.
  6393. If ARG is negative, go up that many levels.
  6394. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6395. indirect buffer previously made with this command, to avoid proliferation of
  6396. indirect buffers. However, when you call the command with a \
  6397. \\[universal-argument] prefix, or
  6398. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6399. is kept so that you can work with several indirect buffers at the same time.
  6400. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6401. \\[universal-argument] prefix also
  6402. requests that a new frame be made for the new buffer, so that the dedicated
  6403. frame is not changed."
  6404. (interactive "P")
  6405. (let ((cbuf (current-buffer))
  6406. (cwin (selected-window))
  6407. (pos (point))
  6408. beg end level heading ibuf)
  6409. (save-excursion
  6410. (org-back-to-heading t)
  6411. (when (numberp arg)
  6412. (setq level (org-outline-level))
  6413. (if (< arg 0) (setq arg (+ level arg)))
  6414. (while (> (setq level (org-outline-level)) arg)
  6415. (outline-up-heading 1 t)))
  6416. (setq beg (point)
  6417. heading (org-get-heading))
  6418. (org-end-of-subtree t t)
  6419. (if (org-at-heading-p) (backward-char 1))
  6420. (setq end (point)))
  6421. (if (and (buffer-live-p org-last-indirect-buffer)
  6422. (not (eq org-indirect-buffer-display 'new-frame))
  6423. (not arg))
  6424. (kill-buffer org-last-indirect-buffer))
  6425. (setq ibuf (org-get-indirect-buffer cbuf)
  6426. org-last-indirect-buffer ibuf)
  6427. (cond
  6428. ((or (eq org-indirect-buffer-display 'new-frame)
  6429. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6430. (select-frame (make-frame))
  6431. (delete-other-windows)
  6432. (org-pop-to-buffer-same-window ibuf)
  6433. (org-set-frame-title heading))
  6434. ((eq org-indirect-buffer-display 'dedicated-frame)
  6435. (raise-frame
  6436. (select-frame (or (and org-indirect-dedicated-frame
  6437. (frame-live-p org-indirect-dedicated-frame)
  6438. org-indirect-dedicated-frame)
  6439. (setq org-indirect-dedicated-frame (make-frame)))))
  6440. (delete-other-windows)
  6441. (org-pop-to-buffer-same-window ibuf)
  6442. (org-set-frame-title (concat "Indirect: " heading)))
  6443. ((eq org-indirect-buffer-display 'current-window)
  6444. (org-pop-to-buffer-same-window ibuf))
  6445. ((eq org-indirect-buffer-display 'other-window)
  6446. (pop-to-buffer ibuf))
  6447. (t (error "Invalid value")))
  6448. (if (featurep 'xemacs)
  6449. (save-excursion (org-mode) (turn-on-font-lock)))
  6450. (narrow-to-region beg end)
  6451. (show-all)
  6452. (goto-char pos)
  6453. (run-hook-with-args 'org-cycle-hook 'all)
  6454. (and (window-live-p cwin) (select-window cwin))))
  6455. (defun org-get-indirect-buffer (&optional buffer)
  6456. (setq buffer (or buffer (current-buffer)))
  6457. (let ((n 1) (base (buffer-name buffer)) bname)
  6458. (while (buffer-live-p
  6459. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6460. (setq n (1+ n)))
  6461. (condition-case nil
  6462. (make-indirect-buffer buffer bname 'clone)
  6463. (error (make-indirect-buffer buffer bname)))))
  6464. (defun org-set-frame-title (title)
  6465. "Set the title of the current frame to the string TITLE."
  6466. ;; FIXME: how to name a single frame in XEmacs???
  6467. (unless (featurep 'xemacs)
  6468. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6469. ;;;; Structure editing
  6470. ;;; Inserting headlines
  6471. (defun org-previous-line-empty-p ()
  6472. (save-excursion
  6473. (and (not (bobp))
  6474. (or (beginning-of-line 0) t)
  6475. (save-match-data
  6476. (looking-at "[ \t]*$")))))
  6477. (defun org-insert-heading (&optional force-heading invisible-ok)
  6478. "Insert a new heading or item with same depth at point.
  6479. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  6480. If point is at the beginning of a headline, insert a sibling before the
  6481. current headline. If point is not at the beginning, split the line,
  6482. create the new headline with the text in the current line after point
  6483. \(but see also the variable `org-M-RET-may-split-line').
  6484. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6485. This is important for non-interactive uses of the command."
  6486. (interactive "P")
  6487. (if (or (= (buffer-size) 0)
  6488. (and (not (save-excursion
  6489. (and (ignore-errors (org-back-to-heading invisible-ok))
  6490. (org-at-heading-p))))
  6491. (or force-heading (not (org-in-item-p)))))
  6492. (progn
  6493. (insert "\n* ")
  6494. (run-hooks 'org-insert-heading-hook))
  6495. (when (or force-heading (not (org-insert-item)))
  6496. (let* ((empty-line-p nil)
  6497. (level nil)
  6498. (on-heading (org-at-heading-p))
  6499. (head (save-excursion
  6500. (condition-case nil
  6501. (progn
  6502. (org-back-to-heading invisible-ok)
  6503. (when (and (not on-heading)
  6504. (featurep 'org-inlinetask)
  6505. (integerp org-inlinetask-min-level)
  6506. (>= (length (match-string 0))
  6507. org-inlinetask-min-level))
  6508. ;; Find a heading level before the inline task
  6509. (while (and (setq level (org-up-heading-safe))
  6510. (>= level org-inlinetask-min-level)))
  6511. (if (org-at-heading-p)
  6512. (org-back-to-heading invisible-ok)
  6513. (error "This should not happen")))
  6514. (setq empty-line-p (org-previous-line-empty-p))
  6515. (match-string 0))
  6516. (error "*"))))
  6517. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6518. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6519. pos hide-previous previous-pos)
  6520. (cond
  6521. ((and (org-at-heading-p) (bolp)
  6522. (or (bobp)
  6523. (save-excursion (backward-char 1) (not (outline-invisible-p)))))
  6524. ;; insert before the current line
  6525. (open-line (if blank 2 1)))
  6526. ((and (bolp)
  6527. (not org-insert-heading-respect-content)
  6528. (or (bobp)
  6529. (save-excursion
  6530. (backward-char 1) (not (outline-invisible-p)))))
  6531. ;; insert right here
  6532. nil)
  6533. (t
  6534. ;; somewhere in the line
  6535. (save-excursion
  6536. (setq previous-pos (point-at-bol))
  6537. (end-of-line)
  6538. (setq hide-previous (outline-invisible-p)))
  6539. (and org-insert-heading-respect-content (org-show-subtree))
  6540. (let ((split
  6541. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  6542. (save-excursion
  6543. (let ((p (point)))
  6544. (goto-char (point-at-bol))
  6545. (and (looking-at org-complex-heading-regexp)
  6546. (match-beginning 4)
  6547. (> p (match-beginning 4)))))))
  6548. tags pos)
  6549. (cond
  6550. (org-insert-heading-respect-content
  6551. (org-end-of-subtree nil t)
  6552. (when (featurep 'org-inlinetask)
  6553. (while (and (not (eobp))
  6554. (looking-at "\\(\\*+\\)[ \t]+")
  6555. (>= (length (match-string 1))
  6556. org-inlinetask-min-level))
  6557. (org-end-of-subtree nil t)))
  6558. (or (bolp) (newline))
  6559. (or (org-previous-line-empty-p)
  6560. (and blank (newline)))
  6561. (open-line 1))
  6562. ((org-at-heading-p)
  6563. (when hide-previous
  6564. (show-children)
  6565. (org-show-entry))
  6566. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  6567. (setq tags (and (match-end 2) (match-string 2)))
  6568. (and (match-end 1)
  6569. (delete-region (match-beginning 1) (match-end 1)))
  6570. (setq pos (point-at-bol))
  6571. (or split (end-of-line 1))
  6572. (delete-horizontal-space)
  6573. (if (string-match "\\`\\*+\\'"
  6574. (buffer-substring (point-at-bol) (point)))
  6575. (insert " "))
  6576. (newline (if blank 2 1))
  6577. (when tags
  6578. (save-excursion
  6579. (goto-char pos)
  6580. (end-of-line 1)
  6581. (insert " " tags)
  6582. (org-set-tags nil 'align))))
  6583. (t
  6584. (or split (end-of-line 1))
  6585. (newline (if blank 2 1)))))))
  6586. (insert head) (just-one-space)
  6587. (setq pos (point))
  6588. (end-of-line 1)
  6589. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  6590. (when (and org-insert-heading-respect-content hide-previous)
  6591. (save-excursion
  6592. (goto-char previous-pos)
  6593. (hide-subtree)))
  6594. (run-hooks 'org-insert-heading-hook)))))
  6595. (defun org-get-heading (&optional no-tags no-todo)
  6596. "Return the heading of the current entry, without the stars.
  6597. When NO-TAGS is non-nil, don't include tags.
  6598. When NO-TODO is non-nil, don't include TODO keywords."
  6599. (save-excursion
  6600. (org-back-to-heading t)
  6601. (cond
  6602. ((and no-tags no-todo)
  6603. (looking-at org-complex-heading-regexp)
  6604. (match-string 4))
  6605. (no-tags
  6606. (looking-at (concat org-outline-regexp
  6607. "\\(.*?\\)"
  6608. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6609. (match-string 1))
  6610. (no-todo
  6611. (looking-at org-todo-line-regexp)
  6612. (match-string 3))
  6613. (t (looking-at org-heading-regexp)
  6614. (match-string 2)))))
  6615. (defun org-heading-components ()
  6616. "Return the components of the current heading.
  6617. This is a list with the following elements:
  6618. - the level as an integer
  6619. - the reduced level, different if `org-odd-levels-only' is set.
  6620. - the TODO keyword, or nil
  6621. - the priority character, like ?A, or nil if no priority is given
  6622. - the headline text itself, or the tags string if no headline text
  6623. - the tags string, or nil."
  6624. (save-excursion
  6625. (org-back-to-heading t)
  6626. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  6627. (list (length (match-string 1))
  6628. (org-reduced-level (length (match-string 1)))
  6629. (org-match-string-no-properties 2)
  6630. (and (match-end 3) (aref (match-string 3) 2))
  6631. (org-match-string-no-properties 4)
  6632. (org-match-string-no-properties 5)))))
  6633. (defun org-get-entry ()
  6634. "Get the entry text, after heading, entire subtree."
  6635. (save-excursion
  6636. (org-back-to-heading t)
  6637. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6638. (defun org-insert-heading-after-current ()
  6639. "Insert a new heading with same level as current, after current subtree."
  6640. (interactive)
  6641. (org-back-to-heading)
  6642. (org-insert-heading)
  6643. (org-move-subtree-down)
  6644. (end-of-line 1))
  6645. (defun org-insert-heading-respect-content ()
  6646. (interactive)
  6647. (let ((org-insert-heading-respect-content t))
  6648. (org-insert-heading t)))
  6649. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6650. (interactive "P")
  6651. (let ((org-insert-heading-respect-content t))
  6652. (org-insert-todo-heading force-state t)))
  6653. (defun org-insert-todo-heading (arg &optional force-heading)
  6654. "Insert a new heading with the same level and TODO state as current heading.
  6655. If the heading has no TODO state, or if the state is DONE, use the first
  6656. state (TODO by default). Also with prefix arg, force first state."
  6657. (interactive "P")
  6658. (when (or force-heading (not (org-insert-item 'checkbox)))
  6659. (org-insert-heading force-heading)
  6660. (save-excursion
  6661. (org-back-to-heading)
  6662. (outline-previous-heading)
  6663. (looking-at org-todo-line-regexp))
  6664. (let*
  6665. ((new-mark-x
  6666. (if (or arg
  6667. (not (match-beginning 2))
  6668. (member (match-string 2) org-done-keywords))
  6669. (car org-todo-keywords-1)
  6670. (match-string 2)))
  6671. (new-mark
  6672. (or
  6673. (run-hook-with-args-until-success
  6674. 'org-todo-get-default-hook new-mark-x nil)
  6675. new-mark-x)))
  6676. (beginning-of-line 1)
  6677. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6678. (if org-treat-insert-todo-heading-as-state-change
  6679. (org-todo new-mark)
  6680. (insert new-mark " "))))
  6681. (when org-provide-todo-statistics
  6682. (org-update-parent-todo-statistics))))
  6683. (defun org-insert-subheading (arg)
  6684. "Insert a new subheading and demote it.
  6685. Works for outline headings and for plain lists alike."
  6686. (interactive "P")
  6687. (org-insert-heading arg)
  6688. (cond
  6689. ((org-at-heading-p) (org-do-demote))
  6690. ((org-at-item-p) (org-indent-item))))
  6691. (defun org-insert-todo-subheading (arg)
  6692. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6693. Works for outline headings and for plain lists alike."
  6694. (interactive "P")
  6695. (org-insert-todo-heading arg)
  6696. (cond
  6697. ((org-at-heading-p) (org-do-demote))
  6698. ((org-at-item-p) (org-indent-item))))
  6699. ;;; Promotion and Demotion
  6700. (defvar org-after-demote-entry-hook nil
  6701. "Hook run after an entry has been demoted.
  6702. The cursor will be at the beginning of the entry.
  6703. When a subtree is being demoted, the hook will be called for each node.")
  6704. (defvar org-after-promote-entry-hook nil
  6705. "Hook run after an entry has been promoted.
  6706. The cursor will be at the beginning of the entry.
  6707. When a subtree is being promoted, the hook will be called for each node.")
  6708. (defun org-promote-subtree ()
  6709. "Promote the entire subtree.
  6710. See also `org-promote'."
  6711. (interactive)
  6712. (save-excursion
  6713. (org-with-limited-levels (org-map-tree 'org-promote)))
  6714. (org-fix-position-after-promote))
  6715. (defun org-demote-subtree ()
  6716. "Demote the entire subtree. See `org-demote'.
  6717. See also `org-promote'."
  6718. (interactive)
  6719. (save-excursion
  6720. (org-with-limited-levels (org-map-tree 'org-demote)))
  6721. (org-fix-position-after-promote))
  6722. (defun org-do-promote ()
  6723. "Promote the current heading higher up the tree.
  6724. If the region is active in `transient-mark-mode', promote all headings
  6725. in the region."
  6726. (interactive)
  6727. (save-excursion
  6728. (if (org-region-active-p)
  6729. (org-map-region 'org-promote (region-beginning) (region-end))
  6730. (org-promote)))
  6731. (org-fix-position-after-promote))
  6732. (defun org-do-demote ()
  6733. "Demote the current heading lower down the tree.
  6734. If the region is active in `transient-mark-mode', demote all headings
  6735. in the region."
  6736. (interactive)
  6737. (save-excursion
  6738. (if (org-region-active-p)
  6739. (org-map-region 'org-demote (region-beginning) (region-end))
  6740. (org-demote)))
  6741. (org-fix-position-after-promote))
  6742. (defun org-fix-position-after-promote ()
  6743. "Make sure that after pro/demotion cursor position is right."
  6744. (let ((pos (point)))
  6745. (when (save-excursion
  6746. (beginning-of-line 1)
  6747. (looking-at org-todo-line-regexp)
  6748. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6749. (cond ((eobp) (insert " "))
  6750. ((eolp) (insert " "))
  6751. ((equal (char-after) ?\ ) (forward-char 1))))))
  6752. (defun org-current-level ()
  6753. "Return the level of the current entry, or nil if before the first headline.
  6754. The level is the number of stars at the beginning of the headline."
  6755. (save-excursion
  6756. (org-with-limited-levels
  6757. (if (ignore-errors (org-back-to-heading t))
  6758. (funcall outline-level)))))
  6759. (defun org-get-previous-line-level ()
  6760. "Return the outline depth of the last headline before the current line.
  6761. Returns 0 for the first headline in the buffer, and nil if before the
  6762. first headline."
  6763. (let ((current-level (org-current-level))
  6764. (prev-level (when (> (line-number-at-pos) 1)
  6765. (save-excursion
  6766. (beginning-of-line 0)
  6767. (org-current-level)))))
  6768. (cond ((null current-level) nil) ; Before first headline
  6769. ((null prev-level) 0) ; At first headline
  6770. (prev-level))))
  6771. (defun org-reduced-level (l)
  6772. "Compute the effective level of a heading.
  6773. This takes into account the setting of `org-odd-levels-only'."
  6774. (cond
  6775. ((zerop l) 0)
  6776. (org-odd-levels-only (1+ (floor (/ l 2))))
  6777. (t l)))
  6778. (defun org-level-increment ()
  6779. "Return the number of stars that will be added or removed at a
  6780. time to headlines when structure editing, based on the value of
  6781. `org-odd-levels-only'."
  6782. (if org-odd-levels-only 2 1))
  6783. (defun org-get-valid-level (level &optional change)
  6784. "Rectify a level change under the influence of `org-odd-levels-only'
  6785. LEVEL is a current level, CHANGE is by how much the level should be
  6786. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6787. even level numbers will become the next higher odd number."
  6788. (if org-odd-levels-only
  6789. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6790. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6791. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6792. (max 1 (+ level (or change 0)))))
  6793. (if (boundp 'define-obsolete-function-alias)
  6794. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6795. (define-obsolete-function-alias 'org-get-legal-level
  6796. 'org-get-valid-level)
  6797. (define-obsolete-function-alias 'org-get-legal-level
  6798. 'org-get-valid-level "23.1")))
  6799. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  6800. ;; ̀org-with-limited-levels'
  6801. (defun org-promote ()
  6802. "Promote the current heading higher up the tree.
  6803. If the region is active in `transient-mark-mode', promote all headings
  6804. in the region."
  6805. (org-back-to-heading t)
  6806. (let* ((level (save-match-data (funcall outline-level)))
  6807. (after-change-functions (remove 'flyspell-after-change-function
  6808. after-change-functions))
  6809. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6810. (diff (abs (- level (length up-head) -1))))
  6811. (cond ((and (= level 1) org-called-with-limited-levels
  6812. org-allow-promoting-top-level-subtree)
  6813. (replace-match "# " nil t))
  6814. ((= level 1)
  6815. (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6816. (t (replace-match up-head nil t)))
  6817. ;; Fixup tag positioning
  6818. (unless (= level 1)
  6819. (and org-auto-align-tags (org-set-tags nil t))
  6820. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  6821. (run-hooks 'org-after-promote-entry-hook)))
  6822. (defun org-demote ()
  6823. "Demote the current heading lower down the tree.
  6824. If the region is active in `transient-mark-mode', demote all headings
  6825. in the region."
  6826. (org-back-to-heading t)
  6827. (let* ((level (save-match-data (funcall outline-level)))
  6828. (after-change-functions (remove 'flyspell-after-change-function
  6829. after-change-functions))
  6830. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6831. (diff (abs (- level (length down-head) -1))))
  6832. (replace-match down-head nil t)
  6833. ;; Fixup tag positioning
  6834. (and org-auto-align-tags (org-set-tags nil t))
  6835. (if org-adapt-indentation (org-fixup-indentation diff))
  6836. (run-hooks 'org-after-demote-entry-hook)))
  6837. (defun org-cycle-level ()
  6838. "Cycle the level of an empty headline through possible states.
  6839. This goes first to child, then to parent, level, then up the hierarchy.
  6840. After top level, it switches back to sibling level."
  6841. (interactive)
  6842. (let ((org-adapt-indentation nil))
  6843. (when (org-point-at-end-of-empty-headline)
  6844. (setq this-command 'org-cycle-level) ; Only needed for caching
  6845. (let ((cur-level (org-current-level))
  6846. (prev-level (org-get-previous-line-level)))
  6847. (cond
  6848. ;; If first headline in file, promote to top-level.
  6849. ((= prev-level 0)
  6850. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6851. do (org-do-promote)))
  6852. ;; If same level as prev, demote one.
  6853. ((= prev-level cur-level)
  6854. (org-do-demote))
  6855. ;; If parent is top-level, promote to top level if not already.
  6856. ((= prev-level 1)
  6857. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6858. do (org-do-promote)))
  6859. ;; If top-level, return to prev-level.
  6860. ((= cur-level 1)
  6861. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6862. do (org-do-demote)))
  6863. ;; If less than prev-level, promote one.
  6864. ((< cur-level prev-level)
  6865. (org-do-promote))
  6866. ;; If deeper than prev-level, promote until higher than
  6867. ;; prev-level.
  6868. ((> cur-level prev-level)
  6869. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6870. do (org-do-promote))))
  6871. t))))
  6872. (defun org-map-tree (fun)
  6873. "Call FUN for every heading underneath the current one."
  6874. (org-back-to-heading)
  6875. (let ((level (funcall outline-level)))
  6876. (save-excursion
  6877. (funcall fun)
  6878. (while (and (progn
  6879. (outline-next-heading)
  6880. (> (funcall outline-level) level))
  6881. (not (eobp)))
  6882. (funcall fun)))))
  6883. (defun org-map-region (fun beg end)
  6884. "Call FUN for every heading between BEG and END."
  6885. (let ((org-ignore-region t))
  6886. (save-excursion
  6887. (setq end (copy-marker end))
  6888. (goto-char beg)
  6889. (if (and (re-search-forward org-outline-regexp-bol nil t)
  6890. (< (point) end))
  6891. (funcall fun))
  6892. (while (and (progn
  6893. (outline-next-heading)
  6894. (< (point) end))
  6895. (not (eobp)))
  6896. (funcall fun)))))
  6897. (defvar org-property-end-re) ; silence byte-compiler
  6898. (defun org-fixup-indentation (diff)
  6899. "Change the indentation in the current entry by DIFF.
  6900. However, if any line in the current entry has no indentation, or if it
  6901. would end up with no indentation after the change, nothing at all is done."
  6902. (save-excursion
  6903. (let ((end (save-excursion (outline-next-heading)
  6904. (point-marker)))
  6905. (prohibit (if (> diff 0)
  6906. "^\\S-"
  6907. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6908. col)
  6909. (unless (save-excursion (end-of-line 1)
  6910. (re-search-forward prohibit end t))
  6911. (while (and (< (point) end)
  6912. (re-search-forward "^[ \t]+" end t))
  6913. (goto-char (match-end 0))
  6914. (setq col (current-column))
  6915. (if (< diff 0) (replace-match ""))
  6916. (org-indent-to-column (+ diff col))))
  6917. (move-marker end nil))))
  6918. (defun org-convert-to-odd-levels ()
  6919. "Convert an org-mode file with all levels allowed to one with odd levels.
  6920. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6921. level 5 etc."
  6922. (interactive)
  6923. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6924. (let ((outline-level 'org-outline-level)
  6925. (org-odd-levels-only nil) n)
  6926. (save-excursion
  6927. (goto-char (point-min))
  6928. (while (re-search-forward "^\\*\\*+ " nil t)
  6929. (setq n (- (length (match-string 0)) 2))
  6930. (while (>= (setq n (1- n)) 0)
  6931. (org-demote))
  6932. (end-of-line 1))))))
  6933. (defun org-convert-to-oddeven-levels ()
  6934. "Convert an org-mode file with only odd levels to one with odd/even levels.
  6935. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6936. file contains a section with an even level, conversion would
  6937. destroy the structure of the file. An error is signaled in this
  6938. case."
  6939. (interactive)
  6940. (goto-char (point-min))
  6941. ;; First check if there are no even levels
  6942. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6943. (org-show-context t)
  6944. (error "Not all levels are odd in this file. Conversion not possible"))
  6945. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6946. (let ((outline-regexp org-outline-regexp)
  6947. (outline-level 'org-outline-level)
  6948. (org-odd-levels-only nil) n)
  6949. (save-excursion
  6950. (goto-char (point-min))
  6951. (while (re-search-forward "^\\*\\*+ " nil t)
  6952. (setq n (/ (1- (length (match-string 0))) 2))
  6953. (while (>= (setq n (1- n)) 0)
  6954. (org-promote))
  6955. (end-of-line 1))))))
  6956. (defun org-tr-level (n)
  6957. "Make N odd if required."
  6958. (if org-odd-levels-only (1+ (/ n 2)) n))
  6959. ;;; Vertical tree motion, cutting and pasting of subtrees
  6960. (defun org-move-subtree-up (&optional arg)
  6961. "Move the current subtree up past ARG headlines of the same level."
  6962. (interactive "p")
  6963. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6964. (defun org-move-subtree-down (&optional arg)
  6965. "Move the current subtree down past ARG headlines of the same level."
  6966. (interactive "p")
  6967. (setq arg (prefix-numeric-value arg))
  6968. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6969. 'org-get-last-sibling))
  6970. (ins-point (make-marker))
  6971. (cnt (abs arg))
  6972. (col (current-column))
  6973. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6974. ;; Select the tree
  6975. (org-back-to-heading)
  6976. (setq beg0 (point))
  6977. (save-excursion
  6978. (setq ne-beg (org-back-over-empty-lines))
  6979. (setq beg (point)))
  6980. (save-match-data
  6981. (save-excursion (outline-end-of-heading)
  6982. (setq folded (outline-invisible-p)))
  6983. (outline-end-of-subtree))
  6984. (outline-next-heading)
  6985. (setq ne-end (org-back-over-empty-lines))
  6986. (setq end (point))
  6987. (goto-char beg0)
  6988. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6989. ;; include less whitespace
  6990. (save-excursion
  6991. (goto-char beg)
  6992. (forward-line (- ne-beg ne-end))
  6993. (setq beg (point))))
  6994. ;; Find insertion point, with error handling
  6995. (while (> cnt 0)
  6996. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  6997. (progn (goto-char beg0)
  6998. (error "Cannot move past superior level or buffer limit")))
  6999. (setq cnt (1- cnt)))
  7000. (if (> arg 0)
  7001. ;; Moving forward - still need to move over subtree
  7002. (progn (org-end-of-subtree t t)
  7003. (save-excursion
  7004. (org-back-over-empty-lines)
  7005. (or (bolp) (newline)))))
  7006. (setq ne-ins (org-back-over-empty-lines))
  7007. (move-marker ins-point (point))
  7008. (setq txt (buffer-substring beg end))
  7009. (org-save-markers-in-region beg end)
  7010. (delete-region beg end)
  7011. (org-remove-empty-overlays-at beg)
  7012. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  7013. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  7014. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  7015. (let ((bbb (point)))
  7016. (insert-before-markers txt)
  7017. (org-reinstall-markers-in-region bbb)
  7018. (move-marker ins-point bbb))
  7019. (or (bolp) (insert "\n"))
  7020. (setq ins-end (point))
  7021. (goto-char ins-point)
  7022. (org-skip-whitespace)
  7023. (when (and (< arg 0)
  7024. (org-first-sibling-p)
  7025. (> ne-ins ne-beg))
  7026. ;; Move whitespace back to beginning
  7027. (save-excursion
  7028. (goto-char ins-end)
  7029. (let ((kill-whole-line t))
  7030. (kill-line (- ne-ins ne-beg)) (point)))
  7031. (insert (make-string (- ne-ins ne-beg) ?\n)))
  7032. (move-marker ins-point nil)
  7033. (if folded
  7034. (hide-subtree)
  7035. (org-show-entry)
  7036. (show-children)
  7037. (org-cycle-hide-drawers 'children))
  7038. (org-clean-visibility-after-subtree-move)
  7039. ;; move back to the initial column we were at
  7040. (move-to-column col)))
  7041. (defvar org-subtree-clip ""
  7042. "Clipboard for cut and paste of subtrees.
  7043. This is actually only a copy of the kill, because we use the normal kill
  7044. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  7045. (defvar org-subtree-clip-folded nil
  7046. "Was the last copied subtree folded?
  7047. This is used to fold the tree back after pasting.")
  7048. (defun org-cut-subtree (&optional n)
  7049. "Cut the current subtree into the clipboard.
  7050. With prefix arg N, cut this many sequential subtrees.
  7051. This is a short-hand for marking the subtree and then cutting it."
  7052. (interactive "p")
  7053. (org-copy-subtree n 'cut))
  7054. (defun org-copy-subtree (&optional n cut force-store-markers)
  7055. "Cut the current subtree into the clipboard.
  7056. With prefix arg N, cut this many sequential subtrees.
  7057. This is a short-hand for marking the subtree and then copying it.
  7058. If CUT is non-nil, actually cut the subtree.
  7059. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  7060. of some markers in the region, even if CUT is non-nil. This is
  7061. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  7062. (interactive "p")
  7063. (let (beg end folded (beg0 (point)))
  7064. (if (org-called-interactively-p 'any)
  7065. (org-back-to-heading nil) ; take what looks like a subtree
  7066. (org-back-to-heading t)) ; take what is really there
  7067. (org-back-over-empty-lines)
  7068. (setq beg (point))
  7069. (skip-chars-forward " \t\r\n")
  7070. (save-match-data
  7071. (save-excursion (outline-end-of-heading)
  7072. (setq folded (outline-invisible-p)))
  7073. (condition-case nil
  7074. (org-forward-heading-same-level (1- n) t)
  7075. (error nil))
  7076. (org-end-of-subtree t t))
  7077. (org-back-over-empty-lines)
  7078. (setq end (point))
  7079. (goto-char beg0)
  7080. (when (> end beg)
  7081. (setq org-subtree-clip-folded folded)
  7082. (when (or cut force-store-markers)
  7083. (org-save-markers-in-region beg end))
  7084. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7085. (setq org-subtree-clip (current-kill 0))
  7086. (message "%s: Subtree(s) with %d characters"
  7087. (if cut "Cut" "Copied")
  7088. (length org-subtree-clip)))))
  7089. (defun org-paste-subtree (&optional level tree for-yank)
  7090. "Paste the clipboard as a subtree, with modification of headline level.
  7091. The entire subtree is promoted or demoted in order to match a new headline
  7092. level.
  7093. If the cursor is at the beginning of a headline, the same level as
  7094. that headline is used to paste the tree
  7095. If not, the new level is derived from the *visible* headings
  7096. before and after the insertion point, and taken to be the inferior headline
  7097. level of the two. So if the previous visible heading is level 3 and the
  7098. next is level 4 (or vice versa), level 4 will be used for insertion.
  7099. This makes sure that the subtree remains an independent subtree and does
  7100. not swallow low level entries.
  7101. You can also force a different level, either by using a numeric prefix
  7102. argument, or by inserting the heading marker by hand. For example, if the
  7103. cursor is after \"*****\", then the tree will be shifted to level 5.
  7104. If optional TREE is given, use this text instead of the kill ring.
  7105. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7106. move back over whitespace before inserting, and move point to the end of
  7107. the inserted text when done."
  7108. (interactive "P")
  7109. (setq tree (or tree (and kill-ring (current-kill 0))))
  7110. (unless (org-kill-is-subtree-p tree)
  7111. (error "%s"
  7112. (substitute-command-keys
  7113. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7114. (org-with-limited-levels
  7115. (let* ((visp (not (outline-invisible-p)))
  7116. (txt tree)
  7117. (^re_ "\\(\\*+\\)[ \t]*")
  7118. (old-level (if (string-match org-outline-regexp-bol txt)
  7119. (- (match-end 0) (match-beginning 0) 1)
  7120. -1))
  7121. (force-level (cond (level (prefix-numeric-value level))
  7122. ((and (looking-at "[ \t]*$")
  7123. (string-match
  7124. "^\\*+$" (buffer-substring
  7125. (point-at-bol) (point))))
  7126. (- (match-end 1) (match-beginning 1)))
  7127. ((and (bolp)
  7128. (looking-at org-outline-regexp))
  7129. (- (match-end 0) (point) 1))))
  7130. (previous-level (save-excursion
  7131. (condition-case nil
  7132. (progn
  7133. (outline-previous-visible-heading 1)
  7134. (if (looking-at ^re_)
  7135. (- (match-end 0) (match-beginning 0) 1)
  7136. 1))
  7137. (error 1))))
  7138. (next-level (save-excursion
  7139. (condition-case nil
  7140. (progn
  7141. (or (looking-at org-outline-regexp)
  7142. (outline-next-visible-heading 1))
  7143. (if (looking-at ^re_)
  7144. (- (match-end 0) (match-beginning 0) 1)
  7145. 1))
  7146. (error 1))))
  7147. (new-level (or force-level (max previous-level next-level)))
  7148. (shift (if (or (= old-level -1)
  7149. (= new-level -1)
  7150. (= old-level new-level))
  7151. 0
  7152. (- new-level old-level)))
  7153. (delta (if (> shift 0) -1 1))
  7154. (func (if (> shift 0) 'org-demote 'org-promote))
  7155. (org-odd-levels-only nil)
  7156. beg end newend)
  7157. ;; Remove the forced level indicator
  7158. (if force-level
  7159. (delete-region (point-at-bol) (point)))
  7160. ;; Paste
  7161. (beginning-of-line (if (bolp) 1 2))
  7162. (unless for-yank (org-back-over-empty-lines))
  7163. (setq beg (point))
  7164. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7165. (insert-before-markers txt)
  7166. (unless (string-match "\n\\'" txt) (insert "\n"))
  7167. (setq newend (point))
  7168. (org-reinstall-markers-in-region beg)
  7169. (setq end (point))
  7170. (goto-char beg)
  7171. (skip-chars-forward " \t\n\r")
  7172. (setq beg (point))
  7173. (if (and (outline-invisible-p) visp)
  7174. (save-excursion (outline-show-heading)))
  7175. ;; Shift if necessary
  7176. (unless (= shift 0)
  7177. (save-restriction
  7178. (narrow-to-region beg end)
  7179. (while (not (= shift 0))
  7180. (org-map-region func (point-min) (point-max))
  7181. (setq shift (+ delta shift)))
  7182. (goto-char (point-min))
  7183. (setq newend (point-max))))
  7184. (when (or (org-called-interactively-p 'interactive) for-yank)
  7185. (message "Clipboard pasted as level %d subtree" new-level))
  7186. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7187. kill-ring
  7188. (eq org-subtree-clip (current-kill 0))
  7189. org-subtree-clip-folded)
  7190. ;; The tree was folded before it was killed/copied
  7191. (hide-subtree))
  7192. (and for-yank (goto-char newend)))))
  7193. (defun org-kill-is-subtree-p (&optional txt)
  7194. "Check if the current kill is an outline subtree, or a set of trees.
  7195. Returns nil if kill does not start with a headline, or if the first
  7196. headline level is not the largest headline level in the tree.
  7197. So this will actually accept several entries of equal levels as well,
  7198. which is OK for `org-paste-subtree'.
  7199. If optional TXT is given, check this string instead of the current kill."
  7200. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7201. (re (org-get-limited-outline-regexp))
  7202. (^re (concat "^" re))
  7203. (start-level (and kill
  7204. (string-match
  7205. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7206. kill)
  7207. (- (match-end 2) (match-beginning 2) 1)))
  7208. (start (1+ (or (match-beginning 2) -1))))
  7209. (if (not start-level)
  7210. (progn
  7211. nil) ;; does not even start with a heading
  7212. (catch 'exit
  7213. (while (setq start (string-match ^re kill (1+ start)))
  7214. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7215. (throw 'exit nil)))
  7216. t))))
  7217. (defvar org-markers-to-move nil
  7218. "Markers that should be moved with a cut-and-paste operation.
  7219. Those markers are stored together with their positions relative to
  7220. the start of the region.")
  7221. (defun org-save-markers-in-region (beg end)
  7222. "Check markers in region.
  7223. If these markers are between BEG and END, record their position relative
  7224. to BEG, so that after moving the block of text, we can put the markers back
  7225. into place.
  7226. This function gets called just before an entry or tree gets cut from the
  7227. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7228. called immediately, to move the markers with the entries."
  7229. (setq org-markers-to-move nil)
  7230. (when (featurep 'org-clock)
  7231. (org-clock-save-markers-for-cut-and-paste beg end))
  7232. (when (featurep 'org-agenda)
  7233. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7234. (defun org-check-and-save-marker (marker beg end)
  7235. "Check if MARKER is between BEG and END.
  7236. If yes, remember the marker and the distance to BEG."
  7237. (when (and (marker-buffer marker)
  7238. (equal (marker-buffer marker) (current-buffer)))
  7239. (if (and (>= marker beg) (< marker end))
  7240. (push (cons marker (- marker beg)) org-markers-to-move))))
  7241. (defun org-reinstall-markers-in-region (beg)
  7242. "Move all remembered markers to their position relative to BEG."
  7243. (mapc (lambda (x)
  7244. (move-marker (car x) (+ beg (cdr x))))
  7245. org-markers-to-move)
  7246. (setq org-markers-to-move nil))
  7247. (defun org-narrow-to-subtree ()
  7248. "Narrow buffer to the current subtree."
  7249. (interactive)
  7250. (save-excursion
  7251. (save-match-data
  7252. (org-with-limited-levels
  7253. (narrow-to-region
  7254. (progn (org-back-to-heading t) (point))
  7255. (progn (org-end-of-subtree t t)
  7256. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7257. (point)))))))
  7258. (defun org-narrow-to-block ()
  7259. "Narrow buffer to the current block."
  7260. (interactive)
  7261. (let* ((case-fold-search t)
  7262. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7263. "^[ \t]*#\\+end_.*")))
  7264. (if blockp
  7265. (narrow-to-region (car blockp) (cdr blockp))
  7266. (error "Not in a block"))))
  7267. (eval-when-compile
  7268. (defvar org-property-drawer-re))
  7269. (defvar org-property-start-re) ;; defined below
  7270. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7271. "Clone the task (subtree) at point N times.
  7272. The clones will be inserted as siblings.
  7273. In interactive use, the user will be prompted for the number of
  7274. clones to be produced, and for a time SHIFT, which may be a
  7275. repeater as used in time stamps, for example `+3d'.
  7276. When a valid repeater is given and the entry contains any time
  7277. stamps, the clones will become a sequence in time, with time
  7278. stamps in the subtree shifted for each clone produced. If SHIFT
  7279. is nil or the empty string, time stamps will be left alone. The
  7280. ID property of the original subtree is removed.
  7281. If the original subtree did contain time stamps with a repeater,
  7282. the following will happen:
  7283. - the repeater will be removed in each clone
  7284. - an additional clone will be produced, with the current, unshifted
  7285. date(s) in the entry.
  7286. - the original entry will be placed *after* all the clones, with
  7287. repeater intact.
  7288. - the start days in the repeater in the original entry will be shifted
  7289. to past the last clone.
  7290. In this way you can spell out a number of instances of a repeating task,
  7291. and still retain the repeater to cover future instances of the task."
  7292. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  7293. (let (beg end template task idprop
  7294. shift-n shift-what doshift nmin nmax (n-no-remove -1)
  7295. (drawer-re org-drawer-regexp))
  7296. (if (not (and (integerp n) (> n 0)))
  7297. (error "Invalid number of replications %s" n))
  7298. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7299. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7300. shift)))
  7301. (error "Invalid shift specification %s" shift))
  7302. (when doshift
  7303. (setq shift-n (string-to-number (match-string 1 shift))
  7304. shift-what (cdr (assoc (match-string 2 shift)
  7305. '(("d" . day) ("w" . week)
  7306. ("m" . month) ("y" . year))))))
  7307. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7308. (setq nmin 1 nmax n)
  7309. (org-back-to-heading t)
  7310. (setq beg (point))
  7311. (setq idprop (org-entry-get nil "ID"))
  7312. (org-end-of-subtree t t)
  7313. (or (bolp) (insert "\n"))
  7314. (setq end (point))
  7315. (setq template (buffer-substring beg end))
  7316. (when (and doshift
  7317. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7318. (delete-region beg end)
  7319. (setq end beg)
  7320. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7321. (goto-char end)
  7322. (loop for n from nmin to nmax do
  7323. ;; prepare clone
  7324. (with-temp-buffer
  7325. (insert template)
  7326. (org-mode)
  7327. (goto-char (point-min))
  7328. (org-show-subtree)
  7329. (and idprop (if org-clone-delete-id
  7330. (org-entry-delete nil "ID")
  7331. (org-id-get-create t)))
  7332. (unless (= n 0)
  7333. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7334. (kill-whole-line))
  7335. (goto-char (point-min))
  7336. (while (re-search-forward drawer-re nil t)
  7337. (mapc (lambda (d)
  7338. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7339. (goto-char (point-min))
  7340. (when doshift
  7341. (while (re-search-forward org-ts-regexp-both nil t)
  7342. (org-timestamp-change (* n shift-n) shift-what))
  7343. (unless (= n n-no-remove)
  7344. (goto-char (point-min))
  7345. (while (re-search-forward org-ts-regexp nil t)
  7346. (save-excursion
  7347. (goto-char (match-beginning 0))
  7348. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7349. (delete-region (match-beginning 1) (match-end 1)))))))
  7350. (setq task (buffer-string)))
  7351. (insert task))
  7352. (goto-char beg)))
  7353. ;;; Outline Sorting
  7354. (defun org-sort (with-case)
  7355. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7356. Optional argument WITH-CASE means sort case-sensitively."
  7357. (interactive "P")
  7358. (cond
  7359. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7360. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7361. (t
  7362. (org-call-with-arg 'org-sort-entries with-case))))
  7363. (defun org-sort-remove-invisible (s)
  7364. (remove-text-properties 0 (length s) org-rm-props s)
  7365. (while (string-match org-bracket-link-regexp s)
  7366. (setq s (replace-match (if (match-end 2)
  7367. (match-string 3 s)
  7368. (match-string 1 s)) t t s)))
  7369. s)
  7370. (defvar org-priority-regexp) ; defined later in the file
  7371. (defvar org-after-sorting-entries-or-items-hook nil
  7372. "Hook that is run after a bunch of entries or items have been sorted.
  7373. When children are sorted, the cursor is in the parent line when this
  7374. hook gets called. When a region or a plain list is sorted, the cursor
  7375. will be in the first entry of the sorted region/list.")
  7376. (defun org-sort-entries
  7377. (&optional with-case sorting-type getkey-func compare-func property)
  7378. "Sort entries on a certain level of an outline tree.
  7379. If there is an active region, the entries in the region are sorted.
  7380. Else, if the cursor is before the first entry, sort the top-level items.
  7381. Else, the children of the entry at point are sorted.
  7382. Sorting can be alphabetically, numerically, by date/time as given by
  7383. a time stamp, by a property or by priority.
  7384. The command prompts for the sorting type unless it has been given to the
  7385. function through the SORTING-TYPE argument, which needs to be a character,
  7386. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  7387. precise meaning of each character:
  7388. n Numerically, by converting the beginning of the entry/item to a number.
  7389. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7390. t By date/time, either the first active time stamp in the entry, or, if
  7391. none exist, by the first inactive one.
  7392. s By the scheduled date/time.
  7393. d By deadline date/time.
  7394. c By creation time, which is assumed to be the first inactive time stamp
  7395. at the beginning of a line.
  7396. p By priority according to the cookie.
  7397. r By the value of a property.
  7398. Capital letters will reverse the sort order.
  7399. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7400. called with point at the beginning of the record. It must return either
  7401. a string or a number that should serve as the sorting key for that record.
  7402. Comparing entries ignores case by default. However, with an optional argument
  7403. WITH-CASE, the sorting considers case as well."
  7404. (interactive "P")
  7405. (let ((case-func (if with-case 'identity 'downcase))
  7406. start beg end stars re re2
  7407. txt what tmp)
  7408. ;; Find beginning and end of region to sort
  7409. (cond
  7410. ((org-region-active-p)
  7411. ;; we will sort the region
  7412. (setq end (region-end)
  7413. what "region")
  7414. (goto-char (region-beginning))
  7415. (if (not (org-at-heading-p)) (outline-next-heading))
  7416. (setq start (point)))
  7417. ((or (org-at-heading-p)
  7418. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7419. ;; we will sort the children of the current headline
  7420. (org-back-to-heading)
  7421. (setq start (point)
  7422. end (progn (org-end-of-subtree t t)
  7423. (or (bolp) (insert "\n"))
  7424. (org-back-over-empty-lines)
  7425. (point))
  7426. what "children")
  7427. (goto-char start)
  7428. (show-subtree)
  7429. (outline-next-heading))
  7430. (t
  7431. ;; we will sort the top-level entries in this file
  7432. (goto-char (point-min))
  7433. (or (org-at-heading-p) (outline-next-heading))
  7434. (setq start (point))
  7435. (goto-char (point-max))
  7436. (beginning-of-line 1)
  7437. (when (looking-at ".*?\\S-")
  7438. ;; File ends in a non-white line
  7439. (end-of-line 1)
  7440. (insert "\n"))
  7441. (setq end (point-max))
  7442. (setq what "top-level")
  7443. (goto-char start)
  7444. (show-all)))
  7445. (setq beg (point))
  7446. (if (>= beg end) (error "Nothing to sort"))
  7447. (looking-at "\\(\\*+\\)")
  7448. (setq stars (match-string 1)
  7449. re (concat "^" (regexp-quote stars) " +")
  7450. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7451. txt (buffer-substring beg end))
  7452. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7453. (if (and (not (equal stars "*")) (string-match re2 txt))
  7454. (error "Region to sort contains a level above the first entry"))
  7455. (unless sorting-type
  7456. (message
  7457. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7458. [t]ime [s]cheduled [d]eadline [c]reated
  7459. A/N/T/S/D/C/P/O/F means reversed:"
  7460. what)
  7461. (setq sorting-type (read-char-exclusive))
  7462. (and (= (downcase sorting-type) ?f)
  7463. (setq getkey-func
  7464. (org-icompleting-read "Sort using function: "
  7465. obarray 'fboundp t nil nil))
  7466. (setq getkey-func (intern getkey-func)))
  7467. (and (= (downcase sorting-type) ?r)
  7468. (setq property
  7469. (org-icompleting-read "Property: "
  7470. (mapcar 'list (org-buffer-property-keys t))
  7471. nil t))))
  7472. (message "Sorting entries...")
  7473. (save-restriction
  7474. (narrow-to-region start end)
  7475. (let ((dcst (downcase sorting-type))
  7476. (case-fold-search nil)
  7477. (now (current-time)))
  7478. (sort-subr
  7479. (/= dcst sorting-type)
  7480. ;; This function moves to the beginning character of the "record" to
  7481. ;; be sorted.
  7482. (lambda nil
  7483. (if (re-search-forward re nil t)
  7484. (goto-char (match-beginning 0))
  7485. (goto-char (point-max))))
  7486. ;; This function moves to the last character of the "record" being
  7487. ;; sorted.
  7488. (lambda nil
  7489. (save-match-data
  7490. (condition-case nil
  7491. (outline-forward-same-level 1)
  7492. (error
  7493. (goto-char (point-max))))))
  7494. ;; This function returns the value that gets sorted against.
  7495. (lambda nil
  7496. (cond
  7497. ((= dcst ?n)
  7498. (if (looking-at org-complex-heading-regexp)
  7499. (string-to-number (match-string 4))
  7500. nil))
  7501. ((= dcst ?a)
  7502. (if (looking-at org-complex-heading-regexp)
  7503. (funcall case-func (match-string 4))
  7504. nil))
  7505. ((= dcst ?t)
  7506. (let ((end (save-excursion (outline-next-heading) (point))))
  7507. (if (or (re-search-forward org-ts-regexp end t)
  7508. (re-search-forward org-ts-regexp-both end t))
  7509. (org-time-string-to-seconds (match-string 0))
  7510. (org-float-time now))))
  7511. ((= dcst ?c)
  7512. (let ((end (save-excursion (outline-next-heading) (point))))
  7513. (if (re-search-forward
  7514. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7515. end t)
  7516. (org-time-string-to-seconds (match-string 0))
  7517. (org-float-time now))))
  7518. ((= dcst ?s)
  7519. (let ((end (save-excursion (outline-next-heading) (point))))
  7520. (if (re-search-forward org-scheduled-time-regexp end t)
  7521. (org-time-string-to-seconds (match-string 1))
  7522. (org-float-time now))))
  7523. ((= dcst ?d)
  7524. (let ((end (save-excursion (outline-next-heading) (point))))
  7525. (if (re-search-forward org-deadline-time-regexp end t)
  7526. (org-time-string-to-seconds (match-string 1))
  7527. (org-float-time now))))
  7528. ((= dcst ?p)
  7529. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7530. (string-to-char (match-string 2))
  7531. org-default-priority))
  7532. ((= dcst ?r)
  7533. (or (org-entry-get nil property) ""))
  7534. ((= dcst ?o)
  7535. (if (looking-at org-complex-heading-regexp)
  7536. (- 9999 (length (member (match-string 2)
  7537. org-todo-keywords-1)))))
  7538. ((= dcst ?f)
  7539. (if getkey-func
  7540. (progn
  7541. (setq tmp (funcall getkey-func))
  7542. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7543. tmp)
  7544. (error "Invalid key function `%s'" getkey-func)))
  7545. (t (error "Invalid sorting type `%c'" sorting-type))))
  7546. nil
  7547. (cond
  7548. ((= dcst ?a) 'string<)
  7549. ((= dcst ?f) compare-func)
  7550. ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
  7551. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7552. (message "Sorting entries...done")))
  7553. (defun org-do-sort (table what &optional with-case sorting-type)
  7554. "Sort TABLE of WHAT according to SORTING-TYPE.
  7555. The user will be prompted for the SORTING-TYPE if the call to this
  7556. function does not specify it. WHAT is only for the prompt, to indicate
  7557. what is being sorted. The sorting key will be extracted from
  7558. the car of the elements of the table.
  7559. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7560. (unless sorting-type
  7561. (message
  7562. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  7563. what)
  7564. (setq sorting-type (read-char-exclusive)))
  7565. (let ((dcst (downcase sorting-type))
  7566. extractfun comparefun)
  7567. ;; Define the appropriate functions
  7568. (cond
  7569. ((= dcst ?n)
  7570. (setq extractfun 'string-to-number
  7571. comparefun (if (= dcst sorting-type) '< '>)))
  7572. ((= dcst ?a)
  7573. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7574. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7575. comparefun (if (= dcst sorting-type)
  7576. 'string<
  7577. (lambda (a b) (and (not (string< a b))
  7578. (not (string= a b)))))))
  7579. ((= dcst ?t)
  7580. (setq extractfun
  7581. (lambda (x)
  7582. (if (or (string-match org-ts-regexp x)
  7583. (string-match org-ts-regexp-both x))
  7584. (org-float-time
  7585. (org-time-string-to-time (match-string 0 x)))
  7586. 0))
  7587. comparefun (if (= dcst sorting-type) '< '>)))
  7588. (t (error "Invalid sorting type `%c'" sorting-type)))
  7589. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7590. table)
  7591. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7592. ;;; The orgstruct minor mode
  7593. ;; Define a minor mode which can be used in other modes in order to
  7594. ;; integrate the org-mode structure editing commands.
  7595. ;; This is really a hack, because the org-mode structure commands use
  7596. ;; keys which normally belong to the major mode. Here is how it
  7597. ;; works: The minor mode defines all the keys necessary to operate the
  7598. ;; structure commands, but wraps the commands into a function which
  7599. ;; tests if the cursor is currently at a headline or a plain list
  7600. ;; item. If that is the case, the structure command is used,
  7601. ;; temporarily setting many Org-mode variables like regular
  7602. ;; expressions for filling etc. However, when any of those keys is
  7603. ;; used at a different location, function uses `key-binding' to look
  7604. ;; up if the key has an associated command in another currently active
  7605. ;; keymap (minor modes, major mode, global), and executes that
  7606. ;; command. There might be problems if any of the keys is otherwise
  7607. ;; used as a prefix key.
  7608. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  7609. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  7610. ;; addresses this by checking explicitly for both bindings.
  7611. (defvar orgstruct-mode-map (make-sparse-keymap)
  7612. "Keymap for the minor `orgstruct-mode'.")
  7613. (defvar org-local-vars nil
  7614. "List of local variables, for use by `orgstruct-mode'.")
  7615. ;;;###autoload
  7616. (define-minor-mode orgstruct-mode
  7617. "Toggle the minor mode `orgstruct-mode'.
  7618. This mode is for using Org-mode structure commands in other
  7619. modes. The following keys behave as if Org-mode were active, if
  7620. the cursor is on a headline, or on a plain list item (both as
  7621. defined by Org-mode).
  7622. M-up Move entry/item up
  7623. M-down Move entry/item down
  7624. M-left Promote
  7625. M-right Demote
  7626. M-S-up Move entry/item up
  7627. M-S-down Move entry/item down
  7628. M-S-left Promote subtree
  7629. M-S-right Demote subtree
  7630. M-q Fill paragraph and items like in Org-mode
  7631. C-c ^ Sort entries
  7632. C-c - Cycle list bullet
  7633. TAB Cycle item visibility
  7634. M-RET Insert new heading/item
  7635. S-M-RET Insert new TODO heading / Checkbox item
  7636. C-c C-c Set tags / toggle checkbox"
  7637. nil " OrgStruct" nil
  7638. (org-load-modules-maybe)
  7639. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7640. ;;;###autoload
  7641. (defun turn-on-orgstruct ()
  7642. "Unconditionally turn on `orgstruct-mode'."
  7643. (orgstruct-mode 1))
  7644. (defvar org-fb-vars nil)
  7645. (make-variable-buffer-local 'org-fb-vars)
  7646. (defun orgstruct++-mode (&optional arg)
  7647. "Toggle `orgstruct-mode', the enhanced version of it.
  7648. In addition to setting orgstruct-mode, this also exports all
  7649. indentation and autofilling variables from org-mode into the
  7650. buffer. It will also recognize item context in multiline items."
  7651. (interactive "P")
  7652. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7653. (if (< arg 1)
  7654. (progn (orgstruct-mode -1)
  7655. (mapc (lambda(v)
  7656. (org-set-local (car v)
  7657. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  7658. org-fb-vars))
  7659. (orgstruct-mode 1)
  7660. (setq org-fb-vars nil)
  7661. (let (var val)
  7662. (mapc
  7663. (lambda (x)
  7664. (when (string-match
  7665. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
  7666. (symbol-name (car x)))
  7667. (setq var (car x) val (nth 1 x))
  7668. (push (list var `(quote ,(eval var))) org-fb-vars)
  7669. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7670. org-local-vars)
  7671. (org-set-local 'orgstruct-is-++ t))))
  7672. (defvar orgstruct-is-++ nil
  7673. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  7674. (make-variable-buffer-local 'orgstruct-is-++)
  7675. ;;;###autoload
  7676. (defun turn-on-orgstruct++ ()
  7677. "Unconditionally turn on `orgstruct++-mode'."
  7678. (orgstruct++-mode 1))
  7679. (defun orgstruct-error ()
  7680. "Error when there is no default binding for a structure key."
  7681. (interactive)
  7682. (error "This key has no function outside structure elements"))
  7683. (defun orgstruct-setup ()
  7684. "Setup orgstruct keymaps."
  7685. (let ((nfunc 0)
  7686. (bindings
  7687. (list
  7688. '([(meta up)] org-metaup)
  7689. '([(meta down)] org-metadown)
  7690. '([(meta left)] org-metaleft)
  7691. '([(meta right)] org-metaright)
  7692. '([(meta shift up)] org-shiftmetaup)
  7693. '([(meta shift down)] org-shiftmetadown)
  7694. '([(meta shift left)] org-shiftmetaleft)
  7695. '([(meta shift right)] org-shiftmetaright)
  7696. '([?\e (up)] org-metaup)
  7697. '([?\e (down)] org-metadown)
  7698. '([?\e (left)] org-metaleft)
  7699. '([?\e (right)] org-metaright)
  7700. '([?\e (shift up)] org-shiftmetaup)
  7701. '([?\e (shift down)] org-shiftmetadown)
  7702. '([?\e (shift left)] org-shiftmetaleft)
  7703. '([?\e (shift right)] org-shiftmetaright)
  7704. '([(shift up)] org-shiftup)
  7705. '([(shift down)] org-shiftdown)
  7706. '([(shift left)] org-shiftleft)
  7707. '([(shift right)] org-shiftright)
  7708. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7709. '("\M-q" fill-paragraph)
  7710. '("\C-c^" org-sort)
  7711. '("\C-c-" org-cycle-list-bullet)))
  7712. elt key fun cmd)
  7713. (while (setq elt (pop bindings))
  7714. (setq nfunc (1+ nfunc))
  7715. (setq key (org-key (car elt))
  7716. fun (nth 1 elt)
  7717. cmd (orgstruct-make-binding fun nfunc key))
  7718. (org-defkey orgstruct-mode-map key cmd))
  7719. ;; Prevent an error for users who forgot to make autoloads
  7720. (require 'org-element)
  7721. ;; Special treatment needed for TAB and RET
  7722. (org-defkey orgstruct-mode-map [(tab)]
  7723. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7724. (org-defkey orgstruct-mode-map "\C-i"
  7725. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7726. (org-defkey orgstruct-mode-map "\M-\C-m"
  7727. (orgstruct-make-binding 'org-insert-heading 105
  7728. "\M-\C-m" [(meta return)]))
  7729. (org-defkey orgstruct-mode-map [(meta return)]
  7730. (orgstruct-make-binding 'org-insert-heading 106
  7731. [(meta return)] "\M-\C-m"))
  7732. (org-defkey orgstruct-mode-map [(shift meta return)]
  7733. (orgstruct-make-binding 'org-insert-todo-heading 107
  7734. [(meta return)] "\M-\C-m"))
  7735. (org-defkey orgstruct-mode-map "\e\C-m"
  7736. (orgstruct-make-binding 'org-insert-heading 108
  7737. "\e\C-m" [?\e (return)]))
  7738. (org-defkey orgstruct-mode-map [?\e (return)]
  7739. (orgstruct-make-binding 'org-insert-heading 109
  7740. [?\e (return)] "\e\C-m"))
  7741. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7742. (orgstruct-make-binding 'org-insert-todo-heading 110
  7743. [?\e (return)] "\e\C-m"))
  7744. (unless org-local-vars
  7745. (setq org-local-vars (org-get-local-variables)))
  7746. t))
  7747. (defun orgstruct-make-binding (fun n &rest keys)
  7748. "Create a function for binding in the structure minor mode.
  7749. FUN is the command to call inside a table. N is used to create a unique
  7750. command name. KEYS are keys that should be checked in for a command
  7751. to execute outside of tables."
  7752. (eval
  7753. (list 'defun
  7754. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7755. '(arg)
  7756. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7757. "Outside of structure, run the binding of `"
  7758. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7759. "'.")
  7760. '(interactive "p")
  7761. (list 'if
  7762. `(org-context-p 'headline 'item
  7763. (and orgstruct-is-++
  7764. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7765. 'item-body))
  7766. (list 'org-run-like-in-org-mode (list 'quote fun))
  7767. (list 'let '(orgstruct-mode)
  7768. (list 'call-interactively
  7769. (append '(or)
  7770. (mapcar (lambda (k)
  7771. (list 'key-binding k))
  7772. keys)
  7773. '('orgstruct-error))))))))
  7774. (defun org-contextualize-keys (alist contexts)
  7775. "Return valid elements in ALIST depending on CONTEXTS.
  7776. `org-agenda-custom-commands' or `org-capture-templates' are the
  7777. values used for ALIST, and `org-agenda-custom-commands-contexts'
  7778. or `org-capture-templates-contexts' are the associated contexts
  7779. definitions."
  7780. (let ((contexts
  7781. ;; normalize contexts
  7782. (mapcar
  7783. (lambda(c) (cond ((listp (cadr c))
  7784. (list (car c) (car c) (cadr c)))
  7785. ((string= "" (cadr c))
  7786. (list (car c) (car c) (caddr c)))
  7787. (t c))) contexts))
  7788. (a alist) c r s)
  7789. ;; loop over all commands or templates
  7790. (while (setq c (pop a))
  7791. (let (vrules repl)
  7792. (cond
  7793. ((not (assoc (car c) contexts))
  7794. (push c r))
  7795. ((and (assoc (car c) contexts)
  7796. (setq vrules (org-contextualize-validate-key
  7797. (car c) contexts)))
  7798. (mapc (lambda (vr)
  7799. (when (not (equal (car vr) (cadr vr)))
  7800. (setq repl vr))) vrules)
  7801. (if (not repl) (push c r)
  7802. (push (cadr repl) s)
  7803. (push
  7804. (cons (car c)
  7805. (cdr (or (assoc (cadr repl) alist)
  7806. (error "Undefined key `%s' as contextual replacement for `%s'"
  7807. (cadr repl) (car c)))))
  7808. r))))))
  7809. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  7810. (delq
  7811. nil
  7812. (delete-dups
  7813. (mapcar (lambda (x)
  7814. (let ((tpl (car x)))
  7815. (when (not (delq
  7816. nil
  7817. (mapcar (lambda(y)
  7818. (equal y tpl)) s))) x)))
  7819. (reverse r))))))
  7820. (defun org-contextualize-validate-key (key contexts)
  7821. "Check CONTEXTS for agenda or capture KEY."
  7822. (let (r rr res)
  7823. (while (setq r (pop contexts))
  7824. (mapc
  7825. (lambda (rr)
  7826. (when
  7827. (and (equal key (car r))
  7828. (if (functionp rr) (funcall rr)
  7829. (or (and (eq (car rr) 'in-file)
  7830. (buffer-file-name)
  7831. (string-match (cdr rr) (buffer-file-name)))
  7832. (and (eq (car rr) 'in-mode)
  7833. (string-match (cdr rr) (symbol-name major-mode)))
  7834. (when (and (eq (car rr) 'not-in-file)
  7835. (buffer-file-name))
  7836. (not (string-match (cdr rr) (buffer-file-name))))
  7837. (when (eq (car rr) 'not-in-mode)
  7838. (not (string-match (cdr rr) (symbol-name major-mode)))))))
  7839. (push r res)))
  7840. (car (last r))))
  7841. (delete-dups (delq nil res))))
  7842. (defun org-context-p (&rest contexts)
  7843. "Check if local context is any of CONTEXTS.
  7844. Possible values in the list of contexts are `table', `headline', and `item'."
  7845. (let ((pos (point)))
  7846. (goto-char (point-at-bol))
  7847. (prog1 (or (and (memq 'table contexts)
  7848. (looking-at "[ \t]*|"))
  7849. (and (memq 'headline contexts)
  7850. (looking-at org-outline-regexp))
  7851. (and (memq 'item contexts)
  7852. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7853. (and (memq 'item-body contexts)
  7854. (org-in-item-p)))
  7855. (goto-char pos))))
  7856. (defun org-get-local-variables ()
  7857. "Return a list of all local variables in an Org mode buffer."
  7858. (let (varlist)
  7859. (with-current-buffer (get-buffer-create "*Org tmp*")
  7860. (erase-buffer)
  7861. (org-mode)
  7862. (setq varlist (buffer-local-variables)))
  7863. (kill-buffer "*Org tmp*")
  7864. (delq nil
  7865. (mapcar
  7866. (lambda (x)
  7867. (setq x
  7868. (if (symbolp x)
  7869. (list x)
  7870. (list (car x) (list 'quote (cdr x)))))
  7871. (if (string-match
  7872. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  7873. (symbol-name (car x)))
  7874. x nil))
  7875. varlist))))
  7876. (defun org-clone-local-variables (from-buffer &optional regexp)
  7877. "Clone local variables from FROM-BUFFER.
  7878. Optional argument REGEXP selects variables to clone."
  7879. (mapc
  7880. (lambda (pair)
  7881. (and (symbolp (car pair))
  7882. (or (null regexp)
  7883. (string-match regexp (symbol-name (car pair))))
  7884. (set (make-local-variable (car pair))
  7885. (cdr pair))))
  7886. (buffer-local-variables from-buffer)))
  7887. ;;;###autoload
  7888. (defun org-run-like-in-org-mode (cmd)
  7889. "Run a command, pretending that the current buffer is in Org-mode.
  7890. This will temporarily bind local variables that are typically bound in
  7891. Org-mode to the values they have in Org-mode, and then interactively
  7892. call CMD."
  7893. (org-load-modules-maybe)
  7894. (unless org-local-vars
  7895. (setq org-local-vars (org-get-local-variables)))
  7896. (eval (list 'let org-local-vars
  7897. (list 'call-interactively (list 'quote cmd)))))
  7898. ;;;; Archiving
  7899. (defun org-get-category (&optional pos force-refresh)
  7900. "Get the category applying to position POS."
  7901. (save-match-data
  7902. (if force-refresh (org-refresh-category-properties))
  7903. (let ((pos (or pos (point))))
  7904. (or (get-text-property pos 'org-category)
  7905. (progn (org-refresh-category-properties)
  7906. (get-text-property pos 'org-category))))))
  7907. (defun org-refresh-category-properties ()
  7908. "Refresh category text properties in the buffer."
  7909. (let ((case-fold-search t)
  7910. (inhibit-read-only t)
  7911. (def-cat (cond
  7912. ((null org-category)
  7913. (if buffer-file-name
  7914. (file-name-sans-extension
  7915. (file-name-nondirectory buffer-file-name))
  7916. "???"))
  7917. ((symbolp org-category) (symbol-name org-category))
  7918. (t org-category)))
  7919. beg end cat pos optionp)
  7920. (org-unmodified
  7921. (save-excursion
  7922. (save-restriction
  7923. (widen)
  7924. (goto-char (point-min))
  7925. (put-text-property (point) (point-max) 'org-category def-cat)
  7926. (while (re-search-forward
  7927. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7928. (setq pos (match-end 0)
  7929. optionp (equal (char-after (match-beginning 0)) ?#)
  7930. cat (org-trim (match-string 2)))
  7931. (if optionp
  7932. (setq beg (point-at-bol) end (point-max))
  7933. (org-back-to-heading t)
  7934. (setq beg (point) end (org-end-of-subtree t t)))
  7935. (put-text-property beg end 'org-category cat)
  7936. (put-text-property beg end 'org-category-position beg)
  7937. (goto-char pos)))))))
  7938. ;;;; Link Stuff
  7939. ;;; Link abbreviations
  7940. (defun org-link-expand-abbrev (link)
  7941. "Apply replacements as defined in `org-link-abbrev-alist'."
  7942. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  7943. (let* ((key (match-string 1 link))
  7944. (as (or (assoc key org-link-abbrev-alist-local)
  7945. (assoc key org-link-abbrev-alist)))
  7946. (tag (and (match-end 2) (match-string 3 link)))
  7947. rpl)
  7948. (if (not as)
  7949. link
  7950. (setq rpl (cdr as))
  7951. (cond
  7952. ((symbolp rpl) (funcall rpl tag))
  7953. ((string-match "%(\\([^)]+\\))" rpl)
  7954. (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
  7955. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7956. ((string-match "%h" rpl)
  7957. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7958. (t (concat rpl tag)))))
  7959. link))
  7960. ;;; Storing and inserting links
  7961. (defvar org-insert-link-history nil
  7962. "Minibuffer history for links inserted with `org-insert-link'.")
  7963. (defvar org-stored-links nil
  7964. "Contains the links stored with `org-store-link'.")
  7965. (defvar org-store-link-plist nil
  7966. "Plist with info about the most recently link created with `org-store-link'.")
  7967. (defvar org-link-protocols nil
  7968. "Link protocols added to Org-mode using `org-add-link-type'.")
  7969. (defvar org-store-link-functions nil
  7970. "List of functions that are called to create and store a link.
  7971. Each function will be called in turn until one returns a non-nil
  7972. value. Each function should check if it is responsible for creating
  7973. this link (for example by looking at the major mode).
  7974. If not, it must exit and return nil.
  7975. If yes, it should return a non-nil value after a calling
  7976. `org-store-link-props' with a list of properties and values.
  7977. Special properties are:
  7978. :type The link prefix, like \"http\". This must be given.
  7979. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7980. This is obligatory as well.
  7981. :description Optional default description for the second pair
  7982. of brackets in an Org-mode link. The user can still change
  7983. this when inserting this link into an Org-mode buffer.
  7984. In addition to these, any additional properties can be specified
  7985. and then used in capture templates.")
  7986. (defun org-add-link-type (type &optional follow export)
  7987. "Add TYPE to the list of `org-link-types'.
  7988. Re-compute all regular expressions depending on `org-link-types'
  7989. FOLLOW and EXPORT are two functions.
  7990. FOLLOW should take the link path as the single argument and do whatever
  7991. is necessary to follow the link, for example find a file or display
  7992. a mail message.
  7993. EXPORT should format the link path for export to one of the export formats.
  7994. It should be a function accepting three arguments:
  7995. path the path of the link, the text after the prefix (like \"http:\")
  7996. desc the description of the link, if any, or a description added by
  7997. org-export-normalize-links if there is none
  7998. format the export format, a symbol like `html' or `latex' or `ascii'..
  7999. The function may use the FORMAT information to return different values
  8000. depending on the format. The return value will be put literally into
  8001. the exported file. If the return value is nil, this means Org should
  8002. do what it normally does with links which do not have EXPORT defined.
  8003. Org-mode has a built-in default for exporting links. If you are happy with
  8004. this default, there is no need to define an export function for the link
  8005. type. For a simple example of an export function, see `org-bbdb.el'."
  8006. (add-to-list 'org-link-types type t)
  8007. (org-make-link-regexps)
  8008. (if (assoc type org-link-protocols)
  8009. (setcdr (assoc type org-link-protocols) (list follow export))
  8010. (push (list type follow export) org-link-protocols)))
  8011. (defvar org-agenda-buffer-name)
  8012. ;;;###autoload
  8013. (defun org-store-link (arg)
  8014. "\\<org-mode-map>Store an org-link to the current location.
  8015. This link is added to `org-stored-links' and can later be inserted
  8016. into an org-buffer with \\[org-insert-link].
  8017. For some link types, a prefix arg is interpreted:
  8018. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  8019. For file links, arg negates `org-context-in-file-links'."
  8020. (interactive "P")
  8021. (org-load-modules-maybe)
  8022. (setq org-store-link-plist nil) ; reset
  8023. (org-with-limited-levels
  8024. (let (link cpltxt desc description search txt custom-id agenda-link)
  8025. (cond
  8026. ((run-hook-with-args-until-success 'org-store-link-functions)
  8027. (setq link (plist-get org-store-link-plist :link)
  8028. desc (or (plist-get org-store-link-plist :description) link)))
  8029. ((org-src-edit-buffer-p)
  8030. (let (label gc)
  8031. (while (or (not label)
  8032. (save-excursion
  8033. (save-restriction
  8034. (widen)
  8035. (goto-char (point-min))
  8036. (re-search-forward
  8037. (regexp-quote (format org-coderef-label-format label))
  8038. nil t))))
  8039. (when label (message "Label exists already") (sit-for 2))
  8040. (setq label (read-string "Code line label: " label)))
  8041. (end-of-line 1)
  8042. (setq link (format org-coderef-label-format label))
  8043. (setq gc (- 79 (length link)))
  8044. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  8045. (insert link)
  8046. (setq link (concat "(" label ")") desc nil)))
  8047. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  8048. ;; We are in the agenda, link to referenced location
  8049. (let ((m (or (get-text-property (point) 'org-hd-marker)
  8050. (get-text-property (point) 'org-marker))))
  8051. (when m
  8052. (org-with-point-at m
  8053. (setq agenda-link
  8054. (if (org-called-interactively-p 'any)
  8055. (call-interactively 'org-store-link)
  8056. (org-store-link nil)))))))
  8057. ((eq major-mode 'calendar-mode)
  8058. (let ((cd (calendar-cursor-to-date)))
  8059. (setq link
  8060. (format-time-string
  8061. (car org-time-stamp-formats)
  8062. (apply 'encode-time
  8063. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  8064. nil nil nil))))
  8065. (org-store-link-props :type "calendar" :date cd)))
  8066. ((eq major-mode 'help-mode)
  8067. (setq link (concat "help:" (save-excursion
  8068. (goto-char (point-min))
  8069. (looking-at "^[^ ]+")
  8070. (match-string 0))))
  8071. (org-store-link-props :type "help"))
  8072. ((eq major-mode 'w3-mode)
  8073. (setq cpltxt (if (and (buffer-name)
  8074. (not (string-match "Untitled" (buffer-name))))
  8075. (buffer-name)
  8076. (url-view-url t))
  8077. link (url-view-url t))
  8078. (org-store-link-props :type "w3" :url (url-view-url t)))
  8079. ((eq major-mode 'w3m-mode)
  8080. (setq cpltxt (or w3m-current-title w3m-current-url)
  8081. link w3m-current-url)
  8082. (org-store-link-props :type "w3m" :url (url-view-url t)))
  8083. ((setq search (run-hook-with-args-until-success
  8084. 'org-create-file-search-functions))
  8085. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  8086. "::" search))
  8087. (setq cpltxt (or description link)))
  8088. ((eq major-mode 'image-mode)
  8089. (setq cpltxt (concat "file:"
  8090. (abbreviate-file-name buffer-file-name))
  8091. link cpltxt)
  8092. (org-store-link-props :type "image" :file buffer-file-name))
  8093. ((eq major-mode 'dired-mode)
  8094. ;; link to the file in the current line
  8095. (let ((file (dired-get-filename nil t)))
  8096. (setq file (if file
  8097. (abbreviate-file-name
  8098. (expand-file-name (dired-get-filename nil t)))
  8099. ;; otherwise, no file so use current directory.
  8100. default-directory))
  8101. (setq cpltxt (concat "file:" file)
  8102. link cpltxt)))
  8103. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  8104. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  8105. (cond
  8106. ((org-in-regexp "<<\\(.*?\\)>>")
  8107. (setq cpltxt
  8108. (concat "file:"
  8109. (abbreviate-file-name
  8110. (buffer-file-name (buffer-base-buffer)))
  8111. "::" (match-string 1))
  8112. link cpltxt))
  8113. ((and (featurep 'org-id)
  8114. (or (eq org-link-to-org-use-id t)
  8115. (and (org-called-interactively-p 'any)
  8116. (or (eq org-link-to-org-use-id 'create-if-interactive)
  8117. (and (eq org-link-to-org-use-id
  8118. 'create-if-interactive-and-no-custom-id)
  8119. (not custom-id))))
  8120. (and org-link-to-org-use-id (org-entry-get nil "ID"))))
  8121. ;; We can make a link using the ID.
  8122. (setq link (condition-case nil
  8123. (prog1 (org-id-store-link)
  8124. (setq desc (plist-get org-store-link-plist :description)))
  8125. (error
  8126. ;; probably before first headline, link to file only
  8127. (concat "file:"
  8128. (abbreviate-file-name
  8129. (buffer-file-name (buffer-base-buffer))))))))
  8130. (t
  8131. ;; Just link to current headline
  8132. (setq cpltxt (concat "file:"
  8133. (abbreviate-file-name
  8134. (buffer-file-name (buffer-base-buffer)))))
  8135. ;; Add a context search string
  8136. (when (org-xor org-context-in-file-links arg)
  8137. (setq txt (cond
  8138. ((org-at-heading-p) nil)
  8139. ((org-region-active-p)
  8140. (buffer-substring (region-beginning) (region-end)))))
  8141. (when (or (null txt) (string-match "\\S-" txt))
  8142. (setq cpltxt
  8143. (concat cpltxt "::"
  8144. (condition-case nil
  8145. (org-make-org-heading-search-string txt)
  8146. (error "")))
  8147. desc (or (nth 4 (ignore-errors
  8148. (org-heading-components))) "NONE"))))
  8149. (if (string-match "::\\'" cpltxt)
  8150. (setq cpltxt (substring cpltxt 0 -2)))
  8151. (setq link cpltxt))))
  8152. ((buffer-file-name (buffer-base-buffer))
  8153. ;; Just link to this file here.
  8154. (setq cpltxt (concat "file:"
  8155. (abbreviate-file-name
  8156. (buffer-file-name (buffer-base-buffer)))))
  8157. ;; Add a context string
  8158. (when (org-xor org-context-in-file-links arg)
  8159. (setq txt (if (org-region-active-p)
  8160. (buffer-substring (region-beginning) (region-end))
  8161. (buffer-substring (point-at-bol) (point-at-eol))))
  8162. ;; Only use search option if there is some text.
  8163. (when (string-match "\\S-" txt)
  8164. (setq cpltxt
  8165. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8166. desc "NONE")))
  8167. (setq link cpltxt))
  8168. ((org-called-interactively-p 'interactive)
  8169. (error "Cannot link to a buffer which is not visiting a file"))
  8170. (t (setq link nil)))
  8171. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8172. (setq link (or link cpltxt)
  8173. desc (or desc cpltxt))
  8174. (if (equal desc "NONE") (setq desc nil))
  8175. (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
  8176. (progn
  8177. (setq org-stored-links
  8178. (cons (list link desc) org-stored-links))
  8179. (message "Stored: %s" (or desc link))
  8180. (when custom-id
  8181. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  8182. "::#" custom-id))
  8183. (setq org-stored-links
  8184. (cons (list link desc) org-stored-links))))
  8185. (or agenda-link (and link (org-make-link-string link desc)))))))
  8186. (defun org-store-link-props (&rest plist)
  8187. "Store link properties, extract names and addresses."
  8188. (let (x adr)
  8189. (when (setq x (plist-get plist :from))
  8190. (setq adr (mail-extract-address-components x))
  8191. (setq plist (plist-put plist :fromname (car adr)))
  8192. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8193. (when (setq x (plist-get plist :to))
  8194. (setq adr (mail-extract-address-components x))
  8195. (setq plist (plist-put plist :toname (car adr)))
  8196. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8197. (let ((from (plist-get plist :from))
  8198. (to (plist-get plist :to)))
  8199. (when (and from to org-from-is-user-regexp)
  8200. (setq plist
  8201. (plist-put plist :fromto
  8202. (if (string-match org-from-is-user-regexp from)
  8203. (concat "to %t")
  8204. (concat "from %f"))))))
  8205. (setq org-store-link-plist plist))
  8206. (defun org-add-link-props (&rest plist)
  8207. "Add these properties to the link property list."
  8208. (let (key value)
  8209. (while plist
  8210. (setq key (pop plist) value (pop plist))
  8211. (setq org-store-link-plist
  8212. (plist-put org-store-link-plist key value)))))
  8213. (defun org-email-link-description (&optional fmt)
  8214. "Return the description part of an email link.
  8215. This takes information from `org-store-link-plist' and formats it
  8216. according to FMT (default from `org-email-link-description-format')."
  8217. (setq fmt (or fmt org-email-link-description-format))
  8218. (let* ((p org-store-link-plist)
  8219. (to (plist-get p :toaddress))
  8220. (from (plist-get p :fromaddress))
  8221. (table
  8222. (list
  8223. (cons "%c" (plist-get p :fromto))
  8224. (cons "%F" (plist-get p :from))
  8225. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8226. (cons "%T" (plist-get p :to))
  8227. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8228. (cons "%s" (plist-get p :subject))
  8229. (cons "%d" (plist-get p :date))
  8230. (cons "%m" (plist-get p :message-id)))))
  8231. (when (string-match "%c" fmt)
  8232. ;; Check if the user wrote this message
  8233. (if (and org-from-is-user-regexp from to
  8234. (save-match-data (string-match org-from-is-user-regexp from)))
  8235. (setq fmt (replace-match "to %t" t t fmt))
  8236. (setq fmt (replace-match "from %f" t t fmt))))
  8237. (org-replace-escapes fmt table)))
  8238. (defun org-make-org-heading-search-string (&optional string heading)
  8239. "Make search string for STRING or current headline."
  8240. (interactive)
  8241. (let ((s (or string (org-get-heading)))
  8242. (lines org-context-in-file-links))
  8243. (unless (and string (not heading))
  8244. ;; We are using a headline, clean up garbage in there.
  8245. (if (string-match org-todo-regexp s)
  8246. (setq s (replace-match "" t t s)))
  8247. (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
  8248. (setq s (replace-match "" t t s)))
  8249. (setq s (org-trim s))
  8250. (if (string-match (concat "^\\(" org-quote-string "\\|"
  8251. org-comment-string "\\)") s)
  8252. (setq s (replace-match "" t t s)))
  8253. (while (string-match org-ts-regexp s)
  8254. (setq s (replace-match "" t t s))))
  8255. (or string (setq s (concat "*" s))) ; Add * for headlines
  8256. (when (and string (integerp lines) (> lines 0))
  8257. (let ((slines (org-split-string s "\n")))
  8258. (when (< lines (length slines))
  8259. (setq s (mapconcat
  8260. 'identity
  8261. (reverse (nthcdr (- (length slines) lines)
  8262. (reverse slines))) "\n")))))
  8263. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8264. (defun org-make-link-string (link &optional description)
  8265. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8266. (unless (string-match "\\S-" link)
  8267. (error "Empty link"))
  8268. (when (and description
  8269. (stringp description)
  8270. (not (string-match "\\S-" description)))
  8271. (setq description nil))
  8272. (when (stringp description)
  8273. ;; Remove brackets from the description, they are fatal.
  8274. (while (string-match "\\[" description)
  8275. (setq description (replace-match "{" t t description)))
  8276. (while (string-match "\\]" description)
  8277. (setq description (replace-match "}" t t description))))
  8278. (when (equal link description)
  8279. ;; No description needed, it is identical
  8280. (setq description nil))
  8281. (when (and (not description)
  8282. (not (string-match (org-image-file-name-regexp) link))
  8283. (not (equal link (org-link-escape link))))
  8284. (setq description (org-extract-attributes link)))
  8285. (setq link
  8286. (cond ((string-match (org-image-file-name-regexp) link) link)
  8287. ((string-match org-link-types-re link)
  8288. (concat (match-string 1 link)
  8289. (org-link-escape (substring link (match-end 1)))))
  8290. (t (org-link-escape link))))
  8291. (concat "[[" link "]"
  8292. (if description (concat "[" description "]") "")
  8293. "]"))
  8294. (defconst org-link-escape-chars
  8295. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  8296. "List of characters that should be escaped in link.
  8297. This is the list that is used for internal purposes.")
  8298. (defconst org-link-escape-chars-browser
  8299. '(?\ )
  8300. "List of escapes for characters that are problematic in links.
  8301. This is the list that is used before handing over to the browser.")
  8302. (defun org-link-escape (text &optional table merge)
  8303. "Return percent escaped representation of TEXT.
  8304. TEXT is a string with the text to escape.
  8305. Optional argument TABLE is a list with characters that should be
  8306. escaped. When nil, `org-link-escape-chars' is used.
  8307. If optional argument MERGE is set, merge TABLE into
  8308. `org-link-escape-chars'."
  8309. (cond
  8310. ((and table merge)
  8311. (mapc (lambda (defchr)
  8312. (unless (member defchr table)
  8313. (setq table (cons defchr table)))) org-link-escape-chars))
  8314. ((null table)
  8315. (setq table org-link-escape-chars)))
  8316. (mapconcat
  8317. (lambda (char)
  8318. (if (or (member char table)
  8319. (and (or (< char 32) (= char 37) (> char 126))
  8320. org-url-hexify-p))
  8321. (mapconcat (lambda (sequence-element)
  8322. (format "%%%.2X" sequence-element))
  8323. (or (encode-coding-char char 'utf-8)
  8324. (error "Unable to percent escape character: %s"
  8325. (char-to-string char))) "")
  8326. (char-to-string char))) text ""))
  8327. (defun org-link-unescape (str)
  8328. "Unhex hexified Unicode strings as returned from the JavaScript function
  8329. encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
  8330. (unless (and (null str) (string= "" str))
  8331. (let ((pos 0) (case-fold-search t) unhexed)
  8332. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8333. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8334. (setq str (replace-match unhexed t t str))
  8335. (setq pos (+ pos (length unhexed))))))
  8336. str)
  8337. (defun org-link-unescape-compound (hex)
  8338. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
  8339. Note: this function also decodes single byte encodings like
  8340. `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
  8341. (save-match-data
  8342. (let* ((bytes (cdr (split-string hex "%")))
  8343. (ret "")
  8344. (eat 0)
  8345. (sum 0))
  8346. (while bytes
  8347. (let* ((val (string-to-number (pop bytes) 16))
  8348. (shift-xor
  8349. (if (= 0 eat)
  8350. (cond
  8351. ((>= val 252) (cons 6 252))
  8352. ((>= val 248) (cons 5 248))
  8353. ((>= val 240) (cons 4 240))
  8354. ((>= val 224) (cons 3 224))
  8355. ((>= val 192) (cons 2 192))
  8356. (t (cons 0 0)))
  8357. (cons 6 128))))
  8358. (if (>= val 192) (setq eat (car shift-xor)))
  8359. (setq val (logxor val (cdr shift-xor)))
  8360. (setq sum (+ (lsh sum (car shift-xor)) val))
  8361. (if (> eat 0) (setq eat (- eat 1)))
  8362. (cond
  8363. ((= 0 eat) ;multi byte
  8364. (setq ret (concat ret (org-char-to-string sum)))
  8365. (setq sum 0))
  8366. ((not bytes) ; single byte(s)
  8367. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8368. )) ;; end (while bytes
  8369. ret )))
  8370. (defun org-link-unescape-single-byte-sequence (hex)
  8371. "Unhexify hex-encoded single byte character sequences."
  8372. (mapconcat (lambda (byte)
  8373. (char-to-string (string-to-number byte 16)))
  8374. (cdr (split-string hex "%")) ""))
  8375. (defun org-xor (a b)
  8376. "Exclusive or."
  8377. (if a (not b) b))
  8378. (defun org-fixup-message-id-for-http (s)
  8379. "Replace special characters in a message id, so it can be used in an http query."
  8380. (when (string-match "%" s)
  8381. (setq s (mapconcat (lambda (c)
  8382. (if (eq c ?%)
  8383. "%25"
  8384. (char-to-string c)))
  8385. s "")))
  8386. (while (string-match "<" s)
  8387. (setq s (replace-match "%3C" t t s)))
  8388. (while (string-match ">" s)
  8389. (setq s (replace-match "%3E" t t s)))
  8390. (while (string-match "@" s)
  8391. (setq s (replace-match "%40" t t s)))
  8392. s)
  8393. (defun org-link-prettify (link)
  8394. "Return a human-readable representation of LINK.
  8395. The car of LINK must be a raw link the cdr of LINK must be either
  8396. a link description or nil."
  8397. (let ((desc (or (cadr link) "<no description>")))
  8398. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8399. "<" (car link) ">")))
  8400. ;;;###autoload
  8401. (defun org-insert-link-global ()
  8402. "Insert a link like Org-mode does.
  8403. This command can be called in any mode to insert a link in Org-mode syntax."
  8404. (interactive)
  8405. (org-load-modules-maybe)
  8406. (org-run-like-in-org-mode 'org-insert-link))
  8407. (defun org-insert-all-links (&optional keep)
  8408. "Insert all links in `org-stored-links'."
  8409. (interactive "P")
  8410. (let ((links (copy-sequence org-stored-links)) l)
  8411. (while (setq l (if keep (pop links) (pop org-stored-links)))
  8412. (insert "- ")
  8413. (org-insert-link nil (car l) (cadr l))
  8414. (insert "\n"))))
  8415. (defun org-link-fontify-links-to-this-file ()
  8416. "Fontify links to the current file in `org-stored-links'."
  8417. (let ((f (buffer-file-name)) a b)
  8418. (setq a (mapcar (lambda(l)
  8419. (let ((ll (car l)))
  8420. (when (and (string-match "^file:\\(.+\\)::" ll)
  8421. (equal f (expand-file-name (match-string 1 ll))))
  8422. ll)))
  8423. org-stored-links))
  8424. (when (featurep 'org-id)
  8425. (setq b (mapcar (lambda(l)
  8426. (let ((ll (car l)))
  8427. (when (and (string-match "^id:\\(.+\\)$" ll)
  8428. (equal f (expand-file-name
  8429. (or (org-id-find-id-file
  8430. (match-string 1 ll)) ""))))
  8431. ll)))
  8432. org-stored-links)))
  8433. (mapcar (lambda(l)
  8434. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  8435. (delq nil (append a b)))))
  8436. (defvar org-link-links-in-this-file nil)
  8437. (defun org-insert-link (&optional complete-file link-location default-description)
  8438. "Insert a link. At the prompt, enter the link.
  8439. Completion can be used to insert any of the link protocol prefixes like
  8440. http or ftp in use.
  8441. The history can be used to select a link previously stored with
  8442. `org-store-link'. When the empty string is entered (i.e. if you just
  8443. press RET at the prompt), the link defaults to the most recently
  8444. stored link. As SPC triggers completion in the minibuffer, you need to
  8445. use M-SPC or C-q SPC to force the insertion of a space character.
  8446. You will also be prompted for a description, and if one is given, it will
  8447. be displayed in the buffer instead of the link.
  8448. If there is already a link at point, this command will allow you to edit link
  8449. and description parts.
  8450. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8451. be selected using completion. The path to the file will be relative to the
  8452. current directory if the file is in the current directory or a subdirectory.
  8453. Otherwise, the link will be the absolute path as completed in the minibuffer
  8454. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8455. option `org-link-file-path-type'.
  8456. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8457. the current directory or below.
  8458. With three \\[universal-argument] prefixes, negate the meaning of
  8459. `org-keep-stored-link-after-insertion'.
  8460. If `org-make-link-description-function' is non-nil, this function will be
  8461. called with the link target, and the result will be the default
  8462. link description.
  8463. If the LINK-LOCATION parameter is non-nil, this value will be
  8464. used as the link location instead of reading one interactively.
  8465. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8466. be used as the default description."
  8467. (interactive "P")
  8468. (let* ((wcf (current-window-configuration))
  8469. (region (if (org-region-active-p)
  8470. (buffer-substring (region-beginning) (region-end))))
  8471. (remove (and region (list (region-beginning) (region-end))))
  8472. (desc region)
  8473. tmphist ; byte-compile incorrectly complains about this
  8474. (link link-location)
  8475. (abbrevs org-link-abbrev-alist-local)
  8476. entry file all-prefixes auto-desc)
  8477. (cond
  8478. (link-location) ; specified by arg, just use it.
  8479. ((org-in-regexp org-bracket-link-regexp 1)
  8480. ;; We do have a link at point, and we are going to edit it.
  8481. (setq remove (list (match-beginning 0) (match-end 0)))
  8482. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8483. (setq link (read-string "Link: "
  8484. (org-link-unescape
  8485. (org-match-string-no-properties 1)))))
  8486. ((or (org-in-regexp org-angle-link-re)
  8487. (org-in-regexp org-plain-link-re))
  8488. ;; Convert to bracket link
  8489. (setq remove (list (match-beginning 0) (match-end 0))
  8490. link (read-string "Link: "
  8491. (org-remove-angle-brackets (match-string 0)))))
  8492. ((member complete-file '((4) (16)))
  8493. ;; Completing read for file names.
  8494. (setq link (org-file-complete-link complete-file)))
  8495. (t
  8496. ;; Read link, with completion for stored links.
  8497. (org-link-fontify-links-to-this-file)
  8498. (org-switch-to-buffer-other-window "*Org Links*")
  8499. (with-current-buffer "*Org Links*"
  8500. (erase-buffer)
  8501. (insert "Insert a link.
  8502. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  8503. (when org-stored-links
  8504. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  8505. (insert (mapconcat 'org-link-prettify
  8506. (reverse org-stored-links) "\n")))
  8507. (goto-char (point-min)))
  8508. (let ((cw (selected-window)))
  8509. (select-window (get-buffer-window "*Org Links*" 'visible))
  8510. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  8511. (unless (pos-visible-in-window-p (point-max))
  8512. (org-fit-window-to-buffer))
  8513. (and (window-live-p cw) (select-window cw)))
  8514. ;; Fake a link history, containing the stored links.
  8515. (setq tmphist (append (mapcar 'car org-stored-links)
  8516. org-insert-link-history))
  8517. (setq all-prefixes (append (mapcar 'car abbrevs)
  8518. (mapcar 'car org-link-abbrev-alist)
  8519. org-link-types))
  8520. (unwind-protect
  8521. (progn
  8522. (setq link
  8523. (let ((org-completion-use-ido nil)
  8524. (org-completion-use-iswitchb nil))
  8525. (org-completing-read
  8526. "Link: "
  8527. (append
  8528. (mapcar (lambda (x) (list (concat x ":")))
  8529. all-prefixes)
  8530. (mapcar 'car org-stored-links)
  8531. (mapcar 'cadr org-stored-links))
  8532. nil nil nil
  8533. 'tmphist
  8534. (caar org-stored-links))))
  8535. (if (not (string-match "\\S-" link))
  8536. (error "No link selected"))
  8537. (mapc (lambda(l)
  8538. (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
  8539. org-stored-links)
  8540. (if (or (member link all-prefixes)
  8541. (and (equal ":" (substring link -1))
  8542. (member (substring link 0 -1) all-prefixes)
  8543. (setq link (substring link 0 -1))))
  8544. (setq link (org-link-try-special-completion link))))
  8545. (set-window-configuration wcf)
  8546. (kill-buffer "*Org Links*"))
  8547. (setq entry (assoc link org-stored-links))
  8548. (or entry (push link org-insert-link-history))
  8549. (setq desc (or desc (nth 1 entry)))))
  8550. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  8551. (not org-keep-stored-link-after-insertion))
  8552. (setq org-stored-links (delq (assoc link org-stored-links)
  8553. org-stored-links)))
  8554. (if (string-match org-plain-link-re link)
  8555. ;; URL-like link, normalize the use of angular brackets.
  8556. (setq link (org-remove-angle-brackets link)))
  8557. ;; Check if we are linking to the current file with a search option
  8558. ;; If yes, simplify the link by using only the search option.
  8559. (when (and buffer-file-name
  8560. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  8561. (let* ((path (match-string 1 link))
  8562. (case-fold-search nil)
  8563. (search (match-string 2 link)))
  8564. (save-match-data
  8565. (if (equal (file-truename buffer-file-name) (file-truename path))
  8566. ;; We are linking to this same file, with a search option
  8567. (setq link search)))))
  8568. ;; Check if we can/should use a relative path. If yes, simplify the link
  8569. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  8570. (let* ((type (match-string 1 link))
  8571. (path (match-string 2 link))
  8572. (origpath path)
  8573. (case-fold-search nil))
  8574. (cond
  8575. ((or (eq org-link-file-path-type 'absolute)
  8576. (equal complete-file '(16)))
  8577. (setq path (abbreviate-file-name (expand-file-name path))))
  8578. ((eq org-link-file-path-type 'noabbrev)
  8579. (setq path (expand-file-name path)))
  8580. ((eq org-link-file-path-type 'relative)
  8581. (setq path (file-relative-name path)))
  8582. (t
  8583. (save-match-data
  8584. (if (string-match (concat "^" (regexp-quote
  8585. (expand-file-name
  8586. (file-name-as-directory
  8587. default-directory))))
  8588. (expand-file-name path))
  8589. ;; We are linking a file with relative path name.
  8590. (setq path (substring (expand-file-name path)
  8591. (match-end 0)))
  8592. (setq path (abbreviate-file-name (expand-file-name path)))))))
  8593. (setq link (concat type path))
  8594. (if (equal desc origpath)
  8595. (setq desc path))))
  8596. (if org-make-link-description-function
  8597. (setq desc (funcall org-make-link-description-function link desc))
  8598. (if default-description (setq desc default-description)
  8599. (setq desc (or (and auto-desc desc)
  8600. (read-string "Description: " desc)))))
  8601. (unless (string-match "\\S-" desc) (setq desc nil))
  8602. (if remove (apply 'delete-region remove))
  8603. (insert (org-make-link-string link desc))))
  8604. (defun org-link-try-special-completion (type)
  8605. "If there is completion support for link type TYPE, offer it."
  8606. (let ((fun (intern (concat "org-" type "-complete-link"))))
  8607. (if (functionp fun)
  8608. (funcall fun)
  8609. (read-string "Link (no completion support): " (concat type ":")))))
  8610. (defun org-file-complete-link (&optional arg)
  8611. "Create a file link using completion."
  8612. (let (file link)
  8613. (setq file (read-file-name "File: "))
  8614. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  8615. (pwd1 (file-name-as-directory (abbreviate-file-name
  8616. (expand-file-name ".")))))
  8617. (cond
  8618. ((equal arg '(16))
  8619. (setq link (concat
  8620. "file:"
  8621. (abbreviate-file-name (expand-file-name file)))))
  8622. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  8623. (setq link (concat "file:" (match-string 1 file))))
  8624. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  8625. (expand-file-name file))
  8626. (setq link (concat
  8627. "file:" (match-string 1 (expand-file-name file)))))
  8628. (t (setq link (concat "file:" file)))))
  8629. link))
  8630. (defun org-completing-read (&rest args)
  8631. "Completing-read with SPACE being a normal character."
  8632. (let ((enable-recursive-minibuffers t)
  8633. (minibuffer-local-completion-map
  8634. (copy-keymap minibuffer-local-completion-map)))
  8635. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  8636. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  8637. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  8638. (apply 'org-icompleting-read args)))
  8639. (defun org-completing-read-no-i (&rest args)
  8640. (let (org-completion-use-ido org-completion-use-iswitchb)
  8641. (apply 'org-completing-read args)))
  8642. (defun org-iswitchb-completing-read (prompt choices &rest args)
  8643. "Use iswitch as a completing-read replacement to choose from choices.
  8644. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  8645. from."
  8646. (let* ((iswitchb-use-virtual-buffers nil)
  8647. (iswitchb-make-buflist-hook
  8648. (lambda ()
  8649. (setq iswitchb-temp-buflist choices))))
  8650. (iswitchb-read-buffer prompt)))
  8651. (defun org-icompleting-read (&rest args)
  8652. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  8653. (org-without-partial-completion
  8654. (if (and org-completion-use-ido
  8655. (fboundp 'ido-completing-read)
  8656. (boundp 'ido-mode) ido-mode
  8657. (listp (second args)))
  8658. (let ((ido-enter-matching-directory nil))
  8659. (apply 'ido-completing-read (concat (car args))
  8660. (if (consp (car (nth 1 args)))
  8661. (mapcar 'car (nth 1 args))
  8662. (nth 1 args))
  8663. (cddr args)))
  8664. (if (and org-completion-use-iswitchb
  8665. (boundp 'iswitchb-mode) iswitchb-mode
  8666. (listp (second args)))
  8667. (apply 'org-iswitchb-completing-read (concat (car args))
  8668. (if (consp (car (nth 1 args)))
  8669. (mapcar 'car (nth 1 args))
  8670. (nth 1 args))
  8671. (cddr args))
  8672. (apply 'completing-read args)))))
  8673. (defun org-extract-attributes (s)
  8674. "Extract the attributes cookie from a string and set as text property."
  8675. (let (a attr (start 0) key value)
  8676. (save-match-data
  8677. (when (string-match "{{\\([^}]+\\)}}$" s)
  8678. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  8679. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  8680. (setq key (match-string 1 a) value (match-string 2 a)
  8681. start (match-end 0)
  8682. attr (plist-put attr (intern key) value))))
  8683. (org-add-props s nil 'org-attr attr))
  8684. s))
  8685. (defun org-extract-attributes-from-string (tag)
  8686. (let (key value attr)
  8687. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  8688. (setq key (match-string 1 tag) value (match-string 2 tag)
  8689. tag (replace-match "" t t tag)
  8690. attr (plist-put attr (intern key) value)))
  8691. (cons tag attr)))
  8692. (defun org-attributes-to-string (plist)
  8693. "Format a property list into an HTML attribute list."
  8694. (let ((s "") key value)
  8695. (while plist
  8696. (setq key (pop plist) value (pop plist))
  8697. (and value
  8698. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  8699. s))
  8700. ;;; Opening/following a link
  8701. (defvar org-link-search-failed nil)
  8702. (defvar org-open-link-functions nil
  8703. "Hook for functions finding a plain text link.
  8704. These functions must take a single argument, the link content.
  8705. They will be called for links that look like [[link text][description]]
  8706. when LINK TEXT does not have a protocol like \"http:\" and does not look
  8707. like a filename (e.g. \"./blue.png\").
  8708. These functions will be called *before* Org attempts to resolve the
  8709. link by doing text searches in the current buffer - so if you want a
  8710. link \"[[target]]\" to still find \"<<target>>\", your function should
  8711. handle this as a special case.
  8712. When the function does handle the link, it must return a non-nil value.
  8713. If it decides that it is not responsible for this link, it must return
  8714. nil to indicate that that Org-mode can continue with other options
  8715. like exact and fuzzy text search.")
  8716. (defun org-next-link ()
  8717. "Move forward to the next link.
  8718. If the link is in hidden text, expose it."
  8719. (interactive)
  8720. (when (and org-link-search-failed (eq this-command last-command))
  8721. (goto-char (point-min))
  8722. (message "Link search wrapped back to beginning of buffer"))
  8723. (setq org-link-search-failed nil)
  8724. (let* ((pos (point))
  8725. (ct (org-context))
  8726. (a (assoc :link ct)))
  8727. (if a (goto-char (nth 2 a)))
  8728. (if (re-search-forward org-any-link-re nil t)
  8729. (progn
  8730. (goto-char (match-beginning 0))
  8731. (if (outline-invisible-p) (org-show-context)))
  8732. (goto-char pos)
  8733. (setq org-link-search-failed t)
  8734. (error "No further link found"))))
  8735. (defun org-previous-link ()
  8736. "Move backward to the previous link.
  8737. If the link is in hidden text, expose it."
  8738. (interactive)
  8739. (when (and org-link-search-failed (eq this-command last-command))
  8740. (goto-char (point-max))
  8741. (message "Link search wrapped back to end of buffer"))
  8742. (setq org-link-search-failed nil)
  8743. (let* ((pos (point))
  8744. (ct (org-context))
  8745. (a (assoc :link ct)))
  8746. (if a (goto-char (nth 1 a)))
  8747. (if (re-search-backward org-any-link-re nil t)
  8748. (progn
  8749. (goto-char (match-beginning 0))
  8750. (if (outline-invisible-p) (org-show-context)))
  8751. (goto-char pos)
  8752. (setq org-link-search-failed t)
  8753. (error "No further link found"))))
  8754. (defun org-translate-link (s)
  8755. "Translate a link string if a translation function has been defined."
  8756. (if (and org-link-translation-function
  8757. (fboundp org-link-translation-function)
  8758. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  8759. (progn
  8760. (setq s (funcall org-link-translation-function
  8761. (match-string 1 s) (match-string 2 s)))
  8762. (concat (car s) ":" (cdr s)))
  8763. s))
  8764. (defun org-translate-link-from-planner (type path)
  8765. "Translate a link from Emacs Planner syntax so that Org can follow it.
  8766. This is still an experimental function, your mileage may vary."
  8767. (cond
  8768. ((member type '("http" "https" "news" "ftp"))
  8769. ;; standard Internet links are the same.
  8770. nil)
  8771. ((and (equal type "irc") (string-match "^//" path))
  8772. ;; Planner has two / at the beginning of an irc link, we have 1.
  8773. ;; We should have zero, actually....
  8774. (setq path (substring path 1)))
  8775. ((and (equal type "lisp") (string-match "^/" path))
  8776. ;; Planner has a slash, we do not.
  8777. (setq type "elisp" path (substring path 1)))
  8778. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  8779. ;; A typical message link. Planner has the id after the final slash,
  8780. ;; we separate it with a hash mark
  8781. (setq path (concat (match-string 1 path) "#"
  8782. (org-remove-angle-brackets (match-string 2 path)))))
  8783. )
  8784. (cons type path))
  8785. (defun org-find-file-at-mouse (ev)
  8786. "Open file link or URL at mouse."
  8787. (interactive "e")
  8788. (mouse-set-point ev)
  8789. (org-open-at-point 'in-emacs))
  8790. (defun org-open-at-mouse (ev)
  8791. "Open file link or URL at mouse.
  8792. See the docstring of `org-open-file' for details."
  8793. (interactive "e")
  8794. (mouse-set-point ev)
  8795. (if (eq major-mode 'org-agenda-mode)
  8796. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  8797. (org-open-at-point))
  8798. (defvar org-window-config-before-follow-link nil
  8799. "The window configuration before following a link.
  8800. This is saved in case the need arises to restore it.")
  8801. (defvar org-open-link-marker (make-marker)
  8802. "Marker pointing to the location where `org-open-at-point; was called.")
  8803. ;;;###autoload
  8804. (defun org-open-at-point-global ()
  8805. "Follow a link like Org-mode does.
  8806. This command can be called in any mode to follow a link that has
  8807. Org-mode syntax."
  8808. (interactive)
  8809. (org-run-like-in-org-mode 'org-open-at-point))
  8810. ;;;###autoload
  8811. (defun org-open-link-from-string (s &optional arg reference-buffer)
  8812. "Open a link in the string S, as if it was in Org-mode."
  8813. (interactive "sLink: \nP")
  8814. (let ((reference-buffer (or reference-buffer (current-buffer))))
  8815. (with-temp-buffer
  8816. (let ((org-inhibit-startup (not reference-buffer)))
  8817. (org-mode)
  8818. (insert s)
  8819. (goto-char (point-min))
  8820. (when reference-buffer
  8821. (setq org-link-abbrev-alist-local
  8822. (with-current-buffer reference-buffer
  8823. org-link-abbrev-alist-local)))
  8824. (org-open-at-point arg reference-buffer)))))
  8825. (defvar org-open-at-point-functions nil
  8826. "Hook that is run when following a link at point.
  8827. Functions in this hook must return t if they identify and follow
  8828. a link at point. If they don't find anything interesting at point,
  8829. they must return nil.")
  8830. (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
  8831. (defun org-open-at-point (&optional arg reference-buffer)
  8832. "Open link at or after point.
  8833. If there is no link at point, this function will search forward up to
  8834. the end of the current line.
  8835. Normally, files will be opened by an appropriate application. If the
  8836. optional prefix argument ARG is non-nil, Emacs will visit the file.
  8837. With a double prefix argument, try to open outside of Emacs, in the
  8838. application the system uses for this file type."
  8839. (interactive "P")
  8840. ;; if in a code block, then open the block's results
  8841. (unless (call-interactively #'org-babel-open-src-block-result)
  8842. (org-load-modules-maybe)
  8843. (move-marker org-open-link-marker (point))
  8844. (setq org-window-config-before-follow-link (current-window-configuration))
  8845. (org-remove-occur-highlights nil nil t)
  8846. (cond
  8847. ((and (org-at-heading-p)
  8848. (not (org-at-timestamp-p t))
  8849. (not (org-in-regexp
  8850. (concat org-plain-link-re "\\|"
  8851. org-bracket-link-regexp "\\|"
  8852. org-angle-link-re "\\|"
  8853. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8854. (not (get-text-property (point) 'org-linked-text)))
  8855. (or (org-offer-links-in-entry arg)
  8856. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8857. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  8858. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  8859. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8860. (not (org-in-regexp org-bracket-link-regexp)))
  8861. (org-footnote-action))
  8862. (t
  8863. (let (type path link line search (pos (point)))
  8864. (catch 'match
  8865. (save-excursion
  8866. (skip-chars-forward "^]\n\r")
  8867. (when (org-in-regexp org-bracket-link-regexp 1)
  8868. (setq link (org-extract-attributes
  8869. (org-link-unescape (org-match-string-no-properties 1))))
  8870. (while (string-match " *\n *" link)
  8871. (setq link (replace-match " " t t link)))
  8872. (setq link (org-link-expand-abbrev link))
  8873. (cond
  8874. ((or (file-name-absolute-p link)
  8875. (string-match "^\\.\\.?/" link))
  8876. (setq type "file" path link))
  8877. ((string-match org-link-re-with-space3 link)
  8878. (setq type (match-string 1 link) path (match-string 2 link)))
  8879. ((string-match "^help:+\\(.+\\)" link)
  8880. (setq type "help" path (match-string 1 link)))
  8881. (t (setq type "thisfile" path link)))
  8882. (throw 'match t)))
  8883. (when (get-text-property (point) 'org-linked-text)
  8884. (setq type "thisfile"
  8885. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8886. (1+ (point)) (point))
  8887. path (buffer-substring
  8888. (or (previous-single-property-change pos 'org-linked-text)
  8889. (point-min))
  8890. (or (next-single-property-change pos 'org-linked-text)
  8891. (point-max))))
  8892. (throw 'match t))
  8893. (save-excursion
  8894. (when (or (org-in-regexp org-angle-link-re)
  8895. (and (goto-char (car (org-in-regexp org-plain-link-re)))
  8896. (save-match-data (not (looking-back "\\[\\[")))))
  8897. (setq type (match-string 1)
  8898. path (org-link-unescape (match-string 2)))
  8899. (throw 'match t)))
  8900. (save-excursion
  8901. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  8902. (setq type "tags"
  8903. path (match-string 1))
  8904. (while (string-match ":" path)
  8905. (setq path (replace-match "+" t t path)))
  8906. (throw 'match t)))
  8907. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8908. (setq type "tree-match"
  8909. path (match-string 1))
  8910. (throw 'match t)))
  8911. (unless path
  8912. (error "No link found"))
  8913. ;; switch back to reference buffer
  8914. ;; needed when if called in a temporary buffer through
  8915. ;; org-open-link-from-string
  8916. (with-current-buffer (or reference-buffer (current-buffer))
  8917. ;; Remove any trailing spaces in path
  8918. (if (string-match " +\\'" path)
  8919. (setq path (replace-match "" t t path)))
  8920. (if (and org-link-translation-function
  8921. (fboundp org-link-translation-function))
  8922. ;; Check if we need to translate the link
  8923. (let ((tmp (funcall org-link-translation-function type path)))
  8924. (setq type (car tmp) path (cdr tmp))))
  8925. (cond
  8926. ((assoc type org-link-protocols)
  8927. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8928. ((equal type "help")
  8929. (let ((f-or-v (intern path)))
  8930. (cond ((fboundp f-or-v)
  8931. (describe-function f-or-v))
  8932. ((boundp f-or-v)
  8933. (describe-variable f-or-v))
  8934. (t (error "Not a known function or variable")))))
  8935. ((equal type "mailto")
  8936. (let ((cmd (car org-link-mailto-program))
  8937. (args (cdr org-link-mailto-program)) args1
  8938. (address path) (subject "") a)
  8939. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8940. (setq address (match-string 1 path)
  8941. subject (org-link-escape (match-string 2 path))))
  8942. (while args
  8943. (cond
  8944. ((not (stringp (car args))) (push (pop args) args1))
  8945. (t (setq a (pop args))
  8946. (if (string-match "%a" a)
  8947. (setq a (replace-match address t t a)))
  8948. (if (string-match "%s" a)
  8949. (setq a (replace-match subject t t a)))
  8950. (push a args1))))
  8951. (apply cmd (nreverse args1))))
  8952. ((member type '("http" "https" "ftp" "news"))
  8953. (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
  8954. (org-link-escape
  8955. path org-link-escape-chars-browser)
  8956. path))))
  8957. ((string= type "doi")
  8958. (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
  8959. (org-link-escape
  8960. path org-link-escape-chars-browser)
  8961. path))))
  8962. ((member type '("message"))
  8963. (browse-url (concat type ":" path)))
  8964. ((string= type "tags")
  8965. (org-tags-view arg path))
  8966. ((string= type "tree-match")
  8967. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8968. ((string= type "file")
  8969. (if (string-match "::\\([0-9]+\\)\\'" path)
  8970. (setq line (string-to-number (match-string 1 path))
  8971. path (substring path 0 (match-beginning 0)))
  8972. (if (string-match "::\\(.+\\)\\'" path)
  8973. (setq search (match-string 1 path)
  8974. path (substring path 0 (match-beginning 0)))))
  8975. (if (string-match "[*?{]" (file-name-nondirectory path))
  8976. (dired path)
  8977. (org-open-file path arg line search)))
  8978. ((string= type "shell")
  8979. (let ((buf (generate-new-buffer "*Org Shell Output"))
  8980. (cmd path))
  8981. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  8982. (string-match org-confirm-shell-link-not-regexp cmd))
  8983. (not org-confirm-shell-link-function)
  8984. (funcall org-confirm-shell-link-function
  8985. (format "Execute \"%s\" in shell? "
  8986. (org-add-props cmd nil
  8987. 'face 'org-warning))))
  8988. (progn
  8989. (message "Executing %s" cmd)
  8990. (shell-command cmd buf)
  8991. (if (featurep 'midnight)
  8992. (setq clean-buffer-list-kill-buffer-names
  8993. (cons buf clean-buffer-list-kill-buffer-names))))
  8994. (error "Abort"))))
  8995. ((string= type "elisp")
  8996. (let ((cmd path))
  8997. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  8998. (string-match org-confirm-elisp-link-not-regexp cmd))
  8999. (not org-confirm-elisp-link-function)
  9000. (funcall org-confirm-elisp-link-function
  9001. (format "Execute \"%s\" as elisp? "
  9002. (org-add-props cmd nil
  9003. 'face 'org-warning))))
  9004. (message "%s => %s" cmd
  9005. (if (equal (string-to-char cmd) ?\()
  9006. (eval (read cmd))
  9007. (call-interactively (read cmd))))
  9008. (error "Abort"))))
  9009. ((and (string= type "thisfile")
  9010. (run-hook-with-args-until-success
  9011. 'org-open-link-functions path)))
  9012. ((string= type "thisfile")
  9013. (if arg
  9014. (switch-to-buffer-other-window
  9015. (org-get-buffer-for-internal-link (current-buffer)))
  9016. (org-mark-ring-push))
  9017. (let ((cmd `(org-link-search
  9018. ,path
  9019. ,(cond ((equal arg '(4)) ''occur)
  9020. ((equal arg '(16)) ''org-occur))
  9021. ,pos)))
  9022. (condition-case nil (let ((org-link-search-inhibit-query t))
  9023. (eval cmd))
  9024. (error (progn (widen) (eval cmd))))))
  9025. (t (browse-url-at-point)))))))
  9026. (move-marker org-open-link-marker nil)
  9027. (run-hook-with-args 'org-follow-link-hook)))
  9028. (defun org-offer-links-in-entry (&optional nth zero)
  9029. "Offer links in the current entry and follow the selected link.
  9030. If there is only one link, follow it immediately as well.
  9031. If NTH is an integer, immediately pick the NTH link found.
  9032. If ZERO is a string, check also this string for a link, and if
  9033. there is one, offer it as link number zero."
  9034. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  9035. "\\(" org-angle-link-re "\\)\\|"
  9036. "\\(" org-plain-link-re "\\)"))
  9037. (cnt ?0)
  9038. (in-emacs (if (integerp nth) nil nth))
  9039. have-zero end links link c)
  9040. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  9041. (push (match-string 0 zero) links)
  9042. (setq cnt (1- cnt) have-zero t))
  9043. (save-excursion
  9044. (org-back-to-heading t)
  9045. (setq end (save-excursion (outline-next-heading) (point)))
  9046. (while (re-search-forward re end t)
  9047. (push (match-string 0) links))
  9048. (setq links (org-uniquify (reverse links))))
  9049. (cond
  9050. ((null links)
  9051. (message "No links"))
  9052. ((equal (length links) 1)
  9053. (setq link (list (car links))))
  9054. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  9055. (setq link (list (nth (if have-zero nth (1- nth)) links))))
  9056. (t ; we have to select a link
  9057. (save-excursion
  9058. (save-window-excursion
  9059. (delete-other-windows)
  9060. (with-output-to-temp-buffer "*Select Link*"
  9061. (mapc (lambda (l)
  9062. (if (not (string-match org-bracket-link-regexp l))
  9063. (princ (format "[%c] %s\n" (incf cnt)
  9064. (org-remove-angle-brackets l)))
  9065. (if (match-end 3)
  9066. (princ (format "[%c] %s (%s)\n" (incf cnt)
  9067. (match-string 3 l) (match-string 1 l)))
  9068. (princ (format "[%c] %s\n" (incf cnt)
  9069. (match-string 1 l))))))
  9070. links))
  9071. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  9072. (message "Select link to open, RET to open all:")
  9073. (setq c (read-char-exclusive))
  9074. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  9075. (when (equal c ?q) (error "Abort"))
  9076. (if (equal c ?\C-m)
  9077. (setq link links)
  9078. (setq nth (- c ?0))
  9079. (if have-zero (setq nth (1+ nth)))
  9080. (unless (and (integerp nth) (>= (length links) nth))
  9081. (error "Invalid link selection"))
  9082. (setq link (list (nth (1- nth) links))))))
  9083. (if link
  9084. (let ((buf (current-buffer)))
  9085. (dolist (l link)
  9086. (org-open-link-from-string l in-emacs buf))
  9087. t)
  9088. nil)))
  9089. ;; Add special file links that specify the way of opening
  9090. (org-add-link-type "file+sys" 'org-open-file-with-system)
  9091. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  9092. (defun org-open-file-with-system (path)
  9093. "Open file at PATH using the system way of opening it."
  9094. (org-open-file path 'system))
  9095. (defun org-open-file-with-emacs (path)
  9096. "Open file at PATH in Emacs."
  9097. (org-open-file path 'emacs))
  9098. (defun org-remove-file-link-modifiers ()
  9099. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  9100. (goto-char (point-min))
  9101. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  9102. (org-if-unprotected
  9103. (replace-match "file:" t t))))
  9104. (eval-after-load "org-exp"
  9105. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  9106. 'org-remove-file-link-modifiers))
  9107. ;;;; Time estimates
  9108. (defun org-get-effort (&optional pom)
  9109. "Get the effort estimate for the current entry."
  9110. (org-entry-get pom org-effort-property))
  9111. ;;; File search
  9112. (defvar org-create-file-search-functions nil
  9113. "List of functions to construct the right search string for a file link.
  9114. These functions are called in turn with point at the location to
  9115. which the link should point.
  9116. A function in the hook should first test if it would like to
  9117. handle this file type, for example by checking the `major-mode'
  9118. or the file extension. If it decides not to handle this file, it
  9119. should just return nil to give other functions a chance. If it
  9120. does handle the file, it must return the search string to be used
  9121. when following the link. The search string will be part of the
  9122. file link, given after a double colon, and `org-open-at-point'
  9123. will automatically search for it. If special measures must be
  9124. taken to make the search successful, another function should be
  9125. added to the companion hook `org-execute-file-search-functions',
  9126. which see.
  9127. A function in this hook may also use `setq' to set the variable
  9128. `description' to provide a suggestion for the descriptive text to
  9129. be used for this link when it gets inserted into an Org-mode
  9130. buffer with \\[org-insert-link].")
  9131. (defvar org-execute-file-search-functions nil
  9132. "List of functions to execute a file search triggered by a link.
  9133. Functions added to this hook must accept a single argument, the
  9134. search string that was part of the file link, the part after the
  9135. double colon. The function must first check if it would like to
  9136. handle this search, for example by checking the `major-mode' or
  9137. the file extension. If it decides not to handle this search, it
  9138. should just return nil to give other functions a chance. If it
  9139. does handle the search, it must return a non-nil value to keep
  9140. other functions from trying.
  9141. Each function can access the current prefix argument through the
  9142. variable `current-prefix-argument'. Note that a single prefix is
  9143. used to force opening a link in Emacs, so it may be good to only
  9144. use a numeric or double prefix to guide the search function.
  9145. In case this is needed, a function in this hook can also restore
  9146. the window configuration before `org-open-at-point' was called using:
  9147. (set-window-configuration org-window-config-before-follow-link)")
  9148. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  9149. (defun org-link-search (s &optional type avoid-pos stealth)
  9150. "Search for a link search option.
  9151. If S is surrounded by forward slashes, it is interpreted as a
  9152. regular expression. In org-mode files, this will create an `org-occur'
  9153. sparse tree. In ordinary files, `occur' will be used to list matches.
  9154. If the current buffer is in `dired-mode', grep will be used to search
  9155. in all files. If AVOID-POS is given, ignore matches near that position.
  9156. When optional argument STEALTH is non-nil, do not modify
  9157. visibility around point, thus ignoring
  9158. `org-show-hierarchy-above', `org-show-following-heading' and
  9159. `org-show-siblings' variables."
  9160. (let ((case-fold-search t)
  9161. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  9162. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  9163. (append '(("") (" ") ("\t") ("\n"))
  9164. org-emphasis-alist)
  9165. "\\|") "\\)"))
  9166. (pos (point))
  9167. (pre nil) (post nil)
  9168. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  9169. (cond
  9170. ;; First check if there are any special search functions
  9171. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9172. ;; Now try the builtin stuff
  9173. ((and (equal (string-to-char s0) ?#)
  9174. (> (length s0) 1)
  9175. (save-excursion
  9176. (goto-char (point-min))
  9177. (and
  9178. (re-search-forward
  9179. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  9180. (setq type 'dedicated
  9181. pos (match-beginning 0))))
  9182. ;; There is an exact target for this
  9183. (goto-char pos)
  9184. (org-back-to-heading t)))
  9185. ((save-excursion
  9186. (goto-char (point-min))
  9187. (and
  9188. (re-search-forward
  9189. (concat "<<" (regexp-quote s0) ">>") nil t)
  9190. (setq type 'dedicated
  9191. pos (match-beginning 0))))
  9192. ;; There is an exact target for this
  9193. (goto-char pos))
  9194. ((save-excursion
  9195. (goto-char (point-min))
  9196. (and
  9197. (re-search-forward
  9198. (format "^[ \t]*#\\+TARGET: %s" (regexp-quote s0)) nil t)
  9199. (setq type 'dedicated pos (match-beginning 0))))
  9200. ;; Found an invisible target.
  9201. (goto-char pos))
  9202. ((save-excursion
  9203. (goto-char (point-min))
  9204. (and
  9205. (re-search-forward
  9206. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9207. (setq type 'dedicated pos (match-beginning 0))))
  9208. ;; Found an element with a matching #+name affiliated keyword.
  9209. (goto-char pos))
  9210. ((and (string-match "^(\\(.*\\))$" s0)
  9211. (save-excursion
  9212. (goto-char (point-min))
  9213. (and
  9214. (re-search-forward
  9215. (concat "[^[]" (regexp-quote
  9216. (format org-coderef-label-format
  9217. (match-string 1 s0))))
  9218. nil t)
  9219. (setq type 'dedicated
  9220. pos (1+ (match-beginning 0))))))
  9221. ;; There is a coderef target for this
  9222. (goto-char pos))
  9223. ((string-match "^/\\(.*\\)/$" s)
  9224. ;; A regular expression
  9225. (cond
  9226. ((derived-mode-p 'org-mode)
  9227. (org-occur (match-string 1 s)))
  9228. ;;((eq major-mode 'dired-mode)
  9229. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  9230. (t (org-do-occur (match-string 1 s)))))
  9231. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9232. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9233. (goto-char (point-min))
  9234. (cond
  9235. ((let (case-fold-search)
  9236. (re-search-forward (format org-complex-heading-regexp-format
  9237. (regexp-quote s))
  9238. nil t))
  9239. ;; OK, found a match
  9240. (setq type 'dedicated)
  9241. (goto-char (match-beginning 0)))
  9242. ((and (not org-link-search-inhibit-query)
  9243. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9244. (y-or-n-p "No match - create this as a new heading? "))
  9245. (goto-char (point-max))
  9246. (or (bolp) (newline))
  9247. (insert "* " s "\n")
  9248. (beginning-of-line 0))
  9249. (t
  9250. (goto-char pos)
  9251. (error "No match"))))
  9252. (t
  9253. ;; A normal search string
  9254. (when (equal (string-to-char s) ?*)
  9255. ;; Anchor on headlines, post may include tags.
  9256. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9257. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9258. s (substring s 1)))
  9259. (remove-text-properties
  9260. 0 (length s)
  9261. '(face nil mouse-face nil keymap nil fontified nil) s)
  9262. ;; Make a series of regular expressions to find a match
  9263. (setq words (org-split-string s "[ \n\r\t]+")
  9264. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9265. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9266. "\\)" markers)
  9267. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  9268. re2a (concat "[ \t\r\n]" re2a_)
  9269. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9270. re4 (concat "[^a-zA-Z_]" re4_)
  9271. re1 (concat pre re2 post)
  9272. re3 (concat pre (if pre re4_ re4) post)
  9273. re5 (concat pre ".*" re4)
  9274. re2 (concat pre re2)
  9275. re2a (concat pre (if pre re2a_ re2a))
  9276. re4 (concat pre (if pre re4_ re4))
  9277. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9278. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9279. re5 "\\)"
  9280. ))
  9281. (cond
  9282. ((eq type 'org-occur) (org-occur reall))
  9283. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9284. (t (goto-char (point-min))
  9285. (setq type 'fuzzy)
  9286. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  9287. (org-search-not-self 1 re1 nil t)
  9288. (org-search-not-self 1 re2 nil t)
  9289. (org-search-not-self 1 re2a nil t)
  9290. (org-search-not-self 1 re3 nil t)
  9291. (org-search-not-self 1 re4 nil t)
  9292. (org-search-not-self 1 re5 nil t)
  9293. )
  9294. (goto-char (match-beginning 1))
  9295. (goto-char pos)
  9296. (error "No match"))))))
  9297. (and (derived-mode-p 'org-mode)
  9298. (not stealth)
  9299. (org-show-context 'link-search))
  9300. type))
  9301. (defun org-search-not-self (group &rest args)
  9302. "Execute `re-search-forward', but only accept matches that do not
  9303. enclose the position of `org-open-link-marker'."
  9304. (let ((m org-open-link-marker))
  9305. (catch 'exit
  9306. (while (apply 're-search-forward args)
  9307. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9308. (goto-char (match-end group))
  9309. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9310. (> (match-beginning 0) (marker-position m))
  9311. (< (match-end 0) (marker-position m)))
  9312. (save-match-data
  9313. (or (not (org-in-regexp
  9314. org-bracket-link-analytic-regexp 1))
  9315. (not (match-end 4)) ; no description
  9316. (and (<= (match-beginning 4) (point))
  9317. (>= (match-end 4) (point))))))
  9318. (throw 'exit (point))))))))
  9319. (defun org-get-buffer-for-internal-link (buffer)
  9320. "Return a buffer to be used for displaying the link target of internal links."
  9321. (cond
  9322. ((not org-display-internal-link-with-indirect-buffer)
  9323. buffer)
  9324. ((string-match "(Clone)$" (buffer-name buffer))
  9325. (message "Buffer is already a clone, not making another one")
  9326. ;; we also do not modify visibility in this case
  9327. buffer)
  9328. (t ; make a new indirect buffer for displaying the link
  9329. (let* ((bn (buffer-name buffer))
  9330. (ibn (concat bn "(Clone)"))
  9331. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9332. (with-current-buffer ib (org-overview))
  9333. ib))))
  9334. (defun org-do-occur (regexp &optional cleanup)
  9335. "Call the Emacs command `occur'.
  9336. If CLEANUP is non-nil, remove the printout of the regular expression
  9337. in the *Occur* buffer. This is useful if the regex is long and not useful
  9338. to read."
  9339. (occur regexp)
  9340. (when cleanup
  9341. (let ((cwin (selected-window)) win beg end)
  9342. (when (setq win (get-buffer-window "*Occur*"))
  9343. (select-window win))
  9344. (goto-char (point-min))
  9345. (when (re-search-forward "match[a-z]+" nil t)
  9346. (setq beg (match-end 0))
  9347. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9348. (setq end (1- (match-beginning 0)))))
  9349. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9350. (goto-char (point-min))
  9351. (select-window cwin))))
  9352. ;;; The mark ring for links jumps
  9353. (defvar org-mark-ring nil
  9354. "Mark ring for positions before jumps in Org-mode.")
  9355. (defvar org-mark-ring-last-goto nil
  9356. "Last position in the mark ring used to go back.")
  9357. ;; Fill and close the ring
  9358. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9359. (loop for i from 1 to org-mark-ring-length do
  9360. (push (make-marker) org-mark-ring))
  9361. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9362. org-mark-ring)
  9363. (defun org-mark-ring-push (&optional pos buffer)
  9364. "Put the current position or POS into the mark ring and rotate it."
  9365. (interactive)
  9366. (setq pos (or pos (point)))
  9367. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9368. (move-marker (car org-mark-ring)
  9369. (or pos (point))
  9370. (or buffer (current-buffer)))
  9371. (message "%s"
  9372. (substitute-command-keys
  9373. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9374. (defun org-mark-ring-goto (&optional n)
  9375. "Jump to the previous position in the mark ring.
  9376. With prefix arg N, jump back that many stored positions. When
  9377. called several times in succession, walk through the entire ring.
  9378. Org-mode commands jumping to a different position in the current file,
  9379. or to another Org-mode file, automatically push the old position
  9380. onto the ring."
  9381. (interactive "p")
  9382. (let (p m)
  9383. (if (eq last-command this-command)
  9384. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9385. (setq p org-mark-ring))
  9386. (setq org-mark-ring-last-goto p)
  9387. (setq m (car p))
  9388. (org-pop-to-buffer-same-window (marker-buffer m))
  9389. (goto-char m)
  9390. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9391. (defun org-remove-angle-brackets (s)
  9392. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9393. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9394. s)
  9395. (defun org-add-angle-brackets (s)
  9396. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9397. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9398. s)
  9399. (defun org-remove-double-quotes (s)
  9400. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9401. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9402. s)
  9403. ;;; Following specific links
  9404. (defun org-follow-timestamp-link ()
  9405. (cond
  9406. ((org-at-date-range-p t)
  9407. (let ((org-agenda-start-on-weekday)
  9408. (t1 (match-string 1))
  9409. (t2 (match-string 2)))
  9410. (setq t1 (time-to-days (org-time-string-to-time t1))
  9411. t2 (time-to-days (org-time-string-to-time t2)))
  9412. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  9413. ((org-at-timestamp-p t)
  9414. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9415. (substring (match-string 1) 0 10)))
  9416. 1))
  9417. (t (error "This should not happen"))))
  9418. ;;; Following file links
  9419. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9420. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9421. (declare-function mailcap-mime-info
  9422. "mailcap" (string &optional request no-decode))
  9423. (defvar org-wait nil)
  9424. (defun org-open-file (path &optional in-emacs line search)
  9425. "Open the file at PATH.
  9426. First, this expands any special file name abbreviations. Then the
  9427. configuration variable `org-file-apps' is checked if it contains an
  9428. entry for this file type, and if yes, the corresponding command is launched.
  9429. If no application is found, Emacs simply visits the file.
  9430. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9431. With a double \\[universal-argument] \\[universal-argument] \
  9432. prefix arg, Org tries to avoid opening in Emacs
  9433. and to use an external application to visit the file.
  9434. Optional LINE specifies a line to go to, optional SEARCH a string
  9435. to search for. If LINE or SEARCH is given, the file will be
  9436. opened in Emacs, unless an entry from org-file-apps that makes
  9437. use of groups in a regexp matches.
  9438. If you want to change the way frames are used when following a
  9439. link, please customize `org-link-frame-setup'.
  9440. If the file does not exist, an error is thrown."
  9441. (let* ((file (if (equal path "")
  9442. buffer-file-name
  9443. (substitute-in-file-name (expand-file-name path))))
  9444. (file-apps (append org-file-apps (org-default-apps)))
  9445. (apps (org-remove-if
  9446. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9447. (apps-dlink (org-remove-if-not
  9448. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9449. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9450. (dirp (if remp nil (file-directory-p file)))
  9451. (file (if (and dirp org-open-directory-means-index-dot-org)
  9452. (concat (file-name-as-directory file) "index.org")
  9453. file))
  9454. (a-m-a-p (assq 'auto-mode apps))
  9455. (dfile (downcase file))
  9456. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9457. (link (cond ((and (eq line nil)
  9458. (eq search nil))
  9459. file)
  9460. (line
  9461. (concat file "::" (number-to-string line)))
  9462. (search
  9463. (concat file "::" search))))
  9464. (dlink (downcase link))
  9465. (old-buffer (current-buffer))
  9466. (old-pos (point))
  9467. (old-mode major-mode)
  9468. ext cmd link-match-data)
  9469. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9470. (setq ext (match-string 1 dfile))
  9471. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9472. (setq ext (match-string 1 dfile))))
  9473. (cond
  9474. ((member in-emacs '((16) system))
  9475. (setq cmd (cdr (assoc 'system apps))))
  9476. (in-emacs (setq cmd 'emacs))
  9477. (t
  9478. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9479. (and dirp (cdr (assoc 'directory apps)))
  9480. ; first, try matching against apps-dlink
  9481. ; if we get a match here, store the match data for later
  9482. (let ((match (assoc-default dlink apps-dlink
  9483. 'string-match)))
  9484. (if match
  9485. (progn (setq link-match-data (match-data))
  9486. match)
  9487. (progn (setq in-emacs (or in-emacs line search))
  9488. nil))) ; if we have no match in apps-dlink,
  9489. ; always open the file in emacs if line or search
  9490. ; is given (for backwards compatibility)
  9491. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9492. 'string-match)
  9493. (cdr (assoc ext apps))
  9494. (cdr (assoc t apps))))))
  9495. (when (eq cmd 'system)
  9496. (setq cmd (cdr (assoc 'system apps))))
  9497. (when (eq cmd 'default)
  9498. (setq cmd (cdr (assoc t apps))))
  9499. (when (eq cmd 'mailcap)
  9500. (require 'mailcap)
  9501. (mailcap-parse-mailcaps)
  9502. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9503. (command (mailcap-mime-info mime-type)))
  9504. (if (stringp command)
  9505. (setq cmd command)
  9506. (setq cmd 'emacs))))
  9507. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  9508. (not (file-exists-p file))
  9509. (not org-open-non-existing-files))
  9510. (error "No such file: %s" file))
  9511. (cond
  9512. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  9513. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  9514. (while (string-match "['\"]%s['\"]" cmd)
  9515. (setq cmd (replace-match "%s" t t cmd)))
  9516. (while (string-match "%s" cmd)
  9517. (setq cmd (replace-match
  9518. (save-match-data
  9519. (shell-quote-argument
  9520. (convert-standard-filename file)))
  9521. t t cmd)))
  9522. ;; Replace "%1", "%2" etc. in command with group matches from regex
  9523. (save-match-data
  9524. (let ((match-index 1)
  9525. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  9526. (set-match-data link-match-data)
  9527. (while (<= match-index number-of-groups)
  9528. (let ((regex (concat "%" (number-to-string match-index)))
  9529. (replace-with (match-string match-index dlink)))
  9530. (while (string-match regex cmd)
  9531. (setq cmd (replace-match replace-with t t cmd))))
  9532. (setq match-index (+ match-index 1)))))
  9533. (save-window-excursion
  9534. (message "Running %s...done" cmd)
  9535. (start-process-shell-command cmd nil cmd)
  9536. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  9537. ((or (stringp cmd)
  9538. (eq cmd 'emacs))
  9539. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  9540. (widen)
  9541. (if line (org-goto-line line)
  9542. (if search (org-link-search search))))
  9543. ((consp cmd)
  9544. (let ((file (convert-standard-filename file)))
  9545. (save-match-data
  9546. (set-match-data link-match-data)
  9547. (eval cmd))))
  9548. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  9549. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  9550. (or (not (equal old-buffer (current-buffer)))
  9551. (not (equal old-pos (point))))
  9552. (org-mark-ring-push old-pos old-buffer))))
  9553. (defun org-file-apps-entry-match-against-dlink-p (entry)
  9554. "This function returns non-nil if `entry' uses a regular
  9555. expression which should be matched against the whole link by
  9556. org-open-file.
  9557. It assumes that is the case when the entry uses a regular
  9558. expression which has at least one grouping construct and the
  9559. action is either a lisp form or a command string containing
  9560. '%1', i.e. using at least one subexpression match as a
  9561. parameter."
  9562. (let ((selector (car entry))
  9563. (action (cdr entry)))
  9564. (if (stringp selector)
  9565. (and (> (regexp-opt-depth selector) 0)
  9566. (or (and (stringp action)
  9567. (string-match "%[0-9]" action))
  9568. (consp action)))
  9569. nil)))
  9570. (defun org-default-apps ()
  9571. "Return the default applications for this operating system."
  9572. (cond
  9573. ((eq system-type 'darwin)
  9574. org-file-apps-defaults-macosx)
  9575. ((eq system-type 'windows-nt)
  9576. org-file-apps-defaults-windowsnt)
  9577. (t org-file-apps-defaults-gnu)))
  9578. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  9579. "Convert extensions to regular expressions in the cars of LIST.
  9580. Also, weed out any non-string entries, because the return value is used
  9581. only for regexp matching.
  9582. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  9583. point to the symbol `emacs', indicating that the file should
  9584. be opened in Emacs."
  9585. (append
  9586. (delq nil
  9587. (mapcar (lambda (x)
  9588. (if (not (stringp (car x)))
  9589. nil
  9590. (if (string-match "\\W" (car x))
  9591. x
  9592. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  9593. list))
  9594. (if add-auto-mode
  9595. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  9596. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  9597. (defun org-file-remote-p (file)
  9598. "Test whether FILE specifies a location on a remote system.
  9599. Return non-nil if the location is indeed remote.
  9600. For example, the filename \"/user@host:/foo\" specifies a location
  9601. on the system \"/user@host:\"."
  9602. (cond ((fboundp 'file-remote-p)
  9603. (file-remote-p file))
  9604. ((fboundp 'tramp-handle-file-remote-p)
  9605. (tramp-handle-file-remote-p file))
  9606. ((and (boundp 'ange-ftp-name-format)
  9607. (string-match (car ange-ftp-name-format) file))
  9608. t)))
  9609. ;;;; Refiling
  9610. (defun org-get-org-file ()
  9611. "Read a filename, with default directory `org-directory'."
  9612. (let ((default (or org-default-notes-file remember-data-file)))
  9613. (read-file-name (format "File name [%s]: " default)
  9614. (file-name-as-directory org-directory)
  9615. default)))
  9616. (defun org-notes-order-reversed-p ()
  9617. "Check if the current file should receive notes in reversed order."
  9618. (cond
  9619. ((not org-reverse-note-order) nil)
  9620. ((eq t org-reverse-note-order) t)
  9621. ((not (listp org-reverse-note-order)) nil)
  9622. (t (catch 'exit
  9623. (let ((all org-reverse-note-order)
  9624. entry)
  9625. (while (setq entry (pop all))
  9626. (if (string-match (car entry) buffer-file-name)
  9627. (throw 'exit (cdr entry))))
  9628. nil)))))
  9629. (defvar org-refile-target-table nil
  9630. "The list of refile targets, created by `org-refile'.")
  9631. (defvar org-agenda-new-buffers nil
  9632. "Buffers created to visit agenda files.")
  9633. (defvar org-refile-cache nil
  9634. "Cache for refile targets.")
  9635. (defvar org-refile-markers nil
  9636. "All the markers used for caching refile locations.")
  9637. (defun org-refile-marker (pos)
  9638. "Get a new refile marker, but only if caching is in use."
  9639. (if (not org-refile-use-cache)
  9640. pos
  9641. (let ((m (make-marker)))
  9642. (move-marker m pos)
  9643. (push m org-refile-markers)
  9644. m)))
  9645. (defun org-refile-cache-clear ()
  9646. "Clear the refile cache and disable all the markers."
  9647. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  9648. (setq org-refile-markers nil)
  9649. (setq org-refile-cache nil)
  9650. (message "Refile cache has been cleared"))
  9651. (defun org-refile-cache-check-set (set)
  9652. "Check if all the markers in the cache still have live buffers."
  9653. (let (marker)
  9654. (catch 'exit
  9655. (while (and set (setq marker (nth 3 (pop set))))
  9656. ;; if org-refile-use-outline-path is 'file, marker may be nil
  9657. (when (and marker (null (marker-buffer marker)))
  9658. (message "not found") (sit-for 3)
  9659. (throw 'exit nil)))
  9660. t)))
  9661. (defun org-refile-cache-put (set &rest identifiers)
  9662. "Push the refile targets SET into the cache, under IDENTIFIERS."
  9663. (let* ((key (sha1 (prin1-to-string identifiers)))
  9664. (entry (assoc key org-refile-cache)))
  9665. (if entry
  9666. (setcdr entry set)
  9667. (push (cons key set) org-refile-cache))))
  9668. (defun org-refile-cache-get (&rest identifiers)
  9669. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  9670. (cond
  9671. ((not org-refile-cache) nil)
  9672. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  9673. (t
  9674. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  9675. org-refile-cache))))
  9676. (and set (org-refile-cache-check-set set) set)))))
  9677. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  9678. "Produce a table with refile targets."
  9679. (let ((case-fold-search nil)
  9680. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  9681. (entries (or org-refile-targets '((nil . (:level . 1)))))
  9682. targets tgs txt re files f desc descre fast-path-p level pos0)
  9683. (message "Getting targets...")
  9684. (with-current-buffer (or default-buffer (current-buffer))
  9685. (while (setq entry (pop entries))
  9686. (setq files (car entry) desc (cdr entry))
  9687. (setq fast-path-p nil)
  9688. (cond
  9689. ((null files) (setq files (list (current-buffer))))
  9690. ((eq files 'org-agenda-files)
  9691. (setq files (org-agenda-files 'unrestricted)))
  9692. ((and (symbolp files) (fboundp files))
  9693. (setq files (funcall files)))
  9694. ((and (symbolp files) (boundp files))
  9695. (setq files (symbol-value files))))
  9696. (if (stringp files) (setq files (list files)))
  9697. (cond
  9698. ((eq (car desc) :tag)
  9699. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  9700. ((eq (car desc) :todo)
  9701. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  9702. ((eq (car desc) :regexp)
  9703. (setq descre (cdr desc)))
  9704. ((eq (car desc) :level)
  9705. (setq descre (concat "^\\*\\{" (number-to-string
  9706. (if org-odd-levels-only
  9707. (1- (* 2 (cdr desc)))
  9708. (cdr desc)))
  9709. "\\}[ \t]")))
  9710. ((eq (car desc) :maxlevel)
  9711. (setq fast-path-p t)
  9712. (setq descre (concat "^\\*\\{1," (number-to-string
  9713. (if org-odd-levels-only
  9714. (1- (* 2 (cdr desc)))
  9715. (cdr desc)))
  9716. "\\}[ \t]")))
  9717. (t (error "Bad refiling target description %s" desc)))
  9718. (while (setq f (pop files))
  9719. (with-current-buffer
  9720. (if (bufferp f) f (org-get-agenda-file-buffer f))
  9721. (or
  9722. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  9723. (progn
  9724. (if (bufferp f) (setq f (buffer-file-name
  9725. (buffer-base-buffer f))))
  9726. (setq f (and f (expand-file-name f)))
  9727. (if (eq org-refile-use-outline-path 'file)
  9728. (push (list (file-name-nondirectory f) f nil nil) tgs))
  9729. (save-excursion
  9730. (save-restriction
  9731. (widen)
  9732. (goto-char (point-min))
  9733. (while (re-search-forward descre nil t)
  9734. (goto-char (setq pos0 (point-at-bol)))
  9735. (catch 'next
  9736. (when org-refile-target-verify-function
  9737. (save-match-data
  9738. (or (funcall org-refile-target-verify-function)
  9739. (throw 'next t))))
  9740. (when (and (looking-at org-complex-heading-regexp)
  9741. (not (member (match-string 4) excluded-entries))
  9742. (match-string 4))
  9743. (setq level (org-reduced-level
  9744. (- (match-end 1) (match-beginning 1)))
  9745. txt (org-link-display-format (match-string 4))
  9746. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  9747. re (format org-complex-heading-regexp-format
  9748. (regexp-quote (match-string 4))))
  9749. (when org-refile-use-outline-path
  9750. (setq txt (mapconcat
  9751. 'org-protect-slash
  9752. (append
  9753. (if (eq org-refile-use-outline-path
  9754. 'file)
  9755. (list (file-name-nondirectory
  9756. (buffer-file-name
  9757. (buffer-base-buffer))))
  9758. (if (eq org-refile-use-outline-path
  9759. 'full-file-path)
  9760. (list (buffer-file-name
  9761. (buffer-base-buffer)))))
  9762. (org-get-outline-path fast-path-p
  9763. level txt)
  9764. (list txt))
  9765. "/")))
  9766. (push (list txt f re (org-refile-marker (point)))
  9767. tgs)))
  9768. (when (= (point) pos0)
  9769. ;; verification function has not moved point
  9770. (goto-char (point-at-eol))))))))
  9771. (when org-refile-use-cache
  9772. (org-refile-cache-put tgs (buffer-file-name) descre))
  9773. (setq targets (append tgs targets))
  9774. ))))
  9775. (message "Getting targets...done")
  9776. (nreverse targets)))
  9777. (defun org-protect-slash (s)
  9778. (while (string-match "/" s)
  9779. (setq s (replace-match "\\" t t s)))
  9780. s)
  9781. (defvar org-olpa (make-vector 20 nil))
  9782. (defun org-get-outline-path (&optional fastp level heading)
  9783. "Return the outline path to the current entry, as a list.
  9784. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  9785. routine which makes outline path derivations for an entire file,
  9786. avoiding backtracing. Refile target collection makes use of that."
  9787. (if fastp
  9788. (progn
  9789. (if (> level 19)
  9790. (error "Outline path failure, more than 19 levels"))
  9791. (loop for i from level upto 19 do
  9792. (aset org-olpa i nil))
  9793. (prog1
  9794. (delq nil (append org-olpa nil))
  9795. (aset org-olpa level heading)))
  9796. (let (rtn case-fold-search)
  9797. (save-excursion
  9798. (save-restriction
  9799. (widen)
  9800. (while (org-up-heading-safe)
  9801. (when (looking-at org-complex-heading-regexp)
  9802. (push (org-match-string-no-properties 4) rtn)))
  9803. rtn)))))
  9804. (defun org-format-outline-path (path &optional width prefix)
  9805. "Format the outline path PATH for display.
  9806. Width is the maximum number of characters that is available.
  9807. Prefix is a prefix to be included in the returned string,
  9808. such as the file name."
  9809. (setq width (or width 79))
  9810. (if prefix (setq width (- width (length prefix))))
  9811. (if (not path)
  9812. (or prefix "")
  9813. (let* ((nsteps (length path))
  9814. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  9815. (maxwidth (if (<= total-width width)
  9816. 10000 ;; everything fits
  9817. ;; we need to shorten the level headings
  9818. (/ (- width nsteps) nsteps)))
  9819. (org-odd-levels-only nil)
  9820. (n 0)
  9821. (total (1+ (length prefix))))
  9822. (setq maxwidth (max maxwidth 10))
  9823. (concat prefix
  9824. (mapconcat
  9825. (lambda (h)
  9826. (setq n (1+ n))
  9827. (if (and (= n nsteps) (< maxwidth 10000))
  9828. (setq maxwidth (- total-width total)))
  9829. (if (< (length h) maxwidth)
  9830. (progn (setq total (+ total (length h) 1)) h)
  9831. (setq h (substring h 0 (- maxwidth 2))
  9832. total (+ total maxwidth 1))
  9833. (if (string-match "[ \t]+\\'" h)
  9834. (setq h (substring h 0 (match-beginning 0))))
  9835. (setq h (concat h "..")))
  9836. (org-add-props h nil 'face
  9837. (nth (% (1- n) org-n-level-faces)
  9838. org-level-faces))
  9839. h)
  9840. path "/")))))
  9841. (defun org-display-outline-path (&optional file current)
  9842. "Display the current outline path in the echo area."
  9843. (interactive "P")
  9844. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  9845. (case-fold-search nil)
  9846. (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
  9847. (if current (setq path (append path
  9848. (save-excursion
  9849. (org-back-to-heading t)
  9850. (if (looking-at org-complex-heading-regexp)
  9851. (list (match-string 4)))))))
  9852. (message "%s"
  9853. (org-format-outline-path
  9854. path
  9855. (1- (frame-width))
  9856. (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
  9857. (defvar org-refile-history nil
  9858. "History for refiling operations.")
  9859. (defvar org-after-refile-insert-hook nil
  9860. "Hook run after `org-refile' has inserted its stuff at the new location.
  9861. Note that this is still *before* the stuff will be removed from
  9862. the *old* location.")
  9863. (defvar org-capture-last-stored-marker)
  9864. (defun org-refile (&optional goto default-buffer rfloc)
  9865. "Move the entry or entries at point to another heading.
  9866. The list of target headings is compiled using the information in
  9867. `org-refile-targets', which see.
  9868. At the target location, the entry is filed as a subitem of the target
  9869. heading. Depending on `org-reverse-note-order', the new subitem will
  9870. either be the first or the last subitem.
  9871. If there is an active region, all entries in that region will be moved.
  9872. However, the region must fulfill the requirement that the first heading
  9873. is the first one sets the top-level of the moved text - at most siblings
  9874. below it are allowed.
  9875. With prefix arg GOTO, the command will only visit the target location
  9876. and not actually move anything.
  9877. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  9878. go to the location where the last refiling operation has put the subtree.
  9879. With a prefix argument of `2', refile to the running clock.
  9880. RFLOC can be a refile location obtained in a different way.
  9881. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  9882. If you are using target caching (see `org-refile-use-cache'),
  9883. you have to clear the target cache in order to find new targets.
  9884. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  9885. prefix argument (`C-u C-u C-u C-c C-w')."
  9886. (interactive "P")
  9887. (if (member goto '(0 (64)))
  9888. (org-refile-cache-clear)
  9889. (let* ((cbuf (current-buffer))
  9890. (regionp (org-region-active-p))
  9891. (region-start (and regionp (region-beginning)))
  9892. (region-end (and regionp (region-end)))
  9893. (region-length (and regionp (- region-end region-start)))
  9894. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9895. pos it nbuf file re level reversed)
  9896. (setq last-command nil)
  9897. (when regionp
  9898. (goto-char region-start)
  9899. (or (bolp) (goto-char (point-at-bol)))
  9900. (setq region-start (point))
  9901. (unless (or (org-kill-is-subtree-p
  9902. (buffer-substring region-start region-end))
  9903. (prog1 org-refile-active-region-within-subtree
  9904. (org-toggle-heading)))
  9905. (error "The region is not a (sequence of) subtree(s)")))
  9906. (if (equal goto '(16))
  9907. (org-refile-goto-last-stored)
  9908. (when (or
  9909. (and (equal goto 2)
  9910. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9911. (prog1
  9912. (setq it (list (or org-clock-heading "running clock")
  9913. (buffer-file-name
  9914. (marker-buffer org-clock-hd-marker))
  9915. ""
  9916. (marker-position org-clock-hd-marker)))
  9917. (setq goto nil)))
  9918. (setq it (or rfloc
  9919. (let (heading-text)
  9920. (save-excursion
  9921. (unless goto
  9922. (org-back-to-heading t)
  9923. (setq heading-text
  9924. (nth 4 (org-heading-components))))
  9925. (org-refile-get-location
  9926. (cond (goto "Goto")
  9927. (regionp "Refile region to")
  9928. (t (concat "Refile subtree \""
  9929. heading-text "\" to")))
  9930. default-buffer
  9931. (and (not (equal '(4) goto))
  9932. org-refile-allow-creating-parent-nodes)
  9933. goto))))))
  9934. (setq file (nth 1 it)
  9935. re (nth 2 it)
  9936. pos (nth 3 it))
  9937. (if (and (not goto)
  9938. pos
  9939. (equal (buffer-file-name) file)
  9940. (if regionp
  9941. (and (>= pos region-start)
  9942. (<= pos region-end))
  9943. (and (>= pos (point))
  9944. (< pos (save-excursion
  9945. (org-end-of-subtree t t))))))
  9946. (error "Cannot refile to position inside the tree or region"))
  9947. (setq nbuf (or (find-buffer-visiting file)
  9948. (find-file-noselect file)))
  9949. (if goto
  9950. (progn
  9951. (org-pop-to-buffer-same-window nbuf)
  9952. (goto-char pos)
  9953. (org-show-context 'org-goto))
  9954. (if regionp
  9955. (progn
  9956. (org-kill-new (buffer-substring region-start region-end))
  9957. (org-save-markers-in-region region-start region-end))
  9958. (org-copy-subtree 1 nil t))
  9959. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9960. (find-file-noselect file)))
  9961. (setq reversed (org-notes-order-reversed-p))
  9962. (save-excursion
  9963. (save-restriction
  9964. (widen)
  9965. (if pos
  9966. (progn
  9967. (goto-char pos)
  9968. (looking-at org-outline-regexp)
  9969. (setq level (org-get-valid-level (funcall outline-level) 1))
  9970. (goto-char
  9971. (if reversed
  9972. (or (outline-next-heading) (point-max))
  9973. (or (save-excursion (org-get-next-sibling))
  9974. (org-end-of-subtree t t)
  9975. (point-max)))))
  9976. (setq level 1)
  9977. (if (not reversed)
  9978. (goto-char (point-max))
  9979. (goto-char (point-min))
  9980. (or (outline-next-heading) (goto-char (point-max)))))
  9981. (if (not (bolp)) (newline))
  9982. (org-paste-subtree level)
  9983. (when org-log-refile
  9984. (org-add-log-setup 'refile nil nil 'findpos
  9985. org-log-refile)
  9986. (unless (eq org-log-refile 'note)
  9987. (save-excursion (org-add-log-note))))
  9988. (and org-auto-align-tags
  9989. (let ((org-loop-over-headlines-in-active-region nil))
  9990. (org-set-tags nil t)))
  9991. (bookmark-set "org-refile-last-stored")
  9992. ;; If we are refiling for capture, make sure that the
  9993. ;; last-capture pointers point here
  9994. (when (org-bound-and-true-p org-refile-for-capture)
  9995. (bookmark-set "org-capture-last-stored-marker")
  9996. (move-marker org-capture-last-stored-marker (point)))
  9997. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9998. (run-hooks 'org-after-refile-insert-hook))))
  9999. (if regionp
  10000. (delete-region (point) (+ (point) region-length))
  10001. (org-cut-subtree))
  10002. (when (featurep 'org-inlinetask)
  10003. (org-inlinetask-remove-END-maybe))
  10004. (setq org-markers-to-move nil)
  10005. (message "Refiled to \"%s\" in file %s" (car it) file)))))))
  10006. (defun org-refile-goto-last-stored ()
  10007. "Go to the location where the last refile was stored."
  10008. (interactive)
  10009. (bookmark-jump "org-refile-last-stored")
  10010. (message "This is the location of the last refile"))
  10011. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  10012. no-exclude)
  10013. "Prompt the user for a refile location, using PROMPT.
  10014. PROMPT should not be suffixed with a colon and a space, because
  10015. this function appends the default value from
  10016. `org-refile-history' automatically, if that is not empty.
  10017. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  10018. this is used for the GOTO interface."
  10019. (let ((org-refile-targets org-refile-targets)
  10020. (org-refile-use-outline-path org-refile-use-outline-path)
  10021. excluded-entries)
  10022. (when (and (derived-mode-p 'org-mode)
  10023. (not org-refile-use-cache)
  10024. (not no-exclude))
  10025. (org-map-tree
  10026. (lambda()
  10027. (setq excluded-entries
  10028. (append excluded-entries (list (org-get-heading t t)))))))
  10029. (setq org-refile-target-table
  10030. (org-refile-get-targets default-buffer excluded-entries)))
  10031. (unless org-refile-target-table
  10032. (error "No refile targets"))
  10033. (let* ((prompt (concat prompt
  10034. (and (car org-refile-history)
  10035. (concat " (default " (car org-refile-history) ")"))
  10036. ": "))
  10037. (cbuf (current-buffer))
  10038. (partial-completion-mode nil)
  10039. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  10040. (cfunc (if (and org-refile-use-outline-path
  10041. org-outline-path-complete-in-steps)
  10042. 'org-olpath-completing-read
  10043. 'org-icompleting-read))
  10044. (extra (if org-refile-use-outline-path "/" ""))
  10045. (filename (and cfn (expand-file-name cfn)))
  10046. (tbl (mapcar
  10047. (lambda (x)
  10048. (if (and (not (member org-refile-use-outline-path
  10049. '(file full-file-path)))
  10050. (not (equal filename (nth 1 x))))
  10051. (cons (concat (car x) extra " ("
  10052. (file-name-nondirectory (nth 1 x)) ")")
  10053. (cdr x))
  10054. (cons (concat (car x) extra) (cdr x))))
  10055. org-refile-target-table))
  10056. (completion-ignore-case t)
  10057. pa answ parent-target child parent old-hist)
  10058. (setq old-hist org-refile-history)
  10059. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  10060. nil 'org-refile-history (car org-refile-history)))
  10061. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  10062. (org-refile-check-position pa)
  10063. (if pa
  10064. (progn
  10065. (when (or (not org-refile-history)
  10066. (not (eq old-hist org-refile-history))
  10067. (not (equal (car pa) (car org-refile-history))))
  10068. (setq org-refile-history
  10069. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  10070. org-refile-history
  10071. (cdr org-refile-history))))
  10072. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  10073. (pop org-refile-history)))
  10074. pa)
  10075. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  10076. (progn
  10077. (setq parent (match-string 1 answ)
  10078. child (match-string 2 answ))
  10079. (setq parent-target (or (assoc parent tbl)
  10080. (assoc (concat parent "/") tbl)))
  10081. (when (and parent-target
  10082. (or (eq new-nodes t)
  10083. (and (eq new-nodes 'confirm)
  10084. (y-or-n-p (format "Create new node \"%s\"? "
  10085. child)))))
  10086. (org-refile-new-child parent-target child)))
  10087. (error "Invalid target location")))))
  10088. (declare-function org-string-nw-p "org-macs.el" (s))
  10089. (defun org-refile-check-position (refile-pointer)
  10090. "Check if the refile pointer matches the readline to which it points."
  10091. (let* ((file (nth 1 refile-pointer))
  10092. (re (nth 2 refile-pointer))
  10093. (pos (nth 3 refile-pointer))
  10094. buffer)
  10095. (when (org-string-nw-p re)
  10096. (setq buffer (if (markerp pos)
  10097. (marker-buffer pos)
  10098. (or (find-buffer-visiting file)
  10099. (find-file-noselect file))))
  10100. (with-current-buffer buffer
  10101. (save-excursion
  10102. (save-restriction
  10103. (widen)
  10104. (goto-char pos)
  10105. (beginning-of-line 1)
  10106. (unless (org-looking-at-p re)
  10107. (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  10108. (defun org-refile-new-child (parent-target child)
  10109. "Use refile target PARENT-TARGET to add new CHILD below it."
  10110. (unless parent-target
  10111. (error "Cannot find parent for new node"))
  10112. (let ((file (nth 1 parent-target))
  10113. (pos (nth 3 parent-target))
  10114. level)
  10115. (with-current-buffer (or (find-buffer-visiting file)
  10116. (find-file-noselect file))
  10117. (save-excursion
  10118. (save-restriction
  10119. (widen)
  10120. (if pos
  10121. (goto-char pos)
  10122. (goto-char (point-max))
  10123. (if (not (bolp)) (newline)))
  10124. (when (looking-at org-outline-regexp)
  10125. (setq level (funcall outline-level))
  10126. (org-end-of-subtree t t))
  10127. (org-back-over-empty-lines)
  10128. (insert "\n" (make-string
  10129. (if pos (org-get-valid-level level 1) 1) ?*)
  10130. " " child "\n")
  10131. (beginning-of-line 0)
  10132. (list (concat (car parent-target) "/" child) file "" (point)))))))
  10133. (defun org-olpath-completing-read (prompt collection &rest args)
  10134. "Read an outline path like a file name."
  10135. (let ((thetable collection)
  10136. (org-completion-use-ido nil) ; does not work with ido.
  10137. (org-completion-use-iswitchb nil)) ; or iswitchb
  10138. (apply
  10139. 'org-icompleting-read prompt
  10140. (lambda (string predicate &optional flag)
  10141. (let (rtn r f (l (length string)))
  10142. (cond
  10143. ((eq flag nil)
  10144. ;; try completion
  10145. (try-completion string thetable))
  10146. ((eq flag t)
  10147. ;; all-completions
  10148. (setq rtn (all-completions string thetable predicate))
  10149. (mapcar
  10150. (lambda (x)
  10151. (setq r (substring x l))
  10152. (if (string-match " ([^)]*)$" x)
  10153. (setq f (match-string 0 x))
  10154. (setq f ""))
  10155. (if (string-match "/" r)
  10156. (concat string (substring r 0 (match-end 0)) f)
  10157. x))
  10158. rtn))
  10159. ((eq flag 'lambda)
  10160. ;; exact match?
  10161. (assoc string thetable)))))
  10162. args)))
  10163. ;;;; Dynamic blocks
  10164. (defun org-find-dblock (name)
  10165. "Find the first dynamic block with name NAME in the buffer.
  10166. If not found, stay at current position and return nil."
  10167. (let ((case-fold-search t) pos)
  10168. (save-excursion
  10169. (goto-char (point-min))
  10170. (setq pos (and (re-search-forward
  10171. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10172. (match-beginning 0))))
  10173. (if pos (goto-char pos))
  10174. pos))
  10175. (defconst org-dblock-start-re
  10176. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  10177. "Matches the start line of a dynamic block, with parameters.")
  10178. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  10179. "Matches the end of a dynamic block.")
  10180. (defun org-create-dblock (plist)
  10181. "Create a dynamic block section, with parameters taken from PLIST.
  10182. PLIST must contain a :name entry which is used as name of the block."
  10183. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10184. (end-of-line 1)
  10185. (newline))
  10186. (let ((col (current-column))
  10187. (name (plist-get plist :name)))
  10188. (insert "#+BEGIN: " name)
  10189. (while plist
  10190. (if (eq (car plist) :name)
  10191. (setq plist (cddr plist))
  10192. (insert " " (prin1-to-string (pop plist)))))
  10193. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10194. (beginning-of-line -2)))
  10195. (defun org-prepare-dblock ()
  10196. "Prepare dynamic block for refresh.
  10197. This empties the block, puts the cursor at the insert position and returns
  10198. the property list including an extra property :name with the block name."
  10199. (unless (looking-at org-dblock-start-re)
  10200. (error "Not at a dynamic block"))
  10201. (let* ((begdel (1+ (match-end 0)))
  10202. (name (org-no-properties (match-string 1)))
  10203. (params (append (list :name name)
  10204. (read (concat "(" (match-string 3) ")")))))
  10205. (save-excursion
  10206. (beginning-of-line 1)
  10207. (skip-chars-forward " \t")
  10208. (setq params (plist-put params :indentation-column (current-column))))
  10209. (unless (re-search-forward org-dblock-end-re nil t)
  10210. (error "Dynamic block not terminated"))
  10211. (setq params
  10212. (append params
  10213. (list :content (buffer-substring
  10214. begdel (match-beginning 0)))))
  10215. (delete-region begdel (match-beginning 0))
  10216. (goto-char begdel)
  10217. (open-line 1)
  10218. params))
  10219. (defun org-map-dblocks (&optional command)
  10220. "Apply COMMAND to all dynamic blocks in the current buffer.
  10221. If COMMAND is not given, use `org-update-dblock'."
  10222. (let ((cmd (or command 'org-update-dblock)))
  10223. (save-excursion
  10224. (goto-char (point-min))
  10225. (while (re-search-forward org-dblock-start-re nil t)
  10226. (goto-char (match-beginning 0))
  10227. (save-excursion
  10228. (condition-case nil
  10229. (funcall cmd)
  10230. (error (message "Error during update of dynamic block"))))
  10231. (unless (re-search-forward org-dblock-end-re nil t)
  10232. (error "Dynamic block not terminated"))))))
  10233. (defun org-dblock-update (&optional arg)
  10234. "User command for updating dynamic blocks.
  10235. Update the dynamic block at point. With prefix ARG, update all dynamic
  10236. blocks in the buffer."
  10237. (interactive "P")
  10238. (if arg
  10239. (org-update-all-dblocks)
  10240. (or (looking-at org-dblock-start-re)
  10241. (org-beginning-of-dblock))
  10242. (org-update-dblock)))
  10243. (defun org-update-dblock ()
  10244. "Update the dynamic block at point.
  10245. This means to empty the block, parse for parameters and then call
  10246. the correct writing function."
  10247. (interactive)
  10248. (save-window-excursion
  10249. (let* ((pos (point))
  10250. (line (org-current-line))
  10251. (params (org-prepare-dblock))
  10252. (name (plist-get params :name))
  10253. (indent (plist-get params :indentation-column))
  10254. (cmd (intern (concat "org-dblock-write:" name))))
  10255. (message "Updating dynamic block `%s' at line %d..." name line)
  10256. (funcall cmd params)
  10257. (message "Updating dynamic block `%s' at line %d...done" name line)
  10258. (goto-char pos)
  10259. (when (and indent (> indent 0))
  10260. (setq indent (make-string indent ?\ ))
  10261. (save-excursion
  10262. (org-beginning-of-dblock)
  10263. (forward-line 1)
  10264. (while (not (looking-at org-dblock-end-re))
  10265. (insert indent)
  10266. (beginning-of-line 2))
  10267. (when (looking-at org-dblock-end-re)
  10268. (and (looking-at "[ \t]+")
  10269. (replace-match ""))
  10270. (insert indent)))))))
  10271. (defun org-beginning-of-dblock ()
  10272. "Find the beginning of the dynamic block at point.
  10273. Error if there is no such block at point."
  10274. (let ((pos (point))
  10275. beg)
  10276. (end-of-line 1)
  10277. (if (and (re-search-backward org-dblock-start-re nil t)
  10278. (setq beg (match-beginning 0))
  10279. (re-search-forward org-dblock-end-re nil t)
  10280. (> (match-end 0) pos))
  10281. (goto-char beg)
  10282. (goto-char pos)
  10283. (error "Not in a dynamic block"))))
  10284. ;;;###autoload
  10285. (defun org-update-all-dblocks ()
  10286. "Update all dynamic blocks in the buffer.
  10287. This function can be used in a hook."
  10288. (interactive)
  10289. (when (derived-mode-p 'org-mode)
  10290. (org-map-dblocks 'org-update-dblock)))
  10291. ;;;; Completion
  10292. (defconst org-additional-option-like-keywords
  10293. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
  10294. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
  10295. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  10296. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
  10297. "BEGIN:" "END:"
  10298. "ORGTBL" "TBLFM:" "TBLNAME:"
  10299. "BEGIN_EXAMPLE" "END_EXAMPLE"
  10300. "BEGIN_VERBATIM" "END_VERBATIM"
  10301. "BEGIN_QUOTE" "END_QUOTE"
  10302. "BEGIN_VERSE" "END_VERSE"
  10303. "BEGIN_CENTER" "END_CENTER"
  10304. "BEGIN_SRC" "END_SRC"
  10305. "BEGIN_RESULT" "END_RESULT"
  10306. "BEGIN_lstlisting" "END_lstlisting"
  10307. "NAME:" "RESULTS:"
  10308. "HEADER:" "HEADERS:"
  10309. "COLUMNS:" "PROPERTY:"
  10310. "CAPTION:" "LABEL:"
  10311. "SETUPFILE:"
  10312. "INCLUDE:"
  10313. "BIND:"
  10314. "MACRO:"))
  10315. (defconst org-options-keywords
  10316. '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
  10317. "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
  10318. "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
  10319. "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
  10320. "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
  10321. "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:"
  10322. "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
  10323. (defconst org-additional-option-like-keywords-for-flyspell
  10324. (delete-dups
  10325. (split-string
  10326. (mapconcat (lambda(k)
  10327. (replace-regexp-in-string
  10328. "_\\|:" " "
  10329. (concat k " " (downcase k) " " (upcase k))))
  10330. (append org-options-keywords org-additional-option-like-keywords)
  10331. " ")
  10332. " +" t)))
  10333. (defcustom org-structure-template-alist
  10334. '(
  10335. ("s" "#+BEGIN_SRC ?\n\n#+END_SRC"
  10336. "<src lang=\"?\">\n\n</src>")
  10337. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE"
  10338. "<example>\n?\n</example>")
  10339. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE"
  10340. "<quote>\n?\n</quote>")
  10341. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE"
  10342. "<verse>\n?\n</verse>")
  10343. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER"
  10344. "<center>\n?\n</center>")
  10345. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10346. "<literal style=\"latex\">\n?\n</literal>")
  10347. ("L" "#+LaTeX: "
  10348. "<literal style=\"latex\">?</literal>")
  10349. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10350. "<literal style=\"html\">\n?\n</literal>")
  10351. ("H" "#+HTML: "
  10352. "<literal style=\"html\">?</literal>")
  10353. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
  10354. ("A" "#+ASCII: ")
  10355. ("i" "#+INDEX: ?"
  10356. "#+INDEX: ?")
  10357. ("I" "#+INCLUDE: %file ?"
  10358. "<include file=%file markup=\"?\">")
  10359. )
  10360. "Structure completion elements.
  10361. This is a list of abbreviation keys and values. The value gets inserted
  10362. if you type `<' followed by the key and then press the completion key,
  10363. usually `M-TAB'. %file will be replaced by a file name after prompting
  10364. for the file using completion. The cursor will be placed at the position
  10365. of the `?` in the template.
  10366. There are two templates for each key, the first uses the original Org syntax,
  10367. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10368. the default when the /org-mtags.el/ module has been loaded. See also the
  10369. variable `org-mtags-prefer-muse-templates'."
  10370. :group 'org-completion
  10371. :type '(repeat
  10372. (string :tag "Key")
  10373. (string :tag "Template")
  10374. (string :tag "Muse Template")))
  10375. (defun org-try-structure-completion ()
  10376. "Try to complete a structure template before point.
  10377. This looks for strings like \"<e\" on an otherwise empty line and
  10378. expands them."
  10379. (let ((l (buffer-substring (point-at-bol) (point)))
  10380. a)
  10381. (when (and (looking-at "[ \t]*$")
  10382. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10383. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10384. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10385. (match-beginning 1)) a)
  10386. t)))
  10387. (defun org-complete-expand-structure-template (start cell)
  10388. "Expand a structure template."
  10389. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10390. (rpl (nth (if musep 2 1) cell))
  10391. (ind ""))
  10392. (delete-region start (point))
  10393. (when (string-match "\\`#\\+" rpl)
  10394. (cond
  10395. ((bolp))
  10396. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10397. (setq ind (buffer-substring (point-at-bol) (point))))
  10398. (t (newline))))
  10399. (setq start (point))
  10400. (if (string-match "%file" rpl)
  10401. (setq rpl (replace-match
  10402. (concat
  10403. "\""
  10404. (save-match-data
  10405. (abbreviate-file-name (read-file-name "Include file: ")))
  10406. "\"")
  10407. t t rpl)))
  10408. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10409. (concat "\n" ind)))
  10410. (insert rpl)
  10411. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10412. ;;;; TODO, DEADLINE, Comments
  10413. (defun org-toggle-comment ()
  10414. "Change the COMMENT state of an entry."
  10415. (interactive)
  10416. (save-excursion
  10417. (org-back-to-heading)
  10418. (let (case-fold-search)
  10419. (cond
  10420. ((looking-at (format org-heading-keyword-regexp-format
  10421. org-comment-string))
  10422. (goto-char (match-end 1))
  10423. (looking-at (concat " +" org-comment-string))
  10424. (replace-match "" t t)
  10425. (when (eolp) (insert " ")))
  10426. ((looking-at org-outline-regexp)
  10427. (goto-char (match-end 0))
  10428. (insert org-comment-string " "))))))
  10429. (defvar org-last-todo-state-is-todo nil
  10430. "This is non-nil when the last TODO state change led to a TODO state.
  10431. If the last change removed the TODO tag or switched to DONE, then
  10432. this is nil.")
  10433. (defvar org-setting-tags nil) ; dynamically skipped
  10434. (defvar org-todo-setup-filter-hook nil
  10435. "Hook for functions that pre-filter todo specs.
  10436. Each function takes a todo spec and returns either nil or the spec
  10437. transformed into canonical form." )
  10438. (defvar org-todo-get-default-hook nil
  10439. "Hook for functions that get a default item for todo.
  10440. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10441. nil or a string to be used for the todo mark." )
  10442. (defvar org-agenda-headline-snapshot-before-repeat)
  10443. (defun org-current-effective-time ()
  10444. "Return current time adjusted for `org-extend-today-until' variable."
  10445. (let* ((ct (org-current-time))
  10446. (dct (decode-time ct))
  10447. (ct1
  10448. (cond
  10449. (org-use-last-clock-out-time-as-effective-time
  10450. (or (org-clock-get-last-clock-out-time) ct))
  10451. ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
  10452. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
  10453. (t ct))))
  10454. ct1))
  10455. (defun org-todo-yesterday (&optional arg)
  10456. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10457. (interactive "P")
  10458. (if (eq major-mode 'org-agenda-mode)
  10459. (apply 'org-agenda-todo-yesterday arg)
  10460. (let* ((hour (third (decode-time
  10461. (org-current-time))))
  10462. (org-extend-today-until (1+ hour)))
  10463. (org-todo arg))))
  10464. (defun org-todo (&optional arg)
  10465. "Change the TODO state of an item.
  10466. The state of an item is given by a keyword at the start of the heading,
  10467. like
  10468. *** TODO Write paper
  10469. *** DONE Call mom
  10470. The different keywords are specified in the variable `org-todo-keywords'.
  10471. By default the available states are \"TODO\" and \"DONE\".
  10472. So for this example: when the item starts with TODO, it is changed to DONE.
  10473. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10474. DONE are present, add TODO at the beginning of the heading.
  10475. With \\[universal-argument] prefix arg, use completion to determine the new \
  10476. state.
  10477. With numeric prefix arg, switch to that state.
  10478. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10479. keywords (nextset).
  10480. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10481. With a numeric prefix arg of 0, inhibit note taking for the change.
  10482. For calling through lisp, arg is also interpreted in the following way:
  10483. 'none -> empty state
  10484. \"\"(empty string) -> switch to empty state
  10485. 'done -> switch to DONE
  10486. 'nextset -> switch to the next set of keywords
  10487. 'previousset -> switch to the previous set of keywords
  10488. \"WAITING\" -> switch to the specified keyword, but only if it
  10489. really is a member of `org-todo-keywords'."
  10490. (interactive "P")
  10491. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10492. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10493. 'region-start-level 'region))
  10494. org-loop-over-headlines-in-active-region)
  10495. (org-map-entries
  10496. `(org-todo ,arg)
  10497. org-loop-over-headlines-in-active-region
  10498. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  10499. (if (equal arg '(16)) (setq arg 'nextset))
  10500. (let ((org-blocker-hook org-blocker-hook)
  10501. (case-fold-search nil))
  10502. (when (equal arg '(64))
  10503. (setq arg nil org-blocker-hook nil))
  10504. (when (and org-blocker-hook
  10505. (or org-inhibit-blocking
  10506. (org-entry-get nil "NOBLOCKING")))
  10507. (setq org-blocker-hook nil))
  10508. (save-excursion
  10509. (catch 'exit
  10510. (org-back-to-heading t)
  10511. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  10512. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  10513. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  10514. (let* ((match-data (match-data))
  10515. (startpos (point-at-bol))
  10516. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  10517. (org-log-done org-log-done)
  10518. (org-log-repeat org-log-repeat)
  10519. (org-todo-log-states org-todo-log-states)
  10520. (org-inhibit-logging
  10521. (if (equal arg 0)
  10522. (progn (setq arg nil) 'note) org-inhibit-logging))
  10523. (this (match-string 1))
  10524. (hl-pos (match-beginning 0))
  10525. (head (org-get-todo-sequence-head this))
  10526. (ass (assoc head org-todo-kwd-alist))
  10527. (interpret (nth 1 ass))
  10528. (done-word (nth 3 ass))
  10529. (final-done-word (nth 4 ass))
  10530. (org-last-state (or this ""))
  10531. (completion-ignore-case t)
  10532. (member (member this org-todo-keywords-1))
  10533. (tail (cdr member))
  10534. (org-state (cond
  10535. ((and org-todo-key-trigger
  10536. (or (and (equal arg '(4))
  10537. (eq org-use-fast-todo-selection 'prefix))
  10538. (and (not arg) org-use-fast-todo-selection
  10539. (not (eq org-use-fast-todo-selection
  10540. 'prefix)))))
  10541. ;; Use fast selection
  10542. (org-fast-todo-selection))
  10543. ((and (equal arg '(4))
  10544. (or (not org-use-fast-todo-selection)
  10545. (not org-todo-key-trigger)))
  10546. ;; Read a state with completion
  10547. (org-icompleting-read
  10548. "State: " (mapcar (lambda(x) (list x))
  10549. org-todo-keywords-1)
  10550. nil t))
  10551. ((eq arg 'right)
  10552. (if this
  10553. (if tail (car tail) nil)
  10554. (car org-todo-keywords-1)))
  10555. ((eq arg 'left)
  10556. (if (equal member org-todo-keywords-1)
  10557. nil
  10558. (if this
  10559. (nth (- (length org-todo-keywords-1)
  10560. (length tail) 2)
  10561. org-todo-keywords-1)
  10562. (org-last org-todo-keywords-1))))
  10563. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  10564. (setq arg nil))) ; hack to fall back to cycling
  10565. (arg
  10566. ;; user or caller requests a specific state
  10567. (cond
  10568. ((equal arg "") nil)
  10569. ((eq arg 'none) nil)
  10570. ((eq arg 'done) (or done-word (car org-done-keywords)))
  10571. ((eq arg 'nextset)
  10572. (or (car (cdr (member head org-todo-heads)))
  10573. (car org-todo-heads)))
  10574. ((eq arg 'previousset)
  10575. (let ((org-todo-heads (reverse org-todo-heads)))
  10576. (or (car (cdr (member head org-todo-heads)))
  10577. (car org-todo-heads))))
  10578. ((car (member arg org-todo-keywords-1)))
  10579. ((stringp arg)
  10580. (error "State `%s' not valid in this file" arg))
  10581. ((nth (1- (prefix-numeric-value arg))
  10582. org-todo-keywords-1))))
  10583. ((null member) (or head (car org-todo-keywords-1)))
  10584. ((equal this final-done-word) nil) ;; -> make empty
  10585. ((null tail) nil) ;; -> first entry
  10586. ((memq interpret '(type priority))
  10587. (if (eq this-command last-command)
  10588. (car tail)
  10589. (if (> (length tail) 0)
  10590. (or done-word (car org-done-keywords))
  10591. nil)))
  10592. (t
  10593. (car tail))))
  10594. (org-state (or
  10595. (run-hook-with-args-until-success
  10596. 'org-todo-get-default-hook org-state org-last-state)
  10597. org-state))
  10598. (next (if org-state (concat " " org-state " ") " "))
  10599. (change-plist (list :type 'todo-state-change :from this :to org-state
  10600. :position startpos))
  10601. dolog now-done-p)
  10602. (when org-blocker-hook
  10603. (setq org-last-todo-state-is-todo
  10604. (not (member this org-done-keywords)))
  10605. (unless (save-excursion
  10606. (save-match-data
  10607. (org-with-wide-buffer
  10608. (run-hook-with-args-until-failure
  10609. 'org-blocker-hook change-plist))))
  10610. (if (org-called-interactively-p 'interactive)
  10611. (error "TODO state change from %s to %s blocked" this org-state)
  10612. ;; fail silently
  10613. (message "TODO state change from %s to %s blocked" this org-state)
  10614. (throw 'exit nil))))
  10615. (store-match-data match-data)
  10616. (replace-match next t t)
  10617. (unless (pos-visible-in-window-p hl-pos)
  10618. (message "TODO state changed to %s" (org-trim next)))
  10619. (unless head
  10620. (setq head (org-get-todo-sequence-head org-state)
  10621. ass (assoc head org-todo-kwd-alist)
  10622. interpret (nth 1 ass)
  10623. done-word (nth 3 ass)
  10624. final-done-word (nth 4 ass)))
  10625. (when (memq arg '(nextset previousset))
  10626. (message "Keyword-Set %d/%d: %s"
  10627. (- (length org-todo-sets) -1
  10628. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  10629. (length org-todo-sets)
  10630. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  10631. (setq org-last-todo-state-is-todo
  10632. (not (member org-state org-done-keywords)))
  10633. (setq now-done-p (and (member org-state org-done-keywords)
  10634. (not (member this org-done-keywords))))
  10635. (and logging (org-local-logging logging))
  10636. (when (and (or org-todo-log-states org-log-done)
  10637. (not (eq org-inhibit-logging t))
  10638. (not (memq arg '(nextset previousset))))
  10639. ;; we need to look at recording a time and note
  10640. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  10641. (nth 2 (assoc this org-todo-log-states))))
  10642. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  10643. (setq dolog 'time))
  10644. (when (and org-state
  10645. (member org-state org-not-done-keywords)
  10646. (not (member this org-not-done-keywords)))
  10647. ;; This is now a todo state and was not one before
  10648. ;; If there was a CLOSED time stamp, get rid of it.
  10649. (org-add-planning-info nil nil 'closed))
  10650. (when (and now-done-p org-log-done)
  10651. ;; It is now done, and it was not done before
  10652. (org-add-planning-info 'closed (org-current-effective-time))
  10653. (if (and (not dolog) (eq 'note org-log-done))
  10654. (org-add-log-setup 'done org-state this 'findpos 'note)))
  10655. (when (and org-state dolog)
  10656. ;; This is a non-nil state, and we need to log it
  10657. (org-add-log-setup 'state org-state this 'findpos dolog)))
  10658. ;; Fixup tag positioning
  10659. (org-todo-trigger-tag-changes org-state)
  10660. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  10661. (when org-provide-todo-statistics
  10662. (org-update-parent-todo-statistics))
  10663. (run-hooks 'org-after-todo-state-change-hook)
  10664. (if (and arg (not (member org-state org-done-keywords)))
  10665. (setq head (org-get-todo-sequence-head org-state)))
  10666. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  10667. ;; Do we need to trigger a repeat?
  10668. (when now-done-p
  10669. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  10670. ;; This is for the agenda, take a snapshot of the headline.
  10671. (save-match-data
  10672. (setq org-agenda-headline-snapshot-before-repeat
  10673. (org-get-heading))))
  10674. (org-auto-repeat-maybe org-state))
  10675. ;; Fixup cursor location if close to the keyword
  10676. (if (and (outline-on-heading-p)
  10677. (not (bolp))
  10678. (save-excursion (beginning-of-line 1)
  10679. (looking-at org-todo-line-regexp))
  10680. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  10681. (progn
  10682. (goto-char (or (match-end 2) (match-end 1)))
  10683. (and (looking-at " ") (just-one-space))))
  10684. (when org-trigger-hook
  10685. (save-excursion
  10686. (run-hook-with-args 'org-trigger-hook change-plist)))))))))
  10687. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  10688. "Block turning an entry into a TODO, using the hierarchy.
  10689. This checks whether the current task should be blocked from state
  10690. changes. Such blocking occurs when:
  10691. 1. The task has children which are not all in a completed state.
  10692. 2. A task has a parent with the property :ORDERED:, and there
  10693. are siblings prior to the current task with incomplete
  10694. status.
  10695. 3. The parent of the task is blocked because it has siblings that should
  10696. be done first, or is child of a block grandparent TODO entry."
  10697. (if (not org-enforce-todo-dependencies)
  10698. t ; if locally turned off don't block
  10699. (catch 'dont-block
  10700. ;; If this is not a todo state change, or if this entry is already DONE,
  10701. ;; do not block
  10702. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10703. (member (plist-get change-plist :from)
  10704. (cons 'done org-done-keywords))
  10705. (member (plist-get change-plist :to)
  10706. (cons 'todo org-not-done-keywords))
  10707. (not (plist-get change-plist :to)))
  10708. (throw 'dont-block t))
  10709. ;; If this task has children, and any are undone, it's blocked
  10710. (save-excursion
  10711. (org-back-to-heading t)
  10712. (let ((this-level (funcall outline-level)))
  10713. (outline-next-heading)
  10714. (let ((child-level (funcall outline-level)))
  10715. (while (and (not (eobp))
  10716. (> child-level this-level))
  10717. ;; this todo has children, check whether they are all
  10718. ;; completed
  10719. (if (and (not (org-entry-is-done-p))
  10720. (org-entry-is-todo-p))
  10721. (throw 'dont-block nil))
  10722. (outline-next-heading)
  10723. (setq child-level (funcall outline-level))))))
  10724. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  10725. ;; any previous siblings are undone, it's blocked
  10726. (save-excursion
  10727. (org-back-to-heading t)
  10728. (let* ((pos (point))
  10729. (parent-pos (and (org-up-heading-safe) (point))))
  10730. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10731. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10732. (forward-line 1)
  10733. (re-search-forward org-not-done-heading-regexp pos t))
  10734. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  10735. ;; Search further up the hierarchy, to see if an ancestor is blocked
  10736. (while t
  10737. (goto-char parent-pos)
  10738. (if (not (looking-at org-not-done-heading-regexp))
  10739. (throw 'dont-block t)) ; do not block, parent is not a TODO
  10740. (setq pos (point))
  10741. (setq parent-pos (and (org-up-heading-safe) (point)))
  10742. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10743. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10744. (forward-line 1)
  10745. (re-search-forward org-not-done-heading-regexp pos t))
  10746. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  10747. (defcustom org-track-ordered-property-with-tag nil
  10748. "Should the ORDERED property also be shown as a tag?
  10749. The ORDERED property decides if an entry should require subtasks to be
  10750. completed in sequence. Since a property is not very visible, setting
  10751. this option means that toggling the ORDERED property with the command
  10752. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  10753. not relevant for the behavior, but it makes things more visible.
  10754. Note that toggling the tag with tags commands will not change the property
  10755. and therefore not influence behavior!
  10756. This can be t, meaning the tag ORDERED should be used, It can also be a
  10757. string to select a different tag for this task."
  10758. :group 'org-todo
  10759. :type '(choice
  10760. (const :tag "No tracking" nil)
  10761. (const :tag "Track with ORDERED tag" t)
  10762. (string :tag "Use other tag")))
  10763. (defun org-toggle-ordered-property ()
  10764. "Toggle the ORDERED property of the current entry.
  10765. For better visibility, you can track the value of this property with a tag.
  10766. See variable `org-track-ordered-property-with-tag'."
  10767. (interactive)
  10768. (let* ((t1 org-track-ordered-property-with-tag)
  10769. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  10770. (save-excursion
  10771. (org-back-to-heading)
  10772. (if (org-entry-get nil "ORDERED")
  10773. (progn
  10774. (org-delete-property "ORDERED")
  10775. (and tag (org-toggle-tag tag 'off))
  10776. (message "Subtasks can be completed in arbitrary order"))
  10777. (org-entry-put nil "ORDERED" "t")
  10778. (and tag (org-toggle-tag tag 'on))
  10779. (message "Subtasks must be completed in sequence")))))
  10780. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  10781. (defun org-block-todo-from-checkboxes (change-plist)
  10782. "Block turning an entry into a TODO, using checkboxes.
  10783. This checks whether the current task should be blocked from state
  10784. changes because there are unchecked boxes in this entry."
  10785. (if (not org-enforce-todo-checkbox-dependencies)
  10786. t ; if locally turned off don't block
  10787. (catch 'dont-block
  10788. ;; If this is not a todo state change, or if this entry is already DONE,
  10789. ;; do not block
  10790. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10791. (member (plist-get change-plist :from)
  10792. (cons 'done org-done-keywords))
  10793. (member (plist-get change-plist :to)
  10794. (cons 'todo org-not-done-keywords))
  10795. (not (plist-get change-plist :to)))
  10796. (throw 'dont-block t))
  10797. ;; If this task has checkboxes that are not checked, it's blocked
  10798. (save-excursion
  10799. (org-back-to-heading t)
  10800. (let ((beg (point)) end)
  10801. (outline-next-heading)
  10802. (setq end (point))
  10803. (goto-char beg)
  10804. (if (org-list-search-forward
  10805. (concat (org-item-beginning-re)
  10806. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  10807. "\\[[- ]\\]")
  10808. end t)
  10809. (progn
  10810. (if (boundp 'org-blocked-by-checkboxes)
  10811. (setq org-blocked-by-checkboxes t))
  10812. (throw 'dont-block nil)))))
  10813. t))) ; do not block
  10814. (defun org-entry-blocked-p ()
  10815. "Is the current entry blocked?"
  10816. (if (org-entry-get nil "NOBLOCKING")
  10817. nil ;; Never block this entry
  10818. (not
  10819. (run-hook-with-args-until-failure
  10820. 'org-blocker-hook
  10821. (list :type 'todo-state-change
  10822. :position (point)
  10823. :from 'todo
  10824. :to 'done)))))
  10825. (defun org-update-statistics-cookies (all)
  10826. "Update the statistics cookie, either from TODO or from checkboxes.
  10827. This should be called with the cursor in a line with a statistics cookie."
  10828. (interactive "P")
  10829. (if all
  10830. (progn
  10831. (org-update-checkbox-count 'all)
  10832. (org-map-entries 'org-update-parent-todo-statistics))
  10833. (if (not (org-at-heading-p))
  10834. (org-update-checkbox-count)
  10835. (let ((pos (move-marker (make-marker) (point)))
  10836. end l1 l2)
  10837. (ignore-errors (org-back-to-heading t))
  10838. (if (not (org-at-heading-p))
  10839. (org-update-checkbox-count)
  10840. (setq l1 (org-outline-level))
  10841. (setq end (save-excursion
  10842. (outline-next-heading)
  10843. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  10844. (point)))
  10845. (if (and (save-excursion
  10846. (re-search-forward
  10847. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  10848. (not (save-excursion (re-search-forward
  10849. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  10850. (org-update-checkbox-count)
  10851. (if (and l2 (> l2 l1))
  10852. (progn
  10853. (goto-char end)
  10854. (org-update-parent-todo-statistics))
  10855. (goto-char pos)
  10856. (beginning-of-line 1)
  10857. (while (re-search-forward
  10858. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  10859. (point-at-eol) t)
  10860. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  10861. (goto-char pos)
  10862. (move-marker pos nil)))))
  10863. (defvar org-entry-property-inherited-from) ;; defined below
  10864. (defun org-update-parent-todo-statistics ()
  10865. "Update any statistics cookie in the parent of the current headline.
  10866. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  10867. the entire subtree and this will travel up the hierarchy and update
  10868. statistics everywhere."
  10869. (let* ((prop (save-excursion (org-up-heading-safe)
  10870. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  10871. (recursive (or (not org-hierarchical-todo-statistics)
  10872. (and prop (string-match "\\<recursive\\>" prop))))
  10873. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  10874. 0))
  10875. (first t)
  10876. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10877. level ltoggle l1 new ndel
  10878. (cnt-all 0) (cnt-done 0) is-percent kwd
  10879. checkbox-beg ov ovs ove cookie-present)
  10880. (catch 'exit
  10881. (save-excursion
  10882. (beginning-of-line 1)
  10883. (setq ltoggle (funcall outline-level))
  10884. ;; Three situations are to consider:
  10885. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  10886. ;; to the top-level ancestor on the headline;
  10887. ;; 2. If parent has "recursive" property, repeat up to the
  10888. ;; headline setting that property, taking inheritance into
  10889. ;; account;
  10890. ;; 3. Else, move up to direct parent and proceed only once.
  10891. (while (and (setq level (org-up-heading-safe))
  10892. (or recursive first)
  10893. (>= (point) lim))
  10894. (setq first nil cookie-present nil)
  10895. (unless (and level
  10896. (not (string-match
  10897. "\\<checkbox\\>"
  10898. (downcase (or (org-entry-get nil "COOKIE_DATA")
  10899. "")))))
  10900. (throw 'exit nil))
  10901. (while (re-search-forward box-re (point-at-eol) t)
  10902. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10903. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  10904. (save-match-data
  10905. (unless (outline-next-heading) (throw 'exit nil))
  10906. (while (and (looking-at org-complex-heading-regexp)
  10907. (> (setq l1 (length (match-string 1))) level))
  10908. (setq kwd (and (or recursive (= l1 ltoggle))
  10909. (match-string 2)))
  10910. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10911. (and (listp org-provide-todo-statistics)
  10912. (or (member kwd org-provide-todo-statistics)
  10913. (member kwd org-done-keywords))))
  10914. (setq cnt-all (1+ cnt-all))
  10915. (if (eq org-provide-todo-statistics t)
  10916. (and kwd (setq cnt-all (1+ cnt-all)))))
  10917. (and (member kwd org-done-keywords)
  10918. (setq cnt-done (1+ cnt-done)))
  10919. (outline-next-heading)))
  10920. (setq new
  10921. (if is-percent
  10922. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10923. (format "[%d/%d]" cnt-done cnt-all))
  10924. ndel (- (match-end 0) checkbox-beg))
  10925. ;; handle overlays when updating cookie from column view
  10926. (when (setq ov (car (overlays-at checkbox-beg)))
  10927. (setq ovs (overlay-start ov) ove (overlay-end ov))
  10928. (delete-overlay ov))
  10929. (goto-char checkbox-beg)
  10930. (insert new)
  10931. (delete-region (point) (+ (point) ndel))
  10932. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  10933. (when ov (move-overlay ov ovs ove)))
  10934. (when cookie-present
  10935. (run-hook-with-args 'org-after-todo-statistics-hook
  10936. cnt-done (- cnt-all cnt-done))))))
  10937. (run-hooks 'org-todo-statistics-hook)))
  10938. (defvar org-after-todo-statistics-hook nil
  10939. "Hook that is called after a TODO statistics cookie has been updated.
  10940. Each function is called with two arguments: the number of not-done entries
  10941. and the number of done entries.
  10942. For example, the following function, when added to this hook, will switch
  10943. an entry to DONE when all children are done, and back to TODO when new
  10944. entries are set to a TODO status. Note that this hook is only called
  10945. when there is a statistics cookie in the headline!
  10946. (defun org-summary-todo (n-done n-not-done)
  10947. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10948. (let (org-log-done org-log-states) ; turn off logging
  10949. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10950. ")
  10951. (defvar org-todo-statistics-hook nil
  10952. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10953. This hook runs even if there is no statistics cookie present, in which case
  10954. `org-after-todo-statistics-hook' would not run.")
  10955. (defun org-todo-trigger-tag-changes (state)
  10956. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10957. (let ((l org-todo-state-tags-triggers)
  10958. changes)
  10959. (when (or (not state) (equal state ""))
  10960. (setq changes (append changes (cdr (assoc "" l)))))
  10961. (when (and (stringp state) (> (length state) 0))
  10962. (setq changes (append changes (cdr (assoc state l)))))
  10963. (when (member state org-not-done-keywords)
  10964. (setq changes (append changes (cdr (assoc 'todo l)))))
  10965. (when (member state org-done-keywords)
  10966. (setq changes (append changes (cdr (assoc 'done l)))))
  10967. (dolist (c changes)
  10968. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10969. (defun org-local-logging (value)
  10970. "Get logging settings from a property VALUE."
  10971. (let* (words w a)
  10972. ;; directly set the variables, they are already local.
  10973. (setq org-log-done nil
  10974. org-log-repeat nil
  10975. org-todo-log-states nil)
  10976. (setq words (org-split-string value))
  10977. (while (setq w (pop words))
  10978. (cond
  10979. ((setq a (assoc w org-startup-options))
  10980. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10981. (set (nth 1 a) (nth 2 a))))
  10982. ((setq a (org-extract-log-state-settings w))
  10983. (and (member (car a) org-todo-keywords-1)
  10984. (push a org-todo-log-states)))))))
  10985. (defun org-get-todo-sequence-head (kwd)
  10986. "Return the head of the TODO sequence to which KWD belongs.
  10987. If KWD is not set, check if there is a text property remembering the
  10988. right sequence."
  10989. (let (p)
  10990. (cond
  10991. ((not kwd)
  10992. (or (get-text-property (point-at-bol) 'org-todo-head)
  10993. (progn
  10994. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  10995. nil (point-at-eol)))
  10996. (get-text-property p 'org-todo-head))))
  10997. ((not (member kwd org-todo-keywords-1))
  10998. (car org-todo-keywords-1))
  10999. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  11000. (defun org-fast-todo-selection ()
  11001. "Fast TODO keyword selection with single keys.
  11002. Returns the new TODO keyword, or nil if no state change should occur."
  11003. (let* ((fulltable org-todo-key-alist)
  11004. (done-keywords org-done-keywords) ;; needed for the faces.
  11005. (maxlen (apply 'max (mapcar
  11006. (lambda (x)
  11007. (if (stringp (car x)) (string-width (car x)) 0))
  11008. fulltable)))
  11009. (expert nil)
  11010. (fwidth (+ maxlen 3 1 3))
  11011. (ncol (/ (- (window-width) 4) fwidth))
  11012. tg cnt e c tbl
  11013. groups ingroup)
  11014. (save-excursion
  11015. (save-window-excursion
  11016. (if expert
  11017. (set-buffer (get-buffer-create " *Org todo*"))
  11018. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  11019. (erase-buffer)
  11020. (org-set-local 'org-done-keywords done-keywords)
  11021. (setq tbl fulltable cnt 0)
  11022. (while (setq e (pop tbl))
  11023. (cond
  11024. ((equal e '(:startgroup))
  11025. (push '() groups) (setq ingroup t)
  11026. (when (not (= cnt 0))
  11027. (setq cnt 0)
  11028. (insert "\n"))
  11029. (insert "{ "))
  11030. ((equal e '(:endgroup))
  11031. (setq ingroup nil cnt 0)
  11032. (insert "}\n"))
  11033. ((equal e '(:newline))
  11034. (when (not (= cnt 0))
  11035. (setq cnt 0)
  11036. (insert "\n")
  11037. (setq e (car tbl))
  11038. (while (equal (car tbl) '(:newline))
  11039. (insert "\n")
  11040. (setq tbl (cdr tbl)))))
  11041. (t
  11042. (setq tg (car e) c (cdr e))
  11043. (if ingroup (push tg (car groups)))
  11044. (setq tg (org-add-props tg nil 'face
  11045. (org-get-todo-face tg)))
  11046. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11047. (insert "[" c "] " tg (make-string
  11048. (- fwidth 4 (length tg)) ?\ ))
  11049. (when (= (setq cnt (1+ cnt)) ncol)
  11050. (insert "\n")
  11051. (if ingroup (insert " "))
  11052. (setq cnt 0)))))
  11053. (insert "\n")
  11054. (goto-char (point-min))
  11055. (if (not expert) (org-fit-window-to-buffer))
  11056. (message "[a-z..]:Set [SPC]:clear")
  11057. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11058. (cond
  11059. ((or (= c ?\C-g)
  11060. (and (= c ?q) (not (rassoc c fulltable))))
  11061. (setq quit-flag t))
  11062. ((= c ?\ ) nil)
  11063. ((setq e (rassoc c fulltable) tg (car e))
  11064. tg)
  11065. (t (setq quit-flag t)))))))
  11066. (defun org-entry-is-todo-p ()
  11067. (member (org-get-todo-state) org-not-done-keywords))
  11068. (defun org-entry-is-done-p ()
  11069. (member (org-get-todo-state) org-done-keywords))
  11070. (defun org-get-todo-state ()
  11071. (save-excursion
  11072. (org-back-to-heading t)
  11073. (and (looking-at org-todo-line-regexp)
  11074. (match-end 2)
  11075. (match-string 2))))
  11076. (defun org-at-date-range-p (&optional inactive-ok)
  11077. "Is the cursor inside a date range?"
  11078. (interactive)
  11079. (save-excursion
  11080. (catch 'exit
  11081. (let ((pos (point)))
  11082. (skip-chars-backward "^[<\r\n")
  11083. (skip-chars-backward "<[")
  11084. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11085. (>= (match-end 0) pos)
  11086. (throw 'exit t))
  11087. (skip-chars-backward "^<[\r\n")
  11088. (skip-chars-backward "<[")
  11089. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11090. (>= (match-end 0) pos)
  11091. (throw 'exit t)))
  11092. nil)))
  11093. (defun org-get-repeat (&optional tagline)
  11094. "Check if there is a deadline/schedule with repeater in this entry."
  11095. (save-match-data
  11096. (save-excursion
  11097. (org-back-to-heading t)
  11098. (and (re-search-forward (if tagline
  11099. (concat tagline "\\s-*" org-repeat-re)
  11100. org-repeat-re)
  11101. (org-entry-end-position) t)
  11102. (match-string-no-properties 1)))))
  11103. (defvar org-last-changed-timestamp)
  11104. (defvar org-last-inserted-timestamp)
  11105. (defvar org-log-post-message)
  11106. (defvar org-log-note-purpose)
  11107. (defvar org-log-note-how)
  11108. (defvar org-log-note-extra)
  11109. (defun org-auto-repeat-maybe (done-word)
  11110. "Check if the current headline contains a repeated deadline/schedule.
  11111. If yes, set TODO state back to what it was and change the base date
  11112. of repeating deadline/scheduled time stamps to new date.
  11113. This function is run automatically after each state change to a DONE state."
  11114. ;; last-state is dynamically scoped into this function
  11115. (let* ((repeat (org-get-repeat))
  11116. (aa (assoc org-last-state org-todo-kwd-alist))
  11117. (interpret (nth 1 aa))
  11118. (head (nth 2 aa))
  11119. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11120. (msg "Entry repeats: ")
  11121. (org-log-done nil)
  11122. (org-todo-log-states nil)
  11123. re type n what ts time to-state)
  11124. (when repeat
  11125. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  11126. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  11127. org-todo-repeat-to-state))
  11128. (unless (and to-state (member to-state org-todo-keywords-1))
  11129. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11130. (org-todo to-state)
  11131. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11132. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11133. (org-time-stamp-format t t))))
  11134. (when org-log-repeat
  11135. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11136. (memq 'org-add-log-note post-command-hook))
  11137. ;; OK, we are already setup for some record
  11138. (if (eq org-log-repeat 'note)
  11139. ;; make sure we take a note, not only a time stamp
  11140. (setq org-log-note-how 'note))
  11141. ;; Set up for taking a record
  11142. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  11143. org-last-state
  11144. 'findpos org-log-repeat)))
  11145. (org-back-to-heading t)
  11146. (org-add-planning-info nil nil 'closed)
  11147. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11148. org-deadline-time-regexp "\\)\\|\\("
  11149. org-ts-regexp "\\)"))
  11150. (while (re-search-forward
  11151. re (save-excursion (outline-next-heading) (point)) t)
  11152. (setq type (if (match-end 1) org-scheduled-string
  11153. (if (match-end 3) org-deadline-string "Plain:"))
  11154. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  11155. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  11156. (setq n (string-to-number (match-string 2 ts))
  11157. what (match-string 3 ts))
  11158. (if (equal what "w") (setq n (* n 7) what "d"))
  11159. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  11160. (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  11161. ;; Preparation, see if we need to modify the start date for the change
  11162. (when (match-end 1)
  11163. (setq time (save-match-data (org-time-string-to-time ts)))
  11164. (cond
  11165. ((equal (match-string 1 ts) ".")
  11166. ;; Shift starting date to today
  11167. (org-timestamp-change
  11168. (- (org-today) (time-to-days time))
  11169. 'day))
  11170. ((equal (match-string 1 ts) "+")
  11171. (let ((nshiftmax 10) (nshift 0))
  11172. (while (or (= nshift 0)
  11173. (<= (time-to-days time)
  11174. (time-to-days (current-time))))
  11175. (when (= (incf nshift) nshiftmax)
  11176. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  11177. (error "Abort")))
  11178. (org-timestamp-change n (cdr (assoc what whata)))
  11179. (org-at-timestamp-p t)
  11180. (setq ts (match-string 1))
  11181. (setq time (save-match-data (org-time-string-to-time ts)))))
  11182. (org-timestamp-change (- n) (cdr (assoc what whata)))
  11183. ;; rematch, so that we have everything in place for the real shift
  11184. (org-at-timestamp-p t)
  11185. (setq ts (match-string 1))
  11186. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  11187. (org-timestamp-change n (cdr (assoc what whata)))
  11188. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  11189. (setq org-log-post-message msg)
  11190. (message "%s" msg))))
  11191. (defun org-show-todo-tree (arg)
  11192. "Make a compact tree which shows all headlines marked with TODO.
  11193. The tree will show the lines where the regexp matches, and all higher
  11194. headlines above the match.
  11195. With a \\[universal-argument] prefix, prompt for a regexp to match.
  11196. With a numeric prefix N, construct a sparse tree for the Nth element
  11197. of `org-todo-keywords-1'."
  11198. (interactive "P")
  11199. (let ((case-fold-search nil)
  11200. (kwd-re
  11201. (cond ((null arg) org-not-done-regexp)
  11202. ((equal arg '(4))
  11203. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  11204. (mapcar 'list org-todo-keywords-1))))
  11205. (concat "\\("
  11206. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  11207. "\\)\\>")))
  11208. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  11209. (regexp-quote (nth (1- (prefix-numeric-value arg))
  11210. org-todo-keywords-1)))
  11211. (t (error "Invalid prefix argument: %s" arg)))))
  11212. (message "%d TODO entries found"
  11213. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  11214. (defun org-deadline (&optional remove time)
  11215. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  11216. With argument REMOVE, remove any deadline from the item.
  11217. With argument TIME, set the deadline at the corresponding date. TIME
  11218. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11219. (interactive "P")
  11220. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11221. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11222. 'region-start-level 'region))
  11223. org-loop-over-headlines-in-active-region)
  11224. (org-map-entries
  11225. `(org-deadline ',remove ,time)
  11226. org-loop-over-headlines-in-active-region
  11227. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11228. (let* ((old-date (org-entry-get nil "DEADLINE"))
  11229. (repeater (and old-date
  11230. (string-match
  11231. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11232. old-date)
  11233. (match-string 1 old-date))))
  11234. (if remove
  11235. (progn
  11236. (when (and old-date org-log-redeadline)
  11237. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11238. org-log-redeadline))
  11239. (org-remove-timestamp-with-keyword org-deadline-string)
  11240. (message "Item no longer has a deadline."))
  11241. (org-add-planning-info 'deadline time 'closed)
  11242. (when (and old-date org-log-redeadline
  11243. (not (equal old-date
  11244. (substring org-last-inserted-timestamp 1 -1))))
  11245. (org-add-log-setup 'redeadline nil old-date 'findpos
  11246. org-log-redeadline))
  11247. (when repeater
  11248. (save-excursion
  11249. (org-back-to-heading t)
  11250. (when (re-search-forward (concat org-deadline-string " "
  11251. org-last-inserted-timestamp)
  11252. (save-excursion
  11253. (outline-next-heading) (point)) t)
  11254. (goto-char (1- (match-end 0)))
  11255. (insert " " repeater)
  11256. (setq org-last-inserted-timestamp
  11257. (concat (substring org-last-inserted-timestamp 0 -1)
  11258. " " repeater
  11259. (substring org-last-inserted-timestamp -1))))))
  11260. (message "Deadline on %s" org-last-inserted-timestamp)))))
  11261. (defun org-schedule (&optional remove time)
  11262. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11263. With argument REMOVE, remove any scheduling date from the item.
  11264. With argument TIME, scheduled at the corresponding date. TIME can
  11265. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11266. (interactive "P")
  11267. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11268. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11269. 'region-start-level 'region))
  11270. org-loop-over-headlines-in-active-region)
  11271. (org-map-entries
  11272. `(org-schedule ',remove ,time)
  11273. org-loop-over-headlines-in-active-region
  11274. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11275. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11276. (repeater (and old-date
  11277. (string-match
  11278. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11279. old-date)
  11280. (match-string 1 old-date))))
  11281. (if remove
  11282. (progn
  11283. (when (and old-date org-log-reschedule)
  11284. (org-add-log-setup 'delschedule nil old-date 'findpos
  11285. org-log-reschedule))
  11286. (org-remove-timestamp-with-keyword org-scheduled-string)
  11287. (message "Item is no longer scheduled."))
  11288. (org-add-planning-info 'scheduled time 'closed)
  11289. (when (and old-date org-log-reschedule
  11290. (not (equal old-date
  11291. (substring org-last-inserted-timestamp 1 -1))))
  11292. (org-add-log-setup 'reschedule nil old-date 'findpos
  11293. org-log-reschedule))
  11294. (when repeater
  11295. (save-excursion
  11296. (org-back-to-heading t)
  11297. (when (re-search-forward (concat org-scheduled-string " "
  11298. org-last-inserted-timestamp)
  11299. (save-excursion
  11300. (outline-next-heading) (point)) t)
  11301. (goto-char (1- (match-end 0)))
  11302. (insert " " repeater)
  11303. (setq org-last-inserted-timestamp
  11304. (concat (substring org-last-inserted-timestamp 0 -1)
  11305. " " repeater
  11306. (substring org-last-inserted-timestamp -1))))))
  11307. (message "Scheduled to %s" org-last-inserted-timestamp)))))
  11308. (defun org-get-scheduled-time (pom &optional inherit)
  11309. "Get the scheduled time as a time tuple, of a format suitable
  11310. for calling org-schedule with, or if there is no scheduling,
  11311. returns nil."
  11312. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11313. (when time
  11314. (apply 'encode-time (org-parse-time-string time)))))
  11315. (defun org-get-deadline-time (pom &optional inherit)
  11316. "Get the deadline as a time tuple, of a format suitable for
  11317. calling org-deadline with, or if there is no scheduling, returns
  11318. nil."
  11319. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11320. (when time
  11321. (apply 'encode-time (org-parse-time-string time)))))
  11322. (defun org-remove-timestamp-with-keyword (keyword)
  11323. "Remove all time stamps with KEYWORD in the current entry."
  11324. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11325. beg)
  11326. (save-excursion
  11327. (org-back-to-heading t)
  11328. (setq beg (point))
  11329. (outline-next-heading)
  11330. (while (re-search-backward re beg t)
  11331. (replace-match "")
  11332. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11333. (equal (char-before) ?\ ))
  11334. (backward-delete-char 1)
  11335. (if (string-match "^[ \t]*$" (buffer-substring
  11336. (point-at-bol) (point-at-eol)))
  11337. (delete-region (point-at-bol)
  11338. (min (point-max) (1+ (point-at-eol))))))))))
  11339. (defun org-add-planning-info (what &optional time &rest remove)
  11340. "Insert new timestamp with keyword in the line directly after the headline.
  11341. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11342. If non is given, the user is prompted for a date.
  11343. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11344. be removed."
  11345. (interactive)
  11346. (let (org-time-was-given org-end-time-was-given ts
  11347. end default-time default-input)
  11348. (catch 'exit
  11349. (when (and (memq what '(scheduled deadline))
  11350. (or (not time)
  11351. (and (stringp time)
  11352. (string-match "^[-+]+[0-9]" time))))
  11353. ;; Try to get a default date/time from existing timestamp
  11354. (save-excursion
  11355. (org-back-to-heading t)
  11356. (setq end (save-excursion (outline-next-heading) (point)))
  11357. (when (re-search-forward (if (eq what 'scheduled)
  11358. org-scheduled-time-regexp
  11359. org-deadline-time-regexp)
  11360. end t)
  11361. (setq ts (match-string 1)
  11362. default-time
  11363. (apply 'encode-time (org-parse-time-string ts))
  11364. default-input (and ts (org-get-compact-tod ts))))))
  11365. (when what
  11366. (setq time
  11367. (if (stringp time)
  11368. ;; This is a string (relative or absolute), set proper date
  11369. (apply 'encode-time
  11370. (org-read-date-analyze
  11371. time default-time (decode-time default-time)))
  11372. ;; If necessary, get the time from the user
  11373. (or time (org-read-date nil 'to-time nil nil
  11374. default-time default-input)))))
  11375. (when (and org-insert-labeled-timestamps-at-point
  11376. (member what '(scheduled deadline)))
  11377. (insert
  11378. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11379. (org-insert-time-stamp time org-time-was-given
  11380. nil nil nil (list org-end-time-was-given))
  11381. (setq what nil))
  11382. (save-excursion
  11383. (save-restriction
  11384. (let (col list elt ts buffer-invisibility-spec)
  11385. (org-back-to-heading t)
  11386. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11387. (goto-char (match-end 1))
  11388. (setq col (current-column))
  11389. (goto-char (match-end 0))
  11390. (if (eobp) (insert "\n") (forward-char 1))
  11391. (when (and (not what)
  11392. (not (looking-at
  11393. (concat "[ \t]*"
  11394. org-keyword-time-not-clock-regexp))))
  11395. ;; Nothing to add, nothing to remove...... :-)
  11396. (throw 'exit nil))
  11397. (if (and (not (looking-at org-outline-regexp))
  11398. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11399. "[^\r\n]*"))
  11400. (not (equal (match-string 1) org-clock-string)))
  11401. (narrow-to-region (match-beginning 0) (match-end 0))
  11402. (insert-before-markers "\n")
  11403. (backward-char 1)
  11404. (narrow-to-region (point) (point))
  11405. (and org-adapt-indentation (org-indent-to-column col)))
  11406. ;; Check if we have to remove something.
  11407. (setq list (cons what remove))
  11408. (while list
  11409. (setq elt (pop list))
  11410. (when (or (and (eq elt 'scheduled)
  11411. (re-search-forward org-scheduled-time-regexp nil t))
  11412. (and (eq elt 'deadline)
  11413. (re-search-forward org-deadline-time-regexp nil t))
  11414. (and (eq elt 'closed)
  11415. (re-search-forward org-closed-time-regexp nil t)))
  11416. (replace-match "")
  11417. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11418. (and (looking-at "[ \t]+") (replace-match ""))
  11419. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11420. (when what
  11421. (insert
  11422. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11423. (cond ((eq what 'scheduled) org-scheduled-string)
  11424. ((eq what 'deadline) org-deadline-string)
  11425. ((eq what 'closed) org-closed-string))
  11426. " ")
  11427. (setq ts (org-insert-time-stamp
  11428. time
  11429. (or org-time-was-given
  11430. (and (eq what 'closed) org-log-done-with-time))
  11431. (eq what 'closed)
  11432. nil nil (list org-end-time-was-given)))
  11433. (insert
  11434. (if (not (or (bolp) (eq (char-before) ?\ )
  11435. (memq (char-after) '(32 10))
  11436. (eobp))) " " ""))
  11437. (end-of-line 1))
  11438. (goto-char (point-min))
  11439. (widen)
  11440. (if (and (looking-at "[ \t]*\n")
  11441. (equal (char-before) ?\n))
  11442. (delete-region (1- (point)) (point-at-eol)))
  11443. ts))))))
  11444. (defvar org-log-note-marker (make-marker))
  11445. (defvar org-log-note-purpose nil)
  11446. (defvar org-log-note-state nil)
  11447. (defvar org-log-note-previous-state nil)
  11448. (defvar org-log-note-how nil)
  11449. (defvar org-log-note-extra nil)
  11450. (defvar org-log-note-window-configuration nil)
  11451. (defvar org-log-note-return-to (make-marker))
  11452. (defvar org-log-note-effective-time nil
  11453. "Remembered current time so that dynamically scoped
  11454. `org-extend-today-until' affects tha timestamps in state change
  11455. log")
  11456. (defvar org-log-post-message nil
  11457. "Message to be displayed after a log note has been stored.
  11458. The auto-repeater uses this.")
  11459. (defun org-add-note ()
  11460. "Add a note to the current entry.
  11461. This is done in the same way as adding a state change note."
  11462. (interactive)
  11463. (org-add-log-setup 'note nil nil 'findpos nil))
  11464. (defvar org-property-end-re)
  11465. (defun org-add-log-setup (&optional purpose state prev-state
  11466. findpos how extra)
  11467. "Set up the post command hook to take a note.
  11468. If this is about to TODO state change, the new state is expected in STATE.
  11469. When FINDPOS is non-nil, find the correct position for the note in
  11470. the current entry. If not, assume that it can be inserted at point.
  11471. HOW is an indicator what kind of note should be created.
  11472. EXTRA is additional text that will be inserted into the notes buffer."
  11473. (let* ((org-log-into-drawer (org-log-into-drawer))
  11474. (drawer (cond ((stringp org-log-into-drawer)
  11475. org-log-into-drawer)
  11476. (org-log-into-drawer "LOGBOOK"))))
  11477. (save-restriction
  11478. (save-excursion
  11479. (when findpos
  11480. (org-back-to-heading t)
  11481. (narrow-to-region (point) (save-excursion
  11482. (outline-next-heading) (point)))
  11483. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  11484. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  11485. "[^\r\n]*\\)?"))
  11486. (goto-char (match-end 0))
  11487. (cond
  11488. (drawer
  11489. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  11490. nil t)
  11491. (progn
  11492. (goto-char (match-end 0))
  11493. (or org-log-states-order-reversed
  11494. (and (re-search-forward org-property-end-re nil t)
  11495. (goto-char (1- (match-beginning 0))))))
  11496. (insert "\n:" drawer ":\n:END:")
  11497. (beginning-of-line 0)
  11498. (org-indent-line)
  11499. (beginning-of-line 2)
  11500. (org-indent-line)
  11501. (end-of-line 0)))
  11502. ((and org-log-state-notes-insert-after-drawers
  11503. (save-excursion
  11504. (forward-line) (looking-at org-drawer-regexp)))
  11505. (forward-line)
  11506. (while (looking-at org-drawer-regexp)
  11507. (goto-char (match-end 0))
  11508. (re-search-forward org-property-end-re (point-max) t)
  11509. (forward-line))
  11510. (forward-line -1)))
  11511. (unless org-log-states-order-reversed
  11512. (and (= (char-after) ?\n) (forward-char 1))
  11513. (org-skip-over-state-notes)
  11514. (skip-chars-backward " \t\n\r")))
  11515. (move-marker org-log-note-marker (point))
  11516. (setq org-log-note-purpose purpose
  11517. org-log-note-state state
  11518. org-log-note-previous-state prev-state
  11519. org-log-note-how how
  11520. org-log-note-extra extra
  11521. org-log-note-effective-time (org-current-effective-time))
  11522. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  11523. (defun org-skip-over-state-notes ()
  11524. "Skip past the list of State notes in an entry."
  11525. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  11526. (when (ignore-errors (goto-char (org-in-item-p)))
  11527. (let* ((struct (org-list-struct))
  11528. (prevs (org-list-prevs-alist struct)))
  11529. (while (looking-at "[ \t]*- State")
  11530. (goto-char (or (org-list-get-next-item (point) struct prevs)
  11531. (org-list-get-item-end (point) struct)))))))
  11532. (defun org-add-log-note (&optional purpose)
  11533. "Pop up a window for taking a note, and add this note later at point."
  11534. (remove-hook 'post-command-hook 'org-add-log-note)
  11535. (setq org-log-note-window-configuration (current-window-configuration))
  11536. (delete-other-windows)
  11537. (move-marker org-log-note-return-to (point))
  11538. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  11539. (goto-char org-log-note-marker)
  11540. (org-switch-to-buffer-other-window "*Org Note*")
  11541. (erase-buffer)
  11542. (if (memq org-log-note-how '(time state))
  11543. (let (current-prefix-arg) (org-store-log-note))
  11544. (let ((org-inhibit-startup t)) (org-mode))
  11545. (insert (format "# Insert note for %s.
  11546. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  11547. (cond
  11548. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  11549. ((eq org-log-note-purpose 'done) "closed todo item")
  11550. ((eq org-log-note-purpose 'state)
  11551. (format "state change from \"%s\" to \"%s\""
  11552. (or org-log-note-previous-state "")
  11553. (or org-log-note-state "")))
  11554. ((eq org-log-note-purpose 'reschedule)
  11555. "rescheduling")
  11556. ((eq org-log-note-purpose 'delschedule)
  11557. "no longer scheduled")
  11558. ((eq org-log-note-purpose 'redeadline)
  11559. "changing deadline")
  11560. ((eq org-log-note-purpose 'deldeadline)
  11561. "removing deadline")
  11562. ((eq org-log-note-purpose 'refile)
  11563. "refiling")
  11564. ((eq org-log-note-purpose 'note)
  11565. "this entry")
  11566. (t (error "This should not happen")))))
  11567. (if org-log-note-extra (insert org-log-note-extra))
  11568. (org-set-local 'org-finish-function 'org-store-log-note)
  11569. (run-hooks 'org-log-buffer-setup-hook)))
  11570. (defvar org-note-abort nil) ; dynamically scoped
  11571. (defun org-store-log-note ()
  11572. "Finish taking a log note, and insert it to where it belongs."
  11573. (let ((txt (buffer-string))
  11574. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  11575. lines ind bul)
  11576. (kill-buffer (current-buffer))
  11577. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  11578. (setq txt (replace-match "" t t txt)))
  11579. (if (string-match "\\s-+\\'" txt)
  11580. (setq txt (replace-match "" t t txt)))
  11581. (setq lines (org-split-string txt "\n"))
  11582. (when (and note (string-match "\\S-" note))
  11583. (setq note
  11584. (org-replace-escapes
  11585. note
  11586. (list (cons "%u" (user-login-name))
  11587. (cons "%U" user-full-name)
  11588. (cons "%t" (format-time-string
  11589. (org-time-stamp-format 'long 'inactive)
  11590. org-log-note-effective-time))
  11591. (cons "%T" (format-time-string
  11592. (org-time-stamp-format 'long nil)
  11593. org-log-note-effective-time))
  11594. (cons "%d" (format-time-string
  11595. (org-time-stamp-format nil 'inactive)
  11596. org-log-note-effective-time))
  11597. (cons "%D" (format-time-string
  11598. (org-time-stamp-format nil nil)
  11599. org-log-note-effective-time))
  11600. (cons "%s" (if org-log-note-state
  11601. (concat "\"" org-log-note-state "\"")
  11602. ""))
  11603. (cons "%S" (if org-log-note-previous-state
  11604. (concat "\"" org-log-note-previous-state "\"")
  11605. "\"\"")))))
  11606. (if lines (setq note (concat note " \\\\")))
  11607. (push note lines))
  11608. (when (or current-prefix-arg org-note-abort)
  11609. (when org-log-into-drawer
  11610. (org-remove-empty-drawer-at
  11611. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  11612. org-log-note-marker))
  11613. (setq lines nil))
  11614. (when lines
  11615. (with-current-buffer (marker-buffer org-log-note-marker)
  11616. (save-excursion
  11617. (goto-char org-log-note-marker)
  11618. (move-marker org-log-note-marker nil)
  11619. (end-of-line 1)
  11620. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  11621. (setq ind (save-excursion
  11622. (if (ignore-errors (goto-char (org-in-item-p)))
  11623. (let ((struct (org-list-struct)))
  11624. (org-list-get-ind
  11625. (org-list-get-top-point struct) struct))
  11626. (skip-chars-backward " \r\t\n")
  11627. (cond
  11628. ((and (org-at-heading-p)
  11629. org-adapt-indentation)
  11630. (1+ (org-current-level)))
  11631. ((org-at-heading-p) 0)
  11632. (t (org-get-indentation))))))
  11633. (setq bul (org-list-bullet-string "-"))
  11634. (org-indent-line-to ind)
  11635. (insert bul (pop lines))
  11636. (let ((ind-body (+ (length bul) ind)))
  11637. (while lines
  11638. (insert "\n")
  11639. (org-indent-line-to ind-body)
  11640. (insert (pop lines))))
  11641. (message "Note stored")
  11642. (org-back-to-heading t)
  11643. (org-cycle-hide-drawers 'children)))))
  11644. (set-window-configuration org-log-note-window-configuration)
  11645. (with-current-buffer (marker-buffer org-log-note-return-to)
  11646. (goto-char org-log-note-return-to))
  11647. (move-marker org-log-note-return-to nil)
  11648. (and org-log-post-message (message "%s" org-log-post-message)))
  11649. (defun org-remove-empty-drawer-at (drawer pos)
  11650. "Remove an empty drawer DRAWER at position POS.
  11651. POS may also be a marker."
  11652. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  11653. (save-excursion
  11654. (save-restriction
  11655. (widen)
  11656. (goto-char pos)
  11657. (if (org-in-regexp
  11658. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  11659. (replace-match ""))))))
  11660. (defvar org-ts-type nil)
  11661. (defun org-sparse-tree (&optional arg type)
  11662. "Create a sparse tree, prompt for the details.
  11663. This command can create sparse trees. You first need to select the type
  11664. of match used to create the tree:
  11665. t Show all TODO entries.
  11666. T Show entries with a specific TODO keyword.
  11667. m Show entries selected by a tags/property match.
  11668. p Enter a property name and its value (both with completion on existing
  11669. names/values) and show entries with that property.
  11670. r Show entries matching a regular expression (`/' can be used as well).
  11671. b Show deadlines and scheduled items before a date.
  11672. a Show deadlines and scheduled items after a date.
  11673. d Show deadlines due within `org-deadline-warning-days'.
  11674. D Show deadlines and scheduled items between a date range."
  11675. (interactive "P")
  11676. (let (ans kwd value ts-type)
  11677. (setq type (or type org-sparse-tree-default-date-type))
  11678. (setq org-ts-type type)
  11679. (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"
  11680. (cond ((eq type 'all) "all timestamps")
  11681. ((eq type 'scheduled) "only scheduled")
  11682. ((eq type 'deadline) "only deadline")
  11683. ((eq type 'active) "only active timestamps")
  11684. ((eq type 'inactive) "only inactive timestamps")
  11685. ((eq type 'scheduled-or-deadline) "scheduled/deadline")
  11686. (t "scheduled/deadline")))
  11687. (setq ans (read-char-exclusive))
  11688. (cond
  11689. ((equal ans ?c)
  11690. (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
  11691. ((equal ans ?d)
  11692. (call-interactively 'org-check-deadlines))
  11693. ((equal ans ?b)
  11694. (call-interactively 'org-check-before-date))
  11695. ((equal ans ?a)
  11696. (call-interactively 'org-check-after-date))
  11697. ((equal ans ?D)
  11698. (call-interactively 'org-check-dates-range))
  11699. ((equal ans ?t)
  11700. (org-show-todo-tree nil))
  11701. ((equal ans ?T)
  11702. (org-show-todo-tree '(4)))
  11703. ((member ans '(?T ?m))
  11704. (call-interactively 'org-match-sparse-tree))
  11705. ((member ans '(?p ?P))
  11706. (setq kwd (org-icompleting-read "Property: "
  11707. (mapcar 'list (org-buffer-property-keys))))
  11708. (setq value (org-icompleting-read "Value: "
  11709. (mapcar 'list (org-property-values kwd))))
  11710. (unless (string-match "\\`{.*}\\'" value)
  11711. (setq value (concat "\"" value "\"")))
  11712. (org-match-sparse-tree arg (concat kwd "=" value)))
  11713. ((member ans '(?r ?R ?/))
  11714. (call-interactively 'org-occur))
  11715. (t (error "No such sparse tree command \"%c\"" ans)))))
  11716. (defvar org-occur-highlights nil
  11717. "List of overlays used for occur matches.")
  11718. (make-variable-buffer-local 'org-occur-highlights)
  11719. (defvar org-occur-parameters nil
  11720. "Parameters of the active org-occur calls.
  11721. This is a list, each call to org-occur pushes as cons cell,
  11722. containing the regular expression and the callback, onto the list.
  11723. The list can contain several entries if `org-occur' has been called
  11724. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  11725. will only contain one set of parameters. When the highlights are
  11726. removed (for example with `C-c C-c', or with the next edit (depending
  11727. on `org-remove-highlights-with-change'), this variable is emptied
  11728. as well.")
  11729. (make-variable-buffer-local 'org-occur-parameters)
  11730. (defun org-occur (regexp &optional keep-previous callback)
  11731. "Make a compact tree which shows all matches of REGEXP.
  11732. The tree will show the lines where the regexp matches, and all higher
  11733. headlines above the match. It will also show the heading after the match,
  11734. to make sure editing the matching entry is easy.
  11735. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  11736. call to `org-occur' will be kept, to allow stacking of calls to this
  11737. command.
  11738. If CALLBACK is non-nil, it is a function which is called to confirm
  11739. that the match should indeed be shown."
  11740. (interactive "sRegexp: \nP")
  11741. (when (equal regexp "")
  11742. (error "Regexp cannot be empty"))
  11743. (unless keep-previous
  11744. (org-remove-occur-highlights nil nil t))
  11745. (push (cons regexp callback) org-occur-parameters)
  11746. (let ((cnt 0))
  11747. (save-excursion
  11748. (goto-char (point-min))
  11749. (if (or (not keep-previous) ; do not want to keep
  11750. (not org-occur-highlights)) ; no previous matches
  11751. ;; hide everything
  11752. (org-overview))
  11753. (while (re-search-forward regexp nil t)
  11754. (when (or (not callback)
  11755. (save-match-data (funcall callback)))
  11756. (setq cnt (1+ cnt))
  11757. (when org-highlight-sparse-tree-matches
  11758. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  11759. (org-show-context 'occur-tree))))
  11760. (when org-remove-highlights-with-change
  11761. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  11762. nil 'local))
  11763. (unless org-sparse-tree-open-archived-trees
  11764. (org-hide-archived-subtrees (point-min) (point-max)))
  11765. (run-hooks 'org-occur-hook)
  11766. (if (org-called-interactively-p 'interactive)
  11767. (message "%d match(es) for regexp %s" cnt regexp))
  11768. cnt))
  11769. (defun org-occur-next-match (&optional n reset)
  11770. "Function for `next-error-function' to find sparse tree matches.
  11771. N is the number of matches to move, when negative move backwards.
  11772. RESET is entirely ignored - this function always goes back to the
  11773. starting point when no match is found."
  11774. (let* ((limit (if (< n 0) (point-min) (point-max)))
  11775. (search-func (if (< n 0)
  11776. 'previous-single-char-property-change
  11777. 'next-single-char-property-change))
  11778. (n (abs n))
  11779. (pos (point))
  11780. p1)
  11781. (catch 'exit
  11782. (while (setq p1 (funcall search-func (point) 'org-type))
  11783. (when (equal p1 limit)
  11784. (goto-char pos)
  11785. (error "No more matches"))
  11786. (when (equal (get-char-property p1 'org-type) 'org-occur)
  11787. (setq n (1- n))
  11788. (when (= n 0)
  11789. (goto-char p1)
  11790. (throw 'exit (point))))
  11791. (goto-char p1))
  11792. (goto-char p1)
  11793. (error "No more matches"))))
  11794. (defun org-show-context (&optional key)
  11795. "Make sure point and context are visible.
  11796. How much context is shown depends upon the variables
  11797. `org-show-hierarchy-above', `org-show-following-heading',
  11798. `org-show-entry-below' and `org-show-siblings'."
  11799. (let ((heading-p (org-at-heading-p t))
  11800. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  11801. (following-p (org-get-alist-option org-show-following-heading key))
  11802. (entry-p (org-get-alist-option org-show-entry-below key))
  11803. (siblings-p (org-get-alist-option org-show-siblings key)))
  11804. (catch 'exit
  11805. ;; Show heading or entry text
  11806. (if (and heading-p (not entry-p))
  11807. (org-flag-heading nil) ; only show the heading
  11808. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  11809. (org-show-hidden-entry))) ; show entire entry
  11810. (when following-p
  11811. ;; Show next sibling, or heading below text
  11812. (save-excursion
  11813. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  11814. (org-flag-heading nil))))
  11815. (when siblings-p (org-show-siblings))
  11816. (when hierarchy-p
  11817. ;; show all higher headings, possibly with siblings
  11818. (save-excursion
  11819. (while (and (condition-case nil
  11820. (progn (org-up-heading-all 1) t)
  11821. (error nil))
  11822. (not (bobp)))
  11823. (org-flag-heading nil)
  11824. (when siblings-p (org-show-siblings))))))))
  11825. (defvar org-reveal-start-hook nil
  11826. "Hook run before revealing a location.")
  11827. (defun org-reveal (&optional siblings)
  11828. "Show current entry, hierarchy above it, and the following headline.
  11829. This can be used to show a consistent set of context around locations
  11830. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  11831. not t for the search context.
  11832. With optional argument SIBLINGS, on each level of the hierarchy all
  11833. siblings are shown. This repairs the tree structure to what it would
  11834. look like when opened with hierarchical calls to `org-cycle'.
  11835. With double optional argument \\[universal-argument] \\[universal-argument], \
  11836. go to the parent and show the
  11837. entire tree."
  11838. (interactive "P")
  11839. (run-hooks 'org-reveal-start-hook)
  11840. (let ((org-show-hierarchy-above t)
  11841. (org-show-following-heading t)
  11842. (org-show-siblings (if siblings t org-show-siblings)))
  11843. (org-show-context nil))
  11844. (when (equal siblings '(16))
  11845. (save-excursion
  11846. (when (org-up-heading-safe)
  11847. (org-show-subtree)
  11848. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  11849. (defun org-highlight-new-match (beg end)
  11850. "Highlight from BEG to END and mark the highlight is an occur headline."
  11851. (let ((ov (make-overlay beg end)))
  11852. (overlay-put ov 'face 'secondary-selection)
  11853. (overlay-put ov 'org-type 'org-occur)
  11854. (push ov org-occur-highlights)))
  11855. (defun org-remove-occur-highlights (&optional beg end noremove)
  11856. "Remove the occur highlights from the buffer.
  11857. BEG and END are ignored. If NOREMOVE is nil, remove this function
  11858. from the `before-change-functions' in the current buffer."
  11859. (interactive)
  11860. (unless org-inhibit-highlight-removal
  11861. (mapc 'delete-overlay org-occur-highlights)
  11862. (setq org-occur-highlights nil)
  11863. (setq org-occur-parameters nil)
  11864. (unless noremove
  11865. (remove-hook 'before-change-functions
  11866. 'org-remove-occur-highlights 'local))))
  11867. ;;;; Priorities
  11868. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  11869. "Regular expression matching the priority indicator.")
  11870. (defvar org-remove-priority-next-time nil)
  11871. (defun org-priority-up ()
  11872. "Increase the priority of the current item."
  11873. (interactive)
  11874. (org-priority 'up))
  11875. (defun org-priority-down ()
  11876. "Decrease the priority of the current item."
  11877. (interactive)
  11878. (org-priority 'down))
  11879. (defun org-priority (&optional action)
  11880. "Change the priority of an item.
  11881. ACTION can be `set', `up', `down', or a character."
  11882. (interactive)
  11883. (unless org-enable-priority-commands
  11884. (error "Priority commands are disabled"))
  11885. (setq action (or action 'set))
  11886. (let (current new news have remove)
  11887. (save-excursion
  11888. (org-back-to-heading t)
  11889. (if (looking-at org-priority-regexp)
  11890. (setq current (string-to-char (match-string 2))
  11891. have t))
  11892. (cond
  11893. ((eq action 'remove)
  11894. (setq remove t new ?\ ))
  11895. ((or (eq action 'set)
  11896. (if (featurep 'xemacs) (characterp action) (integerp action)))
  11897. (if (not (eq action 'set))
  11898. (setq new action)
  11899. (message "Priority %c-%c, SPC to remove: "
  11900. org-highest-priority org-lowest-priority)
  11901. (save-match-data
  11902. (setq new (read-char-exclusive))))
  11903. (if (and (= (upcase org-highest-priority) org-highest-priority)
  11904. (= (upcase org-lowest-priority) org-lowest-priority))
  11905. (setq new (upcase new)))
  11906. (cond ((equal new ?\ ) (setq remove t))
  11907. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  11908. (error "Priority must be between `%c' and `%c'"
  11909. org-highest-priority org-lowest-priority))))
  11910. ((eq action 'up)
  11911. (setq new (if have
  11912. (1- current) ; normal cycling
  11913. ;; last priority was empty
  11914. (if (eq last-command this-command)
  11915. org-lowest-priority ; wrap around empty to lowest
  11916. ;; default
  11917. (if org-priority-start-cycle-with-default
  11918. org-default-priority
  11919. (1- org-default-priority))))))
  11920. ((eq action 'down)
  11921. (setq new (if have
  11922. (1+ current) ; normal cycling
  11923. ;; last priority was empty
  11924. (if (eq last-command this-command)
  11925. org-highest-priority ; wrap around empty to highest
  11926. ;; default
  11927. (if org-priority-start-cycle-with-default
  11928. org-default-priority
  11929. (1+ org-default-priority))))))
  11930. (t (error "Invalid action")))
  11931. (if (or (< (upcase new) org-highest-priority)
  11932. (> (upcase new) org-lowest-priority))
  11933. (if (and (memq action '(up down))
  11934. (not have) (not (eq last-command this-command)))
  11935. ;; `new' is from default priority
  11936. (error
  11937. "The default can not be set, see `org-default-priority' why")
  11938. ;; normal cycling: `new' is beyond highest/lowest priority
  11939. ;; and is wrapped around to the empty priority
  11940. (setq remove t)))
  11941. (setq news (format "%c" new))
  11942. (if have
  11943. (if remove
  11944. (replace-match "" t t nil 1)
  11945. (replace-match news t t nil 2))
  11946. (if remove
  11947. (error "No priority cookie found in line")
  11948. (let ((case-fold-search nil))
  11949. (looking-at org-todo-line-regexp))
  11950. (if (match-end 2)
  11951. (progn
  11952. (goto-char (match-end 2))
  11953. (insert " [#" news "]"))
  11954. (goto-char (match-beginning 3))
  11955. (insert "[#" news "] "))))
  11956. (org-preserve-lc (org-set-tags nil 'align)))
  11957. (if remove
  11958. (message "Priority removed")
  11959. (message "Priority of current item set to %s" news))))
  11960. (defun org-get-priority (s)
  11961. "Find priority cookie and return priority."
  11962. (if (functionp org-get-priority-function)
  11963. (funcall org-get-priority-function)
  11964. (save-match-data
  11965. (if (not (string-match org-priority-regexp s))
  11966. (* 1000 (- org-lowest-priority org-default-priority))
  11967. (* 1000 (- org-lowest-priority
  11968. (string-to-char (match-string 2 s))))))))
  11969. ;;;; Tags
  11970. (defvar org-agenda-archives-mode)
  11971. (defvar org-map-continue-from nil
  11972. "Position from where mapping should continue.
  11973. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  11974. (defvar org-scanner-tags nil
  11975. "The current tag list while the tags scanner is running.")
  11976. (defvar org-trust-scanner-tags nil
  11977. "Should `org-get-tags-at' use the tags for the scanner.
  11978. This is for internal dynamical scoping only.
  11979. When this is non-nil, the function `org-get-tags-at' will return the value
  11980. of `org-scanner-tags' instead of building the list by itself. This
  11981. can lead to large speed-ups when the tags scanner is used in a file with
  11982. many entries, and when the list of tags is retrieved, for example to
  11983. obtain a list of properties. Building the tags list for each entry in such
  11984. a file becomes an N^2 operation - but with this variable set, it scales
  11985. as N.")
  11986. (defun org-scan-tags (action matcher todo-only &optional start-level)
  11987. "Scan headline tags with inheritance and produce output ACTION.
  11988. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  11989. or `agenda' to produce an entry list for an agenda view. It can also be
  11990. a Lisp form or a function that should be called at each matched headline, in
  11991. this case the return value is a list of all return values from these calls.
  11992. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  11993. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  11994. only lines with a not-done TODO keyword are included in the output.
  11995. This should be the same variable that was scoped into
  11996. and set by `org-make-tags-matcher' when it constructed MATCHER.
  11997. START-LEVEL can be a string with asterisks, reducing the scope to
  11998. headlines matching this string."
  11999. (require 'org-agenda)
  12000. (let* ((re (concat "^"
  12001. (if start-level
  12002. ;; Get the correct level to match
  12003. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  12004. org-outline-regexp)
  12005. " *\\(\\<\\("
  12006. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  12007. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  12008. (props (list 'face 'default
  12009. 'done-face 'org-agenda-done
  12010. 'undone-face 'default
  12011. 'mouse-face 'highlight
  12012. 'org-not-done-regexp org-not-done-regexp
  12013. 'org-todo-regexp org-todo-regexp
  12014. 'org-complex-heading-regexp org-complex-heading-regexp
  12015. 'help-echo
  12016. (format "mouse-2 or RET jump to org file %s"
  12017. (abbreviate-file-name
  12018. (or (buffer-file-name (buffer-base-buffer))
  12019. (buffer-name (buffer-base-buffer)))))))
  12020. (case-fold-search nil)
  12021. (org-map-continue-from nil)
  12022. lspos tags tags-list
  12023. (tags-alist (list (cons 0 org-file-tags)))
  12024. (llast 0) rtn rtn1 level category i txt
  12025. todo marker entry priority)
  12026. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  12027. (setq action (list 'lambda nil action)))
  12028. (save-excursion
  12029. (goto-char (point-min))
  12030. (when (eq action 'sparse-tree)
  12031. (org-overview)
  12032. (org-remove-occur-highlights))
  12033. (while (re-search-forward re nil t)
  12034. (setq org-map-continue-from nil)
  12035. (catch :skip
  12036. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  12037. tags (if (match-end 4) (org-match-string-no-properties 4)))
  12038. (goto-char (setq lspos (match-beginning 0)))
  12039. (setq level (org-reduced-level (org-outline-level))
  12040. category (org-get-category))
  12041. (setq i llast llast level)
  12042. ;; remove tag lists from same and sublevels
  12043. (while (>= i level)
  12044. (when (setq entry (assoc i tags-alist))
  12045. (setq tags-alist (delete entry tags-alist)))
  12046. (setq i (1- i)))
  12047. ;; add the next tags
  12048. (when tags
  12049. (setq tags (org-split-string tags ":")
  12050. tags-alist
  12051. (cons (cons level tags) tags-alist)))
  12052. ;; compile tags for current headline
  12053. (setq tags-list
  12054. (if org-use-tag-inheritance
  12055. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  12056. tags)
  12057. org-scanner-tags tags-list)
  12058. (when org-use-tag-inheritance
  12059. (setcdr (car tags-alist)
  12060. (mapcar (lambda (x)
  12061. (setq x (copy-sequence x))
  12062. (org-add-prop-inherited x))
  12063. (cdar tags-alist))))
  12064. (when (and tags org-use-tag-inheritance
  12065. (or (not (eq t org-use-tag-inheritance))
  12066. org-tags-exclude-from-inheritance))
  12067. ;; selective inheritance, remove uninherited ones
  12068. (setcdr (car tags-alist)
  12069. (org-remove-uninherited-tags (cdar tags-alist))))
  12070. (when (and
  12071. ;; eval matcher only when the todo condition is OK
  12072. (and (or (not todo-only) (member todo org-not-done-keywords))
  12073. (let ((case-fold-search t) (org-trust-scanner-tags t))
  12074. (eval matcher)))
  12075. ;; Call the skipper, but return t if it does not skip,
  12076. ;; so that the `and' form continues evaluating
  12077. (progn
  12078. (unless (eq action 'sparse-tree) (org-agenda-skip))
  12079. t)
  12080. ;; Check if timestamps are deselecting this entry
  12081. (or (not todo-only)
  12082. (and (member todo org-not-done-keywords)
  12083. (or (not org-agenda-tags-todo-honor-ignore-options)
  12084. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  12085. ;; Extra check for the archive tag
  12086. ;; FIXME: Does the skipper already do this????
  12087. (or
  12088. (not (member org-archive-tag tags-list))
  12089. ;; we have an archive tag, should we use this anyway?
  12090. (or (not org-agenda-skip-archived-trees)
  12091. (and (eq action 'agenda) org-agenda-archives-mode))))
  12092. ;; select this headline
  12093. (cond
  12094. ((eq action 'sparse-tree)
  12095. (and org-highlight-sparse-tree-matches
  12096. (org-get-heading) (match-end 0)
  12097. (org-highlight-new-match
  12098. (match-beginning 1) (match-end 1)))
  12099. (org-show-context 'tags-tree))
  12100. ((eq action 'agenda)
  12101. (setq txt (org-agenda-format-item
  12102. ""
  12103. (concat
  12104. (if (eq org-tags-match-list-sublevels 'indented)
  12105. (make-string (1- level) ?.) "")
  12106. (org-get-heading))
  12107. level category
  12108. tags-list)
  12109. priority (org-get-priority txt))
  12110. (goto-char lspos)
  12111. (setq marker (org-agenda-new-marker))
  12112. (org-add-props txt props
  12113. 'org-marker marker 'org-hd-marker marker 'org-category category
  12114. 'todo-state todo
  12115. 'priority priority 'type "tagsmatch")
  12116. (push txt rtn))
  12117. ((functionp action)
  12118. (setq org-map-continue-from nil)
  12119. (save-excursion
  12120. (setq rtn1 (funcall action))
  12121. (push rtn1 rtn)))
  12122. (t (error "Invalid action")))
  12123. ;; if we are to skip sublevels, jump to end of subtree
  12124. (unless org-tags-match-list-sublevels
  12125. (org-end-of-subtree t)
  12126. (backward-char 1))))
  12127. ;; Get the correct position from where to continue
  12128. (if org-map-continue-from
  12129. (goto-char org-map-continue-from)
  12130. (and (= (point) lspos) (end-of-line 1)))))
  12131. (when (and (eq action 'sparse-tree)
  12132. (not org-sparse-tree-open-archived-trees))
  12133. (org-hide-archived-subtrees (point-min) (point-max)))
  12134. (nreverse rtn)))
  12135. (defun org-remove-uninherited-tags (tags)
  12136. "Remove all tags that are not inherited from the list TAGS."
  12137. (cond
  12138. ((eq org-use-tag-inheritance t)
  12139. (if org-tags-exclude-from-inheritance
  12140. (org-delete-all org-tags-exclude-from-inheritance tags)
  12141. tags))
  12142. ((not org-use-tag-inheritance) nil)
  12143. ((stringp org-use-tag-inheritance)
  12144. (delq nil (mapcar
  12145. (lambda (x)
  12146. (if (and (string-match org-use-tag-inheritance x)
  12147. (not (member x org-tags-exclude-from-inheritance)))
  12148. x nil))
  12149. tags)))
  12150. ((listp org-use-tag-inheritance)
  12151. (delq nil (mapcar
  12152. (lambda (x)
  12153. (if (member x org-use-tag-inheritance) x nil))
  12154. tags)))))
  12155. (defun org-match-sparse-tree (&optional todo-only match)
  12156. "Create a sparse tree according to tags string MATCH.
  12157. MATCH can contain positive and negative selection of tags, like
  12158. \"+WORK+URGENT-WITHBOSS\".
  12159. If optional argument TODO-ONLY is non-nil, only select lines that are
  12160. also TODO lines."
  12161. (interactive "P")
  12162. (org-agenda-prepare-buffers (list (current-buffer)))
  12163. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  12164. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  12165. (defvar org-cached-props nil)
  12166. (defun org-cached-entry-get (pom property)
  12167. (if (or (eq t org-use-property-inheritance)
  12168. (and (stringp org-use-property-inheritance)
  12169. (string-match org-use-property-inheritance property))
  12170. (and (listp org-use-property-inheritance)
  12171. (member property org-use-property-inheritance)))
  12172. ;; Caching is not possible, check it directly
  12173. (org-entry-get pom property 'inherit)
  12174. ;; Get all properties, so that we can do complicated checks easily
  12175. (cdr (assoc property (or org-cached-props
  12176. (setq org-cached-props
  12177. (org-entry-properties pom)))))))
  12178. (defun org-global-tags-completion-table (&optional files)
  12179. "Return the list of all tags in all agenda buffer/files.
  12180. Optional FILES argument is a list of files which can be used
  12181. instead of the agenda files."
  12182. (save-excursion
  12183. (org-uniquify
  12184. (delq nil
  12185. (apply 'append
  12186. (mapcar
  12187. (lambda (file)
  12188. (set-buffer (find-file-noselect file))
  12189. (append (org-get-buffer-tags)
  12190. (mapcar (lambda (x) (if (stringp (car-safe x))
  12191. (list (car-safe x)) nil))
  12192. org-tag-alist)))
  12193. (if (and files (car files))
  12194. files
  12195. (org-agenda-files))))))))
  12196. (defun org-make-tags-matcher (match)
  12197. "Create the TAGS/TODO matcher form for the selection string MATCH.
  12198. The variable `todo-only' is scoped dynamically into this function.
  12199. It will be set to t if the matcher restricts matching to TODO entries,
  12200. otherwise will not be touched.
  12201. Returns a cons of the selection string MATCH and the constructed
  12202. lisp form implementing the matcher. The matcher is to be evaluated
  12203. at an Org entry, with point on the headline, and returns t if the
  12204. entry matches the selection string MATCH. The returned lisp form
  12205. references two variables with information about the entry, which
  12206. must be bound around the form's evaluation: todo, the TODO keyword
  12207. at the entry (or nil of none); and tags-list, the list of all tags
  12208. at the entry including inherited ones. Additionally, the category
  12209. of the entry (if any) must be specified as the text property
  12210. 'org-category on the headline.
  12211. See also `org-scan-tags'.
  12212. "
  12213. (declare (special todo-only))
  12214. (unless (boundp 'todo-only)
  12215. (error "org-make-tags-matcher expects todo-only to be scoped in"))
  12216. (unless match
  12217. ;; Get a new match request, with completion
  12218. (let ((org-last-tags-completion-table
  12219. (org-global-tags-completion-table)))
  12220. (setq match (org-completing-read-no-i
  12221. "Match: " 'org-tags-completion-function nil nil nil
  12222. 'org-tags-history))))
  12223. ;; Parse the string and create a lisp form
  12224. (let ((match0 match)
  12225. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  12226. minus tag mm
  12227. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  12228. orterms term orlist re-p str-p level-p level-op time-p
  12229. prop-p pn pv po gv rest)
  12230. (if (string-match "/+" match)
  12231. ;; match contains also a todo-matching request
  12232. (progn
  12233. (setq tagsmatch (substring match 0 (match-beginning 0))
  12234. todomatch (substring match (match-end 0)))
  12235. (if (string-match "^!" todomatch)
  12236. (setq todo-only t todomatch (substring todomatch 1)))
  12237. (if (string-match "^\\s-*$" todomatch)
  12238. (setq todomatch nil)))
  12239. ;; only matching tags
  12240. (setq tagsmatch match todomatch nil))
  12241. ;; Make the tags matcher
  12242. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12243. (setq tagsmatcher t)
  12244. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12245. (while (setq term (pop orterms))
  12246. (while (and (equal (substring term -1) "\\") orterms)
  12247. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12248. (while (string-match re term)
  12249. (setq rest (substring term (match-end 0))
  12250. minus (and (match-end 1)
  12251. (equal (match-string 1 term) "-"))
  12252. tag (save-match-data (replace-regexp-in-string
  12253. "\\\\-" "-"
  12254. (match-string 2 term)))
  12255. re-p (equal (string-to-char tag) ?{)
  12256. level-p (match-end 4)
  12257. prop-p (match-end 5)
  12258. mm (cond
  12259. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12260. (level-p
  12261. (setq level-op (org-op-to-function (match-string 3 term)))
  12262. `(,level-op level ,(string-to-number
  12263. (match-string 4 term))))
  12264. (prop-p
  12265. (setq pn (match-string 5 term)
  12266. po (match-string 6 term)
  12267. pv (match-string 7 term)
  12268. re-p (equal (string-to-char pv) ?{)
  12269. str-p (equal (string-to-char pv) ?\")
  12270. time-p (save-match-data
  12271. (string-match "^\"[[<].*[]>]\"$" pv))
  12272. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12273. (if time-p (setq pv (org-matcher-time pv)))
  12274. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12275. (cond
  12276. ((equal pn "CATEGORY")
  12277. (setq gv '(get-text-property (point) 'org-category)))
  12278. ((equal pn "TODO")
  12279. (setq gv 'todo))
  12280. (t
  12281. (setq gv `(org-cached-entry-get nil ,pn))))
  12282. (if re-p
  12283. (if (eq po 'org<>)
  12284. `(not (string-match ,pv (or ,gv "")))
  12285. `(string-match ,pv (or ,gv "")))
  12286. (if str-p
  12287. `(,po (or ,gv "") ,pv)
  12288. `(,po (string-to-number (or ,gv ""))
  12289. ,(string-to-number pv) ))))
  12290. (t `(member ,tag tags-list)))
  12291. mm (if minus (list 'not mm) mm)
  12292. term rest)
  12293. (push mm tagsmatcher))
  12294. (push (if (> (length tagsmatcher) 1)
  12295. (cons 'and tagsmatcher)
  12296. (car tagsmatcher))
  12297. orlist)
  12298. (setq tagsmatcher nil))
  12299. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12300. (setq tagsmatcher
  12301. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12302. ;; Make the todo matcher
  12303. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12304. (setq todomatcher t)
  12305. (setq orterms (org-split-string todomatch "|") orlist nil)
  12306. (while (setq term (pop orterms))
  12307. (while (string-match re term)
  12308. (setq minus (and (match-end 1)
  12309. (equal (match-string 1 term) "-"))
  12310. kwd (match-string 2 term)
  12311. re-p (equal (string-to-char kwd) ?{)
  12312. term (substring term (match-end 0))
  12313. mm (if re-p
  12314. `(string-match ,(substring kwd 1 -1) todo)
  12315. (list 'equal 'todo kwd))
  12316. mm (if minus (list 'not mm) mm))
  12317. (push mm todomatcher))
  12318. (push (if (> (length todomatcher) 1)
  12319. (cons 'and todomatcher)
  12320. (car todomatcher))
  12321. orlist)
  12322. (setq todomatcher nil))
  12323. (setq todomatcher (if (> (length orlist) 1)
  12324. (cons 'or orlist) (car orlist))))
  12325. ;; Return the string and lisp forms of the matcher
  12326. (setq matcher (if todomatcher
  12327. (list 'and tagsmatcher todomatcher)
  12328. tagsmatcher))
  12329. (when todo-only
  12330. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12331. matcher)))
  12332. (cons match0 matcher)))
  12333. (defun org-op-to-function (op &optional stringp)
  12334. "Turn an operator into the appropriate function."
  12335. (setq op
  12336. (cond
  12337. ((equal op "<" ) '(< string< org-time<))
  12338. ((equal op ">" ) '(> org-string> org-time>))
  12339. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12340. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12341. ((member op '("=" "==")) '(= string= org-time=))
  12342. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12343. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12344. (defun org<> (a b) (not (= a b)))
  12345. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12346. (defun org-string>= (a b) (not (string< a b)))
  12347. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12348. (defun org-string<> (a b) (not (string= a b)))
  12349. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  12350. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  12351. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  12352. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  12353. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  12354. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  12355. (defun org-2ft (s)
  12356. "Convert S to a floating point time.
  12357. If S is already a number, just return it. If it is a string, parse
  12358. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  12359. (cond
  12360. ((numberp s) s)
  12361. ((stringp s)
  12362. (condition-case nil
  12363. (float-time (apply 'encode-time (org-parse-time-string s)))
  12364. (error 0.)))
  12365. (t 0.)))
  12366. (defun org-time-today ()
  12367. "Time in seconds today at 0:00.
  12368. Returns the float number of seconds since the beginning of the
  12369. epoch to the beginning of today (00:00)."
  12370. (float-time (apply 'encode-time
  12371. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  12372. (defun org-matcher-time (s)
  12373. "Interpret a time comparison value."
  12374. (save-match-data
  12375. (cond
  12376. ((string= s "<now>") (float-time))
  12377. ((string= s "<today>") (org-time-today))
  12378. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  12379. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  12380. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  12381. (+ (org-time-today)
  12382. (* (string-to-number (match-string 1 s))
  12383. (cdr (assoc (match-string 2 s)
  12384. '(("d" . 86400.0) ("w" . 604800.0)
  12385. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  12386. (t (org-2ft s)))))
  12387. (defun org-match-any-p (re list)
  12388. "Does re match any element of list?"
  12389. (setq list (mapcar (lambda (x) (string-match re x)) list))
  12390. (delq nil list))
  12391. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  12392. (defvar org-tags-overlay (make-overlay 1 1))
  12393. (org-detach-overlay org-tags-overlay)
  12394. (defun org-get-local-tags-at (&optional pos)
  12395. "Get a list of tags defined in the current headline."
  12396. (org-get-tags-at pos 'local))
  12397. (defun org-get-local-tags ()
  12398. "Get a list of tags defined in the current headline."
  12399. (org-get-tags-at nil 'local))
  12400. (defun org-get-tags-at (&optional pos local)
  12401. "Get a list of all headline tags applicable at POS.
  12402. POS defaults to point. If tags are inherited, the list contains
  12403. the targets in the same sequence as the headlines appear, i.e.
  12404. the tags of the current headline come last.
  12405. When LOCAL is non-nil, only return tags from the current headline,
  12406. ignore inherited ones."
  12407. (interactive)
  12408. (if (and org-trust-scanner-tags
  12409. (or (not pos) (equal pos (point)))
  12410. (not local))
  12411. org-scanner-tags
  12412. (let (tags ltags lastpos parent)
  12413. (save-excursion
  12414. (save-restriction
  12415. (widen)
  12416. (goto-char (or pos (point)))
  12417. (save-match-data
  12418. (catch 'done
  12419. (condition-case nil
  12420. (progn
  12421. (org-back-to-heading t)
  12422. (while (not (equal lastpos (point)))
  12423. (setq lastpos (point))
  12424. (when (looking-at
  12425. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  12426. (setq ltags (org-split-string
  12427. (org-match-string-no-properties 1) ":"))
  12428. (when parent
  12429. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  12430. (setq tags (append
  12431. (if parent
  12432. (org-remove-uninherited-tags ltags)
  12433. ltags)
  12434. tags)))
  12435. (or org-use-tag-inheritance (throw 'done t))
  12436. (if local (throw 'done t))
  12437. (or (org-up-heading-safe) (error nil))
  12438. (setq parent t)))
  12439. (error nil)))))
  12440. (if local
  12441. tags
  12442. (append (org-remove-uninherited-tags org-file-tags) tags))))))
  12443. (defun org-add-prop-inherited (s)
  12444. (add-text-properties 0 (length s) '(inherited t) s)
  12445. s)
  12446. (defun org-toggle-tag (tag &optional onoff)
  12447. "Toggle the tag TAG for the current line.
  12448. If ONOFF is `on' or `off', don't toggle but set to this state."
  12449. (let (res current)
  12450. (save-excursion
  12451. (org-back-to-heading t)
  12452. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  12453. (point-at-eol) t)
  12454. (progn
  12455. (setq current (match-string 1))
  12456. (replace-match ""))
  12457. (setq current ""))
  12458. (setq current (nreverse (org-split-string current ":")))
  12459. (cond
  12460. ((eq onoff 'on)
  12461. (setq res t)
  12462. (or (member tag current) (push tag current)))
  12463. ((eq onoff 'off)
  12464. (or (not (member tag current)) (setq current (delete tag current))))
  12465. (t (if (member tag current)
  12466. (setq current (delete tag current))
  12467. (setq res t)
  12468. (push tag current))))
  12469. (end-of-line 1)
  12470. (if current
  12471. (progn
  12472. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  12473. (org-set-tags nil t))
  12474. (delete-horizontal-space))
  12475. (run-hooks 'org-after-tags-change-hook))
  12476. res))
  12477. (defun org-align-tags-here (to-col)
  12478. ;; Assumes that this is a headline
  12479. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  12480. (beginning-of-line 1)
  12481. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12482. (< pos (match-beginning 2)))
  12483. (progn
  12484. (setq tags-l (- (match-end 2) (match-beginning 2)))
  12485. (goto-char (match-beginning 1))
  12486. (insert " ")
  12487. (delete-region (point) (1+ (match-beginning 2)))
  12488. (setq ncol (max (current-column)
  12489. (1+ col)
  12490. (if (> to-col 0)
  12491. to-col
  12492. (- (abs to-col) tags-l))))
  12493. (setq p (point))
  12494. (insert (make-string (- ncol (current-column)) ?\ ))
  12495. (setq ncol (current-column))
  12496. (when indent-tabs-mode (tabify p (point-at-eol)))
  12497. (org-move-to-column (min ncol col) t))
  12498. (goto-char pos))))
  12499. (defun org-set-tags-command (&optional arg just-align)
  12500. "Call the set-tags command for the current entry."
  12501. (interactive "P")
  12502. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  12503. (org-set-tags arg just-align)
  12504. (save-excursion
  12505. (org-back-to-heading t)
  12506. (org-set-tags arg just-align))))
  12507. (defun org-set-tags-to (data)
  12508. "Set the tags of the current entry to DATA, replacing the current tags.
  12509. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  12510. If DATA is nil or the empty string, any tags will be removed."
  12511. (interactive "sTags: ")
  12512. (setq data
  12513. (cond
  12514. ((eq data nil) "")
  12515. ((equal data "") "")
  12516. ((stringp data)
  12517. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  12518. ":"))
  12519. ((listp data)
  12520. (concat ":" (mapconcat 'identity data ":") ":"))))
  12521. (when data
  12522. (save-excursion
  12523. (org-back-to-heading t)
  12524. (when (looking-at org-complex-heading-regexp)
  12525. (if (match-end 5)
  12526. (progn
  12527. (goto-char (match-beginning 5))
  12528. (insert data)
  12529. (delete-region (point) (point-at-eol))
  12530. (org-set-tags nil 'align))
  12531. (goto-char (point-at-eol))
  12532. (insert " " data)
  12533. (org-set-tags nil 'align)))
  12534. (beginning-of-line 1)
  12535. (if (looking-at ".*?\\([ \t]+\\)$")
  12536. (delete-region (match-beginning 1) (match-end 1))))))
  12537. (defun org-align-all-tags ()
  12538. "Align the tags i all headings."
  12539. (interactive)
  12540. (save-excursion
  12541. (or (ignore-errors (org-back-to-heading t))
  12542. (outline-next-heading))
  12543. (if (org-at-heading-p)
  12544. (org-set-tags t)
  12545. (message "No headings"))))
  12546. (defvar org-indent-indentation-per-level)
  12547. (defun org-set-tags (&optional arg just-align)
  12548. "Set the tags for the current headline.
  12549. With prefix ARG, realign all tags in headings in the current buffer."
  12550. (interactive "P")
  12551. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12552. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12553. 'region-start-level 'region))
  12554. org-loop-over-headlines-in-active-region)
  12555. (org-map-entries
  12556. ;; We don't use ARG and JUST-ALIGN here these args are not
  12557. ;; useful when looping over headlines
  12558. `(org-set-tags)
  12559. org-loop-over-headlines-in-active-region
  12560. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12561. (let* ((re org-outline-regexp-bol)
  12562. (current (unless arg (org-get-tags-string)))
  12563. (col (current-column))
  12564. (org-setting-tags t)
  12565. table current-tags inherited-tags ; computed below when needed
  12566. tags p0 c0 c1 rpl di tc level)
  12567. (if arg
  12568. (save-excursion
  12569. (goto-char (point-min))
  12570. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  12571. (while (re-search-forward re nil t)
  12572. (org-set-tags nil t)
  12573. (end-of-line 1)))
  12574. (message "All tags realigned to column %d" org-tags-column))
  12575. (if just-align
  12576. (setq tags current)
  12577. ;; Get a new set of tags from the user
  12578. (save-excursion
  12579. (setq table (append org-tag-persistent-alist
  12580. (or org-tag-alist (org-get-buffer-tags))
  12581. (and
  12582. org-complete-tags-always-offer-all-agenda-tags
  12583. (org-global-tags-completion-table
  12584. (org-agenda-files))))
  12585. org-last-tags-completion-table table
  12586. current-tags (org-split-string current ":")
  12587. inherited-tags (nreverse
  12588. (nthcdr (length current-tags)
  12589. (nreverse (org-get-tags-at))))
  12590. tags
  12591. (if (or (eq t org-use-fast-tag-selection)
  12592. (and org-use-fast-tag-selection
  12593. (delq nil (mapcar 'cdr table))))
  12594. (org-fast-tag-selection
  12595. current-tags inherited-tags table
  12596. (if org-fast-tag-selection-include-todo
  12597. org-todo-key-alist))
  12598. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  12599. (org-trim
  12600. (org-icompleting-read "Tags: "
  12601. 'org-tags-completion-function
  12602. nil nil current 'org-tags-history))))))
  12603. (while (string-match "[-+&]+" tags)
  12604. ;; No boolean logic, just a list
  12605. (setq tags (replace-match ":" t t tags))))
  12606. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  12607. (if org-tags-sort-function
  12608. (setq tags (mapconcat 'identity
  12609. (sort (org-split-string
  12610. tags (org-re "[^[:alnum:]_@#%]+"))
  12611. org-tags-sort-function) ":")))
  12612. (if (string-match "\\`[\t ]*\\'" tags)
  12613. (setq tags "")
  12614. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  12615. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  12616. ;; Insert new tags at the correct column
  12617. (beginning-of-line 1)
  12618. (setq level (or (and (looking-at org-outline-regexp)
  12619. (- (match-end 0) (point) 1))
  12620. 1))
  12621. (cond
  12622. ((and (equal current "") (equal tags "")))
  12623. ((re-search-forward
  12624. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  12625. (point-at-eol) t)
  12626. (if (equal tags "")
  12627. (setq rpl "")
  12628. (goto-char (match-beginning 0))
  12629. (setq c0 (current-column)
  12630. ;; compute offset for the case of org-indent-mode active
  12631. di (if org-indent-mode
  12632. (* (1- org-indent-indentation-per-level) (1- level))
  12633. 0)
  12634. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  12635. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  12636. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  12637. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  12638. (replace-match rpl t t)
  12639. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  12640. tags)
  12641. (t (error "Tags alignment failed")))
  12642. (org-move-to-column col)
  12643. (unless just-align
  12644. (run-hooks 'org-after-tags-change-hook))))))
  12645. (defun org-change-tag-in-region (beg end tag off)
  12646. "Add or remove TAG for each entry in the region.
  12647. This works in the agenda, and also in an org-mode buffer."
  12648. (interactive
  12649. (list (region-beginning) (region-end)
  12650. (let ((org-last-tags-completion-table
  12651. (if (derived-mode-p 'org-mode)
  12652. (org-get-buffer-tags)
  12653. (org-global-tags-completion-table))))
  12654. (org-icompleting-read
  12655. "Tag: " 'org-tags-completion-function nil nil nil
  12656. 'org-tags-history))
  12657. (progn
  12658. (message "[s]et or [r]emove? ")
  12659. (equal (read-char-exclusive) ?r))))
  12660. (if (fboundp 'deactivate-mark) (deactivate-mark))
  12661. (let ((agendap (equal major-mode 'org-agenda-mode))
  12662. l1 l2 m buf pos newhead (cnt 0))
  12663. (goto-char end)
  12664. (setq l2 (1- (org-current-line)))
  12665. (goto-char beg)
  12666. (setq l1 (org-current-line))
  12667. (loop for l from l1 to l2 do
  12668. (org-goto-line l)
  12669. (setq m (get-text-property (point) 'org-hd-marker))
  12670. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  12671. (and agendap m))
  12672. (setq buf (if agendap (marker-buffer m) (current-buffer))
  12673. pos (if agendap m (point)))
  12674. (with-current-buffer buf
  12675. (save-excursion
  12676. (save-restriction
  12677. (goto-char pos)
  12678. (setq cnt (1+ cnt))
  12679. (org-toggle-tag tag (if off 'off 'on))
  12680. (setq newhead (org-get-heading)))))
  12681. (and agendap (org-agenda-change-all-lines newhead m))))
  12682. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  12683. (defun org-tags-completion-function (string predicate &optional flag)
  12684. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  12685. (confirm (lambda (x) (stringp (car x)))))
  12686. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  12687. (setq s1 (match-string 1 string)
  12688. s2 (match-string 2 string))
  12689. (setq s1 "" s2 string))
  12690. (cond
  12691. ((eq flag nil)
  12692. ;; try completion
  12693. (setq rtn (try-completion s2 ctable confirm))
  12694. (if (stringp rtn)
  12695. (setq rtn
  12696. (concat s1 s2 (substring rtn (length s2))
  12697. (if (and org-add-colon-after-tag-completion
  12698. (assoc rtn ctable))
  12699. ":" ""))))
  12700. rtn)
  12701. ((eq flag t)
  12702. ;; all-completions
  12703. (all-completions s2 ctable confirm)
  12704. )
  12705. ((eq flag 'lambda)
  12706. ;; exact match?
  12707. (assoc s2 ctable)))
  12708. ))
  12709. (defun org-fast-tag-insert (kwd tags face &optional end)
  12710. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  12711. (insert (format "%-12s" (concat kwd ":"))
  12712. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  12713. (or end "")))
  12714. (defun org-fast-tag-show-exit (flag)
  12715. (save-excursion
  12716. (org-goto-line 3)
  12717. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  12718. (replace-match ""))
  12719. (when flag
  12720. (end-of-line 1)
  12721. (org-move-to-column (- (window-width) 19) t)
  12722. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  12723. (defun org-set-current-tags-overlay (current prefix)
  12724. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  12725. (if (featurep 'xemacs)
  12726. (org-overlay-display org-tags-overlay (concat prefix s)
  12727. 'secondary-selection)
  12728. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  12729. (org-overlay-display org-tags-overlay (concat prefix s)))))
  12730. (defvar org-last-tag-selection-key nil)
  12731. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  12732. "Fast tag selection with single keys.
  12733. CURRENT is the current list of tags in the headline, INHERITED is the
  12734. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  12735. possibly with grouping information. TODO-TABLE is a similar table with
  12736. TODO keywords, should these have keys assigned to them.
  12737. If the keys are nil, a-z are automatically assigned.
  12738. Returns the new tags string, or nil to not change the current settings."
  12739. (let* ((fulltable (append table todo-table))
  12740. (maxlen (apply 'max (mapcar
  12741. (lambda (x)
  12742. (if (stringp (car x)) (string-width (car x)) 0))
  12743. fulltable)))
  12744. (buf (current-buffer))
  12745. (expert (eq org-fast-tag-selection-single-key 'expert))
  12746. (buffer-tags nil)
  12747. (fwidth (+ maxlen 3 1 3))
  12748. (ncol (/ (- (window-width) 4) fwidth))
  12749. (i-face 'org-done)
  12750. (c-face 'org-todo)
  12751. tg cnt e c char c1 c2 ntable tbl rtn
  12752. ov-start ov-end ov-prefix
  12753. (exit-after-next org-fast-tag-selection-single-key)
  12754. (done-keywords org-done-keywords)
  12755. groups ingroup)
  12756. (save-excursion
  12757. (beginning-of-line 1)
  12758. (if (looking-at
  12759. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12760. (setq ov-start (match-beginning 1)
  12761. ov-end (match-end 1)
  12762. ov-prefix "")
  12763. (setq ov-start (1- (point-at-eol))
  12764. ov-end (1+ ov-start))
  12765. (skip-chars-forward "^\n\r")
  12766. (setq ov-prefix
  12767. (concat
  12768. (buffer-substring (1- (point)) (point))
  12769. (if (> (current-column) org-tags-column)
  12770. " "
  12771. (make-string (- org-tags-column (current-column)) ?\ ))))))
  12772. (move-overlay org-tags-overlay ov-start ov-end)
  12773. (save-window-excursion
  12774. (if expert
  12775. (set-buffer (get-buffer-create " *Org tags*"))
  12776. (delete-other-windows)
  12777. (split-window-vertically)
  12778. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  12779. (erase-buffer)
  12780. (org-set-local 'org-done-keywords done-keywords)
  12781. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  12782. (org-fast-tag-insert "Current" current c-face "\n\n")
  12783. (org-fast-tag-show-exit exit-after-next)
  12784. (org-set-current-tags-overlay current ov-prefix)
  12785. (setq tbl fulltable char ?a cnt 0)
  12786. (while (setq e (pop tbl))
  12787. (cond
  12788. ((equal (car e) :startgroup)
  12789. (push '() groups) (setq ingroup t)
  12790. (when (not (= cnt 0))
  12791. (setq cnt 0)
  12792. (insert "\n"))
  12793. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  12794. ((equal (car e) :endgroup)
  12795. (setq ingroup nil cnt 0)
  12796. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  12797. ((equal e '(:newline))
  12798. (when (not (= cnt 0))
  12799. (setq cnt 0)
  12800. (insert "\n")
  12801. (setq e (car tbl))
  12802. (while (equal (car tbl) '(:newline))
  12803. (insert "\n")
  12804. (setq tbl (cdr tbl)))))
  12805. (t
  12806. (setq tg (copy-sequence (car e)) c2 nil)
  12807. (if (cdr e)
  12808. (setq c (cdr e))
  12809. ;; automatically assign a character.
  12810. (setq c1 (string-to-char
  12811. (downcase (substring
  12812. tg (if (= (string-to-char tg) ?@) 1 0)))))
  12813. (if (or (rassoc c1 ntable) (rassoc c1 table))
  12814. (while (or (rassoc char ntable) (rassoc char table))
  12815. (setq char (1+ char)))
  12816. (setq c2 c1))
  12817. (setq c (or c2 char)))
  12818. (if ingroup (push tg (car groups)))
  12819. (setq tg (org-add-props tg nil 'face
  12820. (cond
  12821. ((not (assoc tg table))
  12822. (org-get-todo-face tg))
  12823. ((member tg current) c-face)
  12824. ((member tg inherited) i-face))))
  12825. (if (and (= cnt 0) (not ingroup)) (insert " "))
  12826. (insert "[" c "] " tg (make-string
  12827. (- fwidth 4 (length tg)) ?\ ))
  12828. (push (cons tg c) ntable)
  12829. (when (= (setq cnt (1+ cnt)) ncol)
  12830. (insert "\n")
  12831. (if ingroup (insert " "))
  12832. (setq cnt 0)))))
  12833. (setq ntable (nreverse ntable))
  12834. (insert "\n")
  12835. (goto-char (point-min))
  12836. (if (not expert) (org-fit-window-to-buffer))
  12837. (setq rtn
  12838. (catch 'exit
  12839. (while t
  12840. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  12841. (if (not groups) "no " "")
  12842. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  12843. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  12844. (setq org-last-tag-selection-key c)
  12845. (cond
  12846. ((= c ?\r) (throw 'exit t))
  12847. ((= c ?!)
  12848. (setq groups (not groups))
  12849. (goto-char (point-min))
  12850. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  12851. ((= c ?\C-c)
  12852. (if (not expert)
  12853. (org-fast-tag-show-exit
  12854. (setq exit-after-next (not exit-after-next)))
  12855. (setq expert nil)
  12856. (delete-other-windows)
  12857. (set-window-buffer (split-window-vertically) " *Org tags*")
  12858. (org-switch-to-buffer-other-window " *Org tags*")
  12859. (org-fit-window-to-buffer)))
  12860. ((or (= c ?\C-g)
  12861. (and (= c ?q) (not (rassoc c ntable))))
  12862. (org-detach-overlay org-tags-overlay)
  12863. (setq quit-flag t))
  12864. ((= c ?\ )
  12865. (setq current nil)
  12866. (if exit-after-next (setq exit-after-next 'now)))
  12867. ((= c ?\t)
  12868. (condition-case nil
  12869. (setq tg (org-icompleting-read
  12870. "Tag: "
  12871. (or buffer-tags
  12872. (with-current-buffer buf
  12873. (org-get-buffer-tags)))))
  12874. (quit (setq tg "")))
  12875. (when (string-match "\\S-" tg)
  12876. (add-to-list 'buffer-tags (list tg))
  12877. (if (member tg current)
  12878. (setq current (delete tg current))
  12879. (push tg current)))
  12880. (if exit-after-next (setq exit-after-next 'now)))
  12881. ((setq e (rassoc c todo-table) tg (car e))
  12882. (with-current-buffer buf
  12883. (save-excursion (org-todo tg)))
  12884. (if exit-after-next (setq exit-after-next 'now)))
  12885. ((setq e (rassoc c ntable) tg (car e))
  12886. (if (member tg current)
  12887. (setq current (delete tg current))
  12888. (loop for g in groups do
  12889. (if (member tg g)
  12890. (mapc (lambda (x)
  12891. (setq current (delete x current)))
  12892. g)))
  12893. (push tg current))
  12894. (if exit-after-next (setq exit-after-next 'now))))
  12895. ;; Create a sorted list
  12896. (setq current
  12897. (sort current
  12898. (lambda (a b)
  12899. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  12900. (if (eq exit-after-next 'now) (throw 'exit t))
  12901. (goto-char (point-min))
  12902. (beginning-of-line 2)
  12903. (delete-region (point) (point-at-eol))
  12904. (org-fast-tag-insert "Current" current c-face)
  12905. (org-set-current-tags-overlay current ov-prefix)
  12906. (while (re-search-forward
  12907. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  12908. (setq tg (match-string 1))
  12909. (add-text-properties
  12910. (match-beginning 1) (match-end 1)
  12911. (list 'face
  12912. (cond
  12913. ((member tg current) c-face)
  12914. ((member tg inherited) i-face)
  12915. (t (get-text-property (match-beginning 1) 'face))))))
  12916. (goto-char (point-min)))))
  12917. (org-detach-overlay org-tags-overlay)
  12918. (if rtn
  12919. (mapconcat 'identity current ":")
  12920. nil))))
  12921. (defun org-get-tags-string ()
  12922. "Get the TAGS string in the current headline."
  12923. (unless (org-at-heading-p t)
  12924. (error "Not on a heading"))
  12925. (save-excursion
  12926. (beginning-of-line 1)
  12927. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12928. (org-match-string-no-properties 1)
  12929. "")))
  12930. (defun org-get-tags ()
  12931. "Get the list of tags specified in the current headline."
  12932. (org-split-string (org-get-tags-string) ":"))
  12933. (defun org-get-buffer-tags ()
  12934. "Get a table of all tags used in the buffer, for completion."
  12935. (let (tags)
  12936. (save-excursion
  12937. (goto-char (point-min))
  12938. (while (re-search-forward
  12939. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  12940. (when (equal (char-after (point-at-bol 0)) ?*)
  12941. (mapc (lambda (x) (add-to-list 'tags x))
  12942. (org-split-string (org-match-string-no-properties 1) ":")))))
  12943. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  12944. (mapcar 'list tags)))
  12945. ;;;; The mapping API
  12946. ;;;###autoload
  12947. (defun org-map-entries (func &optional match scope &rest skip)
  12948. "Call FUNC at each headline selected by MATCH in SCOPE.
  12949. FUNC is a function or a lisp form. The function will be called without
  12950. arguments, with the cursor positioned at the beginning of the headline.
  12951. The return values of all calls to the function will be collected and
  12952. returned as a list.
  12953. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  12954. does not need to preserve point. After evaluation, the cursor will be
  12955. moved to the end of the line (presumably of the headline of the
  12956. processed entry) and search continues from there. Under some
  12957. circumstances, this may not produce the wanted results. For example,
  12958. if you have removed (e.g. archived) the current (sub)tree it could
  12959. mean that the next entry will be skipped entirely. In such cases, you
  12960. can specify the position from where search should continue by making
  12961. FUNC set the variable `org-map-continue-from' to the desired buffer
  12962. position.
  12963. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  12964. Only headlines that are matched by this query will be considered during
  12965. the iteration. When MATCH is nil or t, all headlines will be
  12966. visited by the iteration.
  12967. SCOPE determines the scope of this command. It can be any of:
  12968. nil The current buffer, respecting the restriction if any
  12969. tree The subtree started with the entry at point
  12970. region The entries within the active region, if any
  12971. region-start-level
  12972. The entries within the active region, but only those at
  12973. the same level than the first one.
  12974. file The current buffer, without restriction
  12975. file-with-archives
  12976. The current buffer, and any archives associated with it
  12977. agenda All agenda files
  12978. agenda-with-archives
  12979. All agenda files with any archive files associated with them
  12980. \(file1 file2 ...)
  12981. If this is a list, all files in the list will be scanned
  12982. The remaining args are treated as settings for the skipping facilities of
  12983. the scanner. The following items can be given here:
  12984. archive skip trees with the archive tag.
  12985. comment skip trees with the COMMENT keyword
  12986. function or Emacs Lisp form:
  12987. will be used as value for `org-agenda-skip-function', so whenever
  12988. the function returns t, FUNC will not be called for that
  12989. entry and search will continue from the point where the
  12990. function leaves it.
  12991. If your function needs to retrieve the tags including inherited tags
  12992. at the *current* entry, you can use the value of the variable
  12993. `org-scanner-tags' which will be much faster than getting the value
  12994. with `org-get-tags-at'. If your function gets properties with
  12995. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  12996. to t around the call to `org-entry-properties' to get the same speedup.
  12997. Note that if your function moves around to retrieve tags and properties at
  12998. a *different* entry, you cannot use these techniques."
  12999. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  13000. (not (org-region-active-p)))
  13001. (let* ((org-agenda-archives-mode nil) ; just to make sure
  13002. (org-agenda-skip-archived-trees (memq 'archive skip))
  13003. (org-agenda-skip-comment-trees (memq 'comment skip))
  13004. (org-agenda-skip-function
  13005. (car (org-delete-all '(comment archive) skip)))
  13006. (org-tags-match-list-sublevels t)
  13007. (start-level (eq scope 'region-start-level))
  13008. matcher file res
  13009. org-todo-keywords-for-agenda
  13010. org-done-keywords-for-agenda
  13011. org-todo-keyword-alist-for-agenda
  13012. org-drawers-for-agenda
  13013. org-tag-alist-for-agenda
  13014. todo-only)
  13015. (cond
  13016. ((eq match t) (setq matcher t))
  13017. ((eq match nil) (setq matcher t))
  13018. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  13019. (save-excursion
  13020. (save-restriction
  13021. (cond ((eq scope 'tree)
  13022. (org-back-to-heading t)
  13023. (org-narrow-to-subtree)
  13024. (setq scope nil))
  13025. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  13026. (org-region-active-p))
  13027. ;; If needed, set start-level to a string like "2"
  13028. (when start-level
  13029. (save-excursion
  13030. (goto-char (region-beginning))
  13031. (unless (org-at-heading-p) (outline-next-heading))
  13032. (setq start-level (org-current-level))))
  13033. (narrow-to-region (region-beginning)
  13034. (save-excursion
  13035. (goto-char (region-end))
  13036. (unless (and (bolp) (org-at-heading-p))
  13037. (outline-next-heading))
  13038. (point)))
  13039. (setq scope nil)))
  13040. (if (not scope)
  13041. (progn
  13042. (org-agenda-prepare-buffers
  13043. (list (buffer-file-name (current-buffer))))
  13044. (setq res (org-scan-tags func matcher todo-only start-level)))
  13045. ;; Get the right scope
  13046. (cond
  13047. ((and scope (listp scope) (symbolp (car scope)))
  13048. (setq scope (eval scope)))
  13049. ((eq scope 'agenda)
  13050. (setq scope (org-agenda-files t)))
  13051. ((eq scope 'agenda-with-archives)
  13052. (setq scope (org-agenda-files t))
  13053. (setq scope (org-add-archive-files scope)))
  13054. ((eq scope 'file)
  13055. (setq scope (list (buffer-file-name))))
  13056. ((eq scope 'file-with-archives)
  13057. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  13058. (org-agenda-prepare-buffers scope)
  13059. (while (setq file (pop scope))
  13060. (with-current-buffer (org-find-base-buffer-visiting file)
  13061. (save-excursion
  13062. (save-restriction
  13063. (widen)
  13064. (goto-char (point-min))
  13065. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  13066. res)))
  13067. ;;;; Properties
  13068. ;;; Setting and retrieving properties
  13069. (defconst org-special-properties
  13070. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  13071. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
  13072. "The special properties valid in Org-mode.
  13073. These are properties that are not defined in the property drawer,
  13074. but in some other way.")
  13075. (defconst org-default-properties
  13076. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  13077. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  13078. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  13079. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  13080. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  13081. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  13082. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  13083. "Some properties that are used by Org-mode for various purposes.
  13084. Being in this list makes sure that they are offered for completion.")
  13085. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  13086. "Regular expression matching the first line of a property drawer.")
  13087. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  13088. "Regular expression matching the last line of a property drawer.")
  13089. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  13090. "Regular expression matching the first line of a property drawer.")
  13091. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  13092. "Regular expression matching the first line of a property drawer.")
  13093. (defconst org-property-drawer-re
  13094. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  13095. org-property-end-re "\\)\n?")
  13096. "Matches an entire property drawer.")
  13097. (defconst org-clock-drawer-re
  13098. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  13099. org-property-end-re "\\)\n?")
  13100. "Matches an entire clock drawer.")
  13101. (defsubst org-re-property (property)
  13102. "Return a regexp matching a PROPERTY line.
  13103. Match group 1 will be set to the value."
  13104. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
  13105. (defsubst org-re-property-keyword (property)
  13106. "Return a regexp matching a PROPERTY line, possibly with no
  13107. value for the property."
  13108. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)?"))
  13109. (defun org-property-action ()
  13110. "Do an action on properties."
  13111. (interactive)
  13112. (let (c)
  13113. (org-at-property-p)
  13114. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  13115. (setq c (read-char-exclusive))
  13116. (cond
  13117. ((equal c ?s)
  13118. (call-interactively 'org-set-property))
  13119. ((equal c ?d)
  13120. (call-interactively 'org-delete-property))
  13121. ((equal c ?D)
  13122. (call-interactively 'org-delete-property-globally))
  13123. ((equal c ?c)
  13124. (call-interactively 'org-compute-property-at-point))
  13125. (t (error "No such property action %c" c)))))
  13126. (defun org-inc-effort ()
  13127. "Increment the value of the effort property in the current entry."
  13128. (interactive)
  13129. (org-set-effort nil t))
  13130. (defun org-set-effort (&optional value increment)
  13131. "Set the effort property of the current entry.
  13132. With numerical prefix arg, use the nth allowed value, 0 stands for the
  13133. 10th allowed value.
  13134. When INCREMENT is non-nil, set the property to the next allowed value."
  13135. (interactive "P")
  13136. (if (equal value 0) (setq value 10))
  13137. (let* ((completion-ignore-case t)
  13138. (prop org-effort-property)
  13139. (cur (org-entry-get nil prop))
  13140. (allowed (org-property-get-allowed-values nil prop 'table))
  13141. (existing (mapcar 'list (org-property-values prop)))
  13142. rpl
  13143. (val (cond
  13144. ((stringp value) value)
  13145. ((and allowed (integerp value))
  13146. (or (car (nth (1- value) allowed))
  13147. (car (org-last allowed))))
  13148. ((and allowed increment)
  13149. (or (caadr (member (list cur) allowed))
  13150. (error "Allowed effort values are not set")))
  13151. (allowed
  13152. (message "Select 1-9,0, [RET%s]: %s"
  13153. (if cur (concat "=" cur) "")
  13154. (mapconcat 'car allowed " "))
  13155. (setq rpl (read-char-exclusive))
  13156. (if (equal rpl ?\r)
  13157. cur
  13158. (setq rpl (- rpl ?0))
  13159. (if (equal rpl 0) (setq rpl 10))
  13160. (if (and (> rpl 0) (<= rpl (length allowed)))
  13161. (car (nth (1- rpl) allowed))
  13162. (org-completing-read "Effort: " allowed nil))))
  13163. (t
  13164. (let (org-completion-use-ido org-completion-use-iswitchb)
  13165. (org-completing-read
  13166. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  13167. (concat "[" cur "]") "")
  13168. ": ")
  13169. existing nil nil "" nil cur))))))
  13170. (unless (equal (org-entry-get nil prop) val)
  13171. (org-entry-put nil prop val))
  13172. (message "%s is now %s" prop val)))
  13173. (defun org-at-property-p ()
  13174. "Is cursor inside a property drawer?"
  13175. (save-excursion
  13176. (beginning-of-line 1)
  13177. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  13178. (save-match-data ;; Used by calling procedures
  13179. (let ((p (point))
  13180. (range (unless (org-before-first-heading-p)
  13181. (org-get-property-block))))
  13182. (and range (<= (car range) p) (< p (cdr range))))))))
  13183. (defun org-get-property-block (&optional beg end force)
  13184. "Return the (beg . end) range of the body of the property drawer.
  13185. BEG and END are the beginning and end of the current subtree, or of
  13186. the part before the first headline. If they are not given, they will
  13187. be found. If the drawer does not exist and FORCE is non-nil, create
  13188. the drawer."
  13189. (catch 'exit
  13190. (save-excursion
  13191. (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
  13192. (progn (org-back-to-heading t) (point))))
  13193. (end (or end (and (not (outline-next-heading)) (point-max))
  13194. (point))))
  13195. (goto-char beg)
  13196. (if (re-search-forward org-property-start-re end t)
  13197. (setq beg (1+ (match-end 0)))
  13198. (if force
  13199. (save-excursion
  13200. (org-insert-property-drawer)
  13201. (setq end (progn (outline-next-heading) (point))))
  13202. (throw 'exit nil))
  13203. (goto-char beg)
  13204. (if (re-search-forward org-property-start-re end t)
  13205. (setq beg (1+ (match-end 0)))))
  13206. (if (re-search-forward org-property-end-re end t)
  13207. (setq end (match-beginning 0))
  13208. (or force (throw 'exit nil))
  13209. (goto-char beg)
  13210. (setq end beg)
  13211. (org-indent-line)
  13212. (insert ":END:\n"))
  13213. (cons beg end)))))
  13214. (defun org-entry-properties (&optional pom which specific)
  13215. "Get all properties of the entry at point-or-marker POM.
  13216. This includes the TODO keyword, the tags, time strings for deadline,
  13217. scheduled, and clocking, and any additional properties defined in the
  13218. entry. The return value is an alist, keys may occur multiple times
  13219. if the property key was used several times.
  13220. POM may also be nil, in which case the current entry is used.
  13221. If WHICH is nil or `all', get all properties. If WHICH is
  13222. `special' or `standard', only get that subclass. If WHICH
  13223. is a string only get exactly this property. SPECIFIC can be a string, the
  13224. specific property we are interested in. Specifying it can speed
  13225. things up because then unnecessary parsing is avoided."
  13226. (setq which (or which 'all))
  13227. (org-with-point-at pom
  13228. (let ((clockstr (substring org-clock-string 0 -1))
  13229. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  13230. (case-fold-search nil)
  13231. beg end range props sum-props key key1 value string clocksum clocksumt)
  13232. (save-excursion
  13233. (when (condition-case nil
  13234. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  13235. (error nil))
  13236. (setq beg (point))
  13237. (setq sum-props (get-text-property (point) 'org-summaries))
  13238. (setq clocksum (get-text-property (point) :org-clock-minutes)
  13239. clocksumt (get-text-property (point) :org-clock-minutes-today))
  13240. (outline-next-heading)
  13241. (setq end (point))
  13242. (when (memq which '(all special))
  13243. ;; Get the special properties, like TODO and tags
  13244. (goto-char beg)
  13245. (when (and (or (not specific) (string= specific "TODO"))
  13246. (looking-at org-todo-line-regexp) (match-end 2))
  13247. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  13248. (when (and (or (not specific) (string= specific "PRIORITY"))
  13249. (looking-at org-priority-regexp))
  13250. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  13251. (when (or (not specific) (string= specific "FILE"))
  13252. (push (cons "FILE" buffer-file-name) props))
  13253. (when (and (or (not specific) (string= specific "TAGS"))
  13254. (setq value (org-get-tags-string))
  13255. (string-match "\\S-" value))
  13256. (push (cons "TAGS" value) props))
  13257. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13258. (setq value (org-get-tags-at)))
  13259. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13260. ":"))
  13261. props))
  13262. (when (or (not specific) (string= specific "BLOCKED"))
  13263. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13264. (when (or (not specific)
  13265. (member specific
  13266. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13267. "TIMESTAMP" "TIMESTAMP_IA")))
  13268. (catch 'match
  13269. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13270. (setq key (if (match-end 1)
  13271. (substring (org-match-string-no-properties 1)
  13272. 0 -1))
  13273. string (if (equal key clockstr)
  13274. (org-trim
  13275. (buffer-substring-no-properties
  13276. (match-beginning 3) (goto-char
  13277. (point-at-eol))))
  13278. (substring (org-match-string-no-properties 3)
  13279. 1 -1)))
  13280. ;; Get the correct property name from the key. This is
  13281. ;; necessary if the user has configured time keywords.
  13282. (setq key1 (concat key ":"))
  13283. (cond
  13284. ((not key)
  13285. (setq key
  13286. (if (= (char-after (match-beginning 3)) ?\[)
  13287. "TIMESTAMP_IA" "TIMESTAMP")))
  13288. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13289. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13290. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13291. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13292. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13293. (progn
  13294. (push (cons key string) props)
  13295. ;; no need to search further if match is found
  13296. (throw 'match t))
  13297. (when (or (equal key "CLOCK") (not (assoc key props)))
  13298. (push (cons key string) props)))))))
  13299. (when (memq which '(all standard))
  13300. ;; Get the standard properties, like :PROP: ...
  13301. (setq range (org-get-property-block beg end))
  13302. (when range
  13303. (goto-char (car range))
  13304. (while (re-search-forward
  13305. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  13306. (cdr range) t)
  13307. (setq key (org-match-string-no-properties 1)
  13308. value (org-trim (or (org-match-string-no-properties 2) "")))
  13309. (unless (member key excluded)
  13310. (push (cons key (or value "")) props)))))
  13311. (if clocksum
  13312. (push (cons "CLOCKSUM"
  13313. (org-columns-number-to-string (/ (float clocksum) 60.)
  13314. 'add_times))
  13315. props))
  13316. (if clocksumt
  13317. (push (cons "CLOCKSUM_T"
  13318. (org-columns-number-to-string (/ (float clocksumt) 60.)
  13319. 'add_times))
  13320. props))
  13321. (unless (assoc "CATEGORY" props)
  13322. (push (cons "CATEGORY" (org-get-category)) props))
  13323. (append sum-props (nreverse props)))))))
  13324. (defun org-entry-get (pom property &optional inherit literal-nil)
  13325. "Get value of PROPERTY for entry or content at point-or-marker POM.
  13326. If INHERIT is non-nil and the entry does not have the property,
  13327. then also check higher levels of the hierarchy.
  13328. If INHERIT is the symbol `selective', use inheritance only if the setting
  13329. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13330. If the property is present but empty, the return value is the empty string.
  13331. If the property is not present at all, nil is returned.
  13332. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13333. do not interpret it as the list atom nil. This is used for inheritance
  13334. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13335. (org-with-point-at pom
  13336. (if (and inherit (if (eq inherit 'selective)
  13337. (org-property-inherit-p property)
  13338. t))
  13339. (org-entry-get-with-inheritance property literal-nil)
  13340. (if (member property org-special-properties)
  13341. ;; We need a special property. Use `org-entry-properties' to
  13342. ;; retrieve it, but specify the wanted property
  13343. (cdr (assoc property (org-entry-properties nil 'special property)))
  13344. (let* ((range (org-get-property-block))
  13345. (props (list (or (assoc property org-file-properties)
  13346. (assoc property org-global-properties)
  13347. (assoc property org-global-properties-fixed))))
  13348. (ap (lambda (key)
  13349. (when (re-search-forward
  13350. (org-re-property key) (cdr range) t)
  13351. (setq props
  13352. (org-update-property-plist
  13353. key
  13354. (if (match-end 1)
  13355. (org-match-string-no-properties 1) "")
  13356. props)))))
  13357. val)
  13358. (when (and range (goto-char (car range)))
  13359. (funcall ap property)
  13360. (goto-char (car range))
  13361. (while (funcall ap (concat property "+")))
  13362. (setq val (cdr (assoc property props)))
  13363. (when val (if literal-nil val (org-not-nil val)))))))))
  13364. (defun org-property-or-variable-value (var &optional inherit)
  13365. "Check if there is a property fixing the value of VAR.
  13366. If yes, return this value. If not, return the current value of the variable."
  13367. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  13368. (if (and prop (stringp prop) (string-match "\\S-" prop))
  13369. (read prop)
  13370. (symbol-value var))))
  13371. (defun org-entry-delete (pom property)
  13372. "Delete the property PROPERTY from entry at point-or-marker POM."
  13373. (org-with-point-at pom
  13374. (if (member property org-special-properties)
  13375. nil ; cannot delete these properties.
  13376. (let ((range (org-get-property-block)))
  13377. (if (and range
  13378. (goto-char (car range))
  13379. (re-search-forward
  13380. (org-re-property property)
  13381. (cdr range) t))
  13382. (progn
  13383. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  13384. t)
  13385. nil)))))
  13386. ;; Multi-values properties are properties that contain multiple values
  13387. ;; These values are assumed to be single words, separated by whitespace.
  13388. (defun org-entry-add-to-multivalued-property (pom property value)
  13389. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  13390. (let* ((old (org-entry-get pom property))
  13391. (values (and old (org-split-string old "[ \t]"))))
  13392. (setq value (org-entry-protect-space value))
  13393. (unless (member value values)
  13394. (setq values (cons value values))
  13395. (org-entry-put pom property
  13396. (mapconcat 'identity values " ")))))
  13397. (defun org-entry-remove-from-multivalued-property (pom property value)
  13398. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  13399. (let* ((old (org-entry-get pom property))
  13400. (values (and old (org-split-string old "[ \t]"))))
  13401. (setq value (org-entry-protect-space value))
  13402. (when (member value values)
  13403. (setq values (delete value values))
  13404. (org-entry-put pom property
  13405. (mapconcat 'identity values " ")))))
  13406. (defun org-entry-member-in-multivalued-property (pom property value)
  13407. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  13408. (let* ((old (org-entry-get pom property))
  13409. (values (and old (org-split-string old "[ \t]"))))
  13410. (setq value (org-entry-protect-space value))
  13411. (member value values)))
  13412. (defun org-entry-get-multivalued-property (pom property)
  13413. "Return a list of values in a multivalued property."
  13414. (let* ((value (org-entry-get pom property))
  13415. (values (and value (org-split-string value "[ \t]"))))
  13416. (mapcar 'org-entry-restore-space values)))
  13417. (defun org-entry-put-multivalued-property (pom property &rest values)
  13418. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  13419. VALUES should be a list of strings. Spaces will be protected."
  13420. (org-entry-put pom property
  13421. (mapconcat 'org-entry-protect-space values " "))
  13422. (let* ((value (org-entry-get pom property))
  13423. (values (and value (org-split-string value "[ \t]"))))
  13424. (mapcar 'org-entry-restore-space values)))
  13425. (defun org-entry-protect-space (s)
  13426. "Protect spaces and newline in string S."
  13427. (while (string-match " " s)
  13428. (setq s (replace-match "%20" t t s)))
  13429. (while (string-match "\n" s)
  13430. (setq s (replace-match "%0A" t t s)))
  13431. s)
  13432. (defun org-entry-restore-space (s)
  13433. "Restore spaces and newline in string S."
  13434. (while (string-match "%20" s)
  13435. (setq s (replace-match " " t t s)))
  13436. (while (string-match "%0A" s)
  13437. (setq s (replace-match "\n" t t s)))
  13438. s)
  13439. (defvar org-entry-property-inherited-from (make-marker)
  13440. "Marker pointing to the entry from where a property was inherited.
  13441. Each call to `org-entry-get-with-inheritance' will set this marker to the
  13442. location of the entry where the inheritance search matched. If there was
  13443. no match, the marker will point nowhere.
  13444. Note that also `org-entry-get' calls this function, if the INHERIT flag
  13445. is set.")
  13446. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  13447. "Get PROPERTY of entry or content at point, search higher levels if needed.
  13448. The search will stop at the first ancestor which has the property defined.
  13449. If the value found is \"nil\", return nil to show that the property
  13450. should be considered as undefined (this is the meaning of nil here).
  13451. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  13452. (move-marker org-entry-property-inherited-from nil)
  13453. (let (tmp)
  13454. (save-excursion
  13455. (save-restriction
  13456. (widen)
  13457. (catch 'ex
  13458. (while t
  13459. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  13460. (or (ignore-errors (org-back-to-heading t))
  13461. (goto-char (point-min)))
  13462. (move-marker org-entry-property-inherited-from (point))
  13463. (throw 'ex tmp))
  13464. (or (ignore-errors (org-up-heading-safe))
  13465. (throw 'ex nil))))))
  13466. (setq tmp (or tmp
  13467. (cdr (assoc property org-file-properties))
  13468. (cdr (assoc property org-global-properties))
  13469. (cdr (assoc property org-global-properties-fixed))))
  13470. (if literal-nil tmp (org-not-nil tmp))))
  13471. (defvar org-property-changed-functions nil
  13472. "Hook called when the value of a property has changed.
  13473. Each hook function should accept two arguments, the name of the property
  13474. and the new value.")
  13475. (defun org-entry-put (pom property value)
  13476. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  13477. (org-with-point-at pom
  13478. (org-back-to-heading t)
  13479. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  13480. range)
  13481. (cond
  13482. ((equal property "TODO")
  13483. (when (and (stringp value) (string-match "\\S-" value)
  13484. (not (member value org-todo-keywords-1)))
  13485. (error "\"%s\" is not a valid TODO state" value))
  13486. (if (or (not value)
  13487. (not (string-match "\\S-" value)))
  13488. (setq value 'none))
  13489. (org-todo value)
  13490. (org-set-tags nil 'align))
  13491. ((equal property "PRIORITY")
  13492. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  13493. (string-to-char value) ?\ ))
  13494. (org-set-tags nil 'align))
  13495. ((equal property "CLOCKSUM")
  13496. (if (not (re-search-forward
  13497. (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
  13498. (error "Cannot find a clock log")
  13499. (goto-char (- (match-end 1) 2))
  13500. (cond
  13501. ((eq value 'earlier) (org-timestamp-down))
  13502. ((eq value 'later) (org-timestamp-up)))
  13503. (org-clock-sum-current-item)))
  13504. ((equal property "SCHEDULED")
  13505. (if (re-search-forward org-scheduled-time-regexp end t)
  13506. (cond
  13507. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13508. ((eq value 'later) (org-timestamp-change 1 'day))
  13509. (t (call-interactively 'org-schedule)))
  13510. (call-interactively 'org-schedule)))
  13511. ((equal property "DEADLINE")
  13512. (if (re-search-forward org-deadline-time-regexp end t)
  13513. (cond
  13514. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13515. ((eq value 'later) (org-timestamp-change 1 'day))
  13516. (t (call-interactively 'org-deadline)))
  13517. (call-interactively 'org-deadline)))
  13518. ((member property org-special-properties)
  13519. (error "The %s property can not yet be set with `org-entry-put'"
  13520. property))
  13521. (t ; a non-special property
  13522. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  13523. (setq range (org-get-property-block beg end 'force))
  13524. (goto-char (car range))
  13525. (if (re-search-forward
  13526. (org-re-property-keyword property) (cdr range) t)
  13527. (progn
  13528. (delete-region (match-beginning 0) (match-end 0))
  13529. (goto-char (match-beginning 0)))
  13530. (goto-char (cdr range))
  13531. (insert "\n")
  13532. (backward-char 1)
  13533. (org-indent-line))
  13534. (insert ":" property ":")
  13535. (and value (insert " " value))
  13536. (org-indent-line)))))
  13537. (run-hook-with-args 'org-property-changed-functions property value)))
  13538. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  13539. "Get all property keys in the current buffer.
  13540. With INCLUDE-SPECIALS, also list the special properties that reflect things
  13541. like tags and TODO state.
  13542. With INCLUDE-DEFAULTS, also include properties that has special meaning
  13543. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  13544. and others.
  13545. With INCLUDE-COLUMNS, also include property names given in COLUMN
  13546. formats in the current buffer."
  13547. (let (rtn range cfmt s p)
  13548. (save-excursion
  13549. (save-restriction
  13550. (widen)
  13551. (goto-char (point-min))
  13552. (while (re-search-forward org-property-start-re nil t)
  13553. (setq range (org-get-property-block))
  13554. (goto-char (car range))
  13555. (while (re-search-forward
  13556. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  13557. (cdr range) t)
  13558. (add-to-list 'rtn (org-match-string-no-properties 1)))
  13559. (outline-next-heading))))
  13560. (when include-specials
  13561. (setq rtn (append org-special-properties rtn)))
  13562. (when include-defaults
  13563. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  13564. (add-to-list 'rtn org-effort-property))
  13565. (when include-columns
  13566. (save-excursion
  13567. (save-restriction
  13568. (widen)
  13569. (goto-char (point-min))
  13570. (while (re-search-forward
  13571. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  13572. nil t)
  13573. (setq cfmt (match-string 2) s 0)
  13574. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  13575. cfmt s)
  13576. (setq s (match-end 0)
  13577. p (match-string 1 cfmt))
  13578. (unless (or (equal p "ITEM")
  13579. (member p org-special-properties))
  13580. (add-to-list 'rtn (match-string 1 cfmt))))))))
  13581. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  13582. (defun org-property-values (key)
  13583. "Return a list of all values of property KEY in the current buffer."
  13584. (save-excursion
  13585. (save-restriction
  13586. (widen)
  13587. (goto-char (point-min))
  13588. (let ((re (org-re-property key))
  13589. values)
  13590. (while (re-search-forward re nil t)
  13591. (add-to-list 'values (org-trim (match-string 1))))
  13592. (delete "" values)))))
  13593. (defun org-insert-property-drawer ()
  13594. "Insert a property drawer into the current entry."
  13595. (org-back-to-heading t)
  13596. (looking-at org-outline-regexp)
  13597. (let ((indent (if org-adapt-indentation
  13598. (- (match-end 0) (match-beginning 0))
  13599. 0))
  13600. (beg (point))
  13601. (re (concat "^[ \t]*" org-keyword-time-regexp))
  13602. end hiddenp)
  13603. (outline-next-heading)
  13604. (setq end (point))
  13605. (goto-char beg)
  13606. (while (re-search-forward re end t))
  13607. (setq hiddenp (outline-invisible-p))
  13608. (end-of-line 1)
  13609. (and (equal (char-after) ?\n) (forward-char 1))
  13610. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  13611. (if (member (match-string 1) '("CLOCK:" ":END:"))
  13612. ;; just skip this line
  13613. (beginning-of-line 2)
  13614. ;; Drawer start, find the end
  13615. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  13616. (beginning-of-line 1)))
  13617. (org-skip-over-state-notes)
  13618. (skip-chars-backward " \t\n\r")
  13619. (if (eq (char-before) ?*) (forward-char 1))
  13620. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  13621. (beginning-of-line 0)
  13622. (org-indent-to-column indent)
  13623. (beginning-of-line 2)
  13624. (org-indent-to-column indent)
  13625. (beginning-of-line 0)
  13626. (if hiddenp
  13627. (save-excursion
  13628. (org-back-to-heading t)
  13629. (hide-entry))
  13630. (org-flag-drawer t))))
  13631. (defun org-insert-drawer (&optional arg drawer)
  13632. "Insert a drawer at point.
  13633. Optional argument DRAWER, when non-nil, is a string representing
  13634. drawer's name. Otherwise, the user is prompted for a name.
  13635. If a region is active, insert the drawer around that region
  13636. instead.
  13637. Point is left between drawer's boundaries."
  13638. (interactive "P")
  13639. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  13640. "LOGBOOK"))
  13641. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  13642. ;; internally by Org. They are meant to be inserted
  13643. ;; automatically.
  13644. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  13645. ;; Remove system drawers from list. Note: For some reason,
  13646. ;; `org-completing-read' ignores the predicate while
  13647. ;; `completing-read' handles it fine.
  13648. (drawer (if arg "PROPERTIES"
  13649. (or drawer
  13650. (completing-read
  13651. "Drawer: " org-drawers
  13652. (lambda (d) (not (member d system-drawers))))))))
  13653. (cond
  13654. ;; With C-u, fall back on `org-insert-property-drawer'
  13655. (arg (org-insert-property-drawer))
  13656. ;; With an active region, insert a drawer at point.
  13657. ((not (org-region-active-p))
  13658. (progn
  13659. (unless (bolp) (insert "\n"))
  13660. (insert (format ":%s:\n\n:END:\n" drawer))
  13661. (forward-line -2)))
  13662. ;; Otherwise, insert the drawer at point
  13663. (t
  13664. (let ((rbeg (region-beginning))
  13665. (rend (copy-marker (region-end))))
  13666. (unwind-protect
  13667. (progn
  13668. (goto-char rbeg)
  13669. (beginning-of-line)
  13670. (when (save-excursion
  13671. (re-search-forward org-outline-regexp-bol rend t))
  13672. (error "Drawers cannot contain headlines"))
  13673. ;; Position point at the beginning of the first
  13674. ;; non-blank line in region. Insert drawer's opening
  13675. ;; there, then indent it.
  13676. (org-skip-whitespace)
  13677. (beginning-of-line)
  13678. (insert ":" drawer ":\n")
  13679. (forward-line -1)
  13680. (indent-for-tab-command)
  13681. ;; Move point to the beginning of the first blank line
  13682. ;; after the last non-blank line in region. Insert
  13683. ;; drawer's closing, then indent it.
  13684. (goto-char rend)
  13685. (skip-chars-backward " \r\t\n")
  13686. (insert "\n:END:")
  13687. (deactivate-mark t)
  13688. (indent-for-tab-command)
  13689. (unless (eolp) (insert "\n")))
  13690. ;; Clear marker, whatever the outcome of insertion is.
  13691. (set-marker rend nil)))))))
  13692. (defvar org-property-set-functions-alist nil
  13693. "Property set function alist.
  13694. Each entry should have the following format:
  13695. (PROPERTY . READ-FUNCTION)
  13696. The read function will be called with the same argument as
  13697. `org-completing-read'.")
  13698. (defun org-set-property-function (property)
  13699. "Get the function that should be used to set PROPERTY.
  13700. This is computed according to `org-property-set-functions-alist'."
  13701. (or (cdr (assoc property org-property-set-functions-alist))
  13702. 'org-completing-read))
  13703. (defun org-read-property-value (property)
  13704. "Read PROPERTY value from user."
  13705. (let* ((completion-ignore-case t)
  13706. (allowed (org-property-get-allowed-values nil property 'table))
  13707. (cur (org-entry-get nil property))
  13708. (prompt (concat property " value"
  13709. (if (and cur (string-match "\\S-" cur))
  13710. (concat " [" cur "]") "") ": "))
  13711. (set-function (org-set-property-function property))
  13712. (val (if allowed
  13713. (funcall set-function prompt allowed nil
  13714. (not (get-text-property 0 'org-unrestricted
  13715. (caar allowed))))
  13716. (let (org-completion-use-ido org-completion-use-iswitchb)
  13717. (funcall set-function prompt
  13718. (mapcar 'list (org-property-values property))
  13719. nil nil "" nil cur)))))
  13720. (if (equal val "")
  13721. cur
  13722. val)))
  13723. (defvar org-last-set-property nil)
  13724. (defun org-read-property-name ()
  13725. "Read a property name."
  13726. (let* ((completion-ignore-case t)
  13727. (keys (org-buffer-property-keys nil t t))
  13728. (default-prop (or (save-excursion
  13729. (save-match-data
  13730. (beginning-of-line)
  13731. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  13732. (null (string= (match-string 1) "END"))
  13733. (match-string 1))))
  13734. org-last-set-property))
  13735. (property (org-icompleting-read
  13736. (concat "Property"
  13737. (if default-prop (concat " [" default-prop "]") "")
  13738. ": ")
  13739. (mapcar 'list keys)
  13740. nil nil nil nil
  13741. default-prop
  13742. )))
  13743. (if (member property keys)
  13744. property
  13745. (or (cdr (assoc (downcase property)
  13746. (mapcar (lambda (x) (cons (downcase x) x))
  13747. keys)))
  13748. property))))
  13749. (defun org-set-property (property value)
  13750. "In the current entry, set PROPERTY to VALUE.
  13751. When called interactively, this will prompt for a property name, offering
  13752. completion on existing and default properties. And then it will prompt
  13753. for a value, offering completion either on allowed values (via an inherited
  13754. xxx_ALL property) or on existing values in other instances of this property
  13755. in the current file."
  13756. (interactive (list nil nil))
  13757. (let* ((property (or property (org-read-property-name)))
  13758. (value (or value (org-read-property-value property)))
  13759. (fn (cdr (assoc property org-properties-postprocess-alist))))
  13760. (setq org-last-set-property property)
  13761. ;; Possibly postprocess the inserted value:
  13762. (when fn (setq value (funcall fn value)))
  13763. (unless (equal (org-entry-get nil property) value)
  13764. (org-entry-put nil property value))))
  13765. (defun org-delete-property (property)
  13766. "In the current entry, delete PROPERTY."
  13767. (interactive
  13768. (let* ((completion-ignore-case t)
  13769. (prop (org-icompleting-read "Property: "
  13770. (org-entry-properties nil 'standard))))
  13771. (list prop)))
  13772. (message "Property %s %s" property
  13773. (if (org-entry-delete nil property)
  13774. "deleted"
  13775. "was not present in the entry")))
  13776. (defun org-delete-property-globally (property)
  13777. "Remove PROPERTY globally, from all entries."
  13778. (interactive
  13779. (let* ((completion-ignore-case t)
  13780. (prop (org-icompleting-read
  13781. "Globally remove property: "
  13782. (mapcar 'list (org-buffer-property-keys)))))
  13783. (list prop)))
  13784. (save-excursion
  13785. (save-restriction
  13786. (widen)
  13787. (goto-char (point-min))
  13788. (let ((cnt 0))
  13789. (while (re-search-forward
  13790. (org-re-property property)
  13791. nil t)
  13792. (setq cnt (1+ cnt))
  13793. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  13794. (message "Property \"%s\" removed from %d entries" property cnt)))))
  13795. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  13796. (defun org-compute-property-at-point ()
  13797. "Compute the property at point.
  13798. This looks for an enclosing column format, extracts the operator and
  13799. then applies it to the property in the column format's scope."
  13800. (interactive)
  13801. (unless (org-at-property-p)
  13802. (error "Not at a property"))
  13803. (let ((prop (org-match-string-no-properties 2)))
  13804. (org-columns-get-format-and-top-level)
  13805. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  13806. (error "No operator defined for property %s" prop))
  13807. (org-columns-compute prop)))
  13808. (defvar org-property-allowed-value-functions nil
  13809. "Hook for functions supplying allowed values for a specific property.
  13810. The functions must take a single argument, the name of the property, and
  13811. return a flat list of allowed values. If \":ETC\" is one of
  13812. the values, this means that these values are intended as defaults for
  13813. completion, but that other values should be allowed too.
  13814. The functions must return nil if they are not responsible for this
  13815. property.")
  13816. (defun org-property-get-allowed-values (pom property &optional table)
  13817. "Get allowed values for the property PROPERTY.
  13818. When TABLE is non-nil, return an alist that can directly be used for
  13819. completion."
  13820. (let (vals)
  13821. (cond
  13822. ((equal property "TODO")
  13823. (setq vals (org-with-point-at pom
  13824. (append org-todo-keywords-1 '("")))))
  13825. ((equal property "PRIORITY")
  13826. (let ((n org-lowest-priority))
  13827. (while (>= n org-highest-priority)
  13828. (push (char-to-string n) vals)
  13829. (setq n (1- n)))))
  13830. ((member property org-special-properties))
  13831. ((setq vals (run-hook-with-args-until-success
  13832. 'org-property-allowed-value-functions property)))
  13833. (t
  13834. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  13835. (when (and vals (string-match "\\S-" vals))
  13836. (setq vals (car (read-from-string (concat "(" vals ")"))))
  13837. (setq vals (mapcar (lambda (x)
  13838. (cond ((stringp x) x)
  13839. ((numberp x) (number-to-string x))
  13840. ((symbolp x) (symbol-name x))
  13841. (t "???")))
  13842. vals)))))
  13843. (when (member ":ETC" vals)
  13844. (setq vals (remove ":ETC" vals))
  13845. (org-add-props (car vals) '(org-unrestricted t)))
  13846. (if table (mapcar 'list vals) vals)))
  13847. (defun org-property-previous-allowed-value (&optional previous)
  13848. "Switch to the next allowed value for this property."
  13849. (interactive)
  13850. (org-property-next-allowed-value t))
  13851. (defun org-property-next-allowed-value (&optional previous)
  13852. "Switch to the next allowed value for this property."
  13853. (interactive)
  13854. (unless (org-at-property-p)
  13855. (error "Not at a property"))
  13856. (let* ((key (match-string 2))
  13857. (value (match-string 3))
  13858. (allowed (or (org-property-get-allowed-values (point) key)
  13859. (and (member value '("[ ]" "[-]" "[X]"))
  13860. '("[ ]" "[X]"))))
  13861. nval)
  13862. (unless allowed
  13863. (error "Allowed values for this property have not been defined"))
  13864. (if previous (setq allowed (reverse allowed)))
  13865. (if (member value allowed)
  13866. (setq nval (car (cdr (member value allowed)))))
  13867. (setq nval (or nval (car allowed)))
  13868. (if (equal nval value)
  13869. (error "Only one allowed value for this property"))
  13870. (org-at-property-p)
  13871. (replace-match (concat " :" key ": " nval) t t)
  13872. (org-indent-line)
  13873. (beginning-of-line 1)
  13874. (skip-chars-forward " \t")
  13875. (run-hook-with-args 'org-property-changed-functions key nval)))
  13876. (defun org-find-olp (path &optional this-buffer)
  13877. "Return a marker pointing to the entry at outline path OLP.
  13878. If anything goes wrong, throw an error.
  13879. You can wrap this call to catch the error like this:
  13880. (condition-case msg
  13881. (org-mobile-locate-entry (match-string 4))
  13882. (error (nth 1 msg)))
  13883. The return value will then be either a string with the error message,
  13884. or a marker if everything is OK.
  13885. If THIS-BUFFER is set, the outline path does not contain a file,
  13886. only headings."
  13887. (let* ((file (if this-buffer buffer-file-name (pop path)))
  13888. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  13889. (level 1)
  13890. (lmin 1)
  13891. (lmax 1)
  13892. limit re end found pos heading cnt flevel)
  13893. (unless buffer (error "File not found :%s" file))
  13894. (with-current-buffer buffer
  13895. (save-excursion
  13896. (save-restriction
  13897. (widen)
  13898. (setq limit (point-max))
  13899. (goto-char (point-min))
  13900. (while (setq heading (pop path))
  13901. (setq re (format org-complex-heading-regexp-format
  13902. (regexp-quote heading)))
  13903. (setq cnt 0 pos (point))
  13904. (while (re-search-forward re end t)
  13905. (setq level (- (match-end 1) (match-beginning 1)))
  13906. (if (and (>= level lmin) (<= level lmax))
  13907. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  13908. (when (= cnt 0) (error "Heading not found on level %d: %s"
  13909. lmax heading))
  13910. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  13911. lmax heading))
  13912. (goto-char found)
  13913. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  13914. (setq end (save-excursion (org-end-of-subtree t t))))
  13915. (when (org-at-heading-p)
  13916. (move-marker (make-marker) (point))))))))
  13917. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  13918. "Find node HEADING in BUFFER.
  13919. Return a marker to the heading if it was found, or nil if not.
  13920. If POS-ONLY is set, return just the position instead of a marker.
  13921. The heading text must match exact, but it may have a TODO keyword,
  13922. a priority cookie and tags in the standard locations."
  13923. (with-current-buffer (or buffer (current-buffer))
  13924. (save-excursion
  13925. (save-restriction
  13926. (widen)
  13927. (goto-char (point-min))
  13928. (let (case-fold-search)
  13929. (if (re-search-forward
  13930. (format org-complex-heading-regexp-format
  13931. (regexp-quote heading)) nil t)
  13932. (if pos-only
  13933. (match-beginning 0)
  13934. (move-marker (make-marker) (match-beginning 0)))))))))
  13935. (defun org-find-exact-heading-in-directory (heading &optional dir)
  13936. "Find Org node headline HEADING in all .org files in directory DIR.
  13937. When the target headline is found, return a marker to this location."
  13938. (let ((files (directory-files (or dir default-directory)
  13939. nil "\\`[^.#].*\\.org\\'"))
  13940. file visiting m buffer)
  13941. (catch 'found
  13942. (while (setq file (pop files))
  13943. (message "trying %s" file)
  13944. (setq visiting (org-find-base-buffer-visiting file))
  13945. (setq buffer (or visiting (find-file-noselect file)))
  13946. (setq m (org-find-exact-headline-in-buffer
  13947. heading buffer))
  13948. (when (and (not m) (not visiting)) (kill-buffer buffer))
  13949. (and m (throw 'found m))))))
  13950. (defun org-find-entry-with-id (ident)
  13951. "Locate the entry that contains the ID property with exact value IDENT.
  13952. IDENT can be a string, a symbol or a number, this function will search for
  13953. the string representation of it.
  13954. Return the position where this entry starts, or nil if there is no such entry."
  13955. (interactive "sID: ")
  13956. (let ((id (cond
  13957. ((stringp ident) ident)
  13958. ((symbol-name ident) (symbol-name ident))
  13959. ((numberp ident) (number-to-string ident))
  13960. (t (error "IDENT %s must be a string, symbol or number" ident))))
  13961. (case-fold-search nil))
  13962. (save-excursion
  13963. (save-restriction
  13964. (widen)
  13965. (goto-char (point-min))
  13966. (when (re-search-forward
  13967. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  13968. nil t)
  13969. (org-back-to-heading t)
  13970. (point))))))
  13971. ;;;; Timestamps
  13972. (defvar org-last-changed-timestamp nil)
  13973. (defvar org-last-inserted-timestamp nil
  13974. "The last time stamp inserted with `org-insert-time-stamp'.")
  13975. (defvar org-time-was-given) ; dynamically scoped parameter
  13976. (defvar org-end-time-was-given) ; dynamically scoped parameter
  13977. (defvar org-ts-what) ; dynamically scoped parameter
  13978. (defun org-time-stamp (arg &optional inactive)
  13979. "Prompt for a date/time and insert a time stamp.
  13980. If the user specifies a time like HH:MM or if this command is
  13981. called with at least one prefix argument, the time stamp contains
  13982. the date and the time. Otherwise, only the date is be included.
  13983. All parts of a date not specified by the user is filled in from
  13984. the current date/time. So if you just press return without
  13985. typing anything, the time stamp will represent the current
  13986. date/time.
  13987. If there is already a timestamp at the cursor, it will be
  13988. modified.
  13989. With two universal prefix arguments, insert an active timestamp
  13990. with the current time without prompting the user."
  13991. (interactive "P")
  13992. (let* ((ts nil)
  13993. (default-time
  13994. ;; Default time is either today, or, when entering a range,
  13995. ;; the range start.
  13996. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  13997. (save-excursion
  13998. (re-search-backward
  13999. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  14000. (- (point) 20) t)))
  14001. (apply 'encode-time (org-parse-time-string (match-string 1)))
  14002. (current-time)))
  14003. (default-input (and ts (org-get-compact-tod ts)))
  14004. (repeater (save-excursion
  14005. (save-match-data
  14006. (beginning-of-line)
  14007. (when (re-search-forward
  14008. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  14009. (save-excursion (progn (end-of-line) (point))) t)
  14010. (match-string 0)))))
  14011. org-time-was-given org-end-time-was-given time)
  14012. (cond
  14013. ((and (org-at-timestamp-p t)
  14014. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  14015. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  14016. (insert "--")
  14017. (setq time (let ((this-command this-command))
  14018. (org-read-date arg 'totime nil nil
  14019. default-time default-input inactive)))
  14020. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  14021. ((org-at-timestamp-p t)
  14022. (setq time (let ((this-command this-command))
  14023. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14024. (when (org-at-timestamp-p t) ; just to get the match data
  14025. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  14026. (replace-match "")
  14027. (setq org-last-changed-timestamp
  14028. (org-insert-time-stamp
  14029. time (or org-time-was-given arg)
  14030. inactive nil nil (list org-end-time-was-given)))
  14031. (when repeater (goto-char (1- (point))) (insert " " repeater)
  14032. (setq org-last-changed-timestamp
  14033. (concat (substring org-last-inserted-timestamp 0 -1)
  14034. " " repeater ">"))))
  14035. (message "Timestamp updated"))
  14036. ((equal arg '(16))
  14037. (org-insert-time-stamp (current-time) t))
  14038. (t
  14039. (setq time (let ((this-command this-command))
  14040. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14041. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  14042. nil nil (list org-end-time-was-given))))))
  14043. ;; FIXME: can we use this for something else, like computing time differences?
  14044. (defun org-get-compact-tod (s)
  14045. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  14046. (let* ((t1 (match-string 1 s))
  14047. (h1 (string-to-number (match-string 2 s)))
  14048. (m1 (string-to-number (match-string 3 s)))
  14049. (t2 (and (match-end 4) (match-string 5 s)))
  14050. (h2 (and t2 (string-to-number (match-string 6 s))))
  14051. (m2 (and t2 (string-to-number (match-string 7 s))))
  14052. dh dm)
  14053. (if (not t2)
  14054. t1
  14055. (setq dh (- h2 h1) dm (- m2 m1))
  14056. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  14057. (concat t1 "+" (number-to-string dh)
  14058. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  14059. (defun org-time-stamp-inactive (&optional arg)
  14060. "Insert an inactive time stamp.
  14061. An inactive time stamp is enclosed in square brackets instead of angle
  14062. brackets. It is inactive in the sense that it does not trigger agenda entries,
  14063. does not link to the calendar and cannot be changed with the S-cursor keys.
  14064. So these are more for recording a certain time/date."
  14065. (interactive "P")
  14066. (org-time-stamp arg 'inactive))
  14067. (defvar org-date-ovl (make-overlay 1 1))
  14068. (overlay-put org-date-ovl 'face 'org-date-selected)
  14069. (org-detach-overlay org-date-ovl)
  14070. (defvar org-ans1) ; dynamically scoped parameter
  14071. (defvar org-ans2) ; dynamically scoped parameter
  14072. (defvar org-plain-time-of-day-regexp) ; defined below
  14073. (defvar org-overriding-default-time nil) ; dynamically scoped
  14074. (defvar org-read-date-overlay nil)
  14075. (defvar org-dcst nil) ; dynamically scoped
  14076. (defvar org-read-date-history nil)
  14077. (defvar org-read-date-final-answer nil)
  14078. (defvar org-read-date-analyze-futurep nil)
  14079. (defvar org-read-date-analyze-forced-year nil)
  14080. (defvar org-read-date-inactive)
  14081. (defun org-read-date (&optional org-with-time to-time from-string prompt
  14082. default-time default-input inactive)
  14083. "Read a date, possibly a time, and make things smooth for the user.
  14084. The prompt will suggest to enter an ISO date, but you can also enter anything
  14085. which will at least partially be understood by `parse-time-string'.
  14086. Unrecognized parts of the date will default to the current day, month, year,
  14087. hour and minute. If this command is called to replace a timestamp at point,
  14088. or to enter the second timestamp of a range, the default time is taken
  14089. from the existing stamp. Furthermore, the command prefers the future,
  14090. so if you are giving a date where the year is not given, and the day-month
  14091. combination is already past in the current year, it will assume you
  14092. mean next year. For details, see the manual. A few examples:
  14093. 3-2-5 --> 2003-02-05
  14094. feb 15 --> currentyear-02-15
  14095. 2/15 --> currentyear-02-15
  14096. sep 12 9 --> 2009-09-12
  14097. 12:45 --> today 12:45
  14098. 22 sept 0:34 --> currentyear-09-22 0:34
  14099. 12 --> currentyear-currentmonth-12
  14100. Fri --> nearest Friday (today or later)
  14101. etc.
  14102. Furthermore you can specify a relative date by giving, as the *first* thing
  14103. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  14104. change in days weeks, months, years.
  14105. With a single plus or minus, the date is relative to today. With a double
  14106. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  14107. +4d --> four days from today
  14108. +4 --> same as above
  14109. +2w --> two weeks from today
  14110. ++5 --> five days from default date
  14111. The function understands only English month and weekday abbreviations.
  14112. While prompting, a calendar is popped up - you can also select the
  14113. date with the mouse (button 1). The calendar shows a period of three
  14114. months. To scroll it to other months, use the keys `>' and `<'.
  14115. If you don't like the calendar, turn it off with
  14116. \(setq org-read-date-popup-calendar nil)
  14117. With optional argument TO-TIME, the date will immediately be converted
  14118. to an internal time.
  14119. With an optional argument ORG-WITH-TIME, the prompt will suggest to
  14120. also insert a time. Note that when ORG-WITH-TIME is not set, you can
  14121. still enter a time, and this function will inform the calling routine
  14122. about this change. The calling routine may then choose to change the
  14123. format used to insert the time stamp into the buffer to include the time.
  14124. With optional argument FROM-STRING, read from this string instead from
  14125. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  14126. the time/date that is used for everything that is not specified by the
  14127. user."
  14128. (require 'parse-time)
  14129. (let* ((org-time-stamp-rounding-minutes
  14130. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  14131. (org-dcst org-display-custom-times)
  14132. (ct (org-current-time))
  14133. (org-def (or org-overriding-default-time default-time ct))
  14134. (org-defdecode (decode-time org-def))
  14135. (dummy (progn
  14136. (when (< (nth 2 org-defdecode) org-extend-today-until)
  14137. (setcar (nthcdr 2 org-defdecode) -1)
  14138. (setcar (nthcdr 1 org-defdecode) 59)
  14139. (setq org-def (apply 'encode-time org-defdecode)
  14140. org-defdecode (decode-time org-def)))))
  14141. (calendar-frame-setup nil)
  14142. (calendar-setup nil)
  14143. (calendar-move-hook nil)
  14144. (calendar-view-diary-initially-flag nil)
  14145. (calendar-view-holidays-initially-flag nil)
  14146. (timestr (format-time-string
  14147. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  14148. (prompt (concat (if prompt (concat prompt " ") "")
  14149. (format "Date+time [%s]: " timestr)))
  14150. ans (org-ans0 "") org-ans1 org-ans2 final)
  14151. (cond
  14152. (from-string (setq ans from-string))
  14153. (org-read-date-popup-calendar
  14154. (save-excursion
  14155. (save-window-excursion
  14156. (calendar)
  14157. (org-eval-in-calendar '(setq cursor-type nil) t)
  14158. (unwind-protect
  14159. (progn
  14160. (calendar-forward-day (- (time-to-days org-def)
  14161. (calendar-absolute-from-gregorian
  14162. (calendar-current-date))))
  14163. (org-eval-in-calendar nil t)
  14164. (let* ((old-map (current-local-map))
  14165. (map (copy-keymap calendar-mode-map))
  14166. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  14167. (org-defkey map (kbd "RET") 'org-calendar-select)
  14168. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  14169. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  14170. (org-defkey minibuffer-local-map [(meta shift left)]
  14171. (lambda () (interactive)
  14172. (org-eval-in-calendar '(calendar-backward-month 1))))
  14173. (org-defkey minibuffer-local-map [(meta shift right)]
  14174. (lambda () (interactive)
  14175. (org-eval-in-calendar '(calendar-forward-month 1))))
  14176. (org-defkey minibuffer-local-map [(meta shift up)]
  14177. (lambda () (interactive)
  14178. (org-eval-in-calendar '(calendar-backward-year 1))))
  14179. (org-defkey minibuffer-local-map [(meta shift down)]
  14180. (lambda () (interactive)
  14181. (org-eval-in-calendar '(calendar-forward-year 1))))
  14182. (org-defkey minibuffer-local-map [?\e (shift left)]
  14183. (lambda () (interactive)
  14184. (org-eval-in-calendar '(calendar-backward-month 1))))
  14185. (org-defkey minibuffer-local-map [?\e (shift right)]
  14186. (lambda () (interactive)
  14187. (org-eval-in-calendar '(calendar-forward-month 1))))
  14188. (org-defkey minibuffer-local-map [?\e (shift up)]
  14189. (lambda () (interactive)
  14190. (org-eval-in-calendar '(calendar-backward-year 1))))
  14191. (org-defkey minibuffer-local-map [?\e (shift down)]
  14192. (lambda () (interactive)
  14193. (org-eval-in-calendar '(calendar-forward-year 1))))
  14194. (org-defkey minibuffer-local-map [(shift up)]
  14195. (lambda () (interactive)
  14196. (org-eval-in-calendar '(calendar-backward-week 1))))
  14197. (org-defkey minibuffer-local-map [(shift down)]
  14198. (lambda () (interactive)
  14199. (org-eval-in-calendar '(calendar-forward-week 1))))
  14200. (org-defkey minibuffer-local-map [(shift left)]
  14201. (lambda () (interactive)
  14202. (org-eval-in-calendar '(calendar-backward-day 1))))
  14203. (org-defkey minibuffer-local-map [(shift right)]
  14204. (lambda () (interactive)
  14205. (org-eval-in-calendar '(calendar-forward-day 1))))
  14206. (org-defkey minibuffer-local-map ">"
  14207. (lambda () (interactive)
  14208. (org-eval-in-calendar '(scroll-calendar-left 1))))
  14209. (org-defkey minibuffer-local-map "<"
  14210. (lambda () (interactive)
  14211. (org-eval-in-calendar '(scroll-calendar-right 1))))
  14212. (org-defkey minibuffer-local-map "\C-v"
  14213. (lambda () (interactive)
  14214. (org-eval-in-calendar
  14215. '(calendar-scroll-left-three-months 1))))
  14216. (org-defkey minibuffer-local-map "\M-v"
  14217. (lambda () (interactive)
  14218. (org-eval-in-calendar
  14219. '(calendar-scroll-right-three-months 1))))
  14220. (run-hooks 'org-read-date-minibuffer-setup-hook)
  14221. (unwind-protect
  14222. (progn
  14223. (use-local-map map)
  14224. (setq org-read-date-inactive inactive)
  14225. (add-hook 'post-command-hook 'org-read-date-display)
  14226. (setq org-ans0 (read-string prompt default-input
  14227. 'org-read-date-history nil))
  14228. ;; org-ans0: from prompt
  14229. ;; org-ans1: from mouse click
  14230. ;; org-ans2: from calendar motion
  14231. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  14232. (remove-hook 'post-command-hook 'org-read-date-display)
  14233. (use-local-map old-map)
  14234. (when org-read-date-overlay
  14235. (delete-overlay org-read-date-overlay)
  14236. (setq org-read-date-overlay nil)))))
  14237. (bury-buffer "*Calendar*")))))
  14238. (t ; Naked prompt only
  14239. (unwind-protect
  14240. (setq ans (read-string prompt default-input
  14241. 'org-read-date-history timestr))
  14242. (when org-read-date-overlay
  14243. (delete-overlay org-read-date-overlay)
  14244. (setq org-read-date-overlay nil)))))
  14245. (setq final (org-read-date-analyze ans org-def org-defdecode))
  14246. (when org-read-date-analyze-forced-year
  14247. (message "Year was forced into %s"
  14248. (if org-read-date-force-compatible-dates
  14249. "compatible range (1970-2037)"
  14250. "range representable on this machine"))
  14251. (ding))
  14252. ;; One round trip to get rid of 34th of August and stuff like that....
  14253. (setq final (decode-time (apply 'encode-time final)))
  14254. (setq org-read-date-final-answer ans)
  14255. (if to-time
  14256. (apply 'encode-time final)
  14257. (if (and (boundp 'org-time-was-given) org-time-was-given)
  14258. (format "%04d-%02d-%02d %02d:%02d"
  14259. (nth 5 final) (nth 4 final) (nth 3 final)
  14260. (nth 2 final) (nth 1 final))
  14261. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  14262. (defvar org-def)
  14263. (defvar org-defdecode)
  14264. (defvar org-with-time)
  14265. (defun org-read-date-display ()
  14266. "Display the current date prompt interpretation in the minibuffer."
  14267. (when org-read-date-display-live
  14268. (when org-read-date-overlay
  14269. (delete-overlay org-read-date-overlay))
  14270. (when (minibufferp (current-buffer))
  14271. (save-excursion
  14272. (end-of-line 1)
  14273. (while (not (equal (buffer-substring
  14274. (max (point-min) (- (point) 4)) (point))
  14275. " "))
  14276. (insert " ")))
  14277. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14278. " " (or org-ans1 org-ans2)))
  14279. (org-end-time-was-given nil)
  14280. (f (org-read-date-analyze ans org-def org-defdecode))
  14281. (fmts (if org-dcst
  14282. org-time-stamp-custom-formats
  14283. org-time-stamp-formats))
  14284. (fmt (if (or org-with-time
  14285. (and (boundp 'org-time-was-given) org-time-was-given))
  14286. (cdr fmts)
  14287. (car fmts)))
  14288. (txt (format-time-string fmt (apply 'encode-time f)))
  14289. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  14290. (txt (concat "=> " txt)))
  14291. (when (and org-end-time-was-given
  14292. (string-match org-plain-time-of-day-regexp txt))
  14293. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  14294. org-end-time-was-given
  14295. (substring txt (match-end 0)))))
  14296. (when org-read-date-analyze-futurep
  14297. (setq txt (concat txt " (=>F)")))
  14298. (setq org-read-date-overlay
  14299. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  14300. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  14301. (defun org-read-date-analyze (ans org-def org-defdecode)
  14302. "Analyze the combined answer of the date prompt."
  14303. ;; FIXME: cleanup and comment
  14304. (let ((nowdecode (decode-time (current-time)))
  14305. delta deltan deltaw deltadef year month day
  14306. hour minute second wday pm h2 m2 tl wday1
  14307. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  14308. (setq org-read-date-analyze-futurep nil
  14309. org-read-date-analyze-forced-year nil)
  14310. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  14311. (setq ans "+0"))
  14312. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  14313. (setq ans (replace-match "" t t ans)
  14314. deltan (car delta)
  14315. deltaw (nth 1 delta)
  14316. deltadef (nth 2 delta)))
  14317. ;; Check if there is an iso week date in there. If yes, store the
  14318. ;; info and postpone interpreting it until the rest of the parsing
  14319. ;; is done.
  14320. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  14321. (setq iso-year (if (match-end 1)
  14322. (org-small-year-to-year
  14323. (string-to-number (match-string 1 ans))))
  14324. iso-weekday (if (match-end 3)
  14325. (string-to-number (match-string 3 ans)))
  14326. iso-week (string-to-number (match-string 2 ans)))
  14327. (setq ans (replace-match "" t t ans)))
  14328. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  14329. (when (string-match
  14330. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  14331. (setq year (if (match-end 2)
  14332. (string-to-number (match-string 2 ans))
  14333. (progn (setq kill-year t)
  14334. (string-to-number (format-time-string "%Y"))))
  14335. month (string-to-number (match-string 3 ans))
  14336. day (string-to-number (match-string 4 ans)))
  14337. (if (< year 100) (setq year (+ 2000 year)))
  14338. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14339. t nil ans)))
  14340. ;; Help matching dotted european dates
  14341. (when (string-match
  14342. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
  14343. (setq year (if (match-end 3)
  14344. (string-to-number (match-string 3 ans))
  14345. (progn (setq kill-year t)
  14346. (string-to-number (format-time-string "%Y"))))
  14347. day (string-to-number (match-string 1 ans))
  14348. month (string-to-number (match-string 2 ans))
  14349. ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14350. t nil ans)))
  14351. ;; Help matching american dates, like 5/30 or 5/30/7
  14352. (when (string-match
  14353. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  14354. (setq year (if (match-end 4)
  14355. (string-to-number (match-string 4 ans))
  14356. (progn (setq kill-year t)
  14357. (string-to-number (format-time-string "%Y"))))
  14358. month (string-to-number (match-string 1 ans))
  14359. day (string-to-number (match-string 2 ans)))
  14360. (if (< year 100) (setq year (+ 2000 year)))
  14361. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14362. t nil ans)))
  14363. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  14364. ;; If there is a time with am/pm, and *no* time without it, we convert
  14365. ;; so that matching will be successful.
  14366. (loop for i from 1 to 2 do ; twice, for end time as well
  14367. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  14368. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  14369. (setq hour (string-to-number (match-string 1 ans))
  14370. minute (if (match-end 3)
  14371. (string-to-number (match-string 3 ans))
  14372. 0)
  14373. pm (equal ?p
  14374. (string-to-char (downcase (match-string 4 ans)))))
  14375. (if (and (= hour 12) (not pm))
  14376. (setq hour 0)
  14377. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  14378. (setq ans (replace-match (format "%02d:%02d" hour minute)
  14379. t t ans))))
  14380. ;; Check if a time range is given as a duration
  14381. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  14382. (setq hour (string-to-number (match-string 1 ans))
  14383. h2 (+ hour (string-to-number (match-string 3 ans)))
  14384. minute (string-to-number (match-string 2 ans))
  14385. m2 (+ minute (if (match-end 5) (string-to-number
  14386. (match-string 5 ans))0)))
  14387. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  14388. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  14389. t t ans)))
  14390. ;; Check if there is a time range
  14391. (when (boundp 'org-end-time-was-given)
  14392. (setq org-time-was-given nil)
  14393. (when (and (string-match org-plain-time-of-day-regexp ans)
  14394. (match-end 8))
  14395. (setq org-end-time-was-given (match-string 8 ans))
  14396. (setq ans (concat (substring ans 0 (match-beginning 7))
  14397. (substring ans (match-end 7))))))
  14398. (setq tl (parse-time-string ans)
  14399. day (or (nth 3 tl) (nth 3 org-defdecode))
  14400. month (or (nth 4 tl)
  14401. (if (and org-read-date-prefer-future
  14402. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  14403. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  14404. (nth 4 org-defdecode)))
  14405. year (or (and (not kill-year) (nth 5 tl))
  14406. (if (and org-read-date-prefer-future
  14407. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  14408. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  14409. (nth 5 org-defdecode)))
  14410. hour (or (nth 2 tl) (nth 2 org-defdecode))
  14411. minute (or (nth 1 tl) (nth 1 org-defdecode))
  14412. second (or (nth 0 tl) 0)
  14413. wday (nth 6 tl))
  14414. (when (and (eq org-read-date-prefer-future 'time)
  14415. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  14416. (equal day (nth 3 nowdecode))
  14417. (equal month (nth 4 nowdecode))
  14418. (equal year (nth 5 nowdecode))
  14419. (nth 2 tl)
  14420. (or (< (nth 2 tl) (nth 2 nowdecode))
  14421. (and (= (nth 2 tl) (nth 2 nowdecode))
  14422. (nth 1 tl)
  14423. (< (nth 1 tl) (nth 1 nowdecode)))))
  14424. (setq day (1+ day)
  14425. futurep t))
  14426. ;; Special date definitions below
  14427. (cond
  14428. (iso-week
  14429. ;; There was an iso week
  14430. (require 'cal-iso)
  14431. (setq futurep nil)
  14432. (setq year (or iso-year year)
  14433. day (or iso-weekday wday 1)
  14434. wday nil ; to make sure that the trigger below does not match
  14435. iso-date (calendar-gregorian-from-absolute
  14436. (calendar-absolute-from-iso
  14437. (list iso-week day year))))
  14438. ; FIXME: Should we also push ISO weeks into the future?
  14439. ; (when (and org-read-date-prefer-future
  14440. ; (not iso-year)
  14441. ; (< (calendar-absolute-from-gregorian iso-date)
  14442. ; (time-to-days (current-time))))
  14443. ; (setq year (1+ year)
  14444. ; iso-date (calendar-gregorian-from-absolute
  14445. ; (calendar-absolute-from-iso
  14446. ; (list iso-week day year)))))
  14447. (setq month (car iso-date)
  14448. year (nth 2 iso-date)
  14449. day (nth 1 iso-date)))
  14450. (deltan
  14451. (setq futurep nil)
  14452. (unless deltadef
  14453. (let ((now (decode-time (current-time))))
  14454. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  14455. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  14456. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  14457. ((equal deltaw "m") (setq month (+ month deltan)))
  14458. ((equal deltaw "y") (setq year (+ year deltan)))))
  14459. ((and wday (not (nth 3 tl)))
  14460. ;; Weekday was given, but no day, so pick that day in the week
  14461. ;; on or after the derived date.
  14462. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  14463. (unless (equal wday wday1)
  14464. (setq day (+ day (% (- wday wday1 -7) 7))))))
  14465. (if (and (boundp 'org-time-was-given)
  14466. (nth 2 tl))
  14467. (setq org-time-was-given t))
  14468. (if (< year 100) (setq year (+ 2000 year)))
  14469. ;; Check of the date is representable
  14470. (if org-read-date-force-compatible-dates
  14471. (progn
  14472. (if (< year 1970)
  14473. (setq year 1970 org-read-date-analyze-forced-year t))
  14474. (if (> year 2037)
  14475. (setq year 2037 org-read-date-analyze-forced-year t)))
  14476. (condition-case nil
  14477. (ignore (encode-time second minute hour day month year))
  14478. (error
  14479. (setq year (nth 5 org-defdecode))
  14480. (setq org-read-date-analyze-forced-year t))))
  14481. (setq org-read-date-analyze-futurep futurep)
  14482. (list second minute hour day month year)))
  14483. (defvar parse-time-weekdays)
  14484. (defun org-read-date-get-relative (s today default)
  14485. "Check string S for special relative date string.
  14486. TODAY and DEFAULT are internal times, for today and for a default.
  14487. Return shift list (N what def-flag)
  14488. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  14489. N is the number of WHATs to shift.
  14490. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  14491. the DEFAULT date rather than TODAY."
  14492. (require 'parse-time)
  14493. (when (and
  14494. (string-match
  14495. (concat
  14496. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  14497. "\\([0-9]+\\)?"
  14498. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  14499. "\\([ \t]\\|$\\)") s)
  14500. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  14501. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  14502. (string-to-char (substring (match-string 1 s) -1))
  14503. ?+))
  14504. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  14505. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  14506. (what (if (match-end 3) (match-string 3 s) "d"))
  14507. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  14508. (date (if rel default today))
  14509. (wday (nth 6 (decode-time date)))
  14510. delta)
  14511. (if wday1
  14512. (progn
  14513. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  14514. (if (= dir ?-) (setq delta (- delta 7)))
  14515. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  14516. (list delta "d" rel))
  14517. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  14518. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  14519. "Turn a user-specified date into the internal representation.
  14520. The internal representation needed by the calendar is (month day year).
  14521. This is a wrapper to handle the brain-dead convention in calendar that
  14522. user function argument order change dependent on argument order."
  14523. (if (boundp 'calendar-date-style)
  14524. (cond
  14525. ((eq calendar-date-style 'american)
  14526. (list arg1 arg2 arg3))
  14527. ((eq calendar-date-style 'european)
  14528. (list arg2 arg1 arg3))
  14529. ((eq calendar-date-style 'iso)
  14530. (list arg2 arg3 arg1)))
  14531. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  14532. (if (org-bound-and-true-p european-calendar-style)
  14533. (list arg2 arg1 arg3)
  14534. (list arg1 arg2 arg3)))))
  14535. (defun org-eval-in-calendar (form &optional keepdate)
  14536. "Eval FORM in the calendar window and return to current window.
  14537. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  14538. otherwise stick to the current value of `org-ans2'."
  14539. (let ((sf (selected-frame))
  14540. (sw (selected-window)))
  14541. (select-window (get-buffer-window "*Calendar*" t))
  14542. (eval form)
  14543. (when (and (not keepdate) (calendar-cursor-to-date))
  14544. (let* ((date (calendar-cursor-to-date))
  14545. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14546. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  14547. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  14548. (select-window sw)
  14549. (org-select-frame-set-input-focus sf)))
  14550. (defun org-calendar-select ()
  14551. "Return to `org-read-date' with the date currently selected.
  14552. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14553. (interactive)
  14554. (when (calendar-cursor-to-date)
  14555. (let* ((date (calendar-cursor-to-date))
  14556. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14557. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14558. (if (active-minibuffer-window) (exit-minibuffer))))
  14559. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  14560. "Insert a date stamp for the date given by the internal TIME.
  14561. WITH-HM means use the stamp format that includes the time of the day.
  14562. INACTIVE means use square brackets instead of angular ones, so that the
  14563. stamp will not contribute to the agenda.
  14564. PRE and POST are optional strings to be inserted before and after the
  14565. stamp.
  14566. The command returns the inserted time stamp."
  14567. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  14568. stamp)
  14569. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  14570. (insert-before-markers (or pre ""))
  14571. (when (listp extra)
  14572. (setq extra (car extra))
  14573. (if (and (stringp extra)
  14574. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  14575. (setq extra (format "-%02d:%02d"
  14576. (string-to-number (match-string 1 extra))
  14577. (string-to-number (match-string 2 extra))))
  14578. (setq extra nil)))
  14579. (when extra
  14580. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  14581. (insert-before-markers (setq stamp (format-time-string fmt time)))
  14582. (insert-before-markers (or post ""))
  14583. (setq org-last-inserted-timestamp stamp)))
  14584. (defun org-toggle-time-stamp-overlays ()
  14585. "Toggle the use of custom time stamp formats."
  14586. (interactive)
  14587. (setq org-display-custom-times (not org-display-custom-times))
  14588. (unless org-display-custom-times
  14589. (let ((p (point-min)) (bmp (buffer-modified-p)))
  14590. (while (setq p (next-single-property-change p 'display))
  14591. (if (and (get-text-property p 'display)
  14592. (eq (get-text-property p 'face) 'org-date))
  14593. (remove-text-properties
  14594. p (setq p (next-single-property-change p 'display))
  14595. '(display t))))
  14596. (set-buffer-modified-p bmp)))
  14597. (if (featurep 'xemacs)
  14598. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  14599. (org-restart-font-lock)
  14600. (setq org-table-may-need-update t)
  14601. (if org-display-custom-times
  14602. (message "Time stamps are overlaid with custom format")
  14603. (message "Time stamp overlays removed")))
  14604. (defun org-display-custom-time (beg end)
  14605. "Overlay modified time stamp format over timestamp between BEG and END."
  14606. (let* ((ts (buffer-substring beg end))
  14607. t1 w1 with-hm tf time str w2 (off 0))
  14608. (save-match-data
  14609. (setq t1 (org-parse-time-string ts t))
  14610. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  14611. (setq off (- (match-end 0) (match-beginning 0)))))
  14612. (setq end (- end off))
  14613. (setq w1 (- end beg)
  14614. with-hm (and (nth 1 t1) (nth 2 t1))
  14615. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  14616. time (org-fix-decoded-time t1)
  14617. str (org-add-props
  14618. (format-time-string
  14619. (substring tf 1 -1) (apply 'encode-time time))
  14620. nil 'mouse-face 'highlight)
  14621. w2 (length str))
  14622. (if (not (= w2 w1))
  14623. (add-text-properties (1+ beg) (+ 2 beg)
  14624. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  14625. (if (featurep 'xemacs)
  14626. (progn
  14627. (put-text-property beg end 'invisible t)
  14628. (put-text-property beg end 'end-glyph (make-glyph str)))
  14629. (put-text-property beg end 'display str))))
  14630. (defun org-translate-time (string)
  14631. "Translate all timestamps in STRING to custom format.
  14632. But do this only if the variable `org-display-custom-times' is set."
  14633. (when org-display-custom-times
  14634. (save-match-data
  14635. (let* ((start 0)
  14636. (re org-ts-regexp-both)
  14637. t1 with-hm inactive tf time str beg end)
  14638. (while (setq start (string-match re string start))
  14639. (setq beg (match-beginning 0)
  14640. end (match-end 0)
  14641. t1 (save-match-data
  14642. (org-parse-time-string (substring string beg end) t))
  14643. with-hm (and (nth 1 t1) (nth 2 t1))
  14644. inactive (equal (substring string beg (1+ beg)) "[")
  14645. tf (funcall (if with-hm 'cdr 'car)
  14646. org-time-stamp-custom-formats)
  14647. time (org-fix-decoded-time t1)
  14648. str (format-time-string
  14649. (concat
  14650. (if inactive "[" "<") (substring tf 1 -1)
  14651. (if inactive "]" ">"))
  14652. (apply 'encode-time time))
  14653. string (replace-match str t t string)
  14654. start (+ start (length str)))))))
  14655. string)
  14656. (defun org-fix-decoded-time (time)
  14657. "Set 0 instead of nil for the first 6 elements of time.
  14658. Don't touch the rest."
  14659. (let ((n 0))
  14660. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  14661. (defun org-days-to-time (timestamp-string)
  14662. "Difference between TIMESTAMP-STRING and now in days."
  14663. (- (time-to-days (org-time-string-to-time timestamp-string))
  14664. (time-to-days (current-time))))
  14665. (defun org-deadline-close (timestamp-string &optional ndays)
  14666. "Is the time in TIMESTAMP-STRING close to the current date?"
  14667. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  14668. (and (< (org-days-to-time timestamp-string) ndays)
  14669. (not (org-entry-is-done-p))))
  14670. (defun org-get-wdays (ts)
  14671. "Get the deadline lead time appropriate for timestring TS."
  14672. (cond
  14673. ((<= org-deadline-warning-days 0)
  14674. ;; 0 or negative, enforce this value no matter what
  14675. (- org-deadline-warning-days))
  14676. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  14677. ;; lead time is specified.
  14678. (floor (* (string-to-number (match-string 1 ts))
  14679. (cdr (assoc (match-string 2 ts)
  14680. '(("d" . 1) ("w" . 7)
  14681. ("m" . 30.4) ("y" . 365.25)))))))
  14682. ;; go for the default.
  14683. (t org-deadline-warning-days)))
  14684. (defun org-calendar-select-mouse (ev)
  14685. "Return to `org-read-date' with the date currently selected.
  14686. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14687. (interactive "e")
  14688. (mouse-set-point ev)
  14689. (when (calendar-cursor-to-date)
  14690. (let* ((date (calendar-cursor-to-date))
  14691. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14692. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14693. (if (active-minibuffer-window) (exit-minibuffer))))
  14694. (defun org-check-deadlines (ndays)
  14695. "Check if there are any deadlines due or past due.
  14696. A deadline is considered due if it happens within `org-deadline-warning-days'
  14697. days from today's date. If the deadline appears in an entry marked DONE,
  14698. it is not shown. The prefix arg NDAYS can be used to test that many
  14699. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  14700. (interactive "P")
  14701. (let* ((org-warn-days
  14702. (cond
  14703. ((equal ndays '(4)) 100000)
  14704. (ndays (prefix-numeric-value ndays))
  14705. (t (abs org-deadline-warning-days))))
  14706. (case-fold-search nil)
  14707. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14708. (callback
  14709. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  14710. (message "%d deadlines past-due or due within %d days"
  14711. (org-occur regexp nil callback)
  14712. org-warn-days)))
  14713. (defsubst org-re-timestamp (type)
  14714. "Return a regexp for timestamp TYPE.
  14715. Allowed values for TYPE are:
  14716. all: all timestamps
  14717. active: only active timestamps (<...>)
  14718. inactive: only inactive timestamps ([...])
  14719. scheduled: only scheduled timestamps
  14720. deadline: only deadline timestamps
  14721. When TYPE is nil, fall back on returning a regexp that matches
  14722. both scheduled and deadline timestamps."
  14723. (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
  14724. ((eq type 'active) org-ts-regexp)
  14725. ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
  14726. ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
  14727. ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14728. ((eq type 'scheduled-or-deadline)
  14729. (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
  14730. (defun org-check-before-date (date)
  14731. "Check if there are deadlines or scheduled entries before DATE."
  14732. (interactive (list (org-read-date)))
  14733. (let ((case-fold-search nil)
  14734. (regexp (org-re-timestamp org-ts-type))
  14735. (callback
  14736. (lambda () (time-less-p
  14737. (org-time-string-to-time (match-string 1))
  14738. (org-time-string-to-time date)))))
  14739. (message "%d entries before %s"
  14740. (org-occur regexp nil callback) date)))
  14741. (defun org-check-after-date (date)
  14742. "Check if there are deadlines or scheduled entries after DATE."
  14743. (interactive (list (org-read-date)))
  14744. (let ((case-fold-search nil)
  14745. (regexp (org-re-timestamp org-ts-type))
  14746. (callback
  14747. (lambda () (not
  14748. (time-less-p
  14749. (org-time-string-to-time (match-string 1))
  14750. (org-time-string-to-time date))))))
  14751. (message "%d entries after %s"
  14752. (org-occur regexp nil callback) date)))
  14753. (defun org-check-dates-range (start-date end-date)
  14754. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  14755. (interactive (list (org-read-date nil nil nil "Range starts")
  14756. (org-read-date nil nil nil "Range end")))
  14757. (let ((case-fold-search nil)
  14758. (regexp (org-re-timestamp org-ts-type))
  14759. (callback
  14760. (lambda ()
  14761. (let ((match (match-string 1)))
  14762. (and
  14763. (not (time-less-p
  14764. (org-time-string-to-time match)
  14765. (org-time-string-to-time start-date)))
  14766. (time-less-p
  14767. (org-time-string-to-time match)
  14768. (org-time-string-to-time end-date)))))))
  14769. (message "%d entries between %s and %s"
  14770. (org-occur regexp nil callback) start-date end-date)))
  14771. (defun org-evaluate-time-range (&optional to-buffer)
  14772. "Evaluate a time range by computing the difference between start and end.
  14773. Normally the result is just printed in the echo area, but with prefix arg
  14774. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  14775. If the time range is actually in a table, the result is inserted into the
  14776. next column.
  14777. For time difference computation, a year is assumed to be exactly 365
  14778. days in order to avoid rounding problems."
  14779. (interactive "P")
  14780. (or
  14781. (org-clock-update-time-maybe)
  14782. (save-excursion
  14783. (unless (org-at-date-range-p t)
  14784. (goto-char (point-at-bol))
  14785. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  14786. (if (not (org-at-date-range-p t))
  14787. (error "Not at a time-stamp range, and none found in current line")))
  14788. (let* ((ts1 (match-string 1))
  14789. (ts2 (match-string 2))
  14790. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  14791. (match-end (match-end 0))
  14792. (time1 (org-time-string-to-time ts1))
  14793. (time2 (org-time-string-to-time ts2))
  14794. (t1 (org-float-time time1))
  14795. (t2 (org-float-time time2))
  14796. (diff (abs (- t2 t1)))
  14797. (negative (< (- t2 t1) 0))
  14798. ;; (ys (floor (* 365 24 60 60)))
  14799. (ds (* 24 60 60))
  14800. (hs (* 60 60))
  14801. (fy "%dy %dd %02d:%02d")
  14802. (fy1 "%dy %dd")
  14803. (fd "%dd %02d:%02d")
  14804. (fd1 "%dd")
  14805. (fh "%02d:%02d")
  14806. y d h m align)
  14807. (if havetime
  14808. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14809. y 0
  14810. d (floor (/ diff ds)) diff (mod diff ds)
  14811. h (floor (/ diff hs)) diff (mod diff hs)
  14812. m (floor (/ diff 60)))
  14813. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14814. y 0
  14815. d (floor (+ (/ diff ds) 0.5))
  14816. h 0 m 0))
  14817. (if (not to-buffer)
  14818. (message "%s" (org-make-tdiff-string y d h m))
  14819. (if (org-at-table-p)
  14820. (progn
  14821. (goto-char match-end)
  14822. (setq align t)
  14823. (and (looking-at " *|") (goto-char (match-end 0))))
  14824. (goto-char match-end))
  14825. (if (looking-at
  14826. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  14827. (replace-match ""))
  14828. (if negative (insert " -"))
  14829. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  14830. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  14831. (insert " " (format fh h m))))
  14832. (if align (org-table-align))
  14833. (message "Time difference inserted")))))
  14834. (defun org-make-tdiff-string (y d h m)
  14835. (let ((fmt "")
  14836. (l nil))
  14837. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  14838. l (push y l)))
  14839. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  14840. l (push d l)))
  14841. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  14842. l (push h l)))
  14843. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  14844. l (push m l)))
  14845. (apply 'format fmt (nreverse l))))
  14846. (defun org-time-string-to-time (s &optional buffer pos)
  14847. "Convert a timestamp string into internal time."
  14848. (condition-case errdata
  14849. (apply 'encode-time (org-parse-time-string s))
  14850. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14851. s (if (not (and buffer pos))
  14852. ""
  14853. (format " at %d in buffer `%s'" pos buffer))
  14854. (cdr errdata)))))
  14855. (defun org-time-string-to-seconds (s)
  14856. "Convert a timestamp string to a number of seconds."
  14857. (org-float-time (org-time-string-to-time s)))
  14858. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  14859. "Convert a time stamp to an absolute day number.
  14860. If there is a specifier for a cyclic time stamp, get the closest date to
  14861. DAYNR.
  14862. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  14863. The variable date is bound by the calendar when this is called."
  14864. (cond
  14865. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  14866. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  14867. daynr
  14868. (+ daynr 1000)))
  14869. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  14870. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  14871. (time-to-days (current-time))) (match-string 0 s)
  14872. prefer show-all))
  14873. (t (time-to-days
  14874. (condition-case errdata
  14875. (apply 'encode-time (org-parse-time-string s))
  14876. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14877. s (if (not (and buffer pos))
  14878. ""
  14879. (format " at %d in buffer `%s'" pos buffer))
  14880. (cdr errdata))))))))
  14881. (defun org-days-to-iso-week (days)
  14882. "Return the iso week number."
  14883. (require 'cal-iso)
  14884. (car (calendar-iso-from-absolute days)))
  14885. (defun org-small-year-to-year (year)
  14886. "Convert 2-digit years into 4-digit years.
  14887. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  14888. The year 2000 cannot be abbreviated. Any year larger than 99
  14889. is returned unchanged."
  14890. (if (< year 38)
  14891. (setq year (+ 2000 year))
  14892. (if (< year 100)
  14893. (setq year (+ 1900 year))))
  14894. year)
  14895. (defun org-time-from-absolute (d)
  14896. "Return the time corresponding to date D.
  14897. D may be an absolute day number, or a calendar-type list (month day year)."
  14898. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  14899. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  14900. (defun org-calendar-holiday ()
  14901. "List of holidays, for Diary display in Org-mode."
  14902. (require 'holidays)
  14903. (let ((hl (funcall
  14904. (if (fboundp 'calendar-check-holidays)
  14905. 'calendar-check-holidays 'check-calendar-holidays) date)))
  14906. (if hl (mapconcat 'identity hl "; "))))
  14907. (defun org-diary-sexp-entry (sexp entry date)
  14908. "Process a SEXP diary ENTRY for DATE."
  14909. (require 'diary-lib)
  14910. (let ((result (if calendar-debug-sexp
  14911. (let ((stack-trace-on-error t))
  14912. (eval (car (read-from-string sexp))))
  14913. (condition-case nil
  14914. (eval (car (read-from-string sexp)))
  14915. (error
  14916. (beep)
  14917. (message "Bad sexp at line %d in %s: %s"
  14918. (org-current-line)
  14919. (buffer-file-name) sexp)
  14920. (sleep-for 2))))))
  14921. (cond ((stringp result) (split-string result "; "))
  14922. ((and (consp result)
  14923. (not (consp (cdr result)))
  14924. (stringp (cdr result))) (cdr result))
  14925. ((and (consp result)
  14926. (stringp (car result))) result)
  14927. (result entry))))
  14928. (defun org-diary-to-ical-string (frombuf)
  14929. "Get iCalendar entries from diary entries in buffer FROMBUF.
  14930. This uses the icalendar.el library."
  14931. (let* ((tmpdir (if (featurep 'xemacs)
  14932. (temp-directory)
  14933. temporary-file-directory))
  14934. (tmpfile (make-temp-name
  14935. (expand-file-name "orgics" tmpdir)))
  14936. buf rtn b e)
  14937. (with-current-buffer frombuf
  14938. (icalendar-export-region (point-min) (point-max) tmpfile)
  14939. (setq buf (find-buffer-visiting tmpfile))
  14940. (set-buffer buf)
  14941. (goto-char (point-min))
  14942. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  14943. (setq b (match-beginning 0)))
  14944. (goto-char (point-max))
  14945. (if (re-search-backward "^END:VEVENT" nil t)
  14946. (setq e (match-end 0)))
  14947. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  14948. (kill-buffer buf)
  14949. (delete-file tmpfile)
  14950. rtn))
  14951. (defun org-closest-date (start current change prefer show-all)
  14952. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  14953. When PREFER is `past', return a date that is either CURRENT or past.
  14954. When PREFER is `future', return a date that is either CURRENT or future.
  14955. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  14956. ;; Make the proper lists from the dates
  14957. (catch 'exit
  14958. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  14959. dn dw sday cday n1 n2 n0
  14960. d m y y1 y2 date1 date2 nmonths nm ny m2)
  14961. (setq start (org-date-to-gregorian start)
  14962. current (org-date-to-gregorian
  14963. (if show-all
  14964. current
  14965. (time-to-days (current-time))))
  14966. sday (calendar-absolute-from-gregorian start)
  14967. cday (calendar-absolute-from-gregorian current))
  14968. (if (<= cday sday) (throw 'exit sday))
  14969. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  14970. (setq dn (string-to-number (match-string 1 change))
  14971. dw (cdr (assoc (match-string 2 change) a1)))
  14972. (error "Invalid change specifier: %s" change))
  14973. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  14974. (cond
  14975. ((eq dw 'day)
  14976. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  14977. n2 (+ n1 dn)))
  14978. ((eq dw 'year)
  14979. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  14980. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  14981. (setq date1 (list m d y1)
  14982. n1 (calendar-absolute-from-gregorian date1)
  14983. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  14984. n2 (calendar-absolute-from-gregorian date2)))
  14985. ((eq dw 'month)
  14986. ;; approx number of month between the two dates
  14987. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  14988. ;; How often does dn fit in there?
  14989. (setq d (nth 1 start) m (car start) y (nth 2 start)
  14990. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  14991. m (+ m nm)
  14992. ny (floor (/ m 12))
  14993. y (+ y ny)
  14994. m (- m (* ny 12)))
  14995. (while (> m 12) (setq m (- m 12) y (1+ y)))
  14996. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  14997. (setq m2 (+ m dn) y2 y)
  14998. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14999. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  15000. (while (<= n2 cday)
  15001. (setq n1 n2 m m2 y y2)
  15002. (setq m2 (+ m dn) y2 y)
  15003. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  15004. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  15005. ;; Make sure n1 is the earlier date
  15006. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  15007. (if show-all
  15008. (cond
  15009. ((eq prefer 'past) (if (= cday n2) n2 n1))
  15010. ((eq prefer 'future) (if (= cday n1) n1 n2))
  15011. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  15012. (cond
  15013. ((eq prefer 'past) (if (= cday n2) n2 n1))
  15014. ((eq prefer 'future) (if (= cday n1) n1 n2))
  15015. (t (if (= cday n1) n1 n2)))))))
  15016. (defun org-date-to-gregorian (date)
  15017. "Turn any specification of DATE into a Gregorian date for the calendar."
  15018. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  15019. ((and (listp date) (= (length date) 3)) date)
  15020. ((stringp date)
  15021. (setq date (org-parse-time-string date))
  15022. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  15023. ((listp date)
  15024. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  15025. (defun org-parse-time-string (s &optional nodefault)
  15026. "Parse the standard Org-mode time string.
  15027. This should be a lot faster than the normal `parse-time-string'.
  15028. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  15029. hour and minute fields will be nil if not given."
  15030. (if (string-match org-ts-regexp0 s)
  15031. (list 0
  15032. (if (or (match-beginning 8) (not nodefault))
  15033. (string-to-number (or (match-string 8 s) "0")))
  15034. (if (or (match-beginning 7) (not nodefault))
  15035. (string-to-number (or (match-string 7 s) "0")))
  15036. (string-to-number (match-string 4 s))
  15037. (string-to-number (match-string 3 s))
  15038. (string-to-number (match-string 2 s))
  15039. nil nil nil)
  15040. (error "Not a standard Org-mode time string: %s" s)))
  15041. (defun org-timestamp-up (&optional arg)
  15042. "Increase the date item at the cursor by one.
  15043. If the cursor is on the year, change the year. If it is on the month,
  15044. the day or the time, change that.
  15045. With prefix ARG, change by that many units."
  15046. (interactive "p")
  15047. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  15048. (defun org-timestamp-down (&optional arg)
  15049. "Decrease the date item at the cursor by one.
  15050. If the cursor is on the year, change the year. If it is on the month,
  15051. the day or the time, change that.
  15052. With prefix ARG, change by that many units."
  15053. (interactive "p")
  15054. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  15055. (defun org-timestamp-up-day (&optional arg)
  15056. "Increase the date in the time stamp by one day.
  15057. With prefix ARG, change that many days."
  15058. (interactive "p")
  15059. (if (and (not (org-at-timestamp-p t))
  15060. (org-at-heading-p))
  15061. (org-todo 'up)
  15062. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  15063. (defun org-timestamp-down-day (&optional arg)
  15064. "Decrease the date in the time stamp by one day.
  15065. With prefix ARG, change that many days."
  15066. (interactive "p")
  15067. (if (and (not (org-at-timestamp-p t))
  15068. (org-at-heading-p))
  15069. (org-todo 'down)
  15070. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  15071. (defun org-at-timestamp-p (&optional inactive-ok)
  15072. "Determine if the cursor is in or at a timestamp."
  15073. (interactive)
  15074. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  15075. (pos (point))
  15076. (ans (or (looking-at tsr)
  15077. (save-excursion
  15078. (skip-chars-backward "^[<\n\r\t")
  15079. (if (> (point) (point-min)) (backward-char 1))
  15080. (and (looking-at tsr)
  15081. (> (- (match-end 0) pos) -1))))))
  15082. (and ans
  15083. (boundp 'org-ts-what)
  15084. (setq org-ts-what
  15085. (cond
  15086. ((= pos (match-beginning 0)) 'bracket)
  15087. ;; Point is considered to be "on the bracket" whether
  15088. ;; it's really on it or right after it.
  15089. ((= pos (1- (match-end 0))) 'bracket)
  15090. ((= pos (match-end 0)) 'after)
  15091. ((org-pos-in-match-range pos 2) 'year)
  15092. ((org-pos-in-match-range pos 3) 'month)
  15093. ((org-pos-in-match-range pos 7) 'hour)
  15094. ((org-pos-in-match-range pos 8) 'minute)
  15095. ((or (org-pos-in-match-range pos 4)
  15096. (org-pos-in-match-range pos 5)) 'day)
  15097. ((and (> pos (or (match-end 8) (match-end 5)))
  15098. (< pos (match-end 0)))
  15099. (- pos (or (match-end 8) (match-end 5))))
  15100. (t 'day))))
  15101. ans))
  15102. (defun org-toggle-timestamp-type ()
  15103. "Toggle the type (<active> or [inactive]) of a time stamp."
  15104. (interactive)
  15105. (when (org-at-timestamp-p t)
  15106. (let ((beg (match-beginning 0)) (end (match-end 0))
  15107. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  15108. (save-excursion
  15109. (goto-char beg)
  15110. (while (re-search-forward "[][<>]" end t)
  15111. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  15112. t t)))
  15113. (message "Timestamp is now %sactive"
  15114. (if (equal (char-after beg) ?<) "" "in")))))
  15115. (defvar org-clock-history) ; defined in org-clock.el
  15116. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  15117. (defun org-timestamp-change (n &optional what updown)
  15118. "Change the date in the time stamp at point.
  15119. The date will be changed by N times WHAT. WHAT can be `day', `month',
  15120. `year', `minute', `second'. If WHAT is not given, the cursor position
  15121. in the timestamp determines what will be changed."
  15122. (let ((origin (point)) origin-cat
  15123. with-hm inactive
  15124. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  15125. org-ts-what
  15126. extra rem
  15127. ts time time0 fixnext clrgx)
  15128. (if (not (org-at-timestamp-p t))
  15129. (error "Not at a timestamp"))
  15130. (if (and (not what) (eq org-ts-what 'bracket))
  15131. (org-toggle-timestamp-type)
  15132. ;; Point isn't on brackets. Remember the part of the time-stamp
  15133. ;; the point was in. Indeed, size of time-stamps may change,
  15134. ;; but point must be kept in the same category nonetheless.
  15135. (setq origin-cat org-ts-what)
  15136. (if (and (not what) (not (eq org-ts-what 'day))
  15137. org-display-custom-times
  15138. (get-text-property (point) 'display)
  15139. (not (get-text-property (1- (point)) 'display)))
  15140. (setq org-ts-what 'day))
  15141. (setq org-ts-what (or what org-ts-what)
  15142. inactive (= (char-after (match-beginning 0)) ?\[)
  15143. ts (match-string 0))
  15144. (replace-match "")
  15145. (if (string-match
  15146. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  15147. ts)
  15148. (setq extra (match-string 1 ts)))
  15149. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  15150. (setq with-hm t))
  15151. (setq time0 (org-parse-time-string ts))
  15152. (when (and updown
  15153. (eq org-ts-what 'minute)
  15154. (not current-prefix-arg))
  15155. ;; This looks like s-up and s-down. Change by one rounding step.
  15156. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  15157. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  15158. (setcar (cdr time0) (+ (nth 1 time0)
  15159. (if (> n 0) (- rem) (- dm rem))))))
  15160. (setq time
  15161. (encode-time (or (car time0) 0)
  15162. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  15163. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  15164. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  15165. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  15166. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  15167. (nthcdr 6 time0)))
  15168. (when (and (member org-ts-what '(hour minute))
  15169. extra
  15170. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  15171. (setq extra (org-modify-ts-extra
  15172. extra
  15173. (if (eq org-ts-what 'hour) 2 5)
  15174. n dm)))
  15175. (when (integerp org-ts-what)
  15176. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  15177. (if (eq what 'calendar)
  15178. (let ((cal-date (org-get-date-from-calendar)))
  15179. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  15180. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  15181. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  15182. (setcar time0 (or (car time0) 0))
  15183. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  15184. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  15185. (setq time (apply 'encode-time time0))))
  15186. ;; Insert the new time-stamp, and ensure point stays in the same
  15187. ;; category as before (i.e. not after the last position in that
  15188. ;; category).
  15189. (let ((pos (point)))
  15190. ;; Stay before inserted string. `save-excursion' is of no use.
  15191. (setq org-last-changed-timestamp
  15192. (org-insert-time-stamp time with-hm inactive nil nil extra))
  15193. (goto-char pos))
  15194. (save-match-data
  15195. (looking-at org-ts-regexp3)
  15196. (goto-char (cond
  15197. ;; `day' category ends before `hour' if any, or at
  15198. ;; the end of the day name.
  15199. ((eq origin-cat 'day)
  15200. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  15201. ((eq origin-cat 'hour) (min (match-end 7) origin))
  15202. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  15203. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  15204. ;; `year' and `month' have both fixed size: point
  15205. ;; couldn't have moved into another part.
  15206. (t origin))))
  15207. ;; Update clock if on a CLOCK line.
  15208. (org-clock-update-time-maybe)
  15209. ;; Maybe adjust the closest clock in `org-clock-history'
  15210. (when org-clock-adjust-closest
  15211. (if (not (and (org-at-clock-log-p)
  15212. (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
  15213. org-clock-history))))))
  15214. (message "No clock to adjust")
  15215. (cond ((save-excursion ; fix previous clock?
  15216. (re-search-backward org-ts-regexp0 nil t)
  15217. (org-looking-back (concat org-clock-string " \\[")))
  15218. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  15219. ((save-excursion ; fix next clock?
  15220. (re-search-backward org-ts-regexp0 nil t)
  15221. (looking-at (concat org-ts-regexp0 "\\] =>")))
  15222. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  15223. (save-window-excursion
  15224. ;; Find closest clock to point, adjust the previous/next one in history
  15225. (let* ((p (save-excursion (org-back-to-heading t)))
  15226. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  15227. (clfixnth
  15228. (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
  15229. (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
  15230. (if (not clfixpos)
  15231. (message "No clock to adjust")
  15232. (save-excursion
  15233. (org-goto-marker-or-bmk clfixpos)
  15234. (org-show-subtree)
  15235. (when (re-search-forward clrgx nil t)
  15236. (goto-char (match-beginning 1))
  15237. (let (org-clock-adjust-closest)
  15238. (org-timestamp-change n org-ts-what updown))
  15239. (message "Clock adjusted in %s for heading: %s"
  15240. (file-name-nondirectory (buffer-file-name))
  15241. (org-get-heading t t)))))))))
  15242. ;; Try to recenter the calendar window, if any.
  15243. (if (and org-calendar-follow-timestamp-change
  15244. (get-buffer-window "*Calendar*" t)
  15245. (memq org-ts-what '(day month year)))
  15246. (org-recenter-calendar (time-to-days time))))))
  15247. (defun org-modify-ts-extra (s pos n dm)
  15248. "Change the different parts of the lead-time and repeat fields in timestamp."
  15249. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  15250. ng h m new rem)
  15251. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  15252. (cond
  15253. ((or (org-pos-in-match-range pos 2)
  15254. (org-pos-in-match-range pos 3))
  15255. (setq m (string-to-number (match-string 3 s))
  15256. h (string-to-number (match-string 2 s)))
  15257. (if (org-pos-in-match-range pos 2)
  15258. (setq h (+ h n))
  15259. (setq n (* dm (org-no-warnings (signum n))))
  15260. (when (not (= 0 (setq rem (% m dm))))
  15261. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  15262. (setq m (+ m n)))
  15263. (if (< m 0) (setq m (+ m 60) h (1- h)))
  15264. (if (> m 59) (setq m (- m 60) h (1+ h)))
  15265. (setq h (min 24 (max 0 h)))
  15266. (setq ng 1 new (format "-%02d:%02d" h m)))
  15267. ((org-pos-in-match-range pos 6)
  15268. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  15269. ((org-pos-in-match-range pos 5)
  15270. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  15271. ((org-pos-in-match-range pos 9)
  15272. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  15273. ((org-pos-in-match-range pos 8)
  15274. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  15275. (when ng
  15276. (setq s (concat
  15277. (substring s 0 (match-beginning ng))
  15278. new
  15279. (substring s (match-end ng))))))
  15280. s))
  15281. (defun org-recenter-calendar (date)
  15282. "If the calendar is visible, recenter it to DATE."
  15283. (let ((cwin (get-buffer-window "*Calendar*" t)))
  15284. (when cwin
  15285. (let ((calendar-move-hook nil))
  15286. (with-selected-window cwin
  15287. (calendar-goto-date (if (listp date) date
  15288. (calendar-gregorian-from-absolute date))))))))
  15289. (defun org-goto-calendar (&optional arg)
  15290. "Go to the Emacs calendar at the current date.
  15291. If there is a time stamp in the current line, go to that date.
  15292. A prefix ARG can be used to force the current date."
  15293. (interactive "P")
  15294. (let ((tsr org-ts-regexp) diff
  15295. (calendar-move-hook nil)
  15296. (calendar-view-holidays-initially-flag nil)
  15297. (calendar-view-diary-initially-flag nil))
  15298. (if (or (org-at-timestamp-p)
  15299. (save-excursion
  15300. (beginning-of-line 1)
  15301. (looking-at (concat ".*" tsr))))
  15302. (let ((d1 (time-to-days (current-time)))
  15303. (d2 (time-to-days
  15304. (org-time-string-to-time (match-string 1)))))
  15305. (setq diff (- d2 d1))))
  15306. (calendar)
  15307. (calendar-goto-today)
  15308. (if (and diff (not arg)) (calendar-forward-day diff))))
  15309. (defun org-get-date-from-calendar ()
  15310. "Return a list (month day year) of date at point in calendar."
  15311. (with-current-buffer "*Calendar*"
  15312. (save-match-data
  15313. (calendar-cursor-to-date))))
  15314. (defun org-date-from-calendar ()
  15315. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  15316. If there is already a time stamp at the cursor position, update it."
  15317. (interactive)
  15318. (if (org-at-timestamp-p t)
  15319. (org-timestamp-change 0 'calendar)
  15320. (let ((cal-date (org-get-date-from-calendar)))
  15321. (org-insert-time-stamp
  15322. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  15323. (defun org-minutes-to-hh:mm-string (m)
  15324. "Compute H:MM from a number of minutes."
  15325. (let ((h (/ m 60)))
  15326. (setq m (- m (* 60 h)))
  15327. (format org-time-clocksum-format h m)))
  15328. (defun org-hh:mm-string-to-minutes (s)
  15329. "Convert a string H:MM to a number of minutes.
  15330. If the string is just a number, interpret it as minutes.
  15331. In fact, the first hh:mm or number in the string will be taken,
  15332. there can be extra stuff in the string.
  15333. If no number is found, the return value is 0."
  15334. (cond
  15335. ((integerp s) s)
  15336. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  15337. (+ (* (string-to-number (match-string 1 s)) 60)
  15338. (string-to-number (match-string 2 s))))
  15339. ((string-match "\\([0-9]+\\)" s)
  15340. (string-to-number (match-string 1 s)))
  15341. (t 0)))
  15342. (defcustom org-effort-durations
  15343. `(("h" . 60)
  15344. ("d" . ,(* 60 8))
  15345. ("w" . ,(* 60 8 5))
  15346. ("m" . ,(* 60 8 5 4))
  15347. ("y" . ,(* 60 8 5 40)))
  15348. "Conversion factor to minutes for an effort modifier.
  15349. Each entry has the form (MODIFIER . MINUTES).
  15350. In an effort string, a number followed by MODIFIER is multiplied
  15351. by the specified number of MINUTES to obtain an effort in
  15352. minutes.
  15353. For example, if the value of this variable is ((\"hours\" . 60)), then an
  15354. effort string \"2hours\" is equivalent to 120 minutes."
  15355. :group 'org-agenda
  15356. :version "24.1"
  15357. :type '(alist :key-type (string :tag "Modifier")
  15358. :value-type (number :tag "Minutes")))
  15359. (defcustom org-image-actual-width t
  15360. "Should we use the actual width of images when inlining them?
  15361. When set to `t', always use the image width.
  15362. When set to a number, use imagemagick (when available) to set
  15363. the image's width to this value.
  15364. When set to a number in a list, try to get the width from the
  15365. #+ATTR.* keyword if it matches a width specification like
  15366. width=\"[0-9]+\", and fall back on that number if none is found.
  15367. When set to nil, try to get the width from an #+ATTR.* keyword
  15368. and fall back on the original width if none is found.
  15369. This requires Emacs >= 24.1, build with imagemagick support."
  15370. :group 'org-appearance
  15371. :version "24.3"
  15372. :type '(choice
  15373. (const :tag "Use the image width" t)
  15374. (integer :tag "Use a number of pixels")
  15375. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  15376. (const :tag "Use #+ATTR* or don't resize" nil)))
  15377. (defun org-duration-string-to-minutes (s &optional output-to-string)
  15378. "Convert a duration string S to minutes.
  15379. A bare number is interpreted as minutes, modifiers can be set by
  15380. customizing `org-effort-durations' (which see).
  15381. Entries containing a colon are interpreted as H:MM by
  15382. `org-hh:mm-string-to-minutes'."
  15383. (let ((result 0)
  15384. (re (concat "\\([0-9.]+\\) *\\("
  15385. (regexp-opt (mapcar 'car org-effort-durations))
  15386. "\\)")))
  15387. (while (string-match re s)
  15388. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  15389. (string-to-number (match-string 1 s))))
  15390. (setq s (replace-match "" nil t s)))
  15391. (setq result (floor result))
  15392. (incf result (org-hh:mm-string-to-minutes s))
  15393. (if output-to-string (number-to-string result) result)))
  15394. ;;;; Files
  15395. (defun org-save-all-org-buffers ()
  15396. "Save all Org-mode buffers without user confirmation."
  15397. (interactive)
  15398. (message "Saving all Org-mode buffers...")
  15399. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  15400. (when (featurep 'org-id) (org-id-locations-save))
  15401. (message "Saving all Org-mode buffers... done"))
  15402. (defun org-revert-all-org-buffers ()
  15403. "Revert all Org-mode buffers.
  15404. Prompt for confirmation when there are unsaved changes.
  15405. Be sure you know what you are doing before letting this function
  15406. overwrite your changes.
  15407. This function is useful in a setup where one tracks org files
  15408. with a version control system, to revert on one machine after pulling
  15409. changes from another. I believe the procedure must be like this:
  15410. 1. M-x org-save-all-org-buffers
  15411. 2. Pull changes from the other machine, resolve conflicts
  15412. 3. M-x org-revert-all-org-buffers"
  15413. (interactive)
  15414. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  15415. (error "Abort"))
  15416. (save-excursion
  15417. (save-window-excursion
  15418. (mapc
  15419. (lambda (b)
  15420. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  15421. (with-current-buffer b buffer-file-name))
  15422. (org-pop-to-buffer-same-window b)
  15423. (revert-buffer t 'no-confirm)))
  15424. (buffer-list))
  15425. (when (and (featurep 'org-id) org-id-track-globally)
  15426. (org-id-locations-load)))))
  15427. ;;;; Agenda files
  15428. ;;;###autoload
  15429. (defun org-switchb (&optional arg)
  15430. "Switch between Org buffers.
  15431. With one prefix argument, restrict available buffers to files.
  15432. With two prefix arguments, restrict available buffers to agenda files.
  15433. Defaults to `iswitchb' for buffer name completion.
  15434. Set `org-completion-use-ido' to make it use ido instead."
  15435. (interactive "P")
  15436. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  15437. ((equal arg '(16)) (org-buffer-list 'agenda))
  15438. (t (org-buffer-list))))
  15439. (org-completion-use-iswitchb org-completion-use-iswitchb)
  15440. (org-completion-use-ido org-completion-use-ido))
  15441. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  15442. (setq org-completion-use-iswitchb t))
  15443. (org-pop-to-buffer-same-window
  15444. (org-icompleting-read "Org buffer: "
  15445. (mapcar 'list (mapcar 'buffer-name blist))
  15446. nil t))))
  15447. ;;; Define some older names previously used for this functionality
  15448. ;;;###autoload
  15449. (defalias 'org-ido-switchb 'org-switchb)
  15450. ;;;###autoload
  15451. (defalias 'org-iswitchb 'org-switchb)
  15452. (defun org-buffer-list (&optional predicate exclude-tmp)
  15453. "Return a list of Org buffers.
  15454. PREDICATE can be `export', `files' or `agenda'.
  15455. export restrict the list to Export buffers.
  15456. files restrict the list to buffers visiting Org files.
  15457. agenda restrict the list to buffers visiting agenda files.
  15458. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  15459. (let* ((bfn nil)
  15460. (agenda-files (and (eq predicate 'agenda)
  15461. (mapcar 'file-truename (org-agenda-files t))))
  15462. (filter
  15463. (cond
  15464. ((eq predicate 'files)
  15465. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  15466. ((eq predicate 'export)
  15467. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  15468. ((eq predicate 'agenda)
  15469. (lambda (b)
  15470. (with-current-buffer b
  15471. (and (derived-mode-p 'org-mode)
  15472. (setq bfn (buffer-file-name b))
  15473. (member (file-truename bfn) agenda-files)))))
  15474. (t (lambda (b) (with-current-buffer b
  15475. (or (derived-mode-p 'org-mode)
  15476. (string-match "\*Org .*Export"
  15477. (buffer-name b)))))))))
  15478. (delq nil
  15479. (mapcar
  15480. (lambda(b)
  15481. (if (and (funcall filter b)
  15482. (or (not exclude-tmp)
  15483. (not (string-match "tmp" (buffer-name b)))))
  15484. b
  15485. nil))
  15486. (buffer-list)))))
  15487. (defun org-agenda-files (&optional unrestricted archives)
  15488. "Get the list of agenda files.
  15489. Optional UNRESTRICTED means return the full list even if a restriction
  15490. is currently in place.
  15491. When ARCHIVES is t, include all archive files that are really being
  15492. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  15493. `org-agenda-archives-mode' is t."
  15494. (let ((files
  15495. (cond
  15496. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  15497. ((stringp org-agenda-files) (org-read-agenda-file-list))
  15498. ((listp org-agenda-files) org-agenda-files)
  15499. (t (error "Invalid value of `org-agenda-files'")))))
  15500. (setq files (apply 'append
  15501. (mapcar (lambda (f)
  15502. (if (file-directory-p f)
  15503. (directory-files
  15504. f t org-agenda-file-regexp)
  15505. (list f)))
  15506. files)))
  15507. (when org-agenda-skip-unavailable-files
  15508. (setq files (delq nil
  15509. (mapcar (function
  15510. (lambda (file)
  15511. (and (file-readable-p file) file)))
  15512. files))))
  15513. (when (or (eq archives t)
  15514. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  15515. (setq files (org-add-archive-files files)))
  15516. files))
  15517. (defun org-agenda-file-p (&optional file)
  15518. "Return non-nil, if FILE is an agenda file.
  15519. If FILE is omitted, use the file associated with the current
  15520. buffer."
  15521. (member (or file (buffer-file-name))
  15522. (org-agenda-files t)))
  15523. (defun org-edit-agenda-file-list ()
  15524. "Edit the list of agenda files.
  15525. Depending on setup, this either uses customize to edit the variable
  15526. `org-agenda-files', or it visits the file that is holding the list. In the
  15527. latter case, the buffer is set up in a way that saving it automatically kills
  15528. the buffer and restores the previous window configuration."
  15529. (interactive)
  15530. (if (stringp org-agenda-files)
  15531. (let ((cw (current-window-configuration)))
  15532. (find-file org-agenda-files)
  15533. (org-set-local 'org-window-configuration cw)
  15534. (org-add-hook 'after-save-hook
  15535. (lambda ()
  15536. (set-window-configuration
  15537. (prog1 org-window-configuration
  15538. (kill-buffer (current-buffer))))
  15539. (org-install-agenda-files-menu)
  15540. (message "New agenda file list installed"))
  15541. nil 'local)
  15542. (message "%s" (substitute-command-keys
  15543. "Edit list and finish with \\[save-buffer]")))
  15544. (customize-variable 'org-agenda-files)))
  15545. (defun org-store-new-agenda-file-list (list)
  15546. "Set new value for the agenda file list and save it correctly."
  15547. (if (stringp org-agenda-files)
  15548. (let ((fe (org-read-agenda-file-list t)) b u)
  15549. (while (setq b (find-buffer-visiting org-agenda-files))
  15550. (kill-buffer b))
  15551. (with-temp-file org-agenda-files
  15552. (insert
  15553. (mapconcat
  15554. (lambda (f) ;; Keep un-expanded entries.
  15555. (if (setq u (assoc f fe))
  15556. (cdr u)
  15557. f))
  15558. list "\n")
  15559. "\n")))
  15560. (let ((org-mode-hook nil) (org-inhibit-startup t)
  15561. (org-insert-mode-line-in-empty-file nil))
  15562. (setq org-agenda-files list)
  15563. (customize-save-variable 'org-agenda-files org-agenda-files))))
  15564. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  15565. "Read the list of agenda files from a file.
  15566. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  15567. filenames, used by `org-store-new-agenda-file-list' to write back
  15568. un-expanded file names."
  15569. (when (file-directory-p org-agenda-files)
  15570. (error "`org-agenda-files' cannot be a single directory"))
  15571. (when (stringp org-agenda-files)
  15572. (with-temp-buffer
  15573. (insert-file-contents org-agenda-files)
  15574. (mapcar
  15575. (lambda (f)
  15576. (let ((e (expand-file-name (substitute-in-file-name f)
  15577. org-directory)))
  15578. (if pair-with-expansion
  15579. (cons e f)
  15580. e)))
  15581. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  15582. ;;;###autoload
  15583. (defun org-cycle-agenda-files ()
  15584. "Cycle through the files in `org-agenda-files'.
  15585. If the current buffer visits an agenda file, find the next one in the list.
  15586. If the current buffer does not, find the first agenda file."
  15587. (interactive)
  15588. (let* ((fs (org-agenda-files t))
  15589. (files (append fs (list (car fs))))
  15590. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  15591. file)
  15592. (unless files (error "No agenda files"))
  15593. (catch 'exit
  15594. (while (setq file (pop files))
  15595. (if (equal (file-truename file) tcf)
  15596. (when (car files)
  15597. (find-file (car files))
  15598. (throw 'exit t))))
  15599. (find-file (car fs)))
  15600. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  15601. (defun org-agenda-file-to-front (&optional to-end)
  15602. "Move/add the current file to the top of the agenda file list.
  15603. If the file is not present in the list, it is added to the front. If it is
  15604. present, it is moved there. With optional argument TO-END, add/move to the
  15605. end of the list."
  15606. (interactive "P")
  15607. (let ((org-agenda-skip-unavailable-files nil)
  15608. (file-alist (mapcar (lambda (x)
  15609. (cons (file-truename x) x))
  15610. (org-agenda-files t)))
  15611. (ctf (file-truename buffer-file-name))
  15612. x had)
  15613. (setq x (assoc ctf file-alist) had x)
  15614. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  15615. (if to-end
  15616. (setq file-alist (append (delq x file-alist) (list x)))
  15617. (setq file-alist (cons x (delq x file-alist))))
  15618. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  15619. (org-install-agenda-files-menu)
  15620. (message "File %s to %s of agenda file list"
  15621. (if had "moved" "added") (if to-end "end" "front"))))
  15622. (defun org-remove-file (&optional file)
  15623. "Remove current file from the list of files in variable `org-agenda-files'.
  15624. These are the files which are being checked for agenda entries.
  15625. Optional argument FILE means use this file instead of the current."
  15626. (interactive)
  15627. (let* ((org-agenda-skip-unavailable-files nil)
  15628. (file (or file buffer-file-name))
  15629. (true-file (file-truename file))
  15630. (afile (abbreviate-file-name file))
  15631. (files (delq nil (mapcar
  15632. (lambda (x)
  15633. (if (equal true-file
  15634. (file-truename x))
  15635. nil x))
  15636. (org-agenda-files t)))))
  15637. (if (not (= (length files) (length (org-agenda-files t))))
  15638. (progn
  15639. (org-store-new-agenda-file-list files)
  15640. (org-install-agenda-files-menu)
  15641. (message "Removed file: %s" afile))
  15642. (message "File was not in list: %s (not removed)" afile))))
  15643. (defun org-file-menu-entry (file)
  15644. (vector file (list 'find-file file) t))
  15645. (defun org-check-agenda-file (file)
  15646. "Make sure FILE exists. If not, ask user what to do."
  15647. (when (not (file-exists-p file))
  15648. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  15649. (abbreviate-file-name file))
  15650. (let ((r (downcase (read-char-exclusive))))
  15651. (cond
  15652. ((equal r ?r)
  15653. (org-remove-file file)
  15654. (throw 'nextfile t))
  15655. (t (error "Abort"))))))
  15656. (defun org-get-agenda-file-buffer (file)
  15657. "Get a buffer visiting FILE. If the buffer needs to be created, add
  15658. it to the list of buffers which might be released later."
  15659. (let ((buf (org-find-base-buffer-visiting file)))
  15660. (if buf
  15661. buf ; just return it
  15662. ;; Make a new buffer and remember it
  15663. (setq buf (find-file-noselect file))
  15664. (if buf (push buf org-agenda-new-buffers))
  15665. buf)))
  15666. (defun org-release-buffers (blist)
  15667. "Release all buffers in list, asking the user for confirmation when needed.
  15668. When a buffer is unmodified, it is just killed. When modified, it is saved
  15669. \(if the user agrees) and then killed."
  15670. (let (buf file)
  15671. (while (setq buf (pop blist))
  15672. (setq file (buffer-file-name buf))
  15673. (when (and (buffer-modified-p buf)
  15674. file
  15675. (y-or-n-p (format "Save file %s? " file)))
  15676. (with-current-buffer buf (save-buffer)))
  15677. (kill-buffer buf))))
  15678. (defun org-agenda-prepare-buffers (files)
  15679. "Create buffers for all agenda files, protect archived trees and comments."
  15680. (interactive)
  15681. (let ((pa '(:org-archived t))
  15682. (pc '(:org-comment t))
  15683. (pall '(:org-archived t :org-comment t))
  15684. (inhibit-read-only t)
  15685. (rea (concat ":" org-archive-tag ":"))
  15686. bmp file re)
  15687. (save-excursion
  15688. (save-restriction
  15689. (while (setq file (pop files))
  15690. (catch 'nextfile
  15691. (if (bufferp file)
  15692. (set-buffer file)
  15693. (org-check-agenda-file file)
  15694. (set-buffer (org-get-agenda-file-buffer file)))
  15695. (widen)
  15696. (setq bmp (buffer-modified-p))
  15697. (org-refresh-category-properties)
  15698. (setq org-todo-keywords-for-agenda
  15699. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  15700. (setq org-done-keywords-for-agenda
  15701. (append org-done-keywords-for-agenda org-done-keywords))
  15702. (setq org-todo-keyword-alist-for-agenda
  15703. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  15704. (setq org-drawers-for-agenda
  15705. (append org-drawers-for-agenda org-drawers))
  15706. (setq org-tag-alist-for-agenda
  15707. (append org-tag-alist-for-agenda org-tag-alist))
  15708. (save-excursion
  15709. (remove-text-properties (point-min) (point-max) pall)
  15710. (when org-agenda-skip-archived-trees
  15711. (goto-char (point-min))
  15712. (while (re-search-forward rea nil t)
  15713. (if (org-at-heading-p t)
  15714. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  15715. (goto-char (point-min))
  15716. (setq re (format org-heading-keyword-regexp-format
  15717. org-comment-string))
  15718. (while (re-search-forward re nil t)
  15719. (add-text-properties
  15720. (match-beginning 0) (org-end-of-subtree t) pc)))
  15721. (set-buffer-modified-p bmp)))))
  15722. (setq org-todo-keywords-for-agenda
  15723. (org-uniquify org-todo-keywords-for-agenda))
  15724. (setq org-todo-keyword-alist-for-agenda
  15725. (org-uniquify org-todo-keyword-alist-for-agenda)
  15726. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  15727. ;;;; Embedded LaTeX
  15728. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  15729. "Keymap for the minor `org-cdlatex-mode'.")
  15730. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  15731. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  15732. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  15733. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  15734. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  15735. (defvar org-cdlatex-texmathp-advice-is-done nil
  15736. "Flag remembering if we have applied the advice to texmathp already.")
  15737. (define-minor-mode org-cdlatex-mode
  15738. "Toggle the minor `org-cdlatex-mode'.
  15739. This mode supports entering LaTeX environment and math in LaTeX fragments
  15740. in Org-mode.
  15741. \\{org-cdlatex-mode-map}"
  15742. nil " OCDL" nil
  15743. (when org-cdlatex-mode
  15744. (require 'cdlatex)
  15745. (run-hooks 'cdlatex-mode-hook)
  15746. (cdlatex-compute-tables))
  15747. (unless org-cdlatex-texmathp-advice-is-done
  15748. (setq org-cdlatex-texmathp-advice-is-done t)
  15749. (defadvice texmathp (around org-math-always-on activate)
  15750. "Always return t in org-mode buffers.
  15751. This is because we want to insert math symbols without dollars even outside
  15752. the LaTeX math segments. If Orgmode thinks that point is actually inside
  15753. an embedded LaTeX fragment, let texmathp do its job.
  15754. \\[org-cdlatex-mode-map]"
  15755. (interactive)
  15756. (let (p)
  15757. (cond
  15758. ((not (derived-mode-p 'org-mode)) ad-do-it)
  15759. ((eq this-command 'cdlatex-math-symbol)
  15760. (setq ad-return-value t
  15761. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  15762. (t
  15763. (let ((p (org-inside-LaTeX-fragment-p)))
  15764. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  15765. (setq ad-return-value t
  15766. texmathp-why '("Org-mode embedded math" . 0))
  15767. (if p ad-do-it)))))))))
  15768. (defun turn-on-org-cdlatex ()
  15769. "Unconditionally turn on `org-cdlatex-mode'."
  15770. (org-cdlatex-mode 1))
  15771. (defun org-inside-LaTeX-fragment-p ()
  15772. "Test if point is inside a LaTeX fragment.
  15773. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  15774. sequence appearing also before point.
  15775. Even though the matchers for math are configurable, this function assumes
  15776. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  15777. delimiters are skipped when they have been removed by customization.
  15778. The return value is nil, or a cons cell with the delimiter and the
  15779. position of this delimiter.
  15780. This function does a reasonably good job, but can locally be fooled by
  15781. for example currency specifications. For example it will assume being in
  15782. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  15783. fragments that are properly closed, but during editing, we have to live
  15784. with the uncertainty caused by missing closing delimiters. This function
  15785. looks only before point, not after."
  15786. (catch 'exit
  15787. (let ((pos (point))
  15788. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  15789. (lim (progn
  15790. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  15791. (point)))
  15792. dd-on str (start 0) m re)
  15793. (goto-char pos)
  15794. (when dodollar
  15795. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  15796. re (nth 1 (assoc "$" org-latex-regexps)))
  15797. (while (string-match re str start)
  15798. (cond
  15799. ((= (match-end 0) (length str))
  15800. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  15801. ((= (match-end 0) (- (length str) 5))
  15802. (throw 'exit nil))
  15803. (t (setq start (match-end 0))))))
  15804. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  15805. (goto-char pos)
  15806. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  15807. (and (match-beginning 2) (throw 'exit nil))
  15808. ;; count $$
  15809. (while (re-search-backward "\\$\\$" lim t)
  15810. (setq dd-on (not dd-on)))
  15811. (goto-char pos)
  15812. (if dd-on (cons "$$" m))))))
  15813. (defun org-inside-latex-macro-p ()
  15814. "Is point inside a LaTeX macro or its arguments?"
  15815. (save-match-data
  15816. (org-in-regexp
  15817. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  15818. (defun org-try-cdlatex-tab ()
  15819. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  15820. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  15821. - inside a LaTeX fragment, or
  15822. - after the first word in a line, where an abbreviation expansion could
  15823. insert a LaTeX environment."
  15824. (when org-cdlatex-mode
  15825. (cond
  15826. ;; Before any word on the line: No expansion possible.
  15827. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  15828. ;; Just after first word on the line: Expand it. Make sure it
  15829. ;; cannot happen on headlines, though.
  15830. ((save-excursion
  15831. (skip-chars-backward "a-zA-Z0-9*")
  15832. (skip-chars-backward " \t")
  15833. (and (bolp) (not (org-at-heading-p))))
  15834. (cdlatex-tab) t)
  15835. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  15836. (defun org-cdlatex-underscore-caret (&optional arg)
  15837. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  15838. Revert to the normal definition outside of these fragments."
  15839. (interactive "P")
  15840. (if (org-inside-LaTeX-fragment-p)
  15841. (call-interactively 'cdlatex-sub-superscript)
  15842. (let (org-cdlatex-mode)
  15843. (call-interactively (key-binding (vector last-input-event))))))
  15844. (defun org-cdlatex-math-modify (&optional arg)
  15845. "Execute `cdlatex-math-modify' in LaTeX fragments.
  15846. Revert to the normal definition outside of these fragments."
  15847. (interactive "P")
  15848. (if (org-inside-LaTeX-fragment-p)
  15849. (call-interactively 'cdlatex-math-modify)
  15850. (let (org-cdlatex-mode)
  15851. (call-interactively (key-binding (vector last-input-event))))))
  15852. (defvar org-latex-fragment-image-overlays nil
  15853. "List of overlays carrying the images of latex fragments.")
  15854. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  15855. (defun org-remove-latex-fragment-image-overlays ()
  15856. "Remove all overlays with LaTeX fragment images in current buffer."
  15857. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  15858. (setq org-latex-fragment-image-overlays nil))
  15859. (defun org-preview-latex-fragment (&optional subtree)
  15860. "Preview the LaTeX fragment at point, or all locally or globally.
  15861. If the cursor is in a LaTeX fragment, create the image and overlay
  15862. it over the source code. If there is no fragment at point, display
  15863. all fragments in the current text, from one headline to the next. With
  15864. prefix SUBTREE, display all fragments in the current subtree. With a
  15865. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  15866. the cursor is before the first headline,
  15867. display all fragments in the buffer.
  15868. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  15869. (interactive "P")
  15870. (unless buffer-file-name
  15871. (error "Can't preview LaTeX fragment in a non-file buffer"))
  15872. (org-remove-latex-fragment-image-overlays)
  15873. (save-excursion
  15874. (save-restriction
  15875. (let (beg end at msg)
  15876. (cond
  15877. ((or (equal subtree '(16))
  15878. (not (save-excursion
  15879. (re-search-backward org-outline-regexp-bol nil t))))
  15880. (setq beg (point-min) end (point-max)
  15881. msg "Creating images for buffer...%s"))
  15882. ((equal subtree '(4))
  15883. (org-back-to-heading)
  15884. (setq beg (point) end (org-end-of-subtree t)
  15885. msg "Creating images for subtree...%s"))
  15886. (t
  15887. (if (setq at (org-inside-LaTeX-fragment-p))
  15888. (goto-char (max (point-min) (- (cdr at) 2)))
  15889. (org-back-to-heading))
  15890. (setq beg (point) end (progn (outline-next-heading) (point))
  15891. msg (if at "Creating image...%s"
  15892. "Creating images for entry...%s"))))
  15893. (message msg "")
  15894. (narrow-to-region beg end)
  15895. (goto-char beg)
  15896. (org-format-latex
  15897. (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
  15898. (file-name-nondirectory
  15899. buffer-file-name)))
  15900. default-directory 'overlays msg at 'forbuffer
  15901. org-latex-create-formula-image-program)
  15902. (message msg "done. Use `C-c C-c' to remove images.")))))
  15903. (defvar org-latex-regexps
  15904. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  15905. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  15906. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  15907. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15908. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15909. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  15910. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  15911. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  15912. "Regular expressions for matching embedded LaTeX.")
  15913. (defvar org-export-have-math nil) ;; dynamic scoping
  15914. (defun org-format-latex (prefix &optional dir overlays msg at
  15915. forbuffer processing-type)
  15916. "Replace LaTeX fragments with links to an image, and produce images.
  15917. Some of the options can be changed using the variable
  15918. `org-format-latex-options'."
  15919. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  15920. (let* ((prefixnodir (file-name-nondirectory prefix))
  15921. (absprefix (expand-file-name prefix dir))
  15922. (todir (file-name-directory absprefix))
  15923. (opt org-format-latex-options)
  15924. (optnew org-format-latex-options)
  15925. (matchers (plist-get opt :matchers))
  15926. (re-list org-latex-regexps)
  15927. (org-format-latex-header-extra
  15928. (plist-get (org-infile-export-plist) :latex-header-extra))
  15929. (cnt 0) txt hash link beg end re e checkdir
  15930. string
  15931. m n block-type block linkfile movefile ov)
  15932. ;; Check the different regular expressions
  15933. (while (setq e (pop re-list))
  15934. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  15935. block (if block-type "\n\n" ""))
  15936. (when (member m matchers)
  15937. (goto-char (point-min))
  15938. (while (re-search-forward re nil t)
  15939. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  15940. (not (get-text-property (match-beginning n)
  15941. 'org-protected))
  15942. (or (not overlays)
  15943. (not (eq (get-char-property (match-beginning n)
  15944. 'org-overlay-type)
  15945. 'org-latex-overlay))))
  15946. (setq org-export-have-math t)
  15947. (cond
  15948. ((eq processing-type 'verbatim)
  15949. ;; Leave the text verbatim, just protect it
  15950. (add-text-properties (match-beginning n) (match-end n)
  15951. '(org-protected t)))
  15952. ((eq processing-type 'mathjax)
  15953. ;; Prepare for MathJax processing
  15954. (setq string (match-string n))
  15955. (if (member m '("$" "$1"))
  15956. (save-excursion
  15957. (delete-region (match-beginning n) (match-end n))
  15958. (goto-char (match-beginning n))
  15959. (insert (org-add-props (concat "\\(" (substring string 1 -1)
  15960. "\\)")
  15961. '(org-protected t))))
  15962. (add-text-properties (match-beginning n) (match-end n)
  15963. '(org-protected t))))
  15964. ((or (eq processing-type 'dvipng)
  15965. (eq processing-type 'imagemagick))
  15966. ;; Process to an image
  15967. (setq txt (match-string n)
  15968. beg (match-beginning n) end (match-end n)
  15969. cnt (1+ cnt))
  15970. (let ((face (face-at-point))
  15971. (fg (plist-get opt :foreground))
  15972. (bg (plist-get opt :background))
  15973. print-length print-level) ; make sure full list is printed
  15974. (when forbuffer
  15975. ; Get the colors from the face at point
  15976. (goto-char beg)
  15977. (when (eq fg 'auto)
  15978. (setq fg (face-attribute face :foreground nil 'default)))
  15979. (when (eq bg 'auto)
  15980. (setq bg (face-attribute face :background nil 'default)))
  15981. (setq optnew (copy-sequence opt))
  15982. (plist-put optnew :foreground fg)
  15983. (plist-put optnew :background bg))
  15984. (setq hash (sha1 (prin1-to-string
  15985. (list org-format-latex-header
  15986. org-format-latex-header-extra
  15987. org-export-latex-default-packages-alist
  15988. org-export-latex-packages-alist
  15989. org-format-latex-options
  15990. forbuffer txt fg bg)))
  15991. linkfile (format "%s_%s.png" prefix hash)
  15992. movefile (format "%s_%s.png" absprefix hash)))
  15993. (setq link (concat block "[[file:" linkfile "]]" block))
  15994. (if msg (message msg cnt))
  15995. (goto-char beg)
  15996. (unless checkdir ; make sure the directory exists
  15997. (setq checkdir t)
  15998. (or (file-directory-p todir) (make-directory todir t)))
  15999. (org-create-formula-image
  16000. txt movefile optnew forbuffer processing-type)
  16001. (if overlays
  16002. (progn
  16003. (mapc (lambda (o)
  16004. (if (eq (overlay-get o 'org-overlay-type)
  16005. 'org-latex-overlay)
  16006. (delete-overlay o)))
  16007. (overlays-in beg end))
  16008. (setq ov (make-overlay beg end))
  16009. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  16010. (if (featurep 'xemacs)
  16011. (progn
  16012. (overlay-put ov 'invisible t)
  16013. (overlay-put
  16014. ov 'end-glyph
  16015. (make-glyph (vector 'png :file movefile))))
  16016. (overlay-put
  16017. ov 'display
  16018. (list 'image :type 'png :file movefile :ascent 'center)))
  16019. (push ov org-latex-fragment-image-overlays)
  16020. (goto-char end))
  16021. (delete-region beg end)
  16022. (insert (org-add-props link
  16023. (list 'org-latex-src
  16024. (replace-regexp-in-string
  16025. "\"" "" txt)
  16026. 'org-latex-src-embed-type
  16027. (if block-type 'paragraph 'character))))))
  16028. ((eq processing-type 'mathml)
  16029. ;; Process to MathML
  16030. (unless (save-match-data (org-format-latex-mathml-available-p))
  16031. (error "LaTeX to MathML converter not configured"))
  16032. (setq txt (match-string n)
  16033. beg (match-beginning n) end (match-end n)
  16034. cnt (1+ cnt))
  16035. (if msg (message msg cnt))
  16036. (goto-char beg)
  16037. (delete-region beg end)
  16038. (insert (org-format-latex-as-mathml
  16039. txt block-type prefix dir)))
  16040. (t
  16041. (error "Unknown conversion type %s for latex fragments"
  16042. processing-type)))))))))
  16043. (defun org-create-math-formula (latex-frag &optional mathml-file)
  16044. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  16045. Use `org-latex-to-mathml-convert-command'. If the conversion is
  16046. sucessful, return the portion between \"<math...> </math>\"
  16047. elements otherwise return nil. When MATHML-FILE is specified,
  16048. write the results in to that file. When invoked as an
  16049. interactive command, prompt for LATEX-FRAG, with initial value
  16050. set to the current active region and echo the results for user
  16051. inspection."
  16052. (interactive (list (let ((frag (when (org-region-active-p)
  16053. (buffer-substring-no-properties
  16054. (region-beginning) (region-end)))))
  16055. (read-string "LaTeX Fragment: " frag nil frag))))
  16056. (unless latex-frag (error "Invalid latex-frag"))
  16057. (let* ((tmp-in-file (file-relative-name
  16058. (make-temp-name (expand-file-name "ltxmathml-in"))))
  16059. (ignore (write-region latex-frag nil tmp-in-file))
  16060. (tmp-out-file (file-relative-name
  16061. (make-temp-name (expand-file-name "ltxmathml-out"))))
  16062. (cmd (format-spec
  16063. org-latex-to-mathml-convert-command
  16064. `((?j . ,(shell-quote-argument
  16065. (expand-file-name org-latex-to-mathml-jar-file)))
  16066. (?I . ,(shell-quote-argument tmp-in-file))
  16067. (?o . ,(shell-quote-argument tmp-out-file)))))
  16068. mathml shell-command-output)
  16069. (when (org-called-interactively-p 'any)
  16070. (unless (org-format-latex-mathml-available-p)
  16071. (error "LaTeX to MathML converter not configured")))
  16072. (message "Running %s" cmd)
  16073. (setq shell-command-output (shell-command-to-string cmd))
  16074. (setq mathml
  16075. (when (file-readable-p tmp-out-file)
  16076. (with-current-buffer (find-file-noselect tmp-out-file t)
  16077. (goto-char (point-min))
  16078. (when (re-search-forward
  16079. (concat
  16080. (regexp-quote
  16081. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  16082. "\\(.\\|\n\\)*"
  16083. (regexp-quote "</math>")) nil t)
  16084. (prog1 (match-string 0) (kill-buffer))))))
  16085. (cond
  16086. (mathml
  16087. (setq mathml
  16088. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  16089. (when mathml-file
  16090. (write-region mathml nil mathml-file))
  16091. (when (org-called-interactively-p 'any)
  16092. (message mathml)))
  16093. ((message "LaTeX to MathML conversion failed")
  16094. (message shell-command-output)))
  16095. (delete-file tmp-in-file)
  16096. (when (file-exists-p tmp-out-file)
  16097. (delete-file tmp-out-file))
  16098. mathml))
  16099. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  16100. prefix &optional dir)
  16101. "Use `org-create-math-formula' but check local cache first."
  16102. (let* ((absprefix (expand-file-name prefix dir))
  16103. (print-length nil) (print-level nil)
  16104. (formula-id (concat
  16105. "formula-"
  16106. (sha1
  16107. (prin1-to-string
  16108. (list latex-frag
  16109. org-latex-to-mathml-convert-command)))))
  16110. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  16111. (formula-cache-dir (file-name-directory formula-cache)))
  16112. (unless (file-directory-p formula-cache-dir)
  16113. (make-directory formula-cache-dir t))
  16114. (unless (file-exists-p formula-cache)
  16115. (org-create-math-formula latex-frag formula-cache))
  16116. (if (file-exists-p formula-cache)
  16117. ;; Successful conversion. Return the link to MathML file.
  16118. (org-add-props
  16119. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  16120. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  16121. 'org-latex-src-embed-type (if latex-frag-type
  16122. 'paragraph 'character)))
  16123. ;; Failed conversion. Return the LaTeX fragment verbatim
  16124. (add-text-properties
  16125. 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
  16126. latex-frag)))
  16127. (defun org-create-formula-image (string tofile options buffer &optional type)
  16128. "Create an image from LaTeX source using dvipng or convert.
  16129. This function calls either `org-create-formula-image-with-dvipng'
  16130. or `org-create-formula-image-with-imagemagick' depending on the
  16131. value of `org-latex-create-formula-image-program' or on the value
  16132. of the optional TYPE variable.
  16133. Note: ultimately these two function should be combined as they
  16134. share a good deal of logic."
  16135. (org-check-external-command
  16136. "latex" "needed to convert LaTeX fragments to images")
  16137. (funcall
  16138. (case (or type org-latex-create-formula-image-program)
  16139. ('dvipng
  16140. (org-check-external-command
  16141. "dvipng" "needed to convert LaTeX fragments to images")
  16142. #'org-create-formula-image-with-dvipng)
  16143. ('imagemagick
  16144. (org-check-external-command
  16145. "convert" "you need to install imagemagick")
  16146. #'org-create-formula-image-with-imagemagick)
  16147. (t (error
  16148. "invalid value of `org-latex-create-formula-image-program'")))
  16149. string tofile options buffer))
  16150. ;; This function borrows from Ganesh Swami's latex2png.el
  16151. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  16152. "This calls dvipng."
  16153. (require 'org-latex)
  16154. (let* ((tmpdir (if (featurep 'xemacs)
  16155. (temp-directory)
  16156. temporary-file-directory))
  16157. (texfilebase (make-temp-name
  16158. (expand-file-name "orgtex" tmpdir)))
  16159. (texfile (concat texfilebase ".tex"))
  16160. (dvifile (concat texfilebase ".dvi"))
  16161. (pngfile (concat texfilebase ".png"))
  16162. (fnh (if (featurep 'xemacs)
  16163. (font-height (face-font 'default))
  16164. (face-attribute 'default :height nil)))
  16165. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16166. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16167. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16168. "Black"))
  16169. (bg (or (plist-get options (if buffer :background :html-background))
  16170. "Transparent")))
  16171. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
  16172. (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
  16173. (if (eq bg 'default) (setq bg (org-dvipng-color :background))
  16174. (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
  16175. (with-temp-file texfile
  16176. (insert (org-splice-latex-header
  16177. org-format-latex-header
  16178. org-export-latex-default-packages-alist
  16179. org-export-latex-packages-alist t
  16180. org-format-latex-header-extra))
  16181. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  16182. (require 'org-latex)
  16183. (org-export-latex-fix-inputenc))
  16184. (let ((dir default-directory))
  16185. (condition-case nil
  16186. (progn
  16187. (cd tmpdir)
  16188. (call-process "latex" nil nil nil texfile))
  16189. (error nil))
  16190. (cd dir))
  16191. (if (not (file-exists-p dvifile))
  16192. (progn (message "Failed to create dvi file from %s" texfile) nil)
  16193. (condition-case nil
  16194. (if (featurep 'xemacs)
  16195. (call-process "dvipng" nil nil nil
  16196. "-fg" fg "-bg" bg
  16197. "-T" "tight"
  16198. "-o" pngfile
  16199. dvifile)
  16200. (call-process "dvipng" nil nil nil
  16201. "-fg" fg "-bg" bg
  16202. "-D" dpi
  16203. ;;"-x" scale "-y" scale
  16204. "-T" "tight"
  16205. "-o" pngfile
  16206. dvifile))
  16207. (error nil))
  16208. (if (not (file-exists-p pngfile))
  16209. (if org-format-latex-signal-error
  16210. (error "Failed to create png file from %s" texfile)
  16211. (message "Failed to create png file from %s" texfile)
  16212. nil)
  16213. ;; Use the requested file name and clean up
  16214. (copy-file pngfile tofile 'replace)
  16215. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  16216. (if (file-exists-p (concat texfilebase e))
  16217. (delete-file (concat texfilebase e))))
  16218. pngfile))))
  16219. (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
  16220. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  16221. "This calls convert, which is included into imagemagick."
  16222. (require 'org-latex)
  16223. (let* ((tmpdir (if (featurep 'xemacs)
  16224. (temp-directory)
  16225. temporary-file-directory))
  16226. (texfilebase (make-temp-name
  16227. (expand-file-name "orgtex" tmpdir)))
  16228. (texfile (concat texfilebase ".tex"))
  16229. (pdffile (concat texfilebase ".pdf"))
  16230. (pngfile (concat texfilebase ".png"))
  16231. (fnh (if (featurep 'xemacs)
  16232. (font-height (face-font 'default))
  16233. (face-attribute 'default :height nil)))
  16234. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16235. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16236. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16237. "black"))
  16238. (bg (or (plist-get options (if buffer :background :html-background))
  16239. "white")))
  16240. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  16241. (setq fg (org-latex-color-format fg)))
  16242. (if (eq bg 'default) (setq bg (org-latex-color :background))
  16243. (setq bg (org-latex-color-format
  16244. (if (string= bg "Transparent") "white" bg))))
  16245. (with-temp-file texfile
  16246. (insert (org-splice-latex-header
  16247. org-format-latex-header
  16248. org-export-latex-default-packages-alist
  16249. org-export-latex-packages-alist t
  16250. org-format-latex-header-extra))
  16251. (insert "\n\\begin{document}\n"
  16252. "\\definecolor{fg}{rgb}{" fg "}\n"
  16253. "\\definecolor{bg}{rgb}{" bg "}\n"
  16254. "\n\\pagecolor{bg}\n"
  16255. "\n{\\color{fg}\n"
  16256. string
  16257. "\n}\n"
  16258. "\n\\end{document}\n" )
  16259. (require 'org-latex)
  16260. (org-export-latex-fix-inputenc))
  16261. (let ((dir default-directory) cmd cmds latex-frags-cmds)
  16262. (condition-case nil
  16263. (progn
  16264. (cd tmpdir)
  16265. (setq cmds org-latex-to-pdf-process)
  16266. (while cmds
  16267. (setq latex-frags-cmds (pop cmds))
  16268. (if (listp latex-frags-cmds)
  16269. (setq cmds nil)
  16270. (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
  16271. (while latex-frags-cmds
  16272. (setq cmd (pop latex-frags-cmds))
  16273. (while (string-match "%b" cmd)
  16274. (setq cmd (replace-match
  16275. (save-match-data
  16276. (shell-quote-argument texfile))
  16277. t t cmd)))
  16278. (while (string-match "%f" cmd)
  16279. (setq cmd (replace-match
  16280. (save-match-data
  16281. (shell-quote-argument (file-name-nondirectory texfile)))
  16282. t t cmd)))
  16283. (while (string-match "%o" cmd)
  16284. (setq cmd (replace-match
  16285. (save-match-data
  16286. (shell-quote-argument (file-name-directory texfile)))
  16287. t t cmd)))
  16288. (setq cmd (split-string cmd))
  16289. (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
  16290. (error nil))
  16291. (cd dir))
  16292. (if (not (file-exists-p pdffile))
  16293. (progn (message "Failed to create pdf file from %s" texfile) nil)
  16294. (condition-case nil
  16295. (if (featurep 'xemacs)
  16296. (call-process "convert" nil nil nil
  16297. "-density" "96"
  16298. "-trim"
  16299. "-antialias"
  16300. pdffile
  16301. "-quality" "100"
  16302. ;; "-sharpen" "0x1.0"
  16303. pngfile)
  16304. (call-process "convert" nil nil nil
  16305. "-density" dpi
  16306. "-trim"
  16307. "-antialias"
  16308. pdffile
  16309. "-quality" "100"
  16310. ; "-sharpen" "0x1.0"
  16311. pngfile))
  16312. (error nil))
  16313. (if (not (file-exists-p pngfile))
  16314. (if org-format-latex-signal-error
  16315. (error "Failed to create png file from %s" texfile)
  16316. (message "Failed to create png file from %s" texfile)
  16317. nil)
  16318. ;; Use the requested file name and clean up
  16319. (copy-file pngfile tofile 'replace)
  16320. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  16321. (if (file-exists-p (concat texfilebase e))
  16322. (delete-file (concat texfilebase e))))
  16323. pngfile))))
  16324. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  16325. "Fill a LaTeX header template TPL.
  16326. In the template, the following place holders will be recognized:
  16327. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  16328. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  16329. [PACKAGES] \\usepackage statements for PKG
  16330. [NO-PACKAGES] do not include PKG
  16331. [EXTRA] the string EXTRA
  16332. [NO-EXTRA] do not include EXTRA
  16333. For backward compatibility, if both the positive and the negative place
  16334. holder is missing, the positive one (without the \"NO-\") will be
  16335. assumed to be present at the end of the template.
  16336. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  16337. EXTRA is a string.
  16338. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  16339. (let (rpl (end ""))
  16340. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  16341. (setq rpl (if (or (match-end 1) (not def-pkg))
  16342. "" (org-latex-packages-to-string def-pkg snippets-p t))
  16343. tpl (replace-match rpl t t tpl))
  16344. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  16345. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  16346. (setq rpl (if (or (match-end 1) (not pkg))
  16347. "" (org-latex-packages-to-string pkg snippets-p t))
  16348. tpl (replace-match rpl t t tpl))
  16349. (if pkg (setq end
  16350. (concat end "\n"
  16351. (org-latex-packages-to-string pkg snippets-p)))))
  16352. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  16353. (setq rpl (if (or (match-end 1) (not extra))
  16354. "" (concat extra "\n"))
  16355. tpl (replace-match rpl t t tpl))
  16356. (if (and extra (string-match "\\S-" extra))
  16357. (setq end (concat end "\n" extra))))
  16358. (if (string-match "\\S-" end)
  16359. (concat tpl "\n" end)
  16360. tpl)))
  16361. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  16362. "Turn an alist of packages into a string with the \\usepackage macros."
  16363. (setq pkg (mapconcat (lambda(p)
  16364. (cond
  16365. ((stringp p) p)
  16366. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  16367. (format "%% Package %s omitted" (cadr p)))
  16368. ((equal "" (car p))
  16369. (format "\\usepackage{%s}" (cadr p)))
  16370. (t
  16371. (format "\\usepackage[%s]{%s}"
  16372. (car p) (cadr p)))))
  16373. pkg
  16374. "\n"))
  16375. (if newline (concat pkg "\n") pkg))
  16376. (defun org-dvipng-color (attr)
  16377. "Return a RGB color specification for dvipng."
  16378. (apply 'format "rgb %s %s %s"
  16379. (mapcar 'org-normalize-color
  16380. (if (featurep 'xemacs)
  16381. (color-rgb-components
  16382. (face-property 'default
  16383. (cond ((eq attr :foreground) 'foreground)
  16384. ((eq attr :background) 'background))))
  16385. (color-values (face-attribute 'default attr nil))))))
  16386. (defun org-dvipng-color-format (color-name)
  16387. "Convert COLOR-NAME to a RGB color value for dvipng."
  16388. (apply 'format "rgb %s %s %s"
  16389. (mapcar 'org-normalize-color
  16390. (color-values color-name))))
  16391. (defun org-latex-color (attr)
  16392. "Return a RGB color for the LaTeX color package."
  16393. (apply 'format "%s,%s,%s"
  16394. (mapcar 'org-normalize-color
  16395. (if (featurep 'xemacs)
  16396. (color-rgb-components
  16397. (face-property 'default
  16398. (cond ((eq attr :foreground) 'foreground)
  16399. ((eq attr :background) 'background))))
  16400. (color-values (face-attribute 'default attr nil))))))
  16401. (defun org-latex-color-format (color-name)
  16402. "Convert COLOR-NAME to a RGB color value."
  16403. (apply 'format "%s,%s,%s"
  16404. (mapcar 'org-normalize-color
  16405. (color-values color-name))))
  16406. (defun org-normalize-color (value)
  16407. "Return string to be used as color value for an RGB component."
  16408. (format "%g" (/ value 65535.0)))
  16409. ;; Image display
  16410. (defvar org-inline-image-overlays nil)
  16411. (make-variable-buffer-local 'org-inline-image-overlays)
  16412. (defun org-toggle-inline-images (&optional include-linked)
  16413. "Toggle the display of inline images.
  16414. INCLUDE-LINKED is passed to `org-display-inline-images'."
  16415. (interactive "P")
  16416. (if org-inline-image-overlays
  16417. (progn
  16418. (org-remove-inline-images)
  16419. (message "Inline image display turned off"))
  16420. (org-display-inline-images include-linked)
  16421. (if (and (org-called-interactively-p)
  16422. org-inline-image-overlays)
  16423. (message "%d images displayed inline"
  16424. (length org-inline-image-overlays))
  16425. (message "No images to display inline"))))
  16426. (defun org-redisplay-inline-images ()
  16427. "Refresh the display of inline images."
  16428. (interactive)
  16429. (if (not org-inline-image-overlays)
  16430. (org-toggle-inline-images)
  16431. (org-toggle-inline-images)
  16432. (org-toggle-inline-images)))
  16433. (defun org-display-inline-images (&optional include-linked refresh beg end)
  16434. "Display inline images.
  16435. Normally only links without a description part are inlined, because this
  16436. is how it will work for export. When INCLUDE-LINKED is set, also links
  16437. with a description part will be inlined. This can be nice for a quick
  16438. look at those images, but it does not reflect what exported files will look
  16439. like.
  16440. When REFRESH is set, refresh existing images between BEG and END.
  16441. This will create new image displays only if necessary.
  16442. BEG and END default to the buffer boundaries."
  16443. (interactive "P")
  16444. (unless refresh
  16445. (org-remove-inline-images)
  16446. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  16447. (save-excursion
  16448. (save-restriction
  16449. (widen)
  16450. (setq beg (or beg (point-min)) end (or end (point-max)))
  16451. (goto-char beg)
  16452. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  16453. (substring (org-image-file-name-regexp) 0 -2)
  16454. "\\)\\]" (if include-linked "" "\\]")))
  16455. old file ov img type attrwidth width)
  16456. (while (re-search-forward re end t)
  16457. (setq old (get-char-property-and-overlay (match-beginning 1)
  16458. 'org-image-overlay)
  16459. file (expand-file-name
  16460. (concat (or (match-string 3) "") (match-string 4))))
  16461. (when (image-type-available-p 'imagemagick)
  16462. (setq attrwidth (if (or (listp org-image-actual-width)
  16463. (null org-image-actual-width))
  16464. (save-excursion
  16465. (save-match-data
  16466. (move-beginning-of-line 0)
  16467. (if (looking-at "#\\+ATTR.*width=\"\\([^\"]+\\)\"")
  16468. (string-to-number (match-string 1))))))
  16469. width (cond ((eq org-image-actual-width t) nil)
  16470. ((null org-image-actual-width) attrwidth)
  16471. ((numberp org-image-actual-width)
  16472. org-image-actual-width)
  16473. ((listp org-image-actual-width)
  16474. (or attrwidth (car org-image-actual-width))))
  16475. type (if width 'imagemagick)))
  16476. (when (file-exists-p file)
  16477. (if (and (car-safe old) refresh)
  16478. (image-refresh (overlay-get (cdr old) 'display))
  16479. (setq img (save-match-data (create-image file type nil :width width)))
  16480. (when img
  16481. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  16482. (overlay-put ov 'display img)
  16483. (overlay-put ov 'face 'default)
  16484. (overlay-put ov 'org-image-overlay t)
  16485. (overlay-put ov 'modification-hooks
  16486. (list 'org-display-inline-modification-hook))
  16487. (push ov org-inline-image-overlays)))))))))
  16488. (defun org-display-inline-modification-hook (ov after beg end &optional len)
  16489. "Remove inline-display overlay if a corresponding region is modified."
  16490. (let ((inhibit-modification-hooks t))
  16491. (when (and ov after)
  16492. (delete ov org-inline-image-overlays)
  16493. (delete-overlay ov))))
  16494. (defun org-remove-inline-images ()
  16495. "Remove inline display of images."
  16496. (interactive)
  16497. (mapc 'delete-overlay org-inline-image-overlays)
  16498. (setq org-inline-image-overlays nil))
  16499. ;;;; Key bindings
  16500. ;; Outline functions from `outline-mode-prefix-map'
  16501. ;; that can be remapped in Org:
  16502. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  16503. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  16504. (define-key org-mode-map [remap outline-forward-same-level]
  16505. 'org-forward-heading-same-level)
  16506. (define-key org-mode-map [remap outline-backward-same-level]
  16507. 'org-backward-heading-same-level)
  16508. (define-key org-mode-map [remap show-branches]
  16509. 'org-kill-note-or-show-branches)
  16510. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  16511. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  16512. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  16513. ;; Outline functions from `outline-mode-prefix-map' that can not
  16514. ;; be remapped in Org:
  16515. ;;
  16516. ;; - the column "key binding" shows whether the Outline function is still
  16517. ;; available in Org mode on the same key that it has been bound to in
  16518. ;; Outline mode:
  16519. ;; - "overridden": key used for a different functionality in Org mode
  16520. ;; - else: key still bound to the same Outline function in Org mode
  16521. ;;
  16522. ;; | Outline function | key binding | Org replacement |
  16523. ;; |------------------------------------+-------------+-----------------------|
  16524. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  16525. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  16526. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  16527. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  16528. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  16529. ;; | `show-entry' | overridden | no replacement |
  16530. ;; | `show-children' | `C-c C-i' | visibility cycling |
  16531. ;; | `show-branches' | `C-c C-k' | still same function |
  16532. ;; | `show-subtree' | overridden | visibility cycling |
  16533. ;; | `show-all' | overridden | no replacement |
  16534. ;; | `hide-subtree' | overridden | visibility cycling |
  16535. ;; | `hide-body' | overridden | no replacement |
  16536. ;; | `hide-entry' | overridden | visibility cycling |
  16537. ;; | `hide-leaves' | overridden | no replacement |
  16538. ;; | `hide-sublevels' | overridden | no replacement |
  16539. ;; | `hide-other' | overridden | no replacement |
  16540. ;; Make `C-c C-x' a prefix key
  16541. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  16542. ;; TAB key with modifiers
  16543. (org-defkey org-mode-map "\C-i" 'org-cycle)
  16544. (org-defkey org-mode-map [(tab)] 'org-cycle)
  16545. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  16546. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  16547. ;; The following line is necessary under Suse GNU/Linux
  16548. (unless (featurep 'xemacs)
  16549. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  16550. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  16551. (define-key org-mode-map [backtab] 'org-shifttab)
  16552. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  16553. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  16554. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  16555. ;; Cursor keys with modifiers
  16556. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  16557. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  16558. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  16559. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  16560. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  16561. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  16562. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  16563. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  16564. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  16565. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  16566. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  16567. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  16568. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  16569. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  16570. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  16571. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  16572. ;; Babel keys
  16573. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  16574. (mapc (lambda (pair)
  16575. (define-key org-babel-map (car pair) (cdr pair)))
  16576. org-babel-key-bindings)
  16577. ;;; Extra keys for tty access.
  16578. ;; We only set them when really needed because otherwise the
  16579. ;; menus don't show the simple keys
  16580. (when (or org-use-extra-keys
  16581. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  16582. (not window-system))
  16583. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  16584. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  16585. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  16586. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  16587. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  16588. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  16589. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  16590. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  16591. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  16592. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  16593. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  16594. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  16595. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  16596. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  16597. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  16598. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  16599. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  16600. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  16601. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  16602. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  16603. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  16604. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  16605. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  16606. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  16607. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  16608. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  16609. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  16610. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  16611. ;; All the other keys
  16612. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  16613. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  16614. (if (boundp 'narrow-map)
  16615. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  16616. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  16617. (if (boundp 'narrow-map)
  16618. (org-defkey narrow-map "b" 'org-narrow-to-block)
  16619. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  16620. (if (boundp 'narrow-map)
  16621. (org-defkey narrow-map "e" 'org-narrow-to-element)
  16622. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  16623. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  16624. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  16625. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  16626. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  16627. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  16628. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  16629. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  16630. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  16631. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  16632. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  16633. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  16634. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  16635. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  16636. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  16637. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  16638. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  16639. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  16640. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  16641. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  16642. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  16643. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  16644. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  16645. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  16646. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  16647. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  16648. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  16649. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  16650. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  16651. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  16652. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  16653. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  16654. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  16655. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  16656. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  16657. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  16658. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  16659. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  16660. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  16661. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  16662. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  16663. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  16664. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  16665. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  16666. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  16667. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  16668. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  16669. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  16670. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  16671. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  16672. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  16673. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  16674. (org-defkey org-mode-map "\C-c^" 'org-sort)
  16675. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  16676. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  16677. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  16678. (org-defkey org-mode-map "\C-m" 'org-return)
  16679. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  16680. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  16681. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  16682. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  16683. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  16684. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  16685. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  16686. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  16687. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  16688. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  16689. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  16690. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  16691. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  16692. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  16693. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  16694. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  16695. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  16696. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  16697. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  16698. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  16699. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  16700. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  16701. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  16702. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  16703. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  16704. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  16705. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  16706. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  16707. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  16708. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  16709. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  16710. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  16711. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  16712. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  16713. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  16714. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  16715. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  16716. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  16717. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  16718. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  16719. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  16720. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  16721. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  16722. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  16723. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  16724. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  16725. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  16726. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  16727. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  16728. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  16729. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  16730. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  16731. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  16732. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  16733. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  16734. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  16735. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  16736. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  16737. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  16738. (when (featurep 'xemacs)
  16739. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  16740. (defconst org-speed-commands-default
  16741. '(
  16742. ("Outline Navigation")
  16743. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  16744. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  16745. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  16746. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  16747. ("u" . (org-speed-move-safe 'outline-up-heading))
  16748. ("j" . org-goto)
  16749. ("g" . (org-refile t))
  16750. ("Outline Visibility")
  16751. ("c" . org-cycle)
  16752. ("C" . org-shifttab)
  16753. (" " . org-display-outline-path)
  16754. (":" . org-columns)
  16755. ("Outline Structure Editing")
  16756. ("U" . org-shiftmetaup)
  16757. ("D" . org-shiftmetadown)
  16758. ("r" . org-metaright)
  16759. ("l" . org-metaleft)
  16760. ("R" . org-shiftmetaright)
  16761. ("L" . org-shiftmetaleft)
  16762. ("i" . (progn (forward-char 1) (call-interactively
  16763. 'org-insert-heading-respect-content)))
  16764. ("^" . org-sort)
  16765. ("w" . org-refile)
  16766. ("a" . org-archive-subtree-default-with-confirmation)
  16767. ("." . org-mark-subtree)
  16768. ("#" . org-toggle-comment)
  16769. ("Clock Commands")
  16770. ("I" . org-clock-in)
  16771. ("O" . org-clock-out)
  16772. ("Meta Data Editing")
  16773. ("t" . org-todo)
  16774. ("0" . (org-priority ?\ ))
  16775. ("1" . (org-priority ?A))
  16776. ("2" . (org-priority ?B))
  16777. ("3" . (org-priority ?C))
  16778. (";" . org-set-tags-command)
  16779. ("e" . org-set-effort)
  16780. ("E" . org-inc-effort)
  16781. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  16782. (org-entry-put (point) "APPT_WARNTIME" m)))
  16783. ("Agenda Views etc")
  16784. ("v" . org-agenda)
  16785. ("/" . org-sparse-tree)
  16786. ("Misc")
  16787. ("o" . org-open-at-point)
  16788. ("?" . org-speed-command-help)
  16789. ("<" . (org-agenda-set-restriction-lock 'subtree))
  16790. (">" . (org-agenda-remove-restriction-lock))
  16791. )
  16792. "The default speed commands.")
  16793. (defun org-print-speed-command (e)
  16794. (if (> (length (car e)) 1)
  16795. (progn
  16796. (princ "\n")
  16797. (princ (car e))
  16798. (princ "\n")
  16799. (princ (make-string (length (car e)) ?-))
  16800. (princ "\n"))
  16801. (princ (car e))
  16802. (princ " ")
  16803. (if (symbolp (cdr e))
  16804. (princ (symbol-name (cdr e)))
  16805. (prin1 (cdr e)))
  16806. (princ "\n")))
  16807. (defun org-speed-command-help ()
  16808. "Show the available speed commands."
  16809. (interactive)
  16810. (if (not org-use-speed-commands)
  16811. (error "Speed commands are not activated, customize `org-use-speed-commands'")
  16812. (with-output-to-temp-buffer "*Help*"
  16813. (princ "User-defined Speed commands\n===========================\n")
  16814. (mapc 'org-print-speed-command org-speed-commands-user)
  16815. (princ "\n")
  16816. (princ "Built-in Speed commands\n=======================\n")
  16817. (mapc 'org-print-speed-command org-speed-commands-default))
  16818. (with-current-buffer "*Help*"
  16819. (setq truncate-lines t))))
  16820. (defun org-speed-move-safe (cmd)
  16821. "Execute CMD, but make sure that the cursor always ends up in a headline.
  16822. If not, return to the original position and throw an error."
  16823. (interactive)
  16824. (let ((pos (point)))
  16825. (call-interactively cmd)
  16826. (unless (and (bolp) (org-at-heading-p))
  16827. (goto-char pos)
  16828. (error "Boundary reached while executing %s" cmd))))
  16829. (defvar org-self-insert-command-undo-counter 0)
  16830. (defvar org-table-auto-blank-field) ; defined in org-table.el
  16831. (defvar org-speed-command nil)
  16832. (defun org-speed-command-default-hook (keys)
  16833. "Hook for activating single-letter speed commands.
  16834. `org-speed-commands-default' specifies a minimal command set.
  16835. Use `org-speed-commands-user' for further customization."
  16836. (when (or (and (bolp) (looking-at org-outline-regexp))
  16837. (and (functionp org-use-speed-commands)
  16838. (funcall org-use-speed-commands)))
  16839. (cdr (assoc keys (append org-speed-commands-user
  16840. org-speed-commands-default)))))
  16841. (defun org-babel-speed-command-hook (keys)
  16842. "Hook for activating single-letter code block commands."
  16843. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  16844. (cdr (assoc keys org-babel-key-bindings))))
  16845. (defcustom org-speed-command-hook
  16846. '(org-speed-command-default-hook org-babel-speed-command-hook)
  16847. "Hook for activating speed commands at strategic locations.
  16848. Hook functions are called in sequence until a valid handler is
  16849. found.
  16850. Each hook takes a single argument, a user-pressed command key
  16851. which is also a `self-insert-command' from the global map.
  16852. Within the hook, examine the cursor position and the command key
  16853. and return nil or a valid handler as appropriate. Handler could
  16854. be one of an interactive command, a function, or a form.
  16855. Set `org-use-speed-commands' to non-nil value to enable this
  16856. hook. The default setting is `org-speed-command-default-hook'."
  16857. :group 'org-structure
  16858. :version "24.1"
  16859. :type 'hook)
  16860. (defun org-self-insert-command (N)
  16861. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  16862. If the cursor is in a table looking at whitespace, the whitespace is
  16863. overwritten, and the table is not marked as requiring realignment."
  16864. (interactive "p")
  16865. (org-check-before-invisible-edit 'insert)
  16866. (cond
  16867. ((and org-use-speed-commands
  16868. (setq org-speed-command
  16869. (run-hook-with-args-until-success
  16870. 'org-speed-command-hook (this-command-keys))))
  16871. (cond
  16872. ((commandp org-speed-command)
  16873. (setq this-command org-speed-command)
  16874. (call-interactively org-speed-command))
  16875. ((functionp org-speed-command)
  16876. (funcall org-speed-command))
  16877. ((and org-speed-command (listp org-speed-command))
  16878. (eval org-speed-command))
  16879. (t (let (org-use-speed-commands)
  16880. (call-interactively 'org-self-insert-command)))))
  16881. ((and
  16882. (org-table-p)
  16883. (progn
  16884. ;; check if we blank the field, and if that triggers align
  16885. (and (featurep 'org-table) org-table-auto-blank-field
  16886. (member last-command
  16887. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  16888. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  16889. ;; got extra space, this field does not determine column width
  16890. (let (org-table-may-need-update) (org-table-blank-field))
  16891. ;; no extra space, this field may determine column width
  16892. (org-table-blank-field)))
  16893. t)
  16894. (eq N 1)
  16895. (looking-at "[^|\n]* |"))
  16896. (let (org-table-may-need-update)
  16897. (goto-char (1- (match-end 0)))
  16898. (backward-delete-char 1)
  16899. (goto-char (match-beginning 0))
  16900. (self-insert-command N)))
  16901. (t
  16902. (setq org-table-may-need-update t)
  16903. (self-insert-command N)
  16904. (org-fix-tags-on-the-fly)
  16905. (if org-self-insert-cluster-for-undo
  16906. (if (not (eq last-command 'org-self-insert-command))
  16907. (setq org-self-insert-command-undo-counter 1)
  16908. (if (>= org-self-insert-command-undo-counter 20)
  16909. (setq org-self-insert-command-undo-counter 1)
  16910. (and (> org-self-insert-command-undo-counter 0)
  16911. buffer-undo-list (listp buffer-undo-list)
  16912. (not (cadr buffer-undo-list)) ; remove nil entry
  16913. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  16914. (setq org-self-insert-command-undo-counter
  16915. (1+ org-self-insert-command-undo-counter))))))))
  16916. (defun org-check-before-invisible-edit (kind)
  16917. "Check is editing if kind KIND would be dangerous with invisible text around.
  16918. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  16919. ;; First, try to get out of here as quickly as possible, to reduce overhead
  16920. (if (and org-catch-invisible-edits
  16921. (or (not (boundp 'visible-mode)) (not visible-mode))
  16922. (or (get-char-property (point) 'invisible)
  16923. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  16924. ;; OK, we need to take a closer look
  16925. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  16926. (invisible-before-point (if (bobp) nil (get-char-property
  16927. (1- (point)) 'invisible)))
  16928. (border-and-ok-direction
  16929. (or
  16930. ;; Check if we are acting predictably before invisible text
  16931. (and invisible-at-point (not invisible-before-point)
  16932. (memq kind '(insert delete-backward)))
  16933. ;; Check if we are acting predictably after invisible text
  16934. ;; This works not well, and I have turned it off. It seems
  16935. ;; better to always show and stop after invisible text.
  16936. ;; (and (not invisible-at-point) invisible-before-point
  16937. ;; (memq kind '(insert delete)))
  16938. )))
  16939. (when (or (memq invisible-at-point '(outline org-hide-block t))
  16940. (memq invisible-before-point '(outline org-hide-block t)))
  16941. (if (eq org-catch-invisible-edits 'error)
  16942. (error "Editing in invisible areas is prohibited - make visible first"))
  16943. (if (and org-custom-properties-overlays
  16944. (y-or-n-p "Display invisible properties in this buffer? "))
  16945. (org-toggle-custom-properties-visibility)
  16946. ;; Make the area visible
  16947. (save-excursion
  16948. (if invisible-before-point
  16949. (goto-char (previous-single-char-property-change
  16950. (point) 'invisible)))
  16951. (org-cycle))
  16952. (cond
  16953. ((eq org-catch-invisible-edits 'show)
  16954. ;; That's it, we do the edit after showing
  16955. (message
  16956. "Unfolding invisible region around point before editing")
  16957. (sit-for 1))
  16958. ((and (eq org-catch-invisible-edits 'smart)
  16959. border-and-ok-direction)
  16960. (message "Unfolding invisible region around point before editing"))
  16961. (t
  16962. ;; Don't do the edit, make the user repeat it in full visibility
  16963. (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  16964. (defun org-fix-tags-on-the-fly ()
  16965. (when (and (equal (char-after (point-at-bol)) ?*)
  16966. (org-at-heading-p))
  16967. (org-align-tags-here org-tags-column)))
  16968. (defun org-delete-backward-char (N)
  16969. "Like `delete-backward-char', insert whitespace at field end in tables.
  16970. When deleting backwards, in tables this function will insert whitespace in
  16971. front of the next \"|\" separator, to keep the table aligned. The table will
  16972. still be marked for re-alignment if the field did fill the entire column,
  16973. because, in this case the deletion might narrow the column."
  16974. (interactive "p")
  16975. (org-check-before-invisible-edit 'delete-backward)
  16976. (if (and (org-table-p)
  16977. (eq N 1)
  16978. (string-match "|" (buffer-substring (point-at-bol) (point)))
  16979. (looking-at ".*?|"))
  16980. (let ((pos (point))
  16981. (noalign (looking-at "[^|\n\r]* |"))
  16982. (c org-table-may-need-update))
  16983. (backward-delete-char N)
  16984. (if (not overwrite-mode)
  16985. (progn
  16986. (skip-chars-forward "^|")
  16987. (insert " ")
  16988. (goto-char (1- pos))))
  16989. ;; noalign: if there were two spaces at the end, this field
  16990. ;; does not determine the width of the column.
  16991. (if noalign (setq org-table-may-need-update c)))
  16992. (backward-delete-char N)
  16993. (org-fix-tags-on-the-fly)))
  16994. (defun org-delete-char (N)
  16995. "Like `delete-char', but insert whitespace at field end in tables.
  16996. When deleting characters, in tables this function will insert whitespace in
  16997. front of the next \"|\" separator, to keep the table aligned. The table will
  16998. still be marked for re-alignment if the field did fill the entire column,
  16999. because, in this case the deletion might narrow the column."
  17000. (interactive "p")
  17001. (org-check-before-invisible-edit 'delete)
  17002. (if (and (org-table-p)
  17003. (not (bolp))
  17004. (not (= (char-after) ?|))
  17005. (eq N 1))
  17006. (if (looking-at ".*?|")
  17007. (let ((pos (point))
  17008. (noalign (looking-at "[^|\n\r]* |"))
  17009. (c org-table-may-need-update))
  17010. (replace-match (concat
  17011. (substring (match-string 0) 1 -1)
  17012. " |"))
  17013. (goto-char pos)
  17014. ;; noalign: if there were two spaces at the end, this field
  17015. ;; does not determine the width of the column.
  17016. (if noalign (setq org-table-may-need-update c)))
  17017. (delete-char N))
  17018. (delete-char N)
  17019. (org-fix-tags-on-the-fly)))
  17020. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  17021. (put 'org-self-insert-command 'delete-selection t)
  17022. (put 'orgtbl-self-insert-command 'delete-selection t)
  17023. (put 'org-delete-char 'delete-selection 'supersede)
  17024. (put 'org-delete-backward-char 'delete-selection 'supersede)
  17025. (put 'org-yank 'delete-selection 'yank)
  17026. ;; Make `flyspell-mode' delay after some commands
  17027. (put 'org-self-insert-command 'flyspell-delayed t)
  17028. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  17029. (put 'org-delete-char 'flyspell-delayed t)
  17030. (put 'org-delete-backward-char 'flyspell-delayed t)
  17031. ;; Make pabbrev-mode expand after org-mode commands
  17032. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  17033. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  17034. ;; How to do this: Measure non-white length of current string
  17035. ;; If equal to column width, we should realign.
  17036. (defun org-remap (map &rest commands)
  17037. "In MAP, remap the functions given in COMMANDS.
  17038. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  17039. (let (new old)
  17040. (while commands
  17041. (setq old (pop commands) new (pop commands))
  17042. (if (fboundp 'command-remapping)
  17043. (org-defkey map (vector 'remap old) new)
  17044. (substitute-key-definition old new map global-map)))))
  17045. (when (eq org-enable-table-editor 'optimized)
  17046. ;; If the user wants maximum table support, we need to hijack
  17047. ;; some standard editing functions
  17048. (org-remap org-mode-map
  17049. 'self-insert-command 'org-self-insert-command
  17050. 'delete-char 'org-delete-char
  17051. 'delete-backward-char 'org-delete-backward-char)
  17052. (org-defkey org-mode-map "|" 'org-force-self-insert))
  17053. (defvar org-ctrl-c-ctrl-c-hook nil
  17054. "Hook for functions attaching themselves to `C-c C-c'.
  17055. This can be used to add additional functionality to the C-c C-c
  17056. key which executes context-dependent commands. This hook is run
  17057. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  17058. run after the last test.
  17059. Each function will be called with no arguments. The function
  17060. must check if the context is appropriate for it to act. If yes,
  17061. it should do its thing and then return a non-nil value. If the
  17062. context is wrong, just do nothing and return nil.")
  17063. (defvar org-ctrl-c-ctrl-c-final-hook nil
  17064. "Hook for functions attaching themselves to `C-c C-c'.
  17065. This can be used to add additional functionality to the C-c C-c
  17066. key which executes context-dependent commands. This hook is run
  17067. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  17068. before the first test.
  17069. Each function will be called with no arguments. The function
  17070. must check if the context is appropriate for it to act. If yes,
  17071. it should do its thing and then return a non-nil value. If the
  17072. context is wrong, just do nothing and return nil.")
  17073. (defvar org-tab-first-hook nil
  17074. "Hook for functions to attach themselves to TAB.
  17075. See `org-ctrl-c-ctrl-c-hook' for more information.
  17076. This hook runs as the first action when TAB is pressed, even before
  17077. `org-cycle' messes around with the `outline-regexp' to cater for
  17078. inline tasks and plain list item folding.
  17079. If any function in this hook returns t, any other actions that
  17080. would have been caused by TAB (such as table field motion or visibility
  17081. cycling) will not occur.")
  17082. (defvar org-tab-after-check-for-table-hook nil
  17083. "Hook for functions to attach themselves to TAB.
  17084. See `org-ctrl-c-ctrl-c-hook' for more information.
  17085. This hook runs after it has been established that the cursor is not in a
  17086. table, but before checking if the cursor is in a headline or if global cycling
  17087. should be done.
  17088. If any function in this hook returns t, not other actions like visibility
  17089. cycling will be done.")
  17090. (defvar org-tab-after-check-for-cycling-hook nil
  17091. "Hook for functions to attach themselves to TAB.
  17092. See `org-ctrl-c-ctrl-c-hook' for more information.
  17093. This hook runs after it has been established that not table field motion and
  17094. not visibility should be done because of current context. This is probably
  17095. the place where a package like yasnippets can hook in.")
  17096. (defvar org-tab-before-tab-emulation-hook nil
  17097. "Hook for functions to attach themselves to TAB.
  17098. See `org-ctrl-c-ctrl-c-hook' for more information.
  17099. This hook runs after every other options for TAB have been exhausted, but
  17100. before indentation and \t insertion takes place.")
  17101. (defvar org-metaleft-hook nil
  17102. "Hook for functions attaching themselves to `M-left'.
  17103. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17104. (defvar org-metaright-hook nil
  17105. "Hook for functions attaching themselves to `M-right'.
  17106. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17107. (defvar org-metaup-hook nil
  17108. "Hook for functions attaching themselves to `M-up'.
  17109. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17110. (defvar org-metadown-hook nil
  17111. "Hook for functions attaching themselves to `M-down'.
  17112. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17113. (defvar org-shiftmetaleft-hook nil
  17114. "Hook for functions attaching themselves to `M-S-left'.
  17115. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17116. (defvar org-shiftmetaright-hook nil
  17117. "Hook for functions attaching themselves to `M-S-right'.
  17118. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17119. (defvar org-shiftmetaup-hook nil
  17120. "Hook for functions attaching themselves to `M-S-up'.
  17121. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17122. (defvar org-shiftmetadown-hook nil
  17123. "Hook for functions attaching themselves to `M-S-down'.
  17124. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17125. (defvar org-metareturn-hook nil
  17126. "Hook for functions attaching themselves to `M-RET'.
  17127. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17128. (defvar org-shiftup-hook nil
  17129. "Hook for functions attaching themselves to `S-up'.
  17130. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17131. (defvar org-shiftup-final-hook nil
  17132. "Hook for functions attaching themselves to `S-up'.
  17133. This one runs after all other options except shift-select have been excluded.
  17134. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17135. (defvar org-shiftdown-hook nil
  17136. "Hook for functions attaching themselves to `S-down'.
  17137. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17138. (defvar org-shiftdown-final-hook nil
  17139. "Hook for functions attaching themselves to `S-down'.
  17140. This one runs after all other options except shift-select have been excluded.
  17141. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17142. (defvar org-shiftleft-hook nil
  17143. "Hook for functions attaching themselves to `S-left'.
  17144. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17145. (defvar org-shiftleft-final-hook nil
  17146. "Hook for functions attaching themselves to `S-left'.
  17147. This one runs after all other options except shift-select have been excluded.
  17148. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17149. (defvar org-shiftright-hook nil
  17150. "Hook for functions attaching themselves to `S-right'.
  17151. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17152. (defvar org-shiftright-final-hook nil
  17153. "Hook for functions attaching themselves to `S-right'.
  17154. This one runs after all other options except shift-select have been excluded.
  17155. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17156. (defun org-modifier-cursor-error ()
  17157. "Throw an error, a modified cursor command was applied in wrong context."
  17158. (error "This command is active in special context like tables, headlines or items"))
  17159. (defun org-shiftselect-error ()
  17160. "Throw an error because Shift-Cursor command was applied in wrong context."
  17161. (if (and (boundp 'shift-select-mode) shift-select-mode)
  17162. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  17163. (error "This command works only in special context like headlines or timestamps")))
  17164. (defun org-call-for-shift-select (cmd)
  17165. (let ((this-command-keys-shift-translated t))
  17166. (call-interactively cmd)))
  17167. (defun org-shifttab (&optional arg)
  17168. "Global visibility cycling or move to previous table field.
  17169. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  17170. on context.
  17171. See the individual commands for more information."
  17172. (interactive "P")
  17173. (cond
  17174. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  17175. ((integerp arg)
  17176. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  17177. (message "Content view to level: %d" arg)
  17178. (org-content (prefix-numeric-value arg2))
  17179. (setq org-cycle-global-status 'overview)))
  17180. (t (call-interactively 'org-global-cycle))))
  17181. (defun org-shiftmetaleft ()
  17182. "Promote subtree or delete table column.
  17183. Calls `org-promote-subtree', `org-outdent-item-tree', or
  17184. `org-table-delete-column', depending on context. See the
  17185. individual commands for more information."
  17186. (interactive)
  17187. (cond
  17188. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  17189. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  17190. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  17191. ((if (not (org-region-active-p)) (org-at-item-p)
  17192. (save-excursion (goto-char (region-beginning))
  17193. (org-at-item-p)))
  17194. (call-interactively 'org-outdent-item-tree))
  17195. (t (org-modifier-cursor-error))))
  17196. (defun org-shiftmetaright ()
  17197. "Demote subtree or insert table column.
  17198. Calls `org-demote-subtree', `org-indent-item-tree', or
  17199. `org-table-insert-column', depending on context. See the
  17200. individual commands for more information."
  17201. (interactive)
  17202. (cond
  17203. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  17204. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  17205. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  17206. ((if (not (org-region-active-p)) (org-at-item-p)
  17207. (save-excursion (goto-char (region-beginning))
  17208. (org-at-item-p)))
  17209. (call-interactively 'org-indent-item-tree))
  17210. (t (org-modifier-cursor-error))))
  17211. (defun org-shiftmetaup (&optional arg)
  17212. "Move subtree up or kill table row.
  17213. Calls `org-move-subtree-up' or `org-table-kill-row' or
  17214. `org-move-item-up' or `org-timestamp-up', depending on context.
  17215. See the individual commands for more information."
  17216. (interactive "P")
  17217. (cond
  17218. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  17219. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  17220. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17221. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17222. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17223. (call-interactively 'org-timestamp-up)))
  17224. (t (org-modifier-cursor-error))))
  17225. (defun org-shiftmetadown (&optional arg)
  17226. "Move subtree down or insert table row.
  17227. Calls `org-move-subtree-down' or `org-table-insert-row' or
  17228. `org-move-item-down' or `org-timestamp-up', depending on context.
  17229. See the individual commands for more information."
  17230. (interactive "P")
  17231. (cond
  17232. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  17233. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  17234. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17235. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17236. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17237. (call-interactively 'org-timestamp-down)))
  17238. (t (org-modifier-cursor-error))))
  17239. (defsubst org-hidden-tree-error ()
  17240. (error
  17241. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  17242. (defun org-metaleft (&optional arg)
  17243. "Promote heading or move table column to left.
  17244. Calls `org-do-promote' or `org-table-move-column', depending on context.
  17245. With no specific context, calls the Emacs default `backward-word'.
  17246. See the individual commands for more information."
  17247. (interactive "P")
  17248. (cond
  17249. ((run-hook-with-args-until-success 'org-metaleft-hook))
  17250. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  17251. ((org-with-limited-levels
  17252. (or (org-at-heading-p)
  17253. (and (org-region-active-p)
  17254. (save-excursion
  17255. (goto-char (region-beginning))
  17256. (org-at-heading-p)))))
  17257. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17258. (call-interactively 'org-do-promote))
  17259. ;; At an inline task.
  17260. ((org-at-heading-p)
  17261. (call-interactively 'org-inlinetask-promote))
  17262. ((or (org-at-item-p)
  17263. (and (org-region-active-p)
  17264. (save-excursion
  17265. (goto-char (region-beginning))
  17266. (org-at-item-p))))
  17267. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17268. (call-interactively 'org-outdent-item))
  17269. (t (call-interactively 'backward-word))))
  17270. (defun org-metaright (&optional arg)
  17271. "Demote a subtree, a list item or move table column to right.
  17272. In front of a drawer or a block keyword, indent it correctly.
  17273. With no specific context, calls the Emacs default `forward-word'.
  17274. See the individual commands for more information."
  17275. (interactive "P")
  17276. (cond
  17277. ((run-hook-with-args-until-success 'org-metaright-hook))
  17278. ((org-at-table-p) (call-interactively 'org-table-move-column))
  17279. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  17280. ((org-at-block-p) (call-interactively 'org-indent-block))
  17281. ((org-with-limited-levels
  17282. (or (org-at-heading-p)
  17283. (and (org-region-active-p)
  17284. (save-excursion
  17285. (goto-char (region-beginning))
  17286. (org-at-heading-p)))))
  17287. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17288. (call-interactively 'org-do-demote))
  17289. ;; At an inline task.
  17290. ((org-at-heading-p)
  17291. (call-interactively 'org-inlinetask-demote))
  17292. ((or (org-at-item-p)
  17293. (and (org-region-active-p)
  17294. (save-excursion
  17295. (goto-char (region-beginning))
  17296. (org-at-item-p))))
  17297. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17298. (call-interactively 'org-indent-item))
  17299. (t (call-interactively 'forward-word))))
  17300. (defun org-check-for-hidden (what)
  17301. "Check if there are hidden headlines/items in the current visual line.
  17302. WHAT can be either `headlines' or `items'. If the current line is
  17303. an outline or item heading and it has a folded subtree below it,
  17304. this function returns t, nil otherwise."
  17305. (let ((re (cond
  17306. ((eq what 'headlines) org-outline-regexp-bol)
  17307. ((eq what 'items) (org-item-beginning-re))
  17308. (t (error "This should not happen"))))
  17309. beg end)
  17310. (save-excursion
  17311. (catch 'exit
  17312. (unless (org-region-active-p)
  17313. (setq beg (point-at-bol))
  17314. (beginning-of-line 2)
  17315. (while (and (not (eobp)) ;; this is like `next-line'
  17316. (get-char-property (1- (point)) 'invisible))
  17317. (beginning-of-line 2))
  17318. (setq end (point))
  17319. (goto-char beg)
  17320. (goto-char (point-at-eol))
  17321. (setq end (max end (point)))
  17322. (while (re-search-forward re end t)
  17323. (if (get-char-property (match-beginning 0) 'invisible)
  17324. (throw 'exit t))))
  17325. nil))))
  17326. (autoload 'org-element-at-point "org-element")
  17327. (declare-function org-element-at-point "org-element" (&optional keep-trail))
  17328. (declare-function org-element-type "org-element" (element))
  17329. (declare-function org-element-context "org-element" ())
  17330. (declare-function org-element-contents "org-element" (element))
  17331. (declare-function org-element-property "org-element" (property element))
  17332. (declare-function org-element-paragraph-parser "org-element" (limit))
  17333. (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
  17334. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  17335. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  17336. (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
  17337. (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
  17338. (defun org-metaup (&optional arg)
  17339. "Move subtree up or move table row up.
  17340. Calls `org-move-subtree-up' or `org-table-move-row' or
  17341. `org-move-item-up', depending on context. See the individual commands
  17342. for more information."
  17343. (interactive "P")
  17344. (cond
  17345. ((run-hook-with-args-until-success 'org-metaup-hook))
  17346. ((org-region-active-p)
  17347. (let* ((a (min (region-beginning) (region-end)))
  17348. (b (1- (max (region-beginning) (region-end))))
  17349. (c (save-excursion (goto-char a)
  17350. (move-beginning-of-line 0)))
  17351. (d (save-excursion (goto-char a)
  17352. (move-end-of-line 0) (point))))
  17353. (transpose-regions a b c d)
  17354. (goto-char c)))
  17355. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  17356. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17357. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17358. (t (org-drag-element-backward))))
  17359. (defun org-metadown (&optional arg)
  17360. "Move subtree down or move table row down.
  17361. Calls `org-move-subtree-down' or `org-table-move-row' or
  17362. `org-move-item-down', depending on context. See the individual
  17363. commands for more information."
  17364. (interactive "P")
  17365. (cond
  17366. ((run-hook-with-args-until-success 'org-metadown-hook))
  17367. ((org-region-active-p)
  17368. (let* ((a (min (region-beginning) (region-end)))
  17369. (b (max (region-beginning) (region-end)))
  17370. (c (save-excursion (goto-char b)
  17371. (move-beginning-of-line 1)))
  17372. (d (save-excursion (goto-char b)
  17373. (move-end-of-line 1) (1+ (point)))))
  17374. (transpose-regions a b c d)
  17375. (goto-char d)))
  17376. ((org-at-table-p) (call-interactively 'org-table-move-row))
  17377. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17378. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17379. (t (org-drag-element-forward))))
  17380. (defun org-shiftup (&optional arg)
  17381. "Increase item in timestamp or increase priority of current headline.
  17382. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  17383. depending on context. See the individual commands for more information."
  17384. (interactive "P")
  17385. (cond
  17386. ((run-hook-with-args-until-success 'org-shiftup-hook))
  17387. ((and org-support-shift-select (org-region-active-p))
  17388. (org-call-for-shift-select 'previous-line))
  17389. ((org-at-timestamp-p t)
  17390. (call-interactively (if org-edit-timestamp-down-means-later
  17391. 'org-timestamp-down 'org-timestamp-up)))
  17392. ((and (not (eq org-support-shift-select 'always))
  17393. org-enable-priority-commands
  17394. (org-at-heading-p))
  17395. (call-interactively 'org-priority-up))
  17396. ((and (not org-support-shift-select) (org-at-item-p))
  17397. (call-interactively 'org-previous-item))
  17398. ((org-clocktable-try-shift 'up arg))
  17399. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  17400. (org-support-shift-select
  17401. (org-call-for-shift-select 'previous-line))
  17402. (t (org-shiftselect-error))))
  17403. (defun org-shiftdown (&optional arg)
  17404. "Decrease item in timestamp or decrease priority of current headline.
  17405. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  17406. depending on context. See the individual commands for more information."
  17407. (interactive "P")
  17408. (cond
  17409. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  17410. ((and org-support-shift-select (org-region-active-p))
  17411. (org-call-for-shift-select 'next-line))
  17412. ((org-at-timestamp-p t)
  17413. (call-interactively (if org-edit-timestamp-down-means-later
  17414. 'org-timestamp-up 'org-timestamp-down)))
  17415. ((and (not (eq org-support-shift-select 'always))
  17416. org-enable-priority-commands
  17417. (org-at-heading-p))
  17418. (call-interactively 'org-priority-down))
  17419. ((and (not org-support-shift-select) (org-at-item-p))
  17420. (call-interactively 'org-next-item))
  17421. ((org-clocktable-try-shift 'down arg))
  17422. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  17423. (org-support-shift-select
  17424. (org-call-for-shift-select 'next-line))
  17425. (t (org-shiftselect-error))))
  17426. (defun org-shiftright (&optional arg)
  17427. "Cycle the thing at point or in the current line, depending on context.
  17428. Depending on context, this does one of the following:
  17429. - switch a timestamp at point one day into the future
  17430. - on a headline, switch to the next TODO keyword.
  17431. - on an item, switch entire list to the next bullet type
  17432. - on a property line, switch to the next allowed value
  17433. - on a clocktable definition line, move time block into the future"
  17434. (interactive "P")
  17435. (cond
  17436. ((run-hook-with-args-until-success 'org-shiftright-hook))
  17437. ((and org-support-shift-select (org-region-active-p))
  17438. (org-call-for-shift-select 'forward-char))
  17439. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  17440. ((and (not (eq org-support-shift-select 'always))
  17441. (org-at-heading-p))
  17442. (let ((org-inhibit-logging
  17443. (not org-treat-S-cursor-todo-selection-as-state-change))
  17444. (org-inhibit-blocking
  17445. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17446. (org-call-with-arg 'org-todo 'right)))
  17447. ((or (and org-support-shift-select
  17448. (not (eq org-support-shift-select 'always))
  17449. (org-at-item-bullet-p))
  17450. (and (not org-support-shift-select) (org-at-item-p)))
  17451. (org-call-with-arg 'org-cycle-list-bullet nil))
  17452. ((and (not (eq org-support-shift-select 'always))
  17453. (org-at-property-p))
  17454. (call-interactively 'org-property-next-allowed-value))
  17455. ((org-clocktable-try-shift 'right arg))
  17456. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  17457. (org-support-shift-select
  17458. (org-call-for-shift-select 'forward-char))
  17459. (t (org-shiftselect-error))))
  17460. (defun org-shiftleft (&optional arg)
  17461. "Cycle the thing at point or in the current line, depending on context.
  17462. Depending on context, this does one of the following:
  17463. - switch a timestamp at point one day into the past
  17464. - on a headline, switch to the previous TODO keyword.
  17465. - on an item, switch entire list to the previous bullet type
  17466. - on a property line, switch to the previous allowed value
  17467. - on a clocktable definition line, move time block into the past"
  17468. (interactive "P")
  17469. (cond
  17470. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  17471. ((and org-support-shift-select (org-region-active-p))
  17472. (org-call-for-shift-select 'backward-char))
  17473. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  17474. ((and (not (eq org-support-shift-select 'always))
  17475. (org-at-heading-p))
  17476. (let ((org-inhibit-logging
  17477. (not org-treat-S-cursor-todo-selection-as-state-change))
  17478. (org-inhibit-blocking
  17479. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17480. (org-call-with-arg 'org-todo 'left)))
  17481. ((or (and org-support-shift-select
  17482. (not (eq org-support-shift-select 'always))
  17483. (org-at-item-bullet-p))
  17484. (and (not org-support-shift-select) (org-at-item-p)))
  17485. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  17486. ((and (not (eq org-support-shift-select 'always))
  17487. (org-at-property-p))
  17488. (call-interactively 'org-property-previous-allowed-value))
  17489. ((org-clocktable-try-shift 'left arg))
  17490. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  17491. (org-support-shift-select
  17492. (org-call-for-shift-select 'backward-char))
  17493. (t (org-shiftselect-error))))
  17494. (defun org-shiftcontrolright ()
  17495. "Switch to next TODO set."
  17496. (interactive)
  17497. (cond
  17498. ((and org-support-shift-select (org-region-active-p))
  17499. (org-call-for-shift-select 'forward-word))
  17500. ((and (not (eq org-support-shift-select 'always))
  17501. (org-at-heading-p))
  17502. (org-call-with-arg 'org-todo 'nextset))
  17503. (org-support-shift-select
  17504. (org-call-for-shift-select 'forward-word))
  17505. (t (org-shiftselect-error))))
  17506. (defun org-shiftcontrolleft ()
  17507. "Switch to previous TODO set."
  17508. (interactive)
  17509. (cond
  17510. ((and org-support-shift-select (org-region-active-p))
  17511. (org-call-for-shift-select 'backward-word))
  17512. ((and (not (eq org-support-shift-select 'always))
  17513. (org-at-heading-p))
  17514. (org-call-with-arg 'org-todo 'previousset))
  17515. (org-support-shift-select
  17516. (org-call-for-shift-select 'backward-word))
  17517. (t (org-shiftselect-error))))
  17518. (defun org-shiftcontrolup ()
  17519. "Change timestamps synchronously up in CLOCK log lines."
  17520. (interactive)
  17521. (cond ((and (not org-support-shift-select)
  17522. (org-at-clock-log-p)
  17523. (org-at-timestamp-p t))
  17524. (org-clock-timestamps-up))
  17525. (t (org-shiftselect-error))))
  17526. (defun org-shiftcontroldown ()
  17527. "Change timestamps synchronously down in CLOCK log lines."
  17528. (interactive)
  17529. (cond ((and (not org-support-shift-select)
  17530. (org-at-clock-log-p)
  17531. (org-at-timestamp-p t))
  17532. (org-clock-timestamps-down))
  17533. (t (org-shiftselect-error))))
  17534. (defun org-ctrl-c-ret ()
  17535. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  17536. (interactive)
  17537. (cond
  17538. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  17539. (t (call-interactively 'org-insert-heading))))
  17540. (defun org-find-visible ()
  17541. (let ((s (point)))
  17542. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17543. (get-char-property s 'invisible)))
  17544. s))
  17545. (defun org-find-invisible ()
  17546. (let ((s (point)))
  17547. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17548. (not (get-char-property s 'invisible))))
  17549. s))
  17550. (defun org-copy-visible (beg end)
  17551. "Copy the visible parts of the region."
  17552. (interactive "r")
  17553. (let (snippets s)
  17554. (save-excursion
  17555. (save-restriction
  17556. (narrow-to-region beg end)
  17557. (setq s (goto-char (point-min)))
  17558. (while (not (= (point) (point-max)))
  17559. (goto-char (org-find-invisible))
  17560. (push (buffer-substring s (point)) snippets)
  17561. (setq s (goto-char (org-find-visible))))))
  17562. (kill-new (apply 'concat (nreverse snippets)))))
  17563. (defun org-copy-special ()
  17564. "Copy region in table or copy current subtree.
  17565. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  17566. See the individual commands for more information."
  17567. (interactive)
  17568. (call-interactively
  17569. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  17570. (defun org-cut-special ()
  17571. "Cut region in table or cut current subtree.
  17572. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  17573. See the individual commands for more information."
  17574. (interactive)
  17575. (call-interactively
  17576. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  17577. (defun org-paste-special (arg)
  17578. "Paste rectangular region into table, or past subtree relative to level.
  17579. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  17580. See the individual commands for more information."
  17581. (interactive "P")
  17582. (if (org-at-table-p)
  17583. (org-table-paste-rectangle)
  17584. (org-paste-subtree arg)))
  17585. (defun org-edit-special (&optional arg)
  17586. "Call a special editor for the stuff at point.
  17587. When at a table, call the formula editor with `org-table-edit-formulas'.
  17588. When at the first line of an src example, call `org-edit-src-code'.
  17589. When in an #+include line, visit the include file. Otherwise call
  17590. `ffap' to visit the file at point."
  17591. (interactive)
  17592. ;; possibly prep session before editing source
  17593. (when arg
  17594. (let* ((info (org-babel-get-src-block-info))
  17595. (lang (nth 0 info))
  17596. (params (nth 2 info))
  17597. (session (cdr (assoc :session params))))
  17598. (when (and info session) ;; we are in a source-code block with a session
  17599. (funcall
  17600. (intern (concat "org-babel-prep-session:" lang)) session params))))
  17601. (cond ;; proceed with `org-edit-special'
  17602. ((save-excursion
  17603. (beginning-of-line 1)
  17604. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  17605. (find-file (org-trim (match-string 1))))
  17606. ((org-edit-src-code))
  17607. ((org-edit-fixed-width-region))
  17608. ((org-at-table.el-p)
  17609. (org-edit-src-code))
  17610. ((or (org-at-table-p)
  17611. (save-excursion
  17612. (beginning-of-line 1)
  17613. (let ((case-fold-search )) (looking-at "[ \t]*#\\+tblfm:"))))
  17614. (call-interactively 'org-table-edit-formulas))
  17615. (t (call-interactively 'ffap))))
  17616. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  17617. (defun org-ctrl-c-ctrl-c (&optional arg)
  17618. "Set tags in headline, or update according to changed information at point.
  17619. This command does many different things, depending on context:
  17620. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  17621. this is what we do.
  17622. - If the cursor is on a statistics cookie, update it.
  17623. - If the cursor is in a headline, prompt for tags and insert them
  17624. into the current line, aligned to `org-tags-column'. When called
  17625. with prefix arg, realign all tags in the current buffer.
  17626. - If the cursor is in one of the special #+KEYWORD lines, this
  17627. triggers scanning the buffer for these lines and updating the
  17628. information.
  17629. - If the cursor is inside a table, realign the table. This command
  17630. works even if the automatic table editor has been turned off.
  17631. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  17632. the entire table.
  17633. - If the cursor is at a footnote reference or definition, jump to
  17634. the corresponding definition or references, respectively.
  17635. - If the cursor is a the beginning of a dynamic block, update it.
  17636. - If the current buffer is a capture buffer, close note and file it.
  17637. - If the cursor is on a <<<target>>>, update radio targets and
  17638. corresponding links in this buffer.
  17639. - If the cursor is on a numbered item in a plain list, renumber the
  17640. ordered list.
  17641. - If the cursor is on a checkbox, toggle it.
  17642. - If the cursor is on a code block, evaluate it. The variable
  17643. `org-confirm-babel-evaluate' can be used to control prompting
  17644. before code block evaluation, by default every code block
  17645. evaluation requires confirmation. Code block evaluation can be
  17646. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  17647. (interactive "P")
  17648. (let ((org-enable-table-editor t))
  17649. (cond
  17650. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  17651. org-occur-highlights
  17652. org-latex-fragment-image-overlays)
  17653. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  17654. (org-remove-occur-highlights)
  17655. (org-remove-latex-fragment-image-overlays)
  17656. (message "Temporary highlights/overlays removed from current buffer"))
  17657. ((and (local-variable-p 'org-finish-function (current-buffer))
  17658. (fboundp org-finish-function))
  17659. (funcall org-finish-function))
  17660. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  17661. ((org-in-regexp org-ts-regexp-both)
  17662. (org-timestamp-change 0 'day))
  17663. ((or (looking-at org-property-start-re)
  17664. (org-at-property-p))
  17665. (call-interactively 'org-property-action))
  17666. ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
  17667. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  17668. (or (org-at-heading-p) (org-at-item-p)))
  17669. (call-interactively 'org-update-statistics-cookies))
  17670. ((org-at-heading-p) (call-interactively 'org-set-tags))
  17671. ((org-at-table.el-p)
  17672. (message "Use C-c ' to edit table.el tables"))
  17673. ((org-at-table-p)
  17674. (org-table-maybe-eval-formula)
  17675. (if arg
  17676. (call-interactively 'org-table-recalculate)
  17677. (org-table-maybe-recalculate-line))
  17678. (call-interactively 'org-table-align)
  17679. (orgtbl-send-table 'maybe))
  17680. ((or (org-footnote-at-reference-p)
  17681. (org-footnote-at-definition-p))
  17682. (call-interactively 'org-footnote-action))
  17683. ((org-at-item-checkbox-p)
  17684. ;; Cursor at a checkbox: repair list and update checkboxes. Send
  17685. ;; list only if at top item.
  17686. (let* ((cbox (match-string 1))
  17687. (struct (org-list-struct))
  17688. (old-struct (copy-tree struct))
  17689. (parents (org-list-parents-alist struct))
  17690. (orderedp (org-entry-get nil "ORDERED"))
  17691. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17692. block-item)
  17693. ;; Use a light version of `org-toggle-checkbox' to avoid
  17694. ;; computing list structure twice.
  17695. (let ((new-box (cond
  17696. ((equal arg '(16)) "[-]")
  17697. ((equal arg '(4)) nil)
  17698. ((equal "[X]" cbox) "[ ]")
  17699. (t "[X]"))))
  17700. (if (and firstp arg)
  17701. ;; If at first item of sub-list, remove check-box from
  17702. ;; every item at the same level.
  17703. (mapc
  17704. (lambda (pos) (org-list-set-checkbox pos struct new-box))
  17705. (org-list-get-all-items
  17706. (point-at-bol) struct (org-list-prevs-alist struct)))
  17707. (org-list-set-checkbox (point-at-bol) struct new-box)))
  17708. ;; Replicate `org-list-write-struct', while grabbing a return
  17709. ;; value from `org-list-struct-fix-box'.
  17710. (org-list-struct-fix-ind struct parents 2)
  17711. (org-list-struct-fix-item-end struct)
  17712. (let ((prevs (org-list-prevs-alist struct)))
  17713. (org-list-struct-fix-bul struct prevs)
  17714. (org-list-struct-fix-ind struct parents)
  17715. (setq block-item
  17716. (org-list-struct-fix-box struct parents prevs orderedp)))
  17717. (org-list-struct-apply-struct struct old-struct)
  17718. (org-update-checkbox-count-maybe)
  17719. (when block-item
  17720. (message
  17721. "Checkboxes were removed due to unchecked box at line %d"
  17722. (org-current-line block-item)))
  17723. (when firstp (org-list-send-list 'maybe))))
  17724. ((org-at-item-p)
  17725. ;; Cursor at an item: repair list. Do checkbox related actions
  17726. ;; only if function was called with an argument. Send list only
  17727. ;; if at top item.
  17728. (let* ((struct (org-list-struct))
  17729. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17730. old-struct)
  17731. (when arg
  17732. (setq old-struct (copy-tree struct))
  17733. (if firstp
  17734. ;; If at first item of sub-list, add check-box to every
  17735. ;; item at the same level.
  17736. (mapc
  17737. (lambda (pos)
  17738. (unless (org-list-get-checkbox pos struct)
  17739. (org-list-set-checkbox pos struct "[ ]")))
  17740. (org-list-get-all-items
  17741. (point-at-bol) struct (org-list-prevs-alist struct)))
  17742. (org-list-set-checkbox (point-at-bol) struct "[ ]")))
  17743. (org-list-write-struct
  17744. struct (org-list-parents-alist struct) old-struct)
  17745. (when arg (org-update-checkbox-count-maybe))
  17746. (when firstp (org-list-send-list 'maybe))))
  17747. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  17748. ;; Dynamic block
  17749. (beginning-of-line 1)
  17750. (save-excursion (org-update-dblock)))
  17751. ((save-excursion
  17752. (let ((case-fold-search t))
  17753. (beginning-of-line 1)
  17754. (looking-at "[ \t]*#\\+\\([a-z]+\\)")))
  17755. (cond
  17756. ((or (equal (match-string 1) "TBLFM")
  17757. (equal (match-string 1) "tblfm"))
  17758. ;; Recalculate the table before this line
  17759. (save-excursion
  17760. (beginning-of-line 1)
  17761. (skip-chars-backward " \r\n\t")
  17762. (if (org-at-table-p)
  17763. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  17764. (t
  17765. (let ((org-inhibit-startup-visibility-stuff t)
  17766. (org-startup-align-all-tables nil))
  17767. (when (boundp 'org-table-coordinate-overlays)
  17768. (mapc 'delete-overlay org-table-coordinate-overlays)
  17769. (setq org-table-coordinate-overlays nil))
  17770. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  17771. (message "Local setup has been refreshed"))))
  17772. ((org-clock-update-time-maybe))
  17773. (t
  17774. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  17775. (error "C-c C-c can do nothing useful at this location"))))))
  17776. (defun org-mode-restart ()
  17777. "Restart Org-mode, to scan again for special lines.
  17778. Also updates the keyword regular expressions."
  17779. (interactive)
  17780. (org-mode)
  17781. (message "Org-mode restarted"))
  17782. (defun org-kill-note-or-show-branches ()
  17783. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  17784. (interactive)
  17785. (if (not org-finish-function)
  17786. (progn
  17787. (hide-subtree)
  17788. (call-interactively 'show-branches))
  17789. (let ((org-note-abort t))
  17790. (funcall org-finish-function))))
  17791. (defun org-return (&optional indent)
  17792. "Goto next table row or insert a newline.
  17793. Calls `org-table-next-row' or `newline', depending on context.
  17794. See the individual commands for more information."
  17795. (interactive)
  17796. (let (org-ts-what)
  17797. (cond
  17798. ((or (bobp) (org-in-src-block-p))
  17799. (if indent (newline-and-indent) (newline)))
  17800. ((org-at-table-p)
  17801. (org-table-justify-field-maybe)
  17802. (call-interactively 'org-table-next-row))
  17803. ;; when `newline-and-indent' is called within a list, make sure
  17804. ;; text moved stays inside the item.
  17805. ((and (org-in-item-p) indent)
  17806. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  17807. (progn
  17808. (save-match-data (newline))
  17809. (org-indent-line-to (length (match-string 0))))
  17810. (let ((ind (org-get-indentation)))
  17811. (newline)
  17812. (if (org-looking-back org-list-end-re)
  17813. (org-indent-line)
  17814. (org-indent-line-to ind)))))
  17815. ((and org-return-follows-link
  17816. (org-at-timestamp-p t)
  17817. (not (eq org-ts-what 'after)))
  17818. (org-follow-timestamp-link))
  17819. ((and org-return-follows-link
  17820. (let ((tprop (get-text-property (point) 'face)))
  17821. (or (eq tprop 'org-link)
  17822. (and (listp tprop) (memq 'org-link tprop)))))
  17823. (call-interactively 'org-open-at-point))
  17824. ((and (org-at-heading-p)
  17825. (looking-at
  17826. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  17827. (org-show-entry)
  17828. (end-of-line 1)
  17829. (newline))
  17830. (t (if indent (newline-and-indent) (newline))))))
  17831. (defun org-return-indent ()
  17832. "Goto next table row or insert a newline and indent.
  17833. Calls `org-table-next-row' or `newline-and-indent', depending on
  17834. context. See the individual commands for more information."
  17835. (interactive)
  17836. (org-return t))
  17837. (defun org-ctrl-c-star ()
  17838. "Compute table, or change heading status of lines.
  17839. Calls `org-table-recalculate' or `org-toggle-heading',
  17840. depending on context."
  17841. (interactive)
  17842. (cond
  17843. ((org-at-table-p)
  17844. (call-interactively 'org-table-recalculate))
  17845. (t
  17846. ;; Convert all lines in region to list items
  17847. (call-interactively 'org-toggle-heading))))
  17848. (defun org-ctrl-c-minus ()
  17849. "Insert separator line in table or modify bullet status of line.
  17850. Also turns a plain line or a region of lines into list items.
  17851. Calls `org-table-insert-hline', `org-toggle-item', or
  17852. `org-cycle-list-bullet', depending on context."
  17853. (interactive)
  17854. (cond
  17855. ((org-at-table-p)
  17856. (call-interactively 'org-table-insert-hline))
  17857. ((org-region-active-p)
  17858. (call-interactively 'org-toggle-item))
  17859. ((org-in-item-p)
  17860. (call-interactively 'org-cycle-list-bullet))
  17861. (t
  17862. (call-interactively 'org-toggle-item))))
  17863. (defun org-toggle-item (arg)
  17864. "Convert headings or normal lines to items, items to normal lines.
  17865. If there is no active region, only the current line is considered.
  17866. If the first non blank line in the region is an headline, convert
  17867. all headlines to items, shifting text accordingly.
  17868. If it is an item, convert all items to normal lines.
  17869. If it is normal text, change region into an item. With a prefix
  17870. argument ARG, change each line in region into an item."
  17871. (interactive "P")
  17872. (let ((shift-text
  17873. (function
  17874. ;; Shift text in current section to IND, from point to END.
  17875. ;; The function leaves point to END line.
  17876. (lambda (ind end)
  17877. (let ((min-i 1000) (end (copy-marker end)))
  17878. ;; First determine the minimum indentation (MIN-I) of
  17879. ;; the text.
  17880. (save-excursion
  17881. (catch 'exit
  17882. (while (< (point) end)
  17883. (let ((i (org-get-indentation)))
  17884. (cond
  17885. ;; Skip blank lines and inline tasks.
  17886. ((looking-at "^[ \t]*$"))
  17887. ((looking-at org-outline-regexp-bol))
  17888. ;; We can't find less than 0 indentation.
  17889. ((zerop i) (throw 'exit (setq min-i 0)))
  17890. ((< i min-i) (setq min-i i))))
  17891. (forward-line))))
  17892. ;; Then indent each line so that a line indented to
  17893. ;; MIN-I becomes indented to IND. Ignore blank lines
  17894. ;; and inline tasks in the process.
  17895. (let ((delta (- ind min-i)))
  17896. (while (< (point) end)
  17897. (unless (or (looking-at "^[ \t]*$")
  17898. (looking-at org-outline-regexp-bol))
  17899. (org-indent-line-to (+ (org-get-indentation) delta)))
  17900. (forward-line)))))))
  17901. (skip-blanks
  17902. (function
  17903. ;; Return beginning of first non-blank line, starting from
  17904. ;; line at POS.
  17905. (lambda (pos)
  17906. (save-excursion
  17907. (goto-char pos)
  17908. (skip-chars-forward " \r\t\n")
  17909. (point-at-bol)))))
  17910. beg end)
  17911. ;; Determine boundaries of changes.
  17912. (if (org-region-active-p)
  17913. (setq beg (funcall skip-blanks (region-beginning))
  17914. end (copy-marker (region-end)))
  17915. (setq beg (funcall skip-blanks (point-at-bol))
  17916. end (copy-marker (point-at-eol))))
  17917. ;; Depending on the starting line, choose an action on the text
  17918. ;; between BEG and END.
  17919. (org-with-limited-levels
  17920. (save-excursion
  17921. (goto-char beg)
  17922. (cond
  17923. ;; Case 1. Start at an item: de-itemize. Note that it only
  17924. ;; happens when a region is active: `org-ctrl-c-minus'
  17925. ;; would call `org-cycle-list-bullet' otherwise.
  17926. ((org-at-item-p)
  17927. (while (< (point) end)
  17928. (when (org-at-item-p)
  17929. (skip-chars-forward " \t")
  17930. (delete-region (point) (match-end 0)))
  17931. (forward-line)))
  17932. ;; Case 2. Start at an heading: convert to items.
  17933. ((org-at-heading-p)
  17934. (let* ((bul (org-list-bullet-string "-"))
  17935. (bul-len (length bul))
  17936. ;; Indentation of the first heading. It should be
  17937. ;; relative to the indentation of its parent, if any.
  17938. (start-ind (save-excursion
  17939. (cond
  17940. ((not org-adapt-indentation) 0)
  17941. ((not (outline-previous-heading)) 0)
  17942. (t (length (match-string 0))))))
  17943. ;; Level of first heading. Further headings will be
  17944. ;; compared to it to determine hierarchy in the list.
  17945. (ref-level (org-reduced-level (org-outline-level))))
  17946. (while (< (point) end)
  17947. (let* ((level (org-reduced-level (org-outline-level)))
  17948. (delta (max 0 (- level ref-level))))
  17949. ;; If current headline is less indented than the first
  17950. ;; one, set it as reference, in order to preserve
  17951. ;; subtrees.
  17952. (when (< level ref-level) (setq ref-level level))
  17953. (replace-match bul t t)
  17954. (org-indent-line-to (+ start-ind (* delta bul-len)))
  17955. ;; Ensure all text down to END (or SECTION-END) belongs
  17956. ;; to the newly created item.
  17957. (let ((section-end (save-excursion
  17958. (or (outline-next-heading) (point)))))
  17959. (forward-line)
  17960. (funcall shift-text
  17961. (+ start-ind (* (1+ delta) bul-len))
  17962. (min end section-end)))))))
  17963. ;; Case 3. Normal line with ARG: turn each non-item line into
  17964. ;; an item.
  17965. (arg
  17966. (while (< (point) end)
  17967. (unless (or (org-at-heading-p) (org-at-item-p))
  17968. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  17969. (replace-match
  17970. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  17971. (forward-line)))
  17972. ;; Case 4. Normal line without ARG: make the first line of
  17973. ;; region an item, and shift indentation of others
  17974. ;; lines to set them as item's body.
  17975. (t (let* ((bul (org-list-bullet-string "-"))
  17976. (bul-len (length bul))
  17977. (ref-ind (org-get-indentation)))
  17978. (skip-chars-forward " \t")
  17979. (insert bul)
  17980. (forward-line)
  17981. (while (< (point) end)
  17982. ;; Ensure that lines less indented than first one
  17983. ;; still get included in item body.
  17984. (funcall shift-text
  17985. (+ ref-ind bul-len)
  17986. (min end (save-excursion (or (outline-next-heading)
  17987. (point)))))
  17988. (forward-line)))))))))
  17989. (defun org-toggle-heading (&optional nstars)
  17990. "Convert headings to normal text, or items or text to headings.
  17991. If there is no active region, only the current line is considered.
  17992. With a \\[universal-argument] prefix, convert the whole list at
  17993. point into heading.
  17994. In a region:
  17995. - If the first non blank line is an headline, remove the stars
  17996. from all headlines in the region.
  17997. - If it is a normal line turn each and every normal line (i.e. not an
  17998. heading or an item) in the region into a heading.
  17999. - If it is a plain list item, turn all plain list items into headings.
  18000. When converting a line into a heading, the number of stars is chosen
  18001. such that the lines become children of the current entry. However,
  18002. when a prefix argument is given, its value determines the number of
  18003. stars to add."
  18004. (interactive "P")
  18005. (let ((skip-blanks
  18006. (function
  18007. ;; Return beginning of first non-blank line, starting from
  18008. ;; line at POS.
  18009. (lambda (pos)
  18010. (save-excursion
  18011. (goto-char pos)
  18012. (while (org-at-comment-p) (forward-line))
  18013. (skip-chars-forward " \r\t\n")
  18014. (point-at-bol)))))
  18015. beg end toggled)
  18016. ;; Determine boundaries of changes. If a universal prefix has
  18017. ;; been given, put the list in a region. If region ends at a bol,
  18018. ;; do not consider the last line to be in the region.
  18019. (when (and current-prefix-arg (org-at-item-p))
  18020. (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
  18021. (org-mark-element))
  18022. (if (org-region-active-p)
  18023. (setq beg (funcall skip-blanks (region-beginning))
  18024. end (copy-marker (save-excursion
  18025. (goto-char (region-end))
  18026. (if (bolp) (point) (point-at-eol)))))
  18027. (setq beg (funcall skip-blanks (point-at-bol))
  18028. end (copy-marker (point-at-eol))))
  18029. ;; Ensure inline tasks don't count as headings.
  18030. (org-with-limited-levels
  18031. (save-excursion
  18032. (goto-char beg)
  18033. (cond
  18034. ;; Case 1. Started at an heading: de-star headings.
  18035. ((org-at-heading-p)
  18036. (while (< (point) end)
  18037. (when (org-at-heading-p t)
  18038. (looking-at org-outline-regexp) (replace-match "")
  18039. (setq toggled t))
  18040. (forward-line)))
  18041. ;; Case 2. Started at an item: change items into headlines.
  18042. ;; One star will be added by `org-list-to-subtree'.
  18043. ((org-at-item-p)
  18044. (let* ((stars (make-string
  18045. (if nstars
  18046. ;; subtract the star that will be added again by
  18047. ;; `org-list-to-subtree'
  18048. (1- (prefix-numeric-value current-prefix-arg))
  18049. (or (org-current-level) 0))
  18050. ?*))
  18051. (add-stars
  18052. (cond (nstars "") ; stars from prefix only
  18053. ((equal stars "") "") ; before first heading
  18054. (org-odd-levels-only "*") ; inside heading, odd
  18055. (t "")))) ; inside heading, oddeven
  18056. (while (< (point) end)
  18057. (when (org-at-item-p)
  18058. ;; Pay attention to cases when region ends before list.
  18059. (let* ((struct (org-list-struct))
  18060. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  18061. (save-restriction
  18062. (narrow-to-region (point) list-end)
  18063. (insert
  18064. (org-list-to-subtree
  18065. (org-list-parse-list t)
  18066. '(:istart (concat stars add-stars (funcall get-stars depth))
  18067. :icount (concat stars add-stars (funcall get-stars depth)))))))
  18068. (setq toggled t))
  18069. (forward-line))))
  18070. ;; Case 3. Started at normal text: make every line an heading,
  18071. ;; skipping headlines and items.
  18072. (t (let* ((stars (make-string
  18073. (if nstars
  18074. (prefix-numeric-value current-prefix-arg)
  18075. (or (org-current-level) 0))
  18076. ?*))
  18077. (add-stars
  18078. (cond (nstars "") ; stars from prefix only
  18079. ((equal stars "") "*") ; before first heading
  18080. (org-odd-levels-only "**") ; inside heading, odd
  18081. (t "*"))) ; inside heading, oddeven
  18082. (rpl (concat stars add-stars " ")))
  18083. (while (< (point) end)
  18084. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  18085. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  18086. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  18087. (forward-line)))))))
  18088. (unless toggled (message "Cannot toggle heading from here"))))
  18089. (defun org-meta-return (&optional arg)
  18090. "Insert a new heading or wrap a region in a table.
  18091. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  18092. See the individual commands for more information."
  18093. (interactive "P")
  18094. (cond
  18095. ((run-hook-with-args-until-success 'org-metareturn-hook))
  18096. ((or (org-at-drawer-p) (org-at-property-p))
  18097. (newline-and-indent))
  18098. ((org-at-table-p)
  18099. (call-interactively 'org-table-wrap-region))
  18100. (t (call-interactively 'org-insert-heading))))
  18101. ;;; Menu entries
  18102. ;; Define the Org-mode menus
  18103. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  18104. '("Tbl"
  18105. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  18106. ["Next Field" org-cycle (org-at-table-p)]
  18107. ["Previous Field" org-shifttab (org-at-table-p)]
  18108. ["Next Row" org-return (org-at-table-p)]
  18109. "--"
  18110. ["Blank Field" org-table-blank-field (org-at-table-p)]
  18111. ["Edit Field" org-table-edit-field (org-at-table-p)]
  18112. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  18113. "--"
  18114. ("Column"
  18115. ["Move Column Left" org-metaleft (org-at-table-p)]
  18116. ["Move Column Right" org-metaright (org-at-table-p)]
  18117. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  18118. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  18119. ("Row"
  18120. ["Move Row Up" org-metaup (org-at-table-p)]
  18121. ["Move Row Down" org-metadown (org-at-table-p)]
  18122. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  18123. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  18124. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  18125. "--"
  18126. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  18127. ("Rectangle"
  18128. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  18129. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  18130. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  18131. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  18132. "--"
  18133. ("Calculate"
  18134. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  18135. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  18136. ["Edit Formulas" org-edit-special (org-at-table-p)]
  18137. "--"
  18138. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  18139. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  18140. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  18141. "--"
  18142. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  18143. "--"
  18144. ["Sum Column/Rectangle" org-table-sum
  18145. (or (org-at-table-p) (org-region-active-p))]
  18146. ["Which Column?" org-table-current-column (org-at-table-p)])
  18147. ["Debug Formulas"
  18148. org-table-toggle-formula-debugger
  18149. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  18150. ["Show Col/Row Numbers"
  18151. org-table-toggle-coordinate-overlays
  18152. :style toggle
  18153. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  18154. "--"
  18155. ["Create" org-table-create (and (not (org-at-table-p))
  18156. org-enable-table-editor)]
  18157. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  18158. ["Import from File" org-table-import (not (org-at-table-p))]
  18159. ["Export to File" org-table-export (org-at-table-p)]
  18160. "--"
  18161. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  18162. (easy-menu-define org-org-menu org-mode-map "Org menu"
  18163. '("Org"
  18164. ("Show/Hide"
  18165. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  18166. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  18167. ["Sparse Tree..." org-sparse-tree t]
  18168. ["Reveal Context" org-reveal t]
  18169. ["Show All" show-all t]
  18170. "--"
  18171. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  18172. "--"
  18173. ["New Heading" org-insert-heading t]
  18174. ("Navigate Headings"
  18175. ["Up" outline-up-heading t]
  18176. ["Next" outline-next-visible-heading t]
  18177. ["Previous" outline-previous-visible-heading t]
  18178. ["Next Same Level" outline-forward-same-level t]
  18179. ["Previous Same Level" outline-backward-same-level t]
  18180. "--"
  18181. ["Jump" org-goto t])
  18182. ("Edit Structure"
  18183. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  18184. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  18185. "--"
  18186. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  18187. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  18188. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  18189. "--"
  18190. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  18191. "--"
  18192. ["Copy visible text" org-copy-visible t]
  18193. "--"
  18194. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  18195. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  18196. ["Demote Heading" org-metaright (not (org-at-table-p))]
  18197. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  18198. "--"
  18199. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  18200. "--"
  18201. ["Convert to odd levels" org-convert-to-odd-levels t]
  18202. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  18203. ("Editing"
  18204. ["Emphasis..." org-emphasize t]
  18205. ["Edit Source Example" org-edit-special t]
  18206. "--"
  18207. ["Footnote new/jump" org-footnote-action t]
  18208. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  18209. ("Archive"
  18210. ["Archive (default method)" org-archive-subtree-default t]
  18211. "--"
  18212. ["Move Subtree to Archive file" org-advertized-archive-subtree t]
  18213. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  18214. ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
  18215. )
  18216. "--"
  18217. ("Hyperlinks"
  18218. ["Store Link (Global)" org-store-link t]
  18219. ["Find existing link to here" org-occur-link-in-agenda-files t]
  18220. ["Insert Link" org-insert-link t]
  18221. ["Follow Link" org-open-at-point t]
  18222. "--"
  18223. ["Next link" org-next-link t]
  18224. ["Previous link" org-previous-link t]
  18225. "--"
  18226. ["Descriptive Links"
  18227. org-toggle-link-display
  18228. :style radio
  18229. :selected org-descriptive-links
  18230. ]
  18231. ["Literal Links"
  18232. org-toggle-link-display
  18233. :style radio
  18234. :selected (not org-descriptive-links)])
  18235. "--"
  18236. ("TODO Lists"
  18237. ["TODO/DONE/-" org-todo t]
  18238. ("Select keyword"
  18239. ["Next keyword" org-shiftright (org-at-heading-p)]
  18240. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  18241. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  18242. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  18243. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  18244. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  18245. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  18246. "--"
  18247. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  18248. :selected org-enforce-todo-dependencies :style toggle :active t]
  18249. "Settings for tree at point"
  18250. ["Do Children sequentially" org-toggle-ordered-property :style radio
  18251. :selected (org-entry-get nil "ORDERED")
  18252. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18253. ["Do Children parallel" org-toggle-ordered-property :style radio
  18254. :selected (not (org-entry-get nil "ORDERED"))
  18255. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18256. "--"
  18257. ["Set Priority" org-priority t]
  18258. ["Priority Up" org-shiftup t]
  18259. ["Priority Down" org-shiftdown t]
  18260. "--"
  18261. ["Get news from all feeds" org-feed-update-all t]
  18262. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  18263. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  18264. ("TAGS and Properties"
  18265. ["Set Tags" org-set-tags-command t]
  18266. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  18267. "--"
  18268. ["Set property" org-set-property t]
  18269. ["Column view of properties" org-columns t]
  18270. ["Insert Column View DBlock" org-insert-columns-dblock t])
  18271. ("Dates and Scheduling"
  18272. ["Timestamp" org-time-stamp t]
  18273. ["Timestamp (inactive)" org-time-stamp-inactive t]
  18274. ("Change Date"
  18275. ["1 Day Later" org-shiftright t]
  18276. ["1 Day Earlier" org-shiftleft t]
  18277. ["1 ... Later" org-shiftup t]
  18278. ["1 ... Earlier" org-shiftdown t])
  18279. ["Compute Time Range" org-evaluate-time-range t]
  18280. ["Schedule Item" org-schedule t]
  18281. ["Deadline" org-deadline t]
  18282. "--"
  18283. ["Custom time format" org-toggle-time-stamp-overlays
  18284. :style radio :selected org-display-custom-times]
  18285. "--"
  18286. ["Goto Calendar" org-goto-calendar t]
  18287. ["Date from Calendar" org-date-from-calendar t]
  18288. "--"
  18289. ["Start/Restart Timer" org-timer-start t]
  18290. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  18291. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  18292. ["Insert Timer String" org-timer t]
  18293. ["Insert Timer Item" org-timer-item t])
  18294. ("Logging work"
  18295. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  18296. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  18297. ["Clock out" org-clock-out t]
  18298. ["Clock cancel" org-clock-cancel t]
  18299. "--"
  18300. ["Mark as default task" org-clock-mark-default-task t]
  18301. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  18302. ["Goto running clock" org-clock-goto t]
  18303. "--"
  18304. ["Display times" org-clock-display t]
  18305. ["Create clock table" org-clock-report t]
  18306. "--"
  18307. ["Record DONE time"
  18308. (progn (setq org-log-done (not org-log-done))
  18309. (message "Switching to %s will %s record a timestamp"
  18310. (car org-done-keywords)
  18311. (if org-log-done "automatically" "not")))
  18312. :style toggle :selected org-log-done])
  18313. "--"
  18314. ["Agenda Command..." org-agenda t]
  18315. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  18316. ("File List for Agenda")
  18317. ("Special views current file"
  18318. ["TODO Tree" org-show-todo-tree t]
  18319. ["Check Deadlines" org-check-deadlines t]
  18320. ["Timeline" org-timeline t]
  18321. ["Tags/Property tree" org-match-sparse-tree t])
  18322. "--"
  18323. ["Export/Publish..." org-export t]
  18324. ("LaTeX"
  18325. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  18326. :selected org-cdlatex-mode]
  18327. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  18328. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  18329. ["Modify math symbol" org-cdlatex-math-modify
  18330. (org-inside-LaTeX-fragment-p)]
  18331. ["Insert citation" org-reftex-citation t]
  18332. "--"
  18333. ["Template for BEAMER" (progn (require 'org-beamer)
  18334. (org-insert-beamer-options-template)) t])
  18335. "--"
  18336. ("MobileOrg"
  18337. ["Push Files and Views" org-mobile-push t]
  18338. ["Get Captured and Flagged" org-mobile-pull t]
  18339. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  18340. "--"
  18341. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  18342. "--"
  18343. ("Documentation"
  18344. ["Show Version" org-version t]
  18345. ["Info Documentation" org-info t])
  18346. ("Customize"
  18347. ["Browse Org Group" org-customize t]
  18348. "--"
  18349. ["Expand This Menu" org-create-customize-menu
  18350. (fboundp 'customize-menu-create)])
  18351. ["Send bug report" org-submit-bug-report t]
  18352. "--"
  18353. ("Refresh/Reload"
  18354. ["Refresh setup current buffer" org-mode-restart t]
  18355. ["Reload Org (after update)" org-reload t]
  18356. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  18357. ))
  18358. (defun org-info (&optional node)
  18359. "Read documentation for Org-mode in the info system.
  18360. With optional NODE, go directly to that node."
  18361. (interactive)
  18362. (info (format "(org)%s" (or node ""))))
  18363. ;;;###autoload
  18364. (defun org-submit-bug-report ()
  18365. "Submit a bug report on Org-mode via mail.
  18366. Don't hesitate to report any problems or inaccurate documentation.
  18367. If you don't have setup sending mail from (X)Emacs, please copy the
  18368. output buffer into your mail program, as it gives us important
  18369. information about your Org-mode version and configuration."
  18370. (interactive)
  18371. (require 'reporter)
  18372. (org-load-modules-maybe)
  18373. (org-require-autoloaded-modules)
  18374. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  18375. (reporter-submit-bug-report
  18376. "emacs-orgmode@gnu.org"
  18377. (org-version nil 'full)
  18378. (let (list)
  18379. (save-window-excursion
  18380. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  18381. (delete-other-windows)
  18382. (erase-buffer)
  18383. (insert "You are about to submit a bug report to the Org-mode mailing list.
  18384. We would like to add your full Org-mode and Outline configuration to the
  18385. bug report. This greatly simplifies the work of the maintainer and
  18386. other experts on the mailing list.
  18387. HOWEVER, some variables you have customized may contain private
  18388. information. The names of customers, colleagues, or friends, might
  18389. appear in the form of file names, tags, todo states, or search strings.
  18390. If you answer yes to the prompt, you might want to check and remove
  18391. such private information before sending the email.")
  18392. (add-text-properties (point-min) (point-max) '(face org-warning))
  18393. (when (yes-or-no-p "Include your Org-mode configuration ")
  18394. (mapatoms
  18395. (lambda (v)
  18396. (and (boundp v)
  18397. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  18398. (or (and (symbol-value v)
  18399. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  18400. (and
  18401. (get v 'custom-type) (get v 'standard-value)
  18402. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  18403. (push v list)))))
  18404. (kill-buffer (get-buffer "*Warn about privacy*"))
  18405. list))
  18406. nil nil
  18407. "Remember to cover the basics, that is, what you expected to happen and
  18408. what in fact did happen. You don't know how to make a good report? See
  18409. http://orgmode.org/manual/Feedback.html#Feedback
  18410. Your bug report will be posted to the Org-mode mailing list.
  18411. ------------------------------------------------------------------------")
  18412. (save-excursion
  18413. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  18414. (replace-match "\\1Bug: \\3 [\\2]")))))
  18415. (defun org-install-agenda-files-menu ()
  18416. (let ((bl (buffer-list)))
  18417. (save-excursion
  18418. (while bl
  18419. (set-buffer (pop bl))
  18420. (if (derived-mode-p 'org-mode) (setq bl nil)))
  18421. (when (derived-mode-p 'org-mode)
  18422. (easy-menu-change
  18423. '("Org") "File List for Agenda"
  18424. (append
  18425. (list
  18426. ["Edit File List" (org-edit-agenda-file-list) t]
  18427. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  18428. ["Remove Current File from List" org-remove-file t]
  18429. ["Cycle through agenda files" org-cycle-agenda-files t]
  18430. ["Occur in all agenda files" org-occur-in-agenda-files t]
  18431. "--")
  18432. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  18433. ;;;; Documentation
  18434. ;;;###autoload
  18435. (defun org-require-autoloaded-modules ()
  18436. (interactive)
  18437. (mapc 'require
  18438. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  18439. org-docbook org-exp org-html org-icalendar
  18440. org-id org-latex
  18441. org-publish org-remember org-table
  18442. org-timer org-xoxo)))
  18443. ;;;###autoload
  18444. (defun org-reload (&optional uncompiled)
  18445. "Reload all org lisp files.
  18446. With prefix arg UNCOMPILED, load the uncompiled versions."
  18447. (interactive "P")
  18448. (require 'find-func)
  18449. (let* ((file-re "^org\\(-.*\\)?\\.el")
  18450. (dir-org (file-name-directory (org-find-library-dir "org")))
  18451. (dir-org-contrib (ignore-errors
  18452. (file-name-directory
  18453. (org-find-library-dir "org-contribdir"))))
  18454. (babel-files
  18455. (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
  18456. (append (list nil "comint" "eval" "exp" "keys"
  18457. "lob" "ref" "table" "tangle")
  18458. (delq nil
  18459. (mapcar
  18460. (lambda (lang)
  18461. (when (cdr lang) (symbol-name (car lang))))
  18462. org-babel-load-languages)))))
  18463. (files
  18464. (append babel-files
  18465. (and dir-org-contrib
  18466. (directory-files dir-org-contrib t file-re))
  18467. (directory-files dir-org t file-re)))
  18468. (remove-re (concat (if (featurep 'xemacs)
  18469. "org-colview" "org-colview-xemacs")
  18470. "\\'")))
  18471. (setq files (mapcar 'file-name-sans-extension files))
  18472. (setq files (mapcar
  18473. (lambda (x) (if (string-match remove-re x) nil x))
  18474. files))
  18475. (setq files (delq nil files))
  18476. (mapc
  18477. (lambda (f)
  18478. (when (featurep (intern (file-name-nondirectory f)))
  18479. (if (and (not uncompiled)
  18480. (file-exists-p (concat f ".elc")))
  18481. (load (concat f ".elc") nil nil 'nosuffix)
  18482. (load (concat f ".el") nil nil 'nosuffix))))
  18483. files)
  18484. (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
  18485. (org-version nil 'full 'message))
  18486. ;;;###autoload
  18487. (defun org-customize ()
  18488. "Call the customize function with org as argument."
  18489. (interactive)
  18490. (org-load-modules-maybe)
  18491. (org-require-autoloaded-modules)
  18492. (customize-browse 'org))
  18493. (defun org-create-customize-menu ()
  18494. "Create a full customization menu for Org-mode, insert it into the menu."
  18495. (interactive)
  18496. (org-load-modules-maybe)
  18497. (org-require-autoloaded-modules)
  18498. (if (fboundp 'customize-menu-create)
  18499. (progn
  18500. (easy-menu-change
  18501. '("Org") "Customize"
  18502. `(["Browse Org group" org-customize t]
  18503. "--"
  18504. ,(customize-menu-create 'org)
  18505. ["Set" Custom-set t]
  18506. ["Save" Custom-save t]
  18507. ["Reset to Current" Custom-reset-current t]
  18508. ["Reset to Saved" Custom-reset-saved t]
  18509. ["Reset to Standard Settings" Custom-reset-standard t]))
  18510. (message "\"Org\"-menu now contains full customization menu"))
  18511. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  18512. ;;;; Miscellaneous stuff
  18513. ;;; Generally useful functions
  18514. (defun org-get-at-bol (property)
  18515. "Get text property PROPERTY at beginning of line."
  18516. (get-text-property (point-at-bol) property))
  18517. (defun org-find-text-property-in-string (prop s)
  18518. "Return the first non-nil value of property PROP in string S."
  18519. (or (get-text-property 0 prop s)
  18520. (get-text-property (or (next-single-property-change 0 prop s) 0)
  18521. prop s)))
  18522. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  18523. "Display the given MESSAGE as a warning."
  18524. (if (fboundp 'display-warning)
  18525. (display-warning 'org message
  18526. (if (featurep 'xemacs) 'warning :warning))
  18527. (let ((buf (get-buffer-create "*Org warnings*")))
  18528. (with-current-buffer buf
  18529. (goto-char (point-max))
  18530. (insert "Warning (Org): " message)
  18531. (unless (bolp)
  18532. (newline)))
  18533. (display-buffer buf)
  18534. (sit-for 0))))
  18535. (defun org-eval (form)
  18536. "Eval FORM and return result."
  18537. (condition-case error
  18538. (eval form)
  18539. (error (format "%%![Error: %s]" error))))
  18540. (defun org-in-clocktable-p ()
  18541. "Check if the cursor is in a clocktable."
  18542. (let ((pos (point)) start)
  18543. (save-excursion
  18544. (end-of-line 1)
  18545. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  18546. (setq start (match-beginning 0))
  18547. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  18548. (>= (match-end 0) pos)
  18549. start))))
  18550. (defun org-in-commented-line ()
  18551. "Is point in a line starting with `#'?"
  18552. (equal (char-after (point-at-bol)) ?#))
  18553. (defun org-in-indented-comment-line ()
  18554. "Is point in a line starting with `#' after some white space?"
  18555. (save-excursion
  18556. (save-match-data
  18557. (goto-char (point-at-bol))
  18558. (looking-at "[ \t]*#"))))
  18559. (defun org-in-verbatim-emphasis ()
  18560. (save-match-data
  18561. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  18562. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  18563. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  18564. (if (and marker (marker-buffer marker)
  18565. (buffer-live-p (marker-buffer marker)))
  18566. (progn
  18567. (org-pop-to-buffer-same-window (marker-buffer marker))
  18568. (if (or (> marker (point-max)) (< marker (point-min)))
  18569. (widen))
  18570. (goto-char marker)
  18571. (org-show-context 'org-goto))
  18572. (if bookmark
  18573. (bookmark-jump bookmark)
  18574. (error "Cannot find location"))))
  18575. (defun org-quote-csv-field (s)
  18576. "Quote field for inclusion in CSV material."
  18577. (if (string-match "[\",]" s)
  18578. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  18579. s))
  18580. (defun org-force-self-insert (N)
  18581. "Needed to enforce self-insert under remapping."
  18582. (interactive "p")
  18583. (self-insert-command N))
  18584. (defun org-string-width (s)
  18585. "Compute width of string, ignoring invisible characters.
  18586. This ignores character with invisibility property `org-link', and also
  18587. characters with property `org-cwidth', because these will become invisible
  18588. upon the next fontification round."
  18589. (let (b l)
  18590. (when (or (eq t buffer-invisibility-spec)
  18591. (assq 'org-link buffer-invisibility-spec))
  18592. (while (setq b (text-property-any 0 (length s)
  18593. 'invisible 'org-link s))
  18594. (setq s (concat (substring s 0 b)
  18595. (substring s (or (next-single-property-change
  18596. b 'invisible s) (length s)))))))
  18597. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  18598. (setq s (concat (substring s 0 b)
  18599. (substring s (or (next-single-property-change
  18600. b 'org-cwidth s) (length s))))))
  18601. (setq l (string-width s) b -1)
  18602. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  18603. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  18604. l))
  18605. (defun org-shorten-string (s maxlength)
  18606. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  18607. If the string is shorter or has length MAXLENGTH, just return the
  18608. original string. If it is longer, the functions finds a space in the
  18609. string, breaks this string off at that locations and adds three dots
  18610. as ellipsis. Including the ellipsis, the string will not be longer
  18611. than MAXLENGTH. If finding a good breaking point in the string does
  18612. not work, the string is just chopped off in the middle of a word
  18613. if necessary."
  18614. (if (<= (length s) maxlength)
  18615. s
  18616. (let* ((n (max (- maxlength 4) 1))
  18617. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  18618. (if (string-match re s)
  18619. (concat (match-string 1 s) "...")
  18620. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  18621. (defun org-get-indentation (&optional line)
  18622. "Get the indentation of the current line, interpreting tabs.
  18623. When LINE is given, assume it represents a line and compute its indentation."
  18624. (if line
  18625. (if (string-match "^ *" (org-remove-tabs line))
  18626. (match-end 0))
  18627. (save-excursion
  18628. (beginning-of-line 1)
  18629. (skip-chars-forward " \t")
  18630. (current-column))))
  18631. (defun org-get-string-indentation (s)
  18632. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  18633. (let ((n -1) (i 0) (w tab-width) c)
  18634. (catch 'exit
  18635. (while (< (setq n (1+ n)) (length s))
  18636. (setq c (aref s n))
  18637. (cond ((= c ?\ ) (setq i (1+ i)))
  18638. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  18639. (t (throw 'exit t)))))
  18640. i))
  18641. (defun org-remove-tabs (s &optional width)
  18642. "Replace tabulators in S with spaces.
  18643. Assumes that s is a single line, starting in column 0."
  18644. (setq width (or width tab-width))
  18645. (while (string-match "\t" s)
  18646. (setq s (replace-match
  18647. (make-string
  18648. (- (* width (/ (+ (match-beginning 0) width) width))
  18649. (match-beginning 0)) ?\ )
  18650. t t s)))
  18651. s)
  18652. (defun org-fix-indentation (line ind)
  18653. "Fix indentation in LINE.
  18654. IND is a cons cell with target and minimum indentation.
  18655. If the current indentation in LINE is smaller than the minimum,
  18656. leave it alone. If it is larger than ind, set it to the target."
  18657. (let* ((l (org-remove-tabs line))
  18658. (i (org-get-indentation l))
  18659. (i1 (car ind)) (i2 (cdr ind)))
  18660. (if (>= i i2) (setq l (substring line i2)))
  18661. (if (> i1 0)
  18662. (concat (make-string i1 ?\ ) l)
  18663. l)))
  18664. (defun org-remove-indentation (code &optional n)
  18665. "Remove the maximum common indentation from the lines in CODE.
  18666. N may optionally be the number of spaces to remove."
  18667. (with-temp-buffer
  18668. (insert code)
  18669. (org-do-remove-indentation n)
  18670. (buffer-string)))
  18671. (defun org-do-remove-indentation (&optional n)
  18672. "Remove the maximum common indentation from the buffer."
  18673. (untabify (point-min) (point-max))
  18674. (let ((min 10000) re)
  18675. (if n
  18676. (setq min n)
  18677. (goto-char (point-min))
  18678. (while (re-search-forward "^ *[^ \n]" nil t)
  18679. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  18680. (unless (or (= min 0) (= min 10000))
  18681. (setq re (format "^ \\{%d\\}" min))
  18682. (goto-char (point-min))
  18683. (while (re-search-forward re nil t)
  18684. (replace-match "")
  18685. (end-of-line 1))
  18686. min)))
  18687. (defun org-fill-template (template alist)
  18688. "Find each %key of ALIST in TEMPLATE and replace it."
  18689. (let ((case-fold-search nil)
  18690. entry key value)
  18691. (setq alist (sort (copy-sequence alist)
  18692. (lambda (a b) (< (length (car a)) (length (car b))))))
  18693. (while (setq entry (pop alist))
  18694. (setq template
  18695. (replace-regexp-in-string
  18696. (concat "%" (regexp-quote (car entry)))
  18697. (or (cdr entry) "") template t t)))
  18698. template))
  18699. (defun org-base-buffer (buffer)
  18700. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  18701. (if (not buffer)
  18702. buffer
  18703. (or (buffer-base-buffer buffer)
  18704. buffer)))
  18705. (defun org-trim (s)
  18706. "Remove whitespace at beginning and end of string."
  18707. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  18708. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  18709. s)
  18710. (defun org-wrap (string &optional width lines)
  18711. "Wrap string to either a number of lines, or a width in characters.
  18712. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  18713. that costs. If there is a word longer than WIDTH, the text is actually
  18714. wrapped to the length of that word.
  18715. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  18716. many lines, whatever width that takes.
  18717. The return value is a list of lines, without newlines at the end."
  18718. (let* ((words (org-split-string string "[ \t\n]+"))
  18719. (maxword (apply 'max (mapcar 'org-string-width words)))
  18720. w ll)
  18721. (cond (width
  18722. (org-do-wrap words (max maxword width)))
  18723. (lines
  18724. (setq w maxword)
  18725. (setq ll (org-do-wrap words maxword))
  18726. (if (<= (length ll) lines)
  18727. ll
  18728. (setq ll words)
  18729. (while (> (length ll) lines)
  18730. (setq w (1+ w))
  18731. (setq ll (org-do-wrap words w)))
  18732. ll))
  18733. (t (error "Cannot wrap this")))))
  18734. (defun org-do-wrap (words width)
  18735. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  18736. (let (lines line)
  18737. (while words
  18738. (setq line (pop words))
  18739. (while (and words (< (+ (length line) (length (car words))) width))
  18740. (setq line (concat line " " (pop words))))
  18741. (setq lines (push line lines)))
  18742. (nreverse lines)))
  18743. (defun org-split-string (string &optional separators)
  18744. "Splits STRING into substrings at SEPARATORS.
  18745. No empty strings are returned if there are matches at the beginning
  18746. and end of string."
  18747. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  18748. (start 0)
  18749. notfirst
  18750. (list nil))
  18751. (while (and (string-match rexp string
  18752. (if (and notfirst
  18753. (= start (match-beginning 0))
  18754. (< start (length string)))
  18755. (1+ start) start))
  18756. (< (match-beginning 0) (length string)))
  18757. (setq notfirst t)
  18758. (or (eq (match-beginning 0) 0)
  18759. (and (eq (match-beginning 0) (match-end 0))
  18760. (eq (match-beginning 0) start))
  18761. (setq list
  18762. (cons (substring string start (match-beginning 0))
  18763. list)))
  18764. (setq start (match-end 0)))
  18765. (or (eq start (length string))
  18766. (setq list
  18767. (cons (substring string start)
  18768. list)))
  18769. (nreverse list)))
  18770. (defun org-quote-vert (s)
  18771. "Replace \"|\" with \"\\vert\"."
  18772. (while (string-match "|" s)
  18773. (setq s (replace-match "\\vert" t t s)))
  18774. s)
  18775. (defun org-uuidgen-p (s)
  18776. "Is S an ID created by UUIDGEN?"
  18777. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  18778. (defun org-in-src-block-p nil
  18779. "Whether point is in a code source block."
  18780. (let (ov)
  18781. (when (setq ov (overlays-at (point)))
  18782. (memq 'org-block-background
  18783. (overlay-properties
  18784. (car ov))))))
  18785. (defun org-context ()
  18786. "Return a list of contexts of the current cursor position.
  18787. If several contexts apply, all are returned.
  18788. Each context entry is a list with a symbol naming the context, and
  18789. two positions indicating start and end of the context. Possible
  18790. contexts are:
  18791. :headline anywhere in a headline
  18792. :headline-stars on the leading stars in a headline
  18793. :todo-keyword on a TODO keyword (including DONE) in a headline
  18794. :tags on the TAGS in a headline
  18795. :priority on the priority cookie in a headline
  18796. :item on the first line of a plain list item
  18797. :item-bullet on the bullet/number of a plain list item
  18798. :checkbox on the checkbox in a plain list item
  18799. :table in an org-mode table
  18800. :table-special on a special filed in a table
  18801. :table-table in a table.el table
  18802. :clocktable in a clocktable
  18803. :src-block in a source block
  18804. :link on a hyperlink
  18805. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  18806. :target on a <<target>>
  18807. :radio-target on a <<<radio-target>>>
  18808. :latex-fragment on a LaTeX fragment
  18809. :latex-preview on a LaTeX fragment with overlaid preview image
  18810. This function expects the position to be visible because it uses font-lock
  18811. faces as a help to recognize the following contexts: :table-special, :link,
  18812. and :keyword."
  18813. (let* ((f (get-text-property (point) 'face))
  18814. (faces (if (listp f) f (list f)))
  18815. (case-fold-search t)
  18816. (p (point)) clist o)
  18817. ;; First the large context
  18818. (cond
  18819. ((org-at-heading-p t)
  18820. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  18821. (when (progn
  18822. (beginning-of-line 1)
  18823. (looking-at org-todo-line-tags-regexp))
  18824. (push (org-point-in-group p 1 :headline-stars) clist)
  18825. (push (org-point-in-group p 2 :todo-keyword) clist)
  18826. (push (org-point-in-group p 4 :tags) clist))
  18827. (goto-char p)
  18828. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  18829. (if (looking-at "\\[#[A-Z0-9]\\]")
  18830. (push (org-point-in-group p 0 :priority) clist)))
  18831. ((org-at-item-p)
  18832. (push (org-point-in-group p 2 :item-bullet) clist)
  18833. (push (list :item (point-at-bol)
  18834. (save-excursion (org-end-of-item) (point)))
  18835. clist)
  18836. (and (org-at-item-checkbox-p)
  18837. (push (org-point-in-group p 0 :checkbox) clist)))
  18838. ((org-at-table-p)
  18839. (push (list :table (org-table-begin) (org-table-end)) clist)
  18840. (if (memq 'org-formula faces)
  18841. (push (list :table-special
  18842. (previous-single-property-change p 'face)
  18843. (next-single-property-change p 'face)) clist)))
  18844. ((org-at-table-p 'any)
  18845. (push (list :table-table) clist)))
  18846. (goto-char p)
  18847. (let ((case-fold-search t))
  18848. ;; New the "medium" contexts: clocktables, source blocks
  18849. (cond ((org-in-clocktable-p)
  18850. (push (list :clocktable
  18851. (and (or (looking-at "#\\+BEGIN: clocktable")
  18852. (search-backward "#+BEGIN: clocktable" nil t))
  18853. (match-beginning 0))
  18854. (and (re-search-forward "#\\+END:?" nil t)
  18855. (match-end 0))) clist))
  18856. ((org-in-src-block-p)
  18857. (push (list :src-block
  18858. (and (or (looking-at "#\\+BEGIN_SRC")
  18859. (search-backward "#+BEGIN_SRC" nil t))
  18860. (match-beginning 0))
  18861. (and (search-forward "#+END_SRC" nil t)
  18862. (match-beginning 0))) clist))))
  18863. (goto-char p)
  18864. ;; Now the small context
  18865. (cond
  18866. ((org-at-timestamp-p)
  18867. (push (org-point-in-group p 0 :timestamp) clist))
  18868. ((memq 'org-link faces)
  18869. (push (list :link
  18870. (previous-single-property-change p 'face)
  18871. (next-single-property-change p 'face)) clist))
  18872. ((memq 'org-special-keyword faces)
  18873. (push (list :keyword
  18874. (previous-single-property-change p 'face)
  18875. (next-single-property-change p 'face)) clist))
  18876. ((org-at-target-p)
  18877. (push (org-point-in-group p 0 :target) clist)
  18878. (goto-char (1- (match-beginning 0)))
  18879. (if (looking-at org-radio-target-regexp)
  18880. (push (org-point-in-group p 0 :radio-target) clist))
  18881. (goto-char p))
  18882. ((setq o (car (delq nil
  18883. (mapcar
  18884. (lambda (x)
  18885. (if (memq x org-latex-fragment-image-overlays) x))
  18886. (overlays-at (point))))))
  18887. (push (list :latex-fragment
  18888. (overlay-start o) (overlay-end o)) clist)
  18889. (push (list :latex-preview
  18890. (overlay-start o) (overlay-end o)) clist))
  18891. ((org-inside-LaTeX-fragment-p)
  18892. ;; FIXME: positions wrong.
  18893. (push (list :latex-fragment (point) (point)) clist)))
  18894. (setq clist (nreverse (delq nil clist)))
  18895. clist))
  18896. ;; FIXME: Compare with at-regexp-p Do we need both?
  18897. (defun org-in-regexp (re &optional nlines visually)
  18898. "Check if point is inside a match of regexp.
  18899. Normally only the current line is checked, but you can include NLINES extra
  18900. lines both before and after point into the search.
  18901. If VISUALLY is set, require that the cursor is not after the match but
  18902. really on, so that the block visually is on the match."
  18903. (catch 'exit
  18904. (let ((pos (point))
  18905. (eol (point-at-eol (+ 1 (or nlines 0))))
  18906. (inc (if visually 1 0)))
  18907. (save-excursion
  18908. (beginning-of-line (- 1 (or nlines 0)))
  18909. (while (re-search-forward re eol t)
  18910. (if (and (<= (match-beginning 0) pos)
  18911. (>= (+ inc (match-end 0)) pos))
  18912. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  18913. (defun org-at-regexp-p (regexp)
  18914. "Is point inside a match of REGEXP in the current line?"
  18915. (catch 'exit
  18916. (save-excursion
  18917. (let ((pos (point)) (end (point-at-eol)))
  18918. (beginning-of-line 1)
  18919. (while (re-search-forward regexp end t)
  18920. (if (and (<= (match-beginning 0) pos)
  18921. (>= (match-end 0) pos))
  18922. (throw 'exit t)))
  18923. nil))))
  18924. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  18925. "Non-nil when point is between matches of START-RE and END-RE.
  18926. Also return a non-nil value when point is on one of the matches.
  18927. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  18928. buffer positions. Default values are the positions of headlines
  18929. surrounding the point.
  18930. The functions returns a cons cell whose car (resp. cdr) is the
  18931. position before START-RE (resp. after END-RE)."
  18932. (save-match-data
  18933. (let ((pos (point))
  18934. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  18935. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  18936. beg end)
  18937. (save-excursion
  18938. ;; Point is on a block when on START-RE or if START-RE can be
  18939. ;; found before it...
  18940. (and (or (org-at-regexp-p start-re)
  18941. (re-search-backward start-re limit-up t))
  18942. (setq beg (match-beginning 0))
  18943. ;; ... and END-RE after it...
  18944. (goto-char (match-end 0))
  18945. (re-search-forward end-re limit-down t)
  18946. (> (setq end (match-end 0)) pos)
  18947. ;; ... without another START-RE in-between.
  18948. (goto-char (match-beginning 0))
  18949. (not (re-search-backward start-re (1+ beg) t))
  18950. ;; Return value.
  18951. (cons beg end))))))
  18952. (defun org-in-block-p (names)
  18953. "Non-nil when point belongs to a block whose name belongs to NAMES.
  18954. NAMES is a list of strings containing names of blocks.
  18955. Return first block name matched, or nil. Beware that in case of
  18956. nested blocks, the returned name may not belong to the closest
  18957. block from point."
  18958. (save-match-data
  18959. (catch 'exit
  18960. (let ((case-fold-search t)
  18961. (lim-up (save-excursion (outline-previous-heading)))
  18962. (lim-down (save-excursion (outline-next-heading))))
  18963. (mapc (lambda (name)
  18964. (let ((n (regexp-quote name)))
  18965. (when (org-between-regexps-p
  18966. (concat "^[ \t]*#\\+begin_" n)
  18967. (concat "^[ \t]*#\\+end_" n)
  18968. lim-up lim-down)
  18969. (throw 'exit n))))
  18970. names))
  18971. nil)))
  18972. (defun org-occur-in-agenda-files (regexp &optional nlines)
  18973. "Call `multi-occur' with buffers for all agenda files."
  18974. (interactive "sOrg-files matching: \np")
  18975. (let* ((files (org-agenda-files))
  18976. (tnames (mapcar 'file-truename files))
  18977. (extra org-agenda-text-search-extra-files)
  18978. f)
  18979. (when (eq (car extra) 'agenda-archives)
  18980. (setq extra (cdr extra))
  18981. (setq files (org-add-archive-files files)))
  18982. (while (setq f (pop extra))
  18983. (unless (member (file-truename f) tnames)
  18984. (add-to-list 'files f 'append)
  18985. (add-to-list 'tnames (file-truename f) 'append)))
  18986. (multi-occur
  18987. (mapcar (lambda (x)
  18988. (with-current-buffer
  18989. (or (get-file-buffer x) (find-file-noselect x))
  18990. (widen)
  18991. (current-buffer)))
  18992. files)
  18993. regexp)))
  18994. (if (boundp 'occur-mode-find-occurrence-hook)
  18995. ;; Emacs 23
  18996. (add-hook 'occur-mode-find-occurrence-hook
  18997. (lambda ()
  18998. (when (derived-mode-p 'org-mode)
  18999. (org-reveal))))
  19000. ;; Emacs 22
  19001. (defadvice occur-mode-goto-occurrence
  19002. (after org-occur-reveal activate)
  19003. (and (derived-mode-p 'org-mode) (org-reveal)))
  19004. (defadvice occur-mode-goto-occurrence-other-window
  19005. (after org-occur-reveal activate)
  19006. (and (derived-mode-p 'org-mode) (org-reveal)))
  19007. (defadvice occur-mode-display-occurrence
  19008. (after org-occur-reveal activate)
  19009. (when (derived-mode-p 'org-mode)
  19010. (let ((pos (occur-mode-find-occurrence)))
  19011. (with-current-buffer (marker-buffer pos)
  19012. (save-excursion
  19013. (goto-char pos)
  19014. (org-reveal)))))))
  19015. (defun org-occur-link-in-agenda-files ()
  19016. "Create a link and search for it in the agendas.
  19017. The link is not stored in `org-stored-links', it is just created
  19018. for the search purpose."
  19019. (interactive)
  19020. (let ((link (condition-case nil
  19021. (org-store-link nil)
  19022. (error "Unable to create a link to here"))))
  19023. (org-occur-in-agenda-files (regexp-quote link))))
  19024. (defun org-uniquify (list)
  19025. "Remove duplicate elements from LIST."
  19026. (let (res)
  19027. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  19028. res))
  19029. (defun org-delete-all (elts list)
  19030. "Remove all elements in ELTS from LIST."
  19031. (while elts
  19032. (setq list (delete (pop elts) list)))
  19033. list)
  19034. (defun org-count (cl-item cl-seq)
  19035. "Count the number of occurrences of ITEM in SEQ.
  19036. Taken from `count' in cl-seq.el with all keyword arguments removed."
  19037. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  19038. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  19039. (while (< cl-start cl-end)
  19040. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  19041. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  19042. (setq cl-start (1+ cl-start)))
  19043. cl-count))
  19044. (defun org-remove-if (predicate seq)
  19045. "Remove everything from SEQ that fulfills PREDICATE."
  19046. (let (res e)
  19047. (while seq
  19048. (setq e (pop seq))
  19049. (if (not (funcall predicate e)) (push e res)))
  19050. (nreverse res)))
  19051. (defun org-remove-if-not (predicate seq)
  19052. "Remove everything from SEQ that does not fulfill PREDICATE."
  19053. (let (res e)
  19054. (while seq
  19055. (setq e (pop seq))
  19056. (if (funcall predicate e) (push e res)))
  19057. (nreverse res)))
  19058. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  19059. "Reduce two-argument FUNCTION across SEQ.
  19060. Taken from `reduce' in cl-seq.el with all keyword arguments but
  19061. \":initial-value\" removed."
  19062. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  19063. (cadr (memq :initial-value cl-keys)))
  19064. (cl-seq (pop cl-seq))
  19065. (t (funcall cl-func)))))
  19066. (while cl-seq
  19067. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  19068. cl-accum))
  19069. (defun org-back-over-empty-lines ()
  19070. "Move backwards over whitespace, to the beginning of the first empty line.
  19071. Returns the number of empty lines passed."
  19072. (let ((pos (point)))
  19073. (if (cdr (assoc 'heading org-blank-before-new-entry))
  19074. (skip-chars-backward " \t\n\r")
  19075. (unless (eobp)
  19076. (forward-line -1)))
  19077. (beginning-of-line 2)
  19078. (goto-char (min (point) pos))
  19079. (count-lines (point) pos)))
  19080. (defun org-skip-whitespace ()
  19081. (skip-chars-forward " \t\n\r"))
  19082. (defun org-point-in-group (point group &optional context)
  19083. "Check if POINT is in match-group GROUP.
  19084. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  19085. match. If the match group does not exist or point is not inside it,
  19086. return nil."
  19087. (and (match-beginning group)
  19088. (>= point (match-beginning group))
  19089. (<= point (match-end group))
  19090. (if context
  19091. (list context (match-beginning group) (match-end group))
  19092. t)))
  19093. (defun org-switch-to-buffer-other-window (&rest args)
  19094. "Switch to buffer in a second window on the current frame.
  19095. In particular, do not allow pop-up frames.
  19096. Returns the newly created buffer."
  19097. (let (pop-up-frames special-display-buffer-names special-display-regexps
  19098. special-display-function)
  19099. (apply 'switch-to-buffer-other-window args)))
  19100. (defun org-combine-plists (&rest plists)
  19101. "Create a single property list from all plists in PLISTS.
  19102. The process starts by copying the first list, and then setting properties
  19103. from the other lists. Settings in the last list are the most significant
  19104. ones and overrule settings in the other lists."
  19105. (let ((rtn (copy-sequence (pop plists)))
  19106. p v ls)
  19107. (while plists
  19108. (setq ls (pop plists))
  19109. (while ls
  19110. (setq p (pop ls) v (pop ls))
  19111. (setq rtn (plist-put rtn p v))))
  19112. rtn))
  19113. (defun org-replace-escapes (string table)
  19114. "Replace %-escapes in STRING with values in TABLE.
  19115. TABLE is an association list with keys like \"%a\" and string values.
  19116. The sequences in STRING may contain normal field width and padding information,
  19117. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  19118. so values can contain further %-escapes if they are define later in TABLE."
  19119. (let ((tbl (copy-alist table))
  19120. (case-fold-search nil)
  19121. (pchg 0)
  19122. e re rpl)
  19123. (while (setq e (pop tbl))
  19124. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  19125. (when (and (cdr e) (string-match re (cdr e)))
  19126. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  19127. (safe "SREF"))
  19128. (add-text-properties 0 3 (list 'sref sref) safe)
  19129. (setcdr e (replace-match safe t t (cdr e)))))
  19130. (while (string-match re string)
  19131. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  19132. (cdr e)))
  19133. (setq string (replace-match rpl t t string))))
  19134. (while (setq pchg (next-property-change pchg string))
  19135. (let ((sref (get-text-property pchg 'sref string)))
  19136. (when (and sref (string-match "SREF" string pchg))
  19137. (setq string (replace-match sref t t string)))))
  19138. string))
  19139. (defun org-sublist (list start end)
  19140. "Return a section of LIST, from START to END.
  19141. Counting starts at 1."
  19142. (let (rtn (c start))
  19143. (setq list (nthcdr (1- start) list))
  19144. (while (and list (<= c end))
  19145. (push (pop list) rtn)
  19146. (setq c (1+ c)))
  19147. (nreverse rtn)))
  19148. (defun org-find-base-buffer-visiting (file)
  19149. "Like `find-buffer-visiting' but always return the base buffer and
  19150. not an indirect buffer."
  19151. (let ((buf (or (get-file-buffer file)
  19152. (find-buffer-visiting file))))
  19153. (if buf
  19154. (or (buffer-base-buffer buf) buf)
  19155. nil)))
  19156. (defun org-image-file-name-regexp (&optional extensions)
  19157. "Return regexp matching the file names of images.
  19158. If EXTENSIONS is given, only match these."
  19159. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  19160. (image-file-name-regexp)
  19161. (let ((image-file-name-extensions
  19162. (or extensions
  19163. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  19164. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  19165. (concat "\\."
  19166. (regexp-opt (nconc (mapcar 'upcase
  19167. image-file-name-extensions)
  19168. image-file-name-extensions)
  19169. t)
  19170. "\\'"))))
  19171. (defun org-file-image-p (file &optional extensions)
  19172. "Return non-nil if FILE is an image."
  19173. (save-match-data
  19174. (string-match (org-image-file-name-regexp extensions) file)))
  19175. (defun org-get-cursor-date ()
  19176. "Return the date at cursor in as a time.
  19177. This works in the calendar and in the agenda, anywhere else it just
  19178. returns the current time."
  19179. (let (date day defd)
  19180. (cond
  19181. ((eq major-mode 'calendar-mode)
  19182. (setq date (calendar-cursor-to-date)
  19183. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  19184. ((eq major-mode 'org-agenda-mode)
  19185. (setq day (get-text-property (point) 'day))
  19186. (if day
  19187. (setq date (calendar-gregorian-from-absolute day)
  19188. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  19189. (nth 2 date))))))
  19190. (or defd (current-time))))
  19191. (defvar org-agenda-action-marker (make-marker)
  19192. "Marker pointing to the entry for the next agenda action.")
  19193. (defun org-mark-entry-for-agenda-action ()
  19194. "Mark the current entry as target of an agenda action.
  19195. Agenda actions are actions executed from the agenda with the key `k',
  19196. which make use of the date at the cursor."
  19197. (interactive)
  19198. (move-marker org-agenda-action-marker
  19199. (save-excursion (org-back-to-heading t) (point))
  19200. (current-buffer))
  19201. (message
  19202. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  19203. (defun org-mark-subtree (&optional up)
  19204. "Mark the current subtree.
  19205. This puts point at the start of the current subtree, and mark at
  19206. the end. If a numeric prefix UP is given, move up into the
  19207. hierarchy of headlines by UP levels before marking the subtree."
  19208. (interactive "P")
  19209. (org-with-limited-levels
  19210. (cond ((org-at-heading-p) (beginning-of-line))
  19211. ((org-before-first-heading-p) (error "Not in a subtree"))
  19212. (t (outline-previous-visible-heading 1))))
  19213. (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
  19214. (if (org-called-interactively-p 'any)
  19215. (call-interactively 'org-mark-element)
  19216. (org-mark-element)))
  19217. ;;; Macros
  19218. ;; Macros are expanded with `org-macro-replace-all', which relies
  19219. ;; internally on `org-macro-expand'.
  19220. ;; Templates for expansion are stored in the buffer-local variable
  19221. ;; `org-macro-templates'. This variable is updated by
  19222. ;; `org-macro-initialize-templates'.
  19223. (defvar org-macro-templates nil
  19224. "Alist containing all macro templates in current buffer.
  19225. Associations are in the shape of (NAME . TEMPLATE) where NAME
  19226. stands for macro's name and template for its replacement value,
  19227. both as strings. This is an internal variable. Do not set it
  19228. directly, use instead:
  19229. #+MACRO: name template")
  19230. (make-variable-buffer-local 'org-macro-templates)
  19231. (defun org-macro-expand (macro)
  19232. "Return expanded MACRO, as a string.
  19233. MACRO is an object, obtained, for example, with
  19234. `org-element-context'. Return nil if no template was found."
  19235. (let ((template
  19236. (cdr (assoc-string (org-element-property :key macro)
  19237. org-macro-templates
  19238. ;; Macro names are case-insensitive.
  19239. t))))
  19240. (when template
  19241. (let ((value (replace-regexp-in-string
  19242. "\\$[0-9]+"
  19243. (lambda (arg)
  19244. (or (nth (1- (string-to-number (substring arg 1)))
  19245. (org-element-property :args macro))
  19246. ;; No argument provided: remove
  19247. ;; place-holder.
  19248. ""))
  19249. template)))
  19250. ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
  19251. (when (string-match "\\`(eval\\>" value)
  19252. (setq value (eval (read value))))
  19253. ;; Return string.
  19254. (format "%s" (or value ""))))))
  19255. (defun org-macro-replace-all ()
  19256. "Replace all macros in current buffer by their expansion."
  19257. (save-excursion
  19258. (goto-char (point-min))
  19259. (while (re-search-forward "{{{[-A-Za-z0-9_]" nil t)
  19260. (let ((object (org-element-context)))
  19261. (when (eq (org-element-type object) 'macro)
  19262. (let ((value (org-macro-expand object)))
  19263. (when value
  19264. (delete-region
  19265. (org-element-property :begin object)
  19266. ;; Preserve white spaces after the macro.
  19267. (progn (goto-char (org-element-property :end object))
  19268. (skip-chars-backward " \t")
  19269. (point)))
  19270. ;; Leave point before replacement in case of recursive
  19271. ;; expansions.
  19272. (save-excursion (insert value)))))))))
  19273. (defun org-macro-initialize-templates ()
  19274. "Collect macro templates defined in current buffer.
  19275. Templates are stored in buffer-local variable
  19276. `org-macro-templates'. In addition to buffer-defined macros, the
  19277. function installs the following ones: \"property\", \"date\",
  19278. \"time\". and, if appropriate, \"input-file\" and
  19279. \"modification-time\"."
  19280. (let ((case-fold-search t)
  19281. (set-template
  19282. (lambda (cell)
  19283. ;; Add CELL to `org-macro-templates' if there's no
  19284. ;; association matching its name already. Otherwise,
  19285. ;; replace old association with the new one in that
  19286. ;; variable.
  19287. (let ((old-template (assoc (car cell) org-macro-templates)))
  19288. (if old-template (setcdr old-template (cdr cell))
  19289. (push cell org-macro-templates))))))
  19290. ;; Install buffer-local macros.
  19291. (org-with-wide-buffer
  19292. (goto-char (point-min))
  19293. (while (re-search-forward "^[ \t]*#\\+MACRO:" nil t)
  19294. (let ((element (org-element-at-point)))
  19295. (when (eq (org-element-type element) 'keyword)
  19296. (let ((value (org-element-property :value element)))
  19297. (when (string-match "^\\(.*?\\)\\(?:\\s-+\\(.*\\)\\)?\\s-*$" value)
  19298. (funcall set-template
  19299. (cons (match-string 1 value)
  19300. (or (match-string 2 value) "")))))))))
  19301. ;; Install hard-coded macros.
  19302. (mapc (lambda (cell) (funcall set-template cell))
  19303. (list
  19304. (cons "property" "(eval (org-entry-get nil \"$1\" 'selective))")
  19305. (cons "date" "(eval (format-time-string \"$1\"))")
  19306. (cons "time" "(eval (format-time-string \"$1\"))")))
  19307. (let ((visited-file (buffer-file-name (buffer-base-buffer))))
  19308. (when (and visited-file (file-exists-p visited-file))
  19309. (mapc (lambda (cell) (funcall set-template cell))
  19310. (list
  19311. (cons "input-file" (file-name-nondirectory visited-file))
  19312. (cons "modification-time"
  19313. (format "(eval (format-time-string \"$1\" '%s))"
  19314. (prin1-to-string
  19315. (nth 5 (file-attributes visited-file)))))))))))
  19316. ;;; Indentation
  19317. (defun org-indent-line ()
  19318. "Indent line depending on context."
  19319. (interactive)
  19320. (let* ((pos (point))
  19321. (itemp (org-at-item-p))
  19322. (case-fold-search t)
  19323. (org-drawer-regexp (or org-drawer-regexp "\000"))
  19324. (inline-task-p (and (featurep 'org-inlinetask)
  19325. (org-inlinetask-in-task-p)))
  19326. (inline-re (and inline-task-p
  19327. (org-inlinetask-outline-regexp)))
  19328. column)
  19329. (if (and orgstruct-is-++ (eq pos (point)))
  19330. (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
  19331. (indent-according-to-mode))
  19332. (beginning-of-line 1)
  19333. (cond
  19334. ;; Headings
  19335. ((looking-at org-outline-regexp) (setq column 0))
  19336. ;; Included files
  19337. ((looking-at "#\\+include:") (setq column 0))
  19338. ;; Footnote definition
  19339. ((looking-at org-footnote-definition-re) (setq column 0))
  19340. ;; Literal examples
  19341. ((looking-at "[ \t]*:\\( \\|$\\)")
  19342. (setq column (org-get-indentation))) ; do nothing
  19343. ;; Lists
  19344. ((ignore-errors (goto-char (org-in-item-p)))
  19345. (setq column (if itemp
  19346. (org-get-indentation)
  19347. (org-list-item-body-column (point))))
  19348. (goto-char pos))
  19349. ;; Drawers
  19350. ((and (looking-at "[ \t]*:END:")
  19351. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  19352. (save-excursion
  19353. (goto-char (1- (match-beginning 1)))
  19354. (setq column (current-column))))
  19355. ;; Special blocks
  19356. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  19357. (save-excursion
  19358. (re-search-backward
  19359. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  19360. (setq column (org-get-indentation (match-string 0))))
  19361. ((and (not (looking-at "[ \t]*#\\+begin_"))
  19362. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  19363. (save-excursion
  19364. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  19365. (setq column
  19366. (cond ((equal (downcase (match-string 1)) "src")
  19367. ;; src blocks: let `org-edit-src-exit' handle them
  19368. (org-get-indentation))
  19369. ((equal (downcase (match-string 1)) "example")
  19370. (max (org-get-indentation)
  19371. (org-get-indentation (match-string 0))))
  19372. (t
  19373. (org-get-indentation (match-string 0))))))
  19374. ;; This line has nothing special, look at the previous relevant
  19375. ;; line to compute indentation
  19376. (t
  19377. (beginning-of-line 0)
  19378. (while (and (not (bobp))
  19379. (not (looking-at org-drawer-regexp))
  19380. ;; When point started in an inline task, do not move
  19381. ;; above task starting line.
  19382. (not (and inline-task-p (looking-at inline-re)))
  19383. ;; Skip drawers, blocks, empty lines, verbatim,
  19384. ;; comments, tables, footnotes definitions, lists,
  19385. ;; inline tasks.
  19386. (or (and (looking-at "[ \t]*:END:")
  19387. (re-search-backward org-drawer-regexp nil t))
  19388. (and (looking-at "[ \t]*#\\+end_")
  19389. (re-search-backward "[ \t]*#\\+begin_"nil t))
  19390. (looking-at "[ \t]*[\n:#|]")
  19391. (looking-at org-footnote-definition-re)
  19392. (and (ignore-errors (goto-char (org-in-item-p)))
  19393. (goto-char
  19394. (org-list-get-top-point (org-list-struct))))
  19395. (and (not inline-task-p)
  19396. (featurep 'org-inlinetask)
  19397. (org-inlinetask-in-task-p)
  19398. (or (org-inlinetask-goto-beginning) t))))
  19399. (beginning-of-line 0))
  19400. (cond
  19401. ;; There was an heading above.
  19402. ((looking-at "\\*+[ \t]+")
  19403. (if (not org-adapt-indentation)
  19404. (setq column 0)
  19405. (goto-char (match-end 0))
  19406. (setq column (current-column))))
  19407. ;; A drawer had started and is unfinished
  19408. ((looking-at org-drawer-regexp)
  19409. (goto-char (1- (match-beginning 1)))
  19410. (setq column (current-column)))
  19411. ;; Else, nothing noticeable found: get indentation and go on.
  19412. (t (setq column (org-get-indentation))))))
  19413. ;; Now apply indentation and move cursor accordingly
  19414. (goto-char pos)
  19415. (if (<= (current-column) (current-indentation))
  19416. (org-indent-line-to column)
  19417. (save-excursion (org-indent-line-to column)))
  19418. ;; Special polishing for properties, see `org-property-format'
  19419. (setq column (current-column))
  19420. (beginning-of-line 1)
  19421. (if (looking-at
  19422. "\\([ \t]*\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  19423. (replace-match (concat (match-string 1)
  19424. (format org-property-format
  19425. (match-string 2) (match-string 3)))
  19426. t t))
  19427. (org-move-to-column column))))
  19428. (defun org-indent-drawer ()
  19429. "Indent the drawer at point."
  19430. (interactive)
  19431. (let ((p (point))
  19432. (e (and (save-excursion (re-search-forward ":END:" nil t))
  19433. (match-end 0)))
  19434. (folded
  19435. (save-excursion
  19436. (end-of-line)
  19437. (when (overlays-at (point))
  19438. (member 'invisible (overlay-properties
  19439. (car (overlays-at (point)))))))))
  19440. (when folded (org-cycle))
  19441. (indent-for-tab-command)
  19442. (while (and (move-beginning-of-line 2) (< (point) e))
  19443. (indent-for-tab-command))
  19444. (goto-char p)
  19445. (when folded (org-cycle)))
  19446. (message "Drawer at point indented"))
  19447. (defun org-indent-block ()
  19448. "Indent the block at point."
  19449. (interactive)
  19450. (let ((p (point))
  19451. (case-fold-search t)
  19452. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  19453. (match-end 0)))
  19454. (folded
  19455. (save-excursion
  19456. (end-of-line)
  19457. (when (overlays-at (point))
  19458. (member 'invisible (overlay-properties
  19459. (car (overlays-at (point)))))))))
  19460. (when folded (org-cycle))
  19461. (indent-for-tab-command)
  19462. (while (and (move-beginning-of-line 2) (< (point) e))
  19463. (indent-for-tab-command))
  19464. (goto-char p)
  19465. (when folded (org-cycle)))
  19466. (message "Block at point indented"))
  19467. (defun org-indent-region (start end)
  19468. "Indent region."
  19469. (interactive "r")
  19470. (save-excursion
  19471. (let ((line-end (org-current-line end)))
  19472. (goto-char start)
  19473. (while (< (org-current-line) line-end)
  19474. (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
  19475. (t (call-interactively 'org-indent-line)))
  19476. (move-beginning-of-line 2)))))
  19477. ;;; Filling
  19478. ;; We use our own fill-paragraph and auto-fill functions.
  19479. ;; `org-fill-paragraph' relies on adaptive filling and context
  19480. ;; checking. Appropriate `fill-prefix' is computed with
  19481. ;; `org-adaptive-fill-function'.
  19482. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  19483. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  19484. ;; `org-adaptive-fill-function' value. Internally,
  19485. ;; `org-comment-line-break-function' breaks the line.
  19486. ;; `org-setup-filling' installs filling and auto-filling related
  19487. ;; variables during `org-mode' initialization.
  19488. (defun org-setup-filling ()
  19489. (interactive)
  19490. ;; Prevent auto-fill from inserting unwanted new items.
  19491. (when (boundp 'fill-nobreak-predicate)
  19492. (org-set-local
  19493. 'fill-nobreak-predicate
  19494. (org-uniquify
  19495. (append fill-nobreak-predicate
  19496. '(org-fill-paragraph-separate-nobreak-p
  19497. org-fill-line-break-nobreak-p)))))
  19498. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  19499. (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
  19500. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  19501. (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
  19502. (defvar org-element-paragraph-separate) ; org-element.el
  19503. (defun org-fill-paragraph-separate-nobreak-p ()
  19504. "Non-nil when a line break at point would insert a new item."
  19505. (looking-at (substring org-element-paragraph-separate 1)))
  19506. (defun org-fill-line-break-nobreak-p ()
  19507. "Non-nil when a line break at point would create an Org line break."
  19508. (save-excursion
  19509. (skip-chars-backward "[ \t]")
  19510. (skip-chars-backward "\\\\")
  19511. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  19512. (declare-function message-in-body-p "message" ())
  19513. (defvar org-element--affiliated-re) ; From org-element.el
  19514. (defun org-adaptive-fill-function ()
  19515. "Compute a fill prefix for the current line.
  19516. Return fill prefix, as a string, or nil if current line isn't
  19517. meant to be filled."
  19518. (org-with-wide-buffer
  19519. (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
  19520. ;; FIXME: This is really the job of orgstruct++-mode
  19521. (let* ((p (line-beginning-position))
  19522. (element (save-excursion (beginning-of-line)
  19523. (org-element-at-point)))
  19524. (type (org-element-type element))
  19525. (post-affiliated
  19526. (save-excursion
  19527. (goto-char (org-element-property :begin element))
  19528. (while (looking-at org-element--affiliated-re) (forward-line))
  19529. (point))))
  19530. (unless (< p post-affiliated)
  19531. (case type
  19532. (comment (looking-at "[ \t]*# ?") (match-string 0))
  19533. (footnote-definition "")
  19534. ((item plain-list)
  19535. (make-string (org-list-item-body-column post-affiliated) ? ))
  19536. (paragraph
  19537. ;; Fill prefix is usually the same as the current line,
  19538. ;; except if the paragraph is at the beginning of an item.
  19539. (let ((parent (org-element-property :parent element)))
  19540. (cond ((eq (org-element-type parent) 'item)
  19541. (make-string (org-list-item-body-column
  19542. (org-element-property :begin parent))
  19543. ? ))
  19544. ((save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  19545. (match-string 0))
  19546. (t ""))))
  19547. (comment-block
  19548. ;; Only fill contents if P is within block boundaries.
  19549. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  19550. (forward-line)
  19551. (point)))
  19552. (cend (save-excursion
  19553. (goto-char (org-element-property :end element))
  19554. (skip-chars-backward " \r\t\n")
  19555. (line-beginning-position))))
  19556. (when (and (>= p cbeg) (< p cend))
  19557. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  19558. (match-string 0)
  19559. ""))))))))))
  19560. (declare-function message-goto-body "message" ())
  19561. (defvar message-cite-prefix-regexp) ; From message.el
  19562. (defvar org-element-all-objects) ; From org-element.el
  19563. (defun org-fill-paragraph (&optional justify)
  19564. "Fill element at point, when applicable.
  19565. This function only applies to comment blocks, comments, example
  19566. blocks and paragraphs. Also, as a special case, re-align table
  19567. when point is at one.
  19568. If JUSTIFY is non-nil (interactively, with prefix argument),
  19569. justify as well. If `sentence-end-double-space' is non-nil, then
  19570. period followed by one space does not end a sentence, so don't
  19571. break a line there. The variable `fill-column' controls the
  19572. width for filling.
  19573. For convenience, when point is at a plain list, an item or
  19574. a footnote definition, try to fill the first paragraph within."
  19575. ;; Falls back on message-fill-paragraph when necessary
  19576. (interactive)
  19577. (if (and (derived-mode-p 'message-mode)
  19578. (or (not (message-in-body-p))
  19579. (save-excursion (move-beginning-of-line 1)
  19580. (looking-at message-cite-prefix-regexp))))
  19581. (let ((fill-paragraph-function
  19582. (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
  19583. (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
  19584. (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
  19585. (paragraph-separate
  19586. (cadadr (assoc 'paragraph-separate org-fb-vars))))
  19587. (fill-paragraph nil))
  19588. (save-excursion
  19589. ;; Move to end of line in order to get the first paragraph
  19590. ;; within a plain list or a footnote definition.
  19591. (end-of-line)
  19592. (let ((element (org-element-at-point)))
  19593. ;; First check if point is in a blank line at the beginning of
  19594. ;; the buffer. In that case, ignore filling.
  19595. (if (< (point) (org-element-property :begin element)) t
  19596. (case (org-element-type element)
  19597. ;; Align Org tables, leave table.el tables as-is.
  19598. (table-row (org-table-align) t)
  19599. (table
  19600. (when (eq (org-element-property :type element) 'org)
  19601. (org-table-align))
  19602. t)
  19603. (paragraph
  19604. ;; Paragraphs may contain `line-break' type objects.
  19605. (let ((beg (max (point-min)
  19606. (org-element-property :contents-begin element)))
  19607. (end (min (point-max)
  19608. (org-element-property :contents-end element))))
  19609. ;; Do nothing if point is at an affiliated keyword.
  19610. (if (< (point) beg) t
  19611. (when (derived-mode-p 'message-mode)
  19612. ;; In `message-mode', do not fill following
  19613. ;; citation in current paragraph nor text before
  19614. ;; message body.
  19615. (let ((body-start (save-excursion (message-goto-body))))
  19616. (when body-start (setq beg (max body-start beg))))
  19617. (when (save-excursion
  19618. (re-search-forward
  19619. (concat "^" message-cite-prefix-regexp) end t))
  19620. (setq end (match-beginning 0))))
  19621. ;; Fill paragraph, taking line breaks into
  19622. ;; consideration. For that, slice the paragraph
  19623. ;; using line breaks as separators, and fill the
  19624. ;; parts in reverse order to avoid messing with
  19625. ;; markers.
  19626. (save-excursion
  19627. (goto-char end)
  19628. (mapc
  19629. (lambda (pos)
  19630. (fill-region-as-paragraph pos (point) justify)
  19631. (goto-char pos))
  19632. ;; Find the list of ending positions for line
  19633. ;; breaks in the current paragraph. Add paragraph
  19634. ;; beginning to include first slice.
  19635. (nreverse
  19636. (cons
  19637. beg
  19638. (org-element-map
  19639. (org-element--parse-objects
  19640. beg end nil org-element-all-objects)
  19641. 'line-break
  19642. (lambda (lb) (org-element-property :end lb)))))))
  19643. t)))
  19644. ;; Contents of `comment-block' type elements should be
  19645. ;; filled as plain text, but only if point is within block
  19646. ;; markers.
  19647. (comment-block
  19648. (let* ((case-fold-search t)
  19649. (beg (save-excursion
  19650. (goto-char (org-element-property :begin element))
  19651. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  19652. (forward-line)
  19653. (point)))
  19654. (end (save-excursion
  19655. (goto-char (org-element-property :end element))
  19656. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  19657. (line-beginning-position))))
  19658. (when (and (>= (point) beg) (< (point) end))
  19659. (fill-region-as-paragraph
  19660. (save-excursion
  19661. (end-of-line)
  19662. (re-search-backward "^[ \t]*$" beg 'move)
  19663. (line-beginning-position))
  19664. (save-excursion
  19665. (beginning-of-line)
  19666. (re-search-forward "^[ \t]*$" end 'move)
  19667. (line-beginning-position))
  19668. justify)))
  19669. t)
  19670. ;; Fill comments.
  19671. (comment (fill-comment-paragraph justify))
  19672. ;; Ignore every other element.
  19673. (otherwise t)))))))
  19674. (defun org-auto-fill-function ()
  19675. "Auto-fill function."
  19676. ;; Check if auto-filling is meaningful.
  19677. (let ((fc (current-fill-column)))
  19678. (when (and fc (> (current-column) fc))
  19679. (let ((fill-prefix (org-adaptive-fill-function)))
  19680. (when fill-prefix (do-auto-fill))))))
  19681. (defun org-comment-line-break-function (&optional soft)
  19682. "Break line at point and indent, continuing comment if within one.
  19683. The inserted newline is marked hard if variable
  19684. `use-hard-newlines' is true, unless optional argument SOFT is
  19685. non-nil."
  19686. (if soft (insert-and-inherit ?\n) (newline 1))
  19687. (save-excursion (forward-char -1) (delete-horizontal-space))
  19688. (delete-horizontal-space)
  19689. (indent-to-left-margin)
  19690. (insert-before-markers-and-inherit fill-prefix))
  19691. ;;; Comments
  19692. ;; Org comments syntax is quite complex. It requires the entire line
  19693. ;; to be just a comment. Also, even with the right syntax at the
  19694. ;; beginning of line, some some elements (i.e. verse-block or
  19695. ;; example-block) don't accept comments. Usual Emacs comment commands
  19696. ;; cannot cope with those requirements. Therefore, Org replaces them.
  19697. ;; Org still relies on `comment-dwim', but cannot trust
  19698. ;; `comment-only-p'. So, `comment-region-function' and
  19699. ;; `uncomment-region-function' both point
  19700. ;; to`org-comment-or-uncomment-region'. Eventually,
  19701. ;; `org-insert-comment' takes care of insertion of comments at the
  19702. ;; beginning of line.
  19703. ;; `org-setup-comments-handling' install comments related variables
  19704. ;; during `org-mode' initialization.
  19705. (defun org-setup-comments-handling ()
  19706. (interactive)
  19707. (org-set-local 'comment-use-syntax nil)
  19708. (org-set-local 'comment-start "# ")
  19709. (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  19710. (org-set-local 'comment-insert-comment-function 'org-insert-comment)
  19711. (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
  19712. (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
  19713. (defun org-insert-comment ()
  19714. "Insert an empty comment above current line.
  19715. If the line is empty, insert comment at its beginning."
  19716. (beginning-of-line)
  19717. (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
  19718. (org-indent-line)
  19719. (insert "# "))
  19720. (defvar comment-empty-lines) ; From newcomment.el.
  19721. (defun org-comment-or-uncomment-region (beg end &rest ignore)
  19722. "Comment or uncomment each non-blank line in the region.
  19723. Uncomment each non-blank line between BEG and END if it only
  19724. contains commented lines. Otherwise, comment them."
  19725. (save-restriction
  19726. ;; Restrict region
  19727. (narrow-to-region (save-excursion (goto-char beg)
  19728. (skip-chars-forward " \r\t\n" end)
  19729. (line-beginning-position))
  19730. (save-excursion (goto-char end)
  19731. (skip-chars-backward " \r\t\n" beg)
  19732. (line-end-position)))
  19733. (let ((uncommentp
  19734. ;; UNCOMMENTP is non-nil when every non blank line between
  19735. ;; BEG and END is a comment.
  19736. (save-excursion
  19737. (goto-char (point-min))
  19738. (while (and (not (eobp))
  19739. (let ((element (org-element-at-point)))
  19740. (and (eq (org-element-type element) 'comment)
  19741. (goto-char (min (point-max)
  19742. (org-element-property
  19743. :end element)))))))
  19744. (eobp))))
  19745. (if uncommentp
  19746. ;; Only blank lines and comments in region: uncomment it.
  19747. (save-excursion
  19748. (goto-char (point-min))
  19749. (while (not (eobp))
  19750. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  19751. (replace-match "" nil nil nil 1))
  19752. (forward-line)))
  19753. ;; Comment each line in region.
  19754. (let ((min-indent (point-max)))
  19755. ;; First find the minimum indentation across all lines.
  19756. (save-excursion
  19757. (goto-char (point-min))
  19758. (while (and (not (eobp)) (not (zerop min-indent)))
  19759. (unless (looking-at "[ \t]*$")
  19760. (setq min-indent (min min-indent (current-indentation))))
  19761. (forward-line)))
  19762. ;; Then loop over all lines.
  19763. (save-excursion
  19764. (goto-char (point-min))
  19765. (while (not (eobp))
  19766. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  19767. (org-move-to-column min-indent t)
  19768. (insert comment-start))
  19769. (forward-line))))))))
  19770. ;;; Other stuff.
  19771. (defun org-toggle-fixed-width-section (arg)
  19772. "Toggle the fixed-width export.
  19773. If there is no active region, the QUOTE keyword at the current headline is
  19774. inserted or removed. When present, it causes the text between this headline
  19775. and the next to be exported as fixed-width text, and unmodified.
  19776. If there is an active region, this command adds or removes a colon as the
  19777. first character of this line. If the first character of a line is a colon,
  19778. this line is also exported in fixed-width font."
  19779. (interactive "P")
  19780. (let* ((cc 0)
  19781. (regionp (org-region-active-p))
  19782. (beg (if regionp (region-beginning) (point)))
  19783. (end (if regionp (region-end)))
  19784. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  19785. (case-fold-search nil)
  19786. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  19787. off)
  19788. (if regionp
  19789. (save-excursion
  19790. (goto-char beg)
  19791. (setq cc (current-column))
  19792. (beginning-of-line 1)
  19793. (setq off (looking-at re))
  19794. (while (> nlines 0)
  19795. (setq nlines (1- nlines))
  19796. (beginning-of-line 1)
  19797. (cond
  19798. (arg
  19799. (org-move-to-column cc t)
  19800. (insert ": \n")
  19801. (forward-line -1))
  19802. ((and off (looking-at re))
  19803. (replace-match "" t t nil 1))
  19804. ((not off) (org-move-to-column cc t) (insert ": ")))
  19805. (forward-line 1)))
  19806. (save-excursion
  19807. (org-back-to-heading)
  19808. (cond
  19809. ((looking-at (format org-heading-keyword-regexp-format
  19810. org-quote-string))
  19811. (goto-char (match-end 1))
  19812. (looking-at (concat " +" org-quote-string))
  19813. (replace-match "" t t)
  19814. (when (eolp) (insert " ")))
  19815. ((looking-at org-outline-regexp)
  19816. (goto-char (match-end 0))
  19817. (insert org-quote-string " ")))))))
  19818. (defun org-reftex-citation ()
  19819. "Use reftex-citation to insert a citation into the buffer.
  19820. This looks for a line like
  19821. #+BIBLIOGRAPHY: foo plain option:-d
  19822. and derives from it that foo.bib is the bibliography file relevant
  19823. for this document. It then installs the necessary environment for RefTeX
  19824. to work in this buffer and calls `reftex-citation' to insert a citation
  19825. into the buffer.
  19826. Export of such citations to both LaTeX and HTML is handled by the contributed
  19827. package org-exp-bibtex by Taru Karttunen."
  19828. (interactive)
  19829. (let ((reftex-docstruct-symbol 'rds)
  19830. (reftex-cite-format "\\cite{%l}")
  19831. rds bib)
  19832. (save-excursion
  19833. (save-restriction
  19834. (widen)
  19835. (let ((case-fold-search t)
  19836. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  19837. (if (not (save-excursion
  19838. (or (re-search-forward re nil t)
  19839. (re-search-backward re nil t))))
  19840. (error "No bibliography defined in file")
  19841. (setq bib (concat (match-string 1) ".bib")
  19842. rds (list (list 'bib bib)))))))
  19843. (call-interactively 'reftex-citation)))
  19844. ;;;; Functions extending outline functionality
  19845. (defun org-beginning-of-line (&optional arg)
  19846. "Go to the beginning of the current line. If that is invisible, continue
  19847. to a visible line beginning. This makes the function of C-a more intuitive.
  19848. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19849. first attempt, and only move to after the tags when the cursor is already
  19850. beyond the end of the headline."
  19851. (interactive "P")
  19852. (let ((pos (point))
  19853. (special (if (consp org-special-ctrl-a/e)
  19854. (car org-special-ctrl-a/e)
  19855. org-special-ctrl-a/e))
  19856. refpos)
  19857. (if (org-bound-and-true-p line-move-visual)
  19858. (beginning-of-visual-line 1)
  19859. (beginning-of-line 1))
  19860. (if (and arg (fboundp 'move-beginning-of-line))
  19861. (call-interactively 'move-beginning-of-line)
  19862. (if (bobp)
  19863. nil
  19864. (backward-char 1)
  19865. (if (org-truely-invisible-p)
  19866. (while (and (not (bobp)) (org-truely-invisible-p))
  19867. (backward-char 1)
  19868. (beginning-of-line 1))
  19869. (forward-char 1))))
  19870. (when special
  19871. (cond
  19872. ((and (looking-at org-complex-heading-regexp)
  19873. (= (char-after (match-end 1)) ?\ ))
  19874. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  19875. (point-at-eol)))
  19876. (goto-char
  19877. (if (eq special t)
  19878. (cond ((> pos refpos) refpos)
  19879. ((= pos (point)) refpos)
  19880. (t (point)))
  19881. (cond ((> pos (point)) (point))
  19882. ((not (eq last-command this-command)) (point))
  19883. (t refpos)))))
  19884. ((org-at-item-p)
  19885. ;; Being at an item and not looking at an the item means point
  19886. ;; was previously moved to beginning of a visual line, which
  19887. ;; doesn't contain the item. Therefore, do nothing special,
  19888. ;; just stay here.
  19889. (when (looking-at org-list-full-item-re)
  19890. ;; Set special position at first white space character after
  19891. ;; bullet, and check-box, if any.
  19892. (let ((after-bullet
  19893. (let ((box (match-end 3)))
  19894. (if (not box) (match-end 1)
  19895. (let ((after (char-after box)))
  19896. (if (and after (= after ? )) (1+ box) box))))))
  19897. ;; Special case: Move point to special position when
  19898. ;; currently after it or at beginning of line.
  19899. (if (eq special t)
  19900. (when (or (> pos after-bullet) (= (point) pos))
  19901. (goto-char after-bullet))
  19902. ;; Reversed case: Move point to special position when
  19903. ;; point was already at beginning of line and command is
  19904. ;; repeated.
  19905. (when (and (= (point) pos) (eq last-command this-command))
  19906. (goto-char after-bullet))))))))
  19907. (org-no-warnings
  19908. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19909. (defun org-end-of-line (&optional arg)
  19910. "Go to the end of the line.
  19911. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19912. first attempt, and only move to after the tags when the cursor is already
  19913. beyond the end of the headline."
  19914. (interactive "P")
  19915. (let ((special (if (consp org-special-ctrl-a/e)
  19916. (cdr org-special-ctrl-a/e)
  19917. org-special-ctrl-a/e)))
  19918. (cond
  19919. ((or (not special) arg
  19920. (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
  19921. (call-interactively
  19922. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19923. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19924. (t 'end-of-line))))
  19925. ((org-at-heading-p)
  19926. (let ((pos (point)))
  19927. (beginning-of-line 1)
  19928. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  19929. (if (eq special t)
  19930. (if (or (< pos (match-beginning 1))
  19931. (= pos (match-end 0)))
  19932. (goto-char (match-beginning 1))
  19933. (goto-char (match-end 0)))
  19934. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  19935. (goto-char (match-end 0))
  19936. (goto-char (match-beginning 1))))
  19937. (call-interactively (if (fboundp 'move-end-of-line)
  19938. 'move-end-of-line
  19939. 'end-of-line)))))
  19940. ((org-at-drawer-p)
  19941. (move-end-of-line 1)
  19942. (when (overlays-at (1- (point))) (backward-char 1)))
  19943. ;; At an item: Move before any hidden text.
  19944. (t (call-interactively
  19945. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19946. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19947. (t 'end-of-line)))))
  19948. (org-no-warnings
  19949. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19950. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  19951. (define-key org-mode-map "\C-e" 'org-end-of-line)
  19952. (defun org-backward-sentence (&optional arg)
  19953. "Go to beginning of sentence, or beginning of table field.
  19954. This will call `backward-sentence' or `org-table-beginning-of-field',
  19955. depending on context."
  19956. (interactive "P")
  19957. (cond
  19958. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  19959. (t (call-interactively 'backward-sentence))))
  19960. (defun org-forward-sentence (&optional arg)
  19961. "Go to end of sentence, or end of table field.
  19962. This will call `forward-sentence' or `org-table-end-of-field',
  19963. depending on context."
  19964. (interactive "P")
  19965. (cond
  19966. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  19967. (t (call-interactively 'forward-sentence))))
  19968. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  19969. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  19970. (defun org-kill-line (&optional arg)
  19971. "Kill line, to tags or end of line."
  19972. (interactive "P")
  19973. (cond
  19974. ((or (not org-special-ctrl-k)
  19975. (bolp)
  19976. (not (org-at-heading-p)))
  19977. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  19978. org-ctrl-k-protect-subtree)
  19979. (if (or (eq org-ctrl-k-protect-subtree 'error)
  19980. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  19981. (error "C-k aborted - would kill hidden subtree")))
  19982. (call-interactively
  19983. (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
  19984. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  19985. (kill-region (point) (match-beginning 1))
  19986. (org-set-tags nil t))
  19987. (t (kill-region (point) (point-at-eol)))))
  19988. (define-key org-mode-map "\C-k" 'org-kill-line)
  19989. (defun org-yank (&optional arg)
  19990. "Yank. If the kill is a subtree, treat it specially.
  19991. This command will look at the current kill and check if is a single
  19992. subtree, or a series of subtrees[1]. If it passes the test, and if the
  19993. cursor is at the beginning of a line or after the stars of a currently
  19994. empty headline, then the yank is handled specially. How exactly depends
  19995. on the value of the following variables, both set by default.
  19996. org-yank-folded-subtrees
  19997. When set, the subtree(s) will be folded after insertion, but only
  19998. if doing so would now swallow text after the yanked text.
  19999. org-yank-adjusted-subtrees
  20000. When set, the subtree will be promoted or demoted in order to
  20001. fit into the local outline tree structure, which means that the level
  20002. will be adjusted so that it becomes the smaller one of the two
  20003. *visible* surrounding headings.
  20004. Any prefix to this command will cause `yank' to be called directly with
  20005. no special treatment. In particular, a simple \\[universal-argument] prefix \
  20006. will just
  20007. plainly yank the text as it is.
  20008. \[1] The test checks if the first non-white line is a heading
  20009. and if there are no other headings with fewer stars."
  20010. (interactive "P")
  20011. (org-yank-generic 'yank arg))
  20012. (defun org-yank-generic (command arg)
  20013. "Perform some yank-like command.
  20014. This function implements the behavior described in the `org-yank'
  20015. documentation. However, it has been generalized to work for any
  20016. interactive command with similar behavior."
  20017. ;; pretend to be command COMMAND
  20018. (setq this-command command)
  20019. (if arg
  20020. (call-interactively command)
  20021. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  20022. (and (org-kill-is-subtree-p)
  20023. (or (bolp)
  20024. (and (looking-at "[ \t]*$")
  20025. (string-match
  20026. "\\`\\*+\\'"
  20027. (buffer-substring (point-at-bol) (point)))))))
  20028. swallowp)
  20029. (cond
  20030. ((and subtreep org-yank-folded-subtrees)
  20031. (let ((beg (point))
  20032. end)
  20033. (if (and subtreep org-yank-adjusted-subtrees)
  20034. (org-paste-subtree nil nil 'for-yank)
  20035. (call-interactively command))
  20036. (setq end (point))
  20037. (goto-char beg)
  20038. (when (and (bolp) subtreep
  20039. (not (setq swallowp
  20040. (org-yank-folding-would-swallow-text beg end))))
  20041. (org-with-limited-levels
  20042. (or (looking-at org-outline-regexp)
  20043. (re-search-forward org-outline-regexp-bol end t))
  20044. (while (and (< (point) end) (looking-at org-outline-regexp))
  20045. (hide-subtree)
  20046. (org-cycle-show-empty-lines 'folded)
  20047. (condition-case nil
  20048. (outline-forward-same-level 1)
  20049. (error (goto-char end))))))
  20050. (when swallowp
  20051. (message
  20052. "Inserted text not folded because that would swallow text"))
  20053. (goto-char end)
  20054. (skip-chars-forward " \t\n\r")
  20055. (beginning-of-line 1)
  20056. (push-mark beg 'nomsg)))
  20057. ((and subtreep org-yank-adjusted-subtrees)
  20058. (let ((beg (point-at-bol)))
  20059. (org-paste-subtree nil nil 'for-yank)
  20060. (push-mark beg 'nomsg)))
  20061. (t
  20062. (call-interactively command))))))
  20063. (defun org-yank-folding-would-swallow-text (beg end)
  20064. "Would hide-subtree at BEG swallow any text after END?"
  20065. (let (level)
  20066. (org-with-limited-levels
  20067. (save-excursion
  20068. (goto-char beg)
  20069. (when (or (looking-at org-outline-regexp)
  20070. (re-search-forward org-outline-regexp-bol end t))
  20071. (setq level (org-outline-level)))
  20072. (goto-char end)
  20073. (skip-chars-forward " \t\r\n\v\f")
  20074. (if (or (eobp)
  20075. (and (bolp) (looking-at org-outline-regexp)
  20076. (<= (org-outline-level) level)))
  20077. nil ; Nothing would be swallowed
  20078. t))))) ; something would swallow
  20079. (define-key org-mode-map "\C-y" 'org-yank)
  20080. (defun org-truely-invisible-p ()
  20081. "Check if point is at a character currently not visible.
  20082. This version does not only check the character property, but also
  20083. `visible-mode'."
  20084. ;; Early versions of noutline don't have `outline-invisible-p'.
  20085. (if (org-bound-and-true-p visible-mode)
  20086. nil
  20087. (outline-invisible-p)))
  20088. (defun org-invisible-p2 ()
  20089. "Check if point is at a character currently not visible."
  20090. (save-excursion
  20091. (if (and (eolp) (not (bobp))) (backward-char 1))
  20092. ;; Early versions of noutline don't have `outline-invisible-p'.
  20093. (outline-invisible-p)))
  20094. (defun org-back-to-heading (&optional invisible-ok)
  20095. "Call `outline-back-to-heading', but provide a better error message."
  20096. (condition-case nil
  20097. (outline-back-to-heading invisible-ok)
  20098. (error (error "Before first headline at position %d in buffer %s"
  20099. (point) (current-buffer)))))
  20100. (defun org-before-first-heading-p ()
  20101. "Before first heading?"
  20102. (save-excursion
  20103. (end-of-line)
  20104. (null (re-search-backward org-outline-regexp-bol nil t))))
  20105. (defun org-at-heading-p (&optional ignored)
  20106. (outline-on-heading-p t))
  20107. ;; Compatibility alias with Org versions < 7.8.03
  20108. (defalias 'org-on-heading-p 'org-at-heading-p)
  20109. (defun org-at-comment-p nil
  20110. "Is cursor in a line starting with a # character?"
  20111. (save-excursion
  20112. (beginning-of-line)
  20113. (looking-at "^#")))
  20114. (defun org-at-drawer-p nil
  20115. "Is cursor at a drawer keyword?"
  20116. (save-excursion
  20117. (move-beginning-of-line 1)
  20118. (looking-at org-drawer-regexp)))
  20119. (defun org-at-block-p nil
  20120. "Is cursor at a block keyword?"
  20121. (save-excursion
  20122. (move-beginning-of-line 1)
  20123. (looking-at org-block-regexp)))
  20124. (defun org-point-at-end-of-empty-headline ()
  20125. "If point is at the end of an empty headline, return t, else nil.
  20126. If the heading only contains a TODO keyword, it is still still considered
  20127. empty."
  20128. (and (looking-at "[ \t]*$")
  20129. (when org-todo-line-regexp
  20130. (save-excursion
  20131. (beginning-of-line 1)
  20132. (let ((case-fold-search nil))
  20133. (looking-at org-todo-line-regexp)
  20134. (string= (match-string 3) ""))))))
  20135. (defun org-at-heading-or-item-p ()
  20136. (or (org-at-heading-p) (org-at-item-p)))
  20137. (defun org-at-target-p ()
  20138. (or (org-in-regexp org-radio-target-regexp)
  20139. (org-in-regexp org-target-regexp)))
  20140. ;; Compatibility alias with Org versions < 7.8.03
  20141. (defalias 'org-on-target-p 'org-at-target-p)
  20142. (defun org-up-heading-all (arg)
  20143. "Move to the heading line of which the present line is a subheading.
  20144. This function considers both visible and invisible heading lines.
  20145. With argument, move up ARG levels."
  20146. (if (fboundp 'outline-up-heading-all)
  20147. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  20148. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  20149. (defun org-up-heading-safe ()
  20150. "Move to the heading line of which the present line is a subheading.
  20151. This version will not throw an error. It will return the level of the
  20152. headline found, or nil if no higher level is found.
  20153. Also, this function will be a lot faster than `outline-up-heading',
  20154. because it relies on stars being the outline starters. This can really
  20155. make a significant difference in outlines with very many siblings."
  20156. (let (start-level re)
  20157. (org-back-to-heading t)
  20158. (setq start-level (funcall outline-level))
  20159. (if (equal start-level 1)
  20160. nil
  20161. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  20162. (if (re-search-backward re nil t)
  20163. (funcall outline-level)))))
  20164. (defun org-first-sibling-p ()
  20165. "Is this heading the first child of its parents?"
  20166. (interactive)
  20167. (let ((re org-outline-regexp-bol)
  20168. level l)
  20169. (unless (org-at-heading-p t)
  20170. (error "Not at a heading"))
  20171. (setq level (funcall outline-level))
  20172. (save-excursion
  20173. (if (not (re-search-backward re nil t))
  20174. t
  20175. (setq l (funcall outline-level))
  20176. (< l level)))))
  20177. (defun org-goto-sibling (&optional previous)
  20178. "Goto the next sibling, even if it is invisible.
  20179. When PREVIOUS is set, go to the previous sibling instead. Returns t
  20180. when a sibling was found. When none is found, return nil and don't
  20181. move point."
  20182. (let ((fun (if previous 're-search-backward 're-search-forward))
  20183. (pos (point))
  20184. (re org-outline-regexp-bol)
  20185. level l)
  20186. (when (condition-case nil (org-back-to-heading t) (error nil))
  20187. (setq level (funcall outline-level))
  20188. (catch 'exit
  20189. (or previous (forward-char 1))
  20190. (while (funcall fun re nil t)
  20191. (setq l (funcall outline-level))
  20192. (when (< l level) (goto-char pos) (throw 'exit nil))
  20193. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  20194. (goto-char pos)
  20195. nil))))
  20196. (defun org-show-siblings ()
  20197. "Show all siblings of the current headline."
  20198. (save-excursion
  20199. (while (org-goto-sibling) (org-flag-heading nil)))
  20200. (save-excursion
  20201. (while (org-goto-sibling 'previous)
  20202. (org-flag-heading nil))))
  20203. (defun org-goto-first-child ()
  20204. "Goto the first child, even if it is invisible.
  20205. Return t when a child was found. Otherwise don't move point and
  20206. return nil."
  20207. (let (level (pos (point)) (re org-outline-regexp-bol))
  20208. (when (condition-case nil (org-back-to-heading t) (error nil))
  20209. (setq level (outline-level))
  20210. (forward-char 1)
  20211. (if (and (re-search-forward re nil t) (> (outline-level) level))
  20212. (progn (goto-char (match-beginning 0)) t)
  20213. (goto-char pos) nil))))
  20214. (defun org-show-hidden-entry ()
  20215. "Show an entry where even the heading is hidden."
  20216. (save-excursion
  20217. (org-show-entry)))
  20218. (defun org-flag-heading (flag &optional entry)
  20219. "Flag the current heading. FLAG non-nil means make invisible.
  20220. When ENTRY is non-nil, show the entire entry."
  20221. (save-excursion
  20222. (org-back-to-heading t)
  20223. ;; Check if we should show the entire entry
  20224. (if entry
  20225. (progn
  20226. (org-show-entry)
  20227. (save-excursion
  20228. (and (outline-next-heading)
  20229. (org-flag-heading nil))))
  20230. (outline-flag-region (max (point-min) (1- (point)))
  20231. (save-excursion (outline-end-of-heading) (point))
  20232. flag))))
  20233. (defun org-get-next-sibling ()
  20234. "Move to next heading of the same level, and return point.
  20235. If there is no such heading, return nil.
  20236. This is like outline-next-sibling, but invisible headings are ok."
  20237. (let ((level (funcall outline-level)))
  20238. (outline-next-heading)
  20239. (while (and (not (eobp)) (> (funcall outline-level) level))
  20240. (outline-next-heading))
  20241. (if (or (eobp) (< (funcall outline-level) level))
  20242. nil
  20243. (point))))
  20244. (defun org-get-last-sibling ()
  20245. "Move to previous heading of the same level, and return point.
  20246. If there is no such heading, return nil."
  20247. (let ((opoint (point))
  20248. (level (funcall outline-level)))
  20249. (outline-previous-heading)
  20250. (when (and (/= (point) opoint) (outline-on-heading-p t))
  20251. (while (and (> (funcall outline-level) level)
  20252. (not (bobp)))
  20253. (outline-previous-heading))
  20254. (if (< (funcall outline-level) level)
  20255. nil
  20256. (point)))))
  20257. (defun org-end-of-subtree (&optional invisible-ok to-heading)
  20258. "Goto to the end of a subtree."
  20259. ;; This contains an exact copy of the original function, but it uses
  20260. ;; `org-back-to-heading', to make it work also in invisible
  20261. ;; trees. And is uses an invisible-ok argument.
  20262. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  20263. ;; Furthermore, when used inside Org, finding the end of a large subtree
  20264. ;; with many children and grandchildren etc, this can be much faster
  20265. ;; than the outline version.
  20266. (org-back-to-heading invisible-ok)
  20267. (let ((first t)
  20268. (level (funcall outline-level)))
  20269. (if (and (derived-mode-p 'org-mode) (< level 1000))
  20270. ;; A true heading (not a plain list item), in Org-mode
  20271. ;; This means we can easily find the end by looking
  20272. ;; only for the right number of stars. Using a regexp to do
  20273. ;; this is so much faster than using a Lisp loop.
  20274. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  20275. (forward-char 1)
  20276. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  20277. ;; something else, do it the slow way
  20278. (while (and (not (eobp))
  20279. (or first (> (funcall outline-level) level)))
  20280. (setq first nil)
  20281. (outline-next-heading)))
  20282. (unless to-heading
  20283. (if (memq (preceding-char) '(?\n ?\^M))
  20284. (progn
  20285. ;; Go to end of line before heading
  20286. (forward-char -1)
  20287. (if (memq (preceding-char) '(?\n ?\^M))
  20288. ;; leave blank line before heading
  20289. (forward-char -1))))))
  20290. (point))
  20291. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  20292. "Use Org version in org-mode, for dramatic speed-up."
  20293. (if (derived-mode-p 'org-mode)
  20294. (progn
  20295. (org-end-of-subtree nil t)
  20296. (unless (eobp) (backward-char 1)))
  20297. ad-do-it))
  20298. (defun org-end-of-meta-data-and-drawers ()
  20299. "Jump to the first text after meta data and drawers in the current entry.
  20300. This will move over empty lines, lines with planning time stamps,
  20301. clocking lines, and drawers."
  20302. (org-back-to-heading t)
  20303. (let ((end (save-excursion (outline-next-heading) (point)))
  20304. (re (concat "\\(" org-drawer-regexp "\\)"
  20305. "\\|" "[ \t]*" org-keyword-time-regexp)))
  20306. (forward-line 1)
  20307. (while (re-search-forward re end t)
  20308. (if (not (match-end 1))
  20309. ;; empty or planning line
  20310. (forward-line 1)
  20311. ;; a drawer, find the end
  20312. (re-search-forward "^[ \t]*:END:" end 'move)
  20313. (forward-line 1)))
  20314. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  20315. (point)))
  20316. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  20317. "Move forward to the arg'th subheading at same level as this one.
  20318. Stop at the first and last subheadings of a superior heading.
  20319. Normally this only looks at visible headings, but when INVISIBLE-OK is
  20320. non-nil it will also look at invisible ones."
  20321. (interactive "p")
  20322. (org-back-to-heading invisible-ok)
  20323. (org-at-heading-p)
  20324. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20325. (re (format "^\\*\\{1,%d\\} " level))
  20326. l)
  20327. (forward-char 1)
  20328. (while (> arg 0)
  20329. (while (and (re-search-forward re nil 'move)
  20330. (setq l (- (match-end 0) (match-beginning 0) 1))
  20331. (= l level)
  20332. (not invisible-ok)
  20333. (progn (backward-char 1) (outline-invisible-p)))
  20334. (if (< l level) (setq arg 1)))
  20335. (setq arg (1- arg)))
  20336. (beginning-of-line 1)))
  20337. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  20338. "Move backward to the arg'th subheading at same level as this one.
  20339. Stop at the first and last subheadings of a superior heading."
  20340. (interactive "p")
  20341. (org-back-to-heading)
  20342. (org-at-heading-p)
  20343. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20344. (re (format "^\\*\\{1,%d\\} " level))
  20345. l)
  20346. (while (> arg 0)
  20347. (while (and (re-search-backward re nil 'move)
  20348. (setq l (- (match-end 0) (match-beginning 0) 1))
  20349. (= l level)
  20350. (not invisible-ok)
  20351. (outline-invisible-p))
  20352. (if (< l level) (setq arg 1)))
  20353. (setq arg (1- arg)))))
  20354. ;;;###autoload
  20355. (defun org-forward-element ()
  20356. "Move forward by one element.
  20357. Move to the next element at the same level, when possible."
  20358. (interactive)
  20359. (cond ((eobp) (error "Cannot move further down"))
  20360. ((org-with-limited-levels (org-at-heading-p))
  20361. (let ((origin (point)))
  20362. (org-forward-heading-same-level 1)
  20363. (unless (org-with-limited-levels (org-at-heading-p))
  20364. (goto-char origin)
  20365. (error "Cannot move further down"))))
  20366. (t
  20367. (let* ((elem (org-element-at-point))
  20368. (end (org-element-property :end elem))
  20369. (parent (org-element-property :parent elem)))
  20370. (if (and parent (= (org-element-property :contents-end parent) end))
  20371. (goto-char (org-element-property :end parent))
  20372. (goto-char end))))))
  20373. ;;;###autoload
  20374. (defun org-backward-element ()
  20375. "Move backward by one element.
  20376. Move to the previous element at the same level, when possible."
  20377. (interactive)
  20378. (cond ((bobp) (error "Cannot move further up"))
  20379. ((org-with-limited-levels (org-at-heading-p))
  20380. ;; At an headline, move to the previous one, if any, or stay
  20381. ;; here.
  20382. (let ((origin (point)))
  20383. (org-backward-heading-same-level 1)
  20384. (unless (org-with-limited-levels (org-at-heading-p))
  20385. (goto-char origin)
  20386. (error "Cannot move further up"))))
  20387. (t
  20388. (let* ((trail (org-element-at-point 'keep-trail))
  20389. (elem (car trail))
  20390. (prev-elem (nth 1 trail))
  20391. (beg (org-element-property :begin elem)))
  20392. (cond
  20393. ;; Move to beginning of current element if point isn't
  20394. ;; there already.
  20395. ((/= (point) beg) (goto-char beg))
  20396. (prev-elem (goto-char (org-element-property :begin prev-elem)))
  20397. ((org-before-first-heading-p) (goto-char (point-min)))
  20398. (t (org-back-to-heading)))))))
  20399. ;;;###autoload
  20400. (defun org-up-element ()
  20401. "Move to upper element."
  20402. (interactive)
  20403. (if (org-with-limited-levels (org-at-heading-p))
  20404. (unless (org-up-heading-safe) (error "No surrounding element"))
  20405. (let* ((elem (org-element-at-point))
  20406. (parent (org-element-property :parent elem)))
  20407. (if parent (goto-char (org-element-property :begin parent))
  20408. (if (org-with-limited-levels (org-before-first-heading-p))
  20409. (error "No surrounding element")
  20410. (org-with-limited-levels (org-back-to-heading)))))))
  20411. ;;;###autoload
  20412. (defvar org-element-greater-elements)
  20413. (defun org-down-element ()
  20414. "Move to inner element."
  20415. (interactive)
  20416. (let ((element (org-element-at-point)))
  20417. (cond
  20418. ((memq (org-element-type element) '(plain-list table))
  20419. (goto-char (org-element-property :contents-begin element))
  20420. (forward-char))
  20421. ((memq (org-element-type element) org-element-greater-elements)
  20422. ;; If contents are hidden, first disclose them.
  20423. (when (org-element-property :hiddenp element) (org-cycle))
  20424. (goto-char (or (org-element-property :contents-begin element)
  20425. (error "No content for this element"))))
  20426. (t (error "No inner element")))))
  20427. ;;;###autoload
  20428. (defun org-drag-element-backward ()
  20429. "Move backward element at point."
  20430. (interactive)
  20431. (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
  20432. (let* ((trail (org-element-at-point 'keep-trail))
  20433. (elem (car trail))
  20434. (prev-elem (nth 1 trail)))
  20435. ;; Error out if no previous element or previous element is
  20436. ;; a parent of the current one.
  20437. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  20438. (error "Cannot drag element backward")
  20439. (let ((pos (point)))
  20440. (org-element-swap-A-B prev-elem elem)
  20441. (goto-char (+ (org-element-property :begin prev-elem)
  20442. (- pos (org-element-property :begin elem)))))))))
  20443. ;;;###autoload
  20444. (defun org-drag-element-forward ()
  20445. "Move forward element at point."
  20446. (interactive)
  20447. (let* ((pos (point))
  20448. (elem (org-element-at-point)))
  20449. (when (= (point-max) (org-element-property :end elem))
  20450. (error "Cannot drag element forward"))
  20451. (goto-char (org-element-property :end elem))
  20452. (let ((next-elem (org-element-at-point)))
  20453. (when (or (org-element-nested-p elem next-elem)
  20454. (and (eq (org-element-type next-elem) 'headline)
  20455. (not (eq (org-element-type elem) 'headline))))
  20456. (goto-char pos)
  20457. (error "Cannot drag element forward"))
  20458. ;; Compute new position of point: it's shifted by NEXT-ELEM
  20459. ;; body's length (without final blanks) and by the length of
  20460. ;; blanks between ELEM and NEXT-ELEM.
  20461. (let ((size-next (- (save-excursion
  20462. (goto-char (org-element-property :end next-elem))
  20463. (skip-chars-backward " \r\t\n")
  20464. (forward-line)
  20465. ;; Small correction if buffer doesn't end
  20466. ;; with a newline character.
  20467. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  20468. (org-element-property :begin next-elem)))
  20469. (size-blank (- (org-element-property :end elem)
  20470. (save-excursion
  20471. (goto-char (org-element-property :end elem))
  20472. (skip-chars-backward " \r\t\n")
  20473. (forward-line)
  20474. (point)))))
  20475. (org-element-swap-A-B elem next-elem)
  20476. (goto-char (+ pos size-next size-blank))))))
  20477. ;;;###autoload
  20478. (defun org-mark-element ()
  20479. "Put point at beginning of this element, mark at end.
  20480. Interactively, if this command is repeated or (in Transient Mark
  20481. mode) if the mark is active, it marks the next element after the
  20482. ones already marked."
  20483. (interactive)
  20484. (let (deactivate-mark)
  20485. (if (and (org-called-interactively-p 'any)
  20486. (or (and (eq last-command this-command) (mark t))
  20487. (and transient-mark-mode mark-active)))
  20488. (set-mark
  20489. (save-excursion
  20490. (goto-char (mark))
  20491. (goto-char (org-element-property :end (org-element-at-point)))))
  20492. (let ((element (org-element-at-point)))
  20493. (end-of-line)
  20494. (push-mark (org-element-property :end element) t t)
  20495. (goto-char (org-element-property :begin element))))))
  20496. ;;;###autoload
  20497. (defun org-narrow-to-element ()
  20498. "Narrow buffer to current element."
  20499. (interactive)
  20500. (let ((elem (org-element-at-point)))
  20501. (cond
  20502. ((eq (car elem) 'headline)
  20503. (narrow-to-region
  20504. (org-element-property :begin elem)
  20505. (org-element-property :end elem)))
  20506. ((memq (car elem) org-element-greater-elements)
  20507. (narrow-to-region
  20508. (org-element-property :contents-begin elem)
  20509. (org-element-property :contents-end elem)))
  20510. (t
  20511. (narrow-to-region
  20512. (org-element-property :begin elem)
  20513. (org-element-property :end elem))))))
  20514. ;;;###autoload
  20515. (defun org-transpose-element ()
  20516. "Transpose current and previous elements, keeping blank lines between.
  20517. Point is moved after both elements."
  20518. (interactive)
  20519. (org-skip-whitespace)
  20520. (let ((end (org-element-property :end (org-element-at-point))))
  20521. (org-drag-element-backward)
  20522. (goto-char end)))
  20523. ;;;###autoload
  20524. (defun org-unindent-buffer ()
  20525. "Un-indent the visible part of the buffer.
  20526. Relative indentation (between items, inside blocks, etc.) isn't
  20527. modified."
  20528. (interactive)
  20529. (unless (eq major-mode 'org-mode)
  20530. (error "Cannot un-indent a buffer not in Org mode"))
  20531. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  20532. unindent-tree ; For byte-compiler.
  20533. (unindent-tree
  20534. (function
  20535. (lambda (contents)
  20536. (mapc
  20537. (lambda (element)
  20538. (if (memq (org-element-type element) '(headline section))
  20539. (funcall unindent-tree (org-element-contents element))
  20540. (save-excursion
  20541. (save-restriction
  20542. (narrow-to-region
  20543. (org-element-property :begin element)
  20544. (org-element-property :end element))
  20545. (org-do-remove-indentation)))))
  20546. (reverse contents))))))
  20547. (funcall unindent-tree (org-element-contents parse-tree))))
  20548. (defun org-show-subtree ()
  20549. "Show everything after this heading at deeper levels."
  20550. (interactive)
  20551. (outline-flag-region
  20552. (point)
  20553. (save-excursion
  20554. (org-end-of-subtree t t))
  20555. nil))
  20556. (defun org-show-entry ()
  20557. "Show the body directly following this heading.
  20558. Show the heading too, if it is currently invisible."
  20559. (interactive)
  20560. (save-excursion
  20561. (condition-case nil
  20562. (progn
  20563. (org-back-to-heading t)
  20564. (outline-flag-region
  20565. (max (point-min) (1- (point)))
  20566. (save-excursion
  20567. (if (re-search-forward
  20568. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  20569. (match-beginning 1)
  20570. (point-max)))
  20571. nil)
  20572. (org-cycle-hide-drawers 'children))
  20573. (error nil))))
  20574. (defun org-make-options-regexp (kwds &optional extra)
  20575. "Make a regular expression for keyword lines."
  20576. (concat
  20577. "^#\\+\\("
  20578. (mapconcat 'regexp-quote kwds "\\|")
  20579. (if extra (concat "\\|" extra))
  20580. "\\):[ \t]*\\(.*\\)"))
  20581. ;; Make isearch reveal the necessary context
  20582. (defun org-isearch-end ()
  20583. "Reveal context after isearch exits."
  20584. (when isearch-success ; only if search was successful
  20585. (if (featurep 'xemacs)
  20586. ;; Under XEmacs, the hook is run in the correct place,
  20587. ;; we directly show the context.
  20588. (org-show-context 'isearch)
  20589. ;; In Emacs the hook runs *before* restoring the overlays.
  20590. ;; So we have to use a one-time post-command-hook to do this.
  20591. ;; (Emacs 22 has a special variable, see function `org-mode')
  20592. (unless (and (boundp 'isearch-mode-end-hook-quit)
  20593. isearch-mode-end-hook-quit)
  20594. ;; Only when the isearch was not quitted.
  20595. (org-add-hook 'post-command-hook 'org-isearch-post-command
  20596. 'append 'local)))))
  20597. (defun org-isearch-post-command ()
  20598. "Remove self from hook, and show context."
  20599. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  20600. (org-show-context 'isearch))
  20601. ;;;; Integration with and fixes for other packages
  20602. ;;; Imenu support
  20603. (defvar org-imenu-markers nil
  20604. "All markers currently used by Imenu.")
  20605. (make-variable-buffer-local 'org-imenu-markers)
  20606. (defun org-imenu-new-marker (&optional pos)
  20607. "Return a new marker for use by Imenu, and remember the marker."
  20608. (let ((m (make-marker)))
  20609. (move-marker m (or pos (point)))
  20610. (push m org-imenu-markers)
  20611. m))
  20612. (defun org-imenu-get-tree ()
  20613. "Produce the index for Imenu."
  20614. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  20615. (setq org-imenu-markers nil)
  20616. (let* ((n org-imenu-depth)
  20617. (re (concat "^" (org-get-limited-outline-regexp)))
  20618. (subs (make-vector (1+ n) nil))
  20619. (last-level 0)
  20620. m level head)
  20621. (save-excursion
  20622. (save-restriction
  20623. (widen)
  20624. (goto-char (point-max))
  20625. (while (re-search-backward re nil t)
  20626. (setq level (org-reduced-level (funcall outline-level)))
  20627. (when (and (<= level n)
  20628. (looking-at org-complex-heading-regexp))
  20629. (setq head (org-link-display-format
  20630. (org-match-string-no-properties 4))
  20631. m (org-imenu-new-marker))
  20632. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  20633. (if (>= level last-level)
  20634. (push (cons head m) (aref subs level))
  20635. (push (cons head (aref subs (1+ level))) (aref subs level))
  20636. (loop for i from (1+ level) to n do (aset subs i nil)))
  20637. (setq last-level level)))))
  20638. (aref subs 1)))
  20639. (eval-after-load "imenu"
  20640. '(progn
  20641. (add-hook 'imenu-after-jump-hook
  20642. (lambda ()
  20643. (if (derived-mode-p 'org-mode)
  20644. (org-show-context 'org-goto))))))
  20645. (defun org-link-display-format (link)
  20646. "Replace a link with either the description, or the link target
  20647. if no description is present"
  20648. (save-match-data
  20649. (if (string-match org-bracket-link-analytic-regexp link)
  20650. (replace-match (if (match-end 5)
  20651. (match-string 5 link)
  20652. (concat (match-string 1 link)
  20653. (match-string 3 link)))
  20654. nil t link)
  20655. link)))
  20656. (defun org-toggle-link-display ()
  20657. "Toggle the literal or descriptive display of links."
  20658. (interactive)
  20659. (if org-descriptive-links
  20660. (progn (org-remove-from-invisibility-spec '(org-link))
  20661. (org-restart-font-lock)
  20662. (setq org-descriptive-links nil))
  20663. (progn (add-to-invisibility-spec '(org-link))
  20664. (org-restart-font-lock)
  20665. (setq org-descriptive-links t))))
  20666. ;; Speedbar support
  20667. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  20668. "Overlay marking the agenda restriction line in speedbar.")
  20669. (overlay-put org-speedbar-restriction-lock-overlay
  20670. 'face 'org-agenda-restriction-lock)
  20671. (overlay-put org-speedbar-restriction-lock-overlay
  20672. 'help-echo "Agendas are currently limited to this item.")
  20673. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  20674. (defun org-speedbar-set-agenda-restriction ()
  20675. "Restrict future agenda commands to the location at point in speedbar.
  20676. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  20677. (interactive)
  20678. (require 'org-agenda)
  20679. (let (p m tp np dir txt)
  20680. (cond
  20681. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20682. 'org-imenu t))
  20683. (setq m (get-text-property p 'org-imenu-marker))
  20684. (with-current-buffer (marker-buffer m)
  20685. (goto-char m)
  20686. (org-agenda-set-restriction-lock 'subtree)))
  20687. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20688. 'speedbar-function 'speedbar-find-file))
  20689. (setq tp (previous-single-property-change
  20690. (1+ p) 'speedbar-function)
  20691. np (next-single-property-change
  20692. tp 'speedbar-function)
  20693. dir (speedbar-line-directory)
  20694. txt (buffer-substring-no-properties (or tp (point-min))
  20695. (or np (point-max))))
  20696. (with-current-buffer (find-file-noselect
  20697. (let ((default-directory dir))
  20698. (expand-file-name txt)))
  20699. (unless (derived-mode-p 'org-mode)
  20700. (error "Cannot restrict to non-Org-mode file"))
  20701. (org-agenda-set-restriction-lock 'file)))
  20702. (t (error "Don't know how to restrict Org-mode's agenda")))
  20703. (move-overlay org-speedbar-restriction-lock-overlay
  20704. (point-at-bol) (point-at-eol))
  20705. (setq current-prefix-arg nil)
  20706. (org-agenda-maybe-redo)))
  20707. (eval-after-load "speedbar"
  20708. '(progn
  20709. (speedbar-add-supported-extension ".org")
  20710. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  20711. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  20712. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  20713. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  20714. (add-hook 'speedbar-visiting-tag-hook
  20715. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  20716. ;;; Fixes and Hacks for problems with other packages
  20717. ;; Make flyspell not check words in links, to not mess up our keymap
  20718. (defun org-mode-flyspell-verify ()
  20719. "Don't let flyspell put overlays at active buttons, or on
  20720. {todo,all-time,additional-option-like}-keywords."
  20721. (let ((pos (max (1- (point)) (point-min)))
  20722. (word (thing-at-point 'word)))
  20723. (and (not (get-text-property pos 'keymap))
  20724. (not (get-text-property pos 'org-no-flyspell))
  20725. (not (member word org-todo-keywords-1))
  20726. (not (member word org-all-time-keywords))
  20727. (not (member word org-options-keywords))
  20728. (not (member word (mapcar 'car org-startup-options)))
  20729. (not (member word org-additional-option-like-keywords-for-flyspell)))))
  20730. (defun org-remove-flyspell-overlays-in (beg end)
  20731. "Remove flyspell overlays in region."
  20732. (and (org-bound-and-true-p flyspell-mode)
  20733. (fboundp 'flyspell-delete-region-overlays)
  20734. (flyspell-delete-region-overlays beg end))
  20735. (add-text-properties beg end '(org-no-flyspell t)))
  20736. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  20737. (eval-after-load "bookmark"
  20738. '(if (boundp 'bookmark-after-jump-hook)
  20739. ;; We can use the hook
  20740. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  20741. ;; Hook not available, use advice
  20742. (defadvice bookmark-jump (after org-make-visible activate)
  20743. "Make the position visible."
  20744. (org-bookmark-jump-unhide))))
  20745. ;; Make sure saveplace shows the location if it was hidden
  20746. (eval-after-load "saveplace"
  20747. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  20748. "Make the position visible."
  20749. (org-bookmark-jump-unhide)))
  20750. ;; Make sure ecb shows the location if it was hidden
  20751. (eval-after-load "ecb"
  20752. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  20753. "Make hierarchy visible when jumping into location from ECB tree buffer."
  20754. (if (derived-mode-p 'org-mode)
  20755. (org-show-context))))
  20756. (defun org-bookmark-jump-unhide ()
  20757. "Unhide the current position, to show the bookmark location."
  20758. (and (derived-mode-p 'org-mode)
  20759. (or (outline-invisible-p)
  20760. (save-excursion (goto-char (max (point-min) (1- (point))))
  20761. (outline-invisible-p)))
  20762. (org-show-context 'bookmark-jump)))
  20763. ;; Make session.el ignore our circular variable
  20764. (eval-after-load "session"
  20765. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  20766. ;;;; Experimental code
  20767. (defun org-closed-in-range ()
  20768. "Sparse tree of items closed in a certain time range.
  20769. Still experimental, may disappear in the future."
  20770. (interactive)
  20771. ;; Get the time interval from the user.
  20772. (let* ((time1 (org-float-time
  20773. (org-read-date nil 'to-time nil "Starting date: ")))
  20774. (time2 (org-float-time
  20775. (org-read-date nil 'to-time nil "End date:")))
  20776. ;; callback function
  20777. (callback (lambda ()
  20778. (let ((time
  20779. (org-float-time
  20780. (apply 'encode-time
  20781. (org-parse-time-string
  20782. (match-string 1))))))
  20783. ;; check if time in interval
  20784. (and (>= time time1) (<= time time2))))))
  20785. ;; make tree, check each match with the callback
  20786. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  20787. ;;;; Finish up
  20788. (provide 'org)
  20789. (run-hooks 'org-load-hook)
  20790. ;;; org.el ends here