org.el 852 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612
  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-timestamps-up "org-clock" ())
  105. (declare-function org-clock-timestamps-down "org-clock" ())
  106. ;; load languages based on value of `org-babel-load-languages'
  107. (defvar org-babel-load-languages)
  108. ;;;###autoload
  109. (defun org-babel-do-load-languages (sym value)
  110. "Load the languages defined in `org-babel-load-languages'."
  111. (set-default sym value)
  112. (mapc (lambda (pair)
  113. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  114. (if active
  115. (progn
  116. (require (intern (concat "ob-" lang))))
  117. (progn
  118. (funcall 'fmakunbound
  119. (intern (concat "org-babel-execute:" lang)))
  120. (funcall 'fmakunbound
  121. (intern (concat "org-babel-expand-body:" lang)))))))
  122. org-babel-load-languages))
  123. (defcustom org-babel-load-languages '((emacs-lisp . t))
  124. "Languages which can be evaluated in Org-mode buffers.
  125. This list can be used to load support for any of the languages
  126. below, note that each language will depend on a different set of
  127. system executables and/or Emacs modes. When a language is
  128. \"loaded\", then code blocks in that language can be evaluated
  129. with `org-babel-execute-src-block' bound by default to C-c
  130. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  131. be set to remove code block evaluation from the C-c C-c
  132. keybinding. By default only Emacs Lisp (which has no
  133. requirements) is loaded."
  134. :group 'org-babel
  135. :set 'org-babel-do-load-languages
  136. :version "24.1"
  137. :type '(alist :tag "Babel Languages"
  138. :key-type
  139. (choice
  140. (const :tag "Awk" awk)
  141. (const :tag "C" C)
  142. (const :tag "R" R)
  143. (const :tag "Asymptote" asymptote)
  144. (const :tag "Calc" calc)
  145. (const :tag "Clojure" clojure)
  146. (const :tag "CSS" css)
  147. (const :tag "Ditaa" ditaa)
  148. (const :tag "Dot" dot)
  149. (const :tag "Emacs Lisp" emacs-lisp)
  150. (const :tag "Fortran" fortran)
  151. (const :tag "Gnuplot" gnuplot)
  152. (const :tag "Haskell" haskell)
  153. (const :tag "IO" io)
  154. (const :tag "Java" java)
  155. (const :tag "Javascript" js)
  156. (const :tag "LaTeX" latex)
  157. (const :tag "Ledger" ledger)
  158. (const :tag "Lilypond" lilypond)
  159. (const :tag "Lisp" lisp)
  160. (const :tag "Maxima" maxima)
  161. (const :tag "Matlab" matlab)
  162. (const :tag "Mscgen" mscgen)
  163. (const :tag "Ocaml" ocaml)
  164. (const :tag "Octave" octave)
  165. (const :tag "Org" org)
  166. (const :tag "Perl" perl)
  167. (const :tag "Pico Lisp" picolisp)
  168. (const :tag "PlantUML" plantuml)
  169. (const :tag "Python" python)
  170. (const :tag "Ruby" ruby)
  171. (const :tag "Sass" sass)
  172. (const :tag "Scala" scala)
  173. (const :tag "Scheme" scheme)
  174. (const :tag "Screen" screen)
  175. (const :tag "Shell Script" sh)
  176. (const :tag "Shen" shen)
  177. (const :tag "Sql" sql)
  178. (const :tag "Sqlite" sqlite))
  179. :value-type (boolean :tag "Activate" :value t)))
  180. ;;;; Customization variables
  181. (defcustom org-clone-delete-id nil
  182. "Remove ID property of clones of a subtree.
  183. When non-nil, clones of a subtree don't inherit the ID property.
  184. Otherwise they inherit the ID property with a new unique
  185. identifier."
  186. :type 'boolean
  187. :version "24.1"
  188. :group 'org-id)
  189. ;;; Version
  190. (require 'org-compat)
  191. (org-check-version)
  192. ;;;###autoload
  193. (defun org-version (&optional here full message)
  194. "Show the org-mode version in the echo area.
  195. With prefix argument HERE, insert it at point.
  196. When FULL is non-nil, use a verbose version string.
  197. When MESSAGE is non-nil, display a message with the version."
  198. (interactive "P")
  199. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  200. (org-install-dir (ignore-errors (org-find-library-dir "org-install.el")))
  201. (org-trash (or
  202. (and (fboundp 'org-release) (fboundp 'org-git-version))
  203. (load (concat org-dir "org-version.el")
  204. 'noerror 'nomessage 'nosuffix)))
  205. (org-version (org-release))
  206. (git-version (org-git-version))
  207. (version (format "Org-mode version %s (%s @ %s)"
  208. org-version
  209. git-version
  210. (if org-install-dir
  211. (if (string= org-dir org-install-dir)
  212. org-install-dir
  213. (concat "mixed installation! " org-install-dir " and " org-dir))
  214. "org-install.el can not be found!")))
  215. (_version (if full version org-version)))
  216. (if (org-called-interactively-p 'interactive)
  217. (if here
  218. (insert version)
  219. (message version))
  220. (if message (message _version))
  221. _version)))
  222. (defconst org-version (org-version))
  223. ;;; Compatibility constants
  224. ;;; The custom variables
  225. (defgroup org nil
  226. "Outline-based notes management and organizer."
  227. :tag "Org"
  228. :group 'outlines
  229. :group 'calendar)
  230. (defcustom org-mode-hook nil
  231. "Mode hook for Org-mode, run after the mode was turned on."
  232. :group 'org
  233. :type 'hook)
  234. (defcustom org-load-hook nil
  235. "Hook that is run after org.el has been loaded."
  236. :group 'org
  237. :type 'hook)
  238. (defcustom org-log-buffer-setup-hook nil
  239. "Hook that is run after an Org log buffer is created."
  240. :group 'org
  241. :version "24.1"
  242. :type 'hook)
  243. (defvar org-modules) ; defined below
  244. (defvar org-modules-loaded nil
  245. "Have the modules been loaded already?")
  246. (defun org-load-modules-maybe (&optional force)
  247. "Load all extensions listed in `org-modules'."
  248. (when (or force (not org-modules-loaded))
  249. (mapc (lambda (ext)
  250. (condition-case nil (require ext)
  251. (error (message "Problems while trying to load feature `%s'" ext))))
  252. org-modules)
  253. (setq org-modules-loaded t)))
  254. (defun org-set-modules (var value)
  255. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  256. (set var value)
  257. (when (featurep 'org)
  258. (org-load-modules-maybe 'force)))
  259. (when (org-bound-and-true-p org-modules)
  260. (let ((a (member 'org-infojs org-modules)))
  261. (and a (setcar a 'org-jsinfo))))
  262. (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)
  263. "Modules that should always be loaded together with org.el.
  264. If a description starts with <C>, the file is not part of Emacs
  265. and loading it will require that you have downloaded and properly installed
  266. the org-mode distribution.
  267. You can also use this system to load external packages (i.e. neither Org
  268. core modules, nor modules from the CONTRIB directory). Just add symbols
  269. to the end of the list. If the package is called org-xyz.el, then you need
  270. to add the symbol `xyz', and the package must have a call to
  271. (provide 'org-xyz)"
  272. :group 'org
  273. :set 'org-set-modules
  274. :type
  275. '(set :greedy t
  276. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  277. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  278. (const :tag " crypt: Encryption of subtrees" org-crypt)
  279. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  280. (const :tag " docview: Links to doc-view buffers" org-docview)
  281. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  282. (const :tag " id: Global IDs for identifying entries" org-id)
  283. (const :tag " info: Links to Info nodes" org-info)
  284. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  285. (const :tag " habit: Track your consistency with habits" org-habit)
  286. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  287. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  288. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  289. (const :tag " mew Links to Mew folders/messages" org-mew)
  290. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  291. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  292. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  293. (const :tag " special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  294. (const :tag " vm: Links to VM folders/messages" org-vm)
  295. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  296. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  297. (const :tag " mouse: Additional mouse support" org-mouse)
  298. (const :tag " TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  299. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  300. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  301. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  302. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  303. (const :tag "C collector: Collect properties into tables" org-collector)
  304. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  305. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  306. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  307. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  308. (const :tag "C eval: Include command output as text" org-eval)
  309. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  310. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  311. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  312. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  313. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  314. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  315. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  316. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  317. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  318. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  319. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  320. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  321. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  322. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  323. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  324. (const :tag "C registry: A registry for Org-mode links" org-registry)
  325. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  326. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  327. (const :tag "C secretary: Team management with org-mode" org-secretary)
  328. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  329. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  330. (const :tag "C track: Keep up with Org-mode development" org-track)
  331. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  332. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  333. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  334. (defcustom org-support-shift-select nil
  335. "Non-nil means make shift-cursor commands select text when possible.
  336. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  337. start selecting a region, or enlarge regions started in this way.
  338. In Org-mode, in special contexts, these same keys are used for
  339. other purposes, important enough to compete with shift selection.
  340. Org tries to balance these needs by supporting `shift-select-mode'
  341. outside these special contexts, under control of this variable.
  342. The default of this variable is nil, to avoid confusing behavior. Shifted
  343. cursor keys will then execute Org commands in the following contexts:
  344. - on a headline, changing TODO state (left/right) and priority (up/down)
  345. - on a time stamp, changing the time
  346. - in a plain list item, changing the bullet type
  347. - in a property definition line, switching between allowed values
  348. - in the BEGIN line of a clock table (changing the time block).
  349. Outside these contexts, the commands will throw an error.
  350. When this variable is t and the cursor is not in a special
  351. context, Org-mode will support shift-selection for making and
  352. enlarging regions. To make this more effective, the bullet
  353. cycling will no longer happen anywhere in an item line, but only
  354. if the cursor is exactly on the bullet.
  355. If you set this variable to the symbol `always', then the keys
  356. will not be special in headlines, property lines, and item lines,
  357. to make shift selection work there as well. If this is what you
  358. want, you can use the following alternative commands: `C-c C-t'
  359. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  360. can be used to switch TODO sets, `C-c -' to cycle item bullet
  361. types, and properties can be edited by hand or in column view.
  362. However, when the cursor is on a timestamp, shift-cursor commands
  363. will still edit the time stamp - this is just too good to give up.
  364. XEmacs user should have this variable set to nil, because
  365. `shift-select-mode' is in Emacs 23 or later only."
  366. :group 'org
  367. :type '(choice
  368. (const :tag "Never" nil)
  369. (const :tag "When outside special context" t)
  370. (const :tag "Everywhere except timestamps" always)))
  371. (defcustom org-loop-over-headlines-in-active-region nil
  372. "Shall some commands act upon headlines in the active region?
  373. When set to `t', some commands will be performed in all headlines
  374. within the active region.
  375. When set to `start-level', some commands will be performed in all
  376. headlines within the active region, provided that these headlines
  377. are of the same level than the first one.
  378. When set to a string, those commands will be performed on the
  379. matching headlines within the active region. Such string must be
  380. a tags/property/todo match as it is used in the agenda tags view.
  381. The list of commands is: `org-schedule', `org-deadline',
  382. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  383. `org-archive-to-archive-sibling'. The archiving commands skip
  384. already archived entries."
  385. :type '(choice (const :tag "Don't loop" nil)
  386. (const :tag "All headlines in active region" t)
  387. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  388. (string :tag "Tags/Property/Todo matcher"))
  389. :version "24.1"
  390. :group 'org-todo
  391. :group 'org-archive)
  392. (defgroup org-startup nil
  393. "Options concerning startup of Org-mode."
  394. :tag "Org Startup"
  395. :group 'org)
  396. (defcustom org-startup-folded t
  397. "Non-nil means entering Org-mode will switch to OVERVIEW.
  398. This can also be configured on a per-file basis by adding one of
  399. the following lines anywhere in the buffer:
  400. #+STARTUP: fold (or `overview', this is equivalent)
  401. #+STARTUP: nofold (or `showall', this is equivalent)
  402. #+STARTUP: content
  403. #+STARTUP: showeverything"
  404. :group 'org-startup
  405. :type '(choice
  406. (const :tag "nofold: show all" nil)
  407. (const :tag "fold: overview" t)
  408. (const :tag "content: all headlines" content)
  409. (const :tag "show everything, even drawers" showeverything)))
  410. (defcustom org-startup-truncated t
  411. "Non-nil means entering Org-mode will set `truncate-lines'.
  412. This is useful since some lines containing links can be very long and
  413. uninteresting. Also tables look terrible when wrapped."
  414. :group 'org-startup
  415. :type 'boolean)
  416. (defcustom org-startup-indented nil
  417. "Non-nil means turn on `org-indent-mode' on startup.
  418. This can also be configured on a per-file basis by adding one of
  419. the following lines anywhere in the buffer:
  420. #+STARTUP: indent
  421. #+STARTUP: noindent"
  422. :group 'org-structure
  423. :type '(choice
  424. (const :tag "Not" nil)
  425. (const :tag "Globally (slow on startup in large files)" t)))
  426. (defcustom org-use-sub-superscripts t
  427. "Non-nil means interpret \"_\" and \"^\" for export.
  428. When this option is turned on, you can use TeX-like syntax for sub- and
  429. superscripts. Several characters after \"_\" or \"^\" will be
  430. considered as a single item - so grouping with {} is normally not
  431. needed. For example, the following things will be parsed as single
  432. sub- or superscripts.
  433. 10^24 or 10^tau several digits will be considered 1 item.
  434. 10^-12 or 10^-tau a leading sign with digits or a word
  435. x^2-y^3 will be read as x^2 - y^3, because items are
  436. terminated by almost any nonword/nondigit char.
  437. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  438. Still, ambiguity is possible - so when in doubt use {} to enclose the
  439. sub/superscript. If you set this variable to the symbol `{}',
  440. the braces are *required* in order to trigger interpretations as
  441. sub/superscript. This can be helpful in documents that need \"_\"
  442. frequently in plain text.
  443. Not all export backends support this, but HTML does.
  444. This option can also be set with the #+OPTIONS line, e.g. \"^:nil\"."
  445. :group 'org-startup
  446. :group 'org-export-translation
  447. :version "24.1"
  448. :type '(choice
  449. (const :tag "Always interpret" t)
  450. (const :tag "Only with braces" {})
  451. (const :tag "Never interpret" nil)))
  452. (if (fboundp 'defvaralias)
  453. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
  454. (defcustom org-startup-with-beamer-mode nil
  455. "Non-nil means turn on `org-beamer-mode' on startup.
  456. This can also be configured on a per-file basis by adding one of
  457. the following lines anywhere in the buffer:
  458. #+STARTUP: beamer"
  459. :group 'org-startup
  460. :version "24.1"
  461. :type 'boolean)
  462. (defcustom org-startup-align-all-tables nil
  463. "Non-nil means align all tables when visiting a file.
  464. This is useful when the column width in tables is forced with <N> cookies
  465. in table fields. Such tables will look correct only after the first re-align.
  466. This can also be configured on a per-file basis by adding one of
  467. the following lines anywhere in the buffer:
  468. #+STARTUP: align
  469. #+STARTUP: noalign"
  470. :group 'org-startup
  471. :type 'boolean)
  472. (defcustom org-startup-with-inline-images nil
  473. "Non-nil means show inline images when loading a new Org file.
  474. This can also be configured on a per-file basis by adding one of
  475. the following lines anywhere in the buffer:
  476. #+STARTUP: inlineimages
  477. #+STARTUP: noinlineimages"
  478. :group 'org-startup
  479. :version "24.1"
  480. :type 'boolean)
  481. (defcustom org-insert-mode-line-in-empty-file nil
  482. "Non-nil means insert the first line setting Org-mode in empty files.
  483. When the function `org-mode' is called interactively in an empty file, this
  484. normally means that the file name does not automatically trigger Org-mode.
  485. To ensure that the file will always be in Org-mode in the future, a
  486. line enforcing Org-mode will be inserted into the buffer, if this option
  487. has been set."
  488. :group 'org-startup
  489. :type 'boolean)
  490. (defcustom org-replace-disputed-keys nil
  491. "Non-nil means use alternative key bindings for some keys.
  492. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  493. These keys are also used by other packages like shift-selection-mode'
  494. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  495. If you want to use Org-mode together with one of these other modes,
  496. or more generally if you would like to move some Org-mode commands to
  497. other keys, set this variable and configure the keys with the variable
  498. `org-disputed-keys'.
  499. This option is only relevant at load-time of Org-mode, and must be set
  500. *before* org.el is loaded. Changing it requires a restart of Emacs to
  501. become effective."
  502. :group 'org-startup
  503. :type 'boolean)
  504. (defcustom org-use-extra-keys nil
  505. "Non-nil means use extra key sequence definitions for certain commands.
  506. This happens automatically if you run XEmacs or if `window-system'
  507. is nil. This variable lets you do the same manually. You must
  508. set it before loading org.
  509. Example: on Carbon Emacs 22 running graphically, with an external
  510. keyboard on a Powerbook, the default way of setting M-left might
  511. not work for either Alt or ESC. Setting this variable will make
  512. it work for ESC."
  513. :group 'org-startup
  514. :type 'boolean)
  515. (if (fboundp 'defvaralias)
  516. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  517. (defcustom org-disputed-keys
  518. '(([(shift up)] . [(meta p)])
  519. ([(shift down)] . [(meta n)])
  520. ([(shift left)] . [(meta -)])
  521. ([(shift right)] . [(meta +)])
  522. ([(control shift right)] . [(meta shift +)])
  523. ([(control shift left)] . [(meta shift -)]))
  524. "Keys for which Org-mode and other modes compete.
  525. This is an alist, cars are the default keys, second element specifies
  526. the alternative to use when `org-replace-disputed-keys' is t.
  527. Keys can be specified in any syntax supported by `define-key'.
  528. The value of this option takes effect only at Org-mode's startup,
  529. therefore you'll have to restart Emacs to apply it after changing."
  530. :group 'org-startup
  531. :type 'alist)
  532. (defun org-key (key)
  533. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  534. Or return the original if not disputed.
  535. Also apply the translations defined in `org-xemacs-key-equivalents'."
  536. (when org-replace-disputed-keys
  537. (let* ((nkey (key-description key))
  538. (x (org-find-if (lambda (x)
  539. (equal (key-description (car x)) nkey))
  540. org-disputed-keys)))
  541. (setq key (if x (cdr x) key))))
  542. (when (featurep 'xemacs)
  543. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  544. key)
  545. (defun org-find-if (predicate seq)
  546. (catch 'exit
  547. (while seq
  548. (if (funcall predicate (car seq))
  549. (throw 'exit (car seq))
  550. (pop seq)))))
  551. (defun org-defkey (keymap key def)
  552. "Define a key, possibly translated, as returned by `org-key'."
  553. (define-key keymap (org-key key) def))
  554. (defcustom org-ellipsis nil
  555. "The ellipsis to use in the Org-mode outline.
  556. When nil, just use the standard three dots. When a string, use that instead,
  557. When a face, use the standard 3 dots, but with the specified face.
  558. The change affects only Org-mode (which will then use its own display table).
  559. Changing this requires executing `M-x org-mode' in a buffer to become
  560. effective."
  561. :group 'org-startup
  562. :type '(choice (const :tag "Default" nil)
  563. (face :tag "Face" :value org-warning)
  564. (string :tag "String" :value "...#")))
  565. (defvar org-display-table nil
  566. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  567. (defgroup org-keywords nil
  568. "Keywords in Org-mode."
  569. :tag "Org Keywords"
  570. :group 'org)
  571. (defcustom org-deadline-string "DEADLINE:"
  572. "String to mark deadline entries.
  573. A deadline is this string, followed by a time stamp. Should be a word,
  574. terminated by a colon. You can insert a schedule keyword and
  575. a timestamp with \\[org-deadline].
  576. Changes become only effective after restarting Emacs."
  577. :group 'org-keywords
  578. :type 'string)
  579. (defcustom org-scheduled-string "SCHEDULED:"
  580. "String to mark scheduled TODO entries.
  581. A schedule is this string, followed by a time stamp. Should be a word,
  582. terminated by a colon. You can insert a schedule keyword and
  583. a timestamp with \\[org-schedule].
  584. Changes become only effective after restarting Emacs."
  585. :group 'org-keywords
  586. :type 'string)
  587. (defcustom org-closed-string "CLOSED:"
  588. "String used as the prefix for timestamps logging closing a TODO entry."
  589. :group 'org-keywords
  590. :type 'string)
  591. (defcustom org-clock-string "CLOCK:"
  592. "String used as prefix for timestamps clocking work hours on an item."
  593. :group 'org-keywords
  594. :type 'string)
  595. (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
  596. org-scheduled-string "\\|"
  597. org-deadline-string "\\|"
  598. org-closed-string "\\|"
  599. org-clock-string "\\)")
  600. "Matches a line with planning or clock info.")
  601. (defcustom org-comment-string "COMMENT"
  602. "Entries starting with this keyword will never be exported.
  603. An entry can be toggled between COMMENT and normal with
  604. \\[org-toggle-comment].
  605. Changes become only effective after restarting Emacs."
  606. :group 'org-keywords
  607. :type 'string)
  608. (defcustom org-quote-string "QUOTE"
  609. "Entries starting with this keyword will be exported in fixed-width font.
  610. Quoting applies only to the text in the entry following the headline, and does
  611. not extend beyond the next headline, even if that is lower level.
  612. An entry can be toggled between QUOTE and normal with
  613. \\[org-toggle-fixed-width-section]."
  614. :group 'org-keywords
  615. :type 'string)
  616. (defconst org-repeat-re
  617. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  618. "Regular expression for specifying repeated events.
  619. After a match, group 1 contains the repeat expression.")
  620. (defgroup org-structure nil
  621. "Options concerning the general structure of Org-mode files."
  622. :tag "Org Structure"
  623. :group 'org)
  624. (defgroup org-reveal-location nil
  625. "Options about how to make context of a location visible."
  626. :tag "Org Reveal Location"
  627. :group 'org-structure)
  628. (defconst org-context-choice
  629. '(choice
  630. (const :tag "Always" t)
  631. (const :tag "Never" nil)
  632. (repeat :greedy t :tag "Individual contexts"
  633. (cons
  634. (choice :tag "Context"
  635. (const agenda)
  636. (const org-goto)
  637. (const occur-tree)
  638. (const tags-tree)
  639. (const link-search)
  640. (const mark-goto)
  641. (const bookmark-jump)
  642. (const isearch)
  643. (const default))
  644. (boolean))))
  645. "Contexts for the reveal options.")
  646. (defcustom org-show-hierarchy-above '((default . t))
  647. "Non-nil means show full hierarchy when revealing a location.
  648. Org-mode often shows locations in an org-mode file which might have
  649. been invisible before. When this is set, the hierarchy of headings
  650. above the exposed location is shown.
  651. Turning this off for example for sparse trees makes them very compact.
  652. Instead of t, this can also be an alist specifying this option for different
  653. contexts. Valid contexts are
  654. agenda when exposing an entry from the agenda
  655. org-goto when using the command `org-goto' on key C-c C-j
  656. occur-tree when using the command `org-occur' on key C-c /
  657. tags-tree when constructing a sparse tree based on tags matches
  658. link-search when exposing search matches associated with a link
  659. mark-goto when exposing the jump goal of a mark
  660. bookmark-jump when exposing a bookmark location
  661. isearch when exiting from an incremental search
  662. default default for all contexts not set explicitly"
  663. :group 'org-reveal-location
  664. :type org-context-choice)
  665. (defcustom org-show-following-heading '((default . nil))
  666. "Non-nil means show following heading when revealing a location.
  667. Org-mode often shows locations in an org-mode file which might have
  668. been invisible before. When this is set, the heading following the
  669. match is shown.
  670. Turning this off for example for sparse trees makes them very compact,
  671. but makes it harder to edit the location of the match. In such a case,
  672. use the command \\[org-reveal] to show more context.
  673. Instead of t, this can also be an alist specifying this option for different
  674. contexts. See `org-show-hierarchy-above' for valid contexts."
  675. :group 'org-reveal-location
  676. :type org-context-choice)
  677. (defcustom org-show-siblings '((default . nil) (isearch t))
  678. "Non-nil means show all sibling heading when revealing a location.
  679. Org-mode often shows locations in an org-mode file which might have
  680. been invisible before. When this is set, the sibling of the current entry
  681. heading are all made visible. If `org-show-hierarchy-above' is t,
  682. the same happens on each level of the hierarchy above the current entry.
  683. By default this is on for the isearch context, off for all other contexts.
  684. Turning this off for example for sparse trees makes them very compact,
  685. but makes it harder to edit the location of the match. In such a case,
  686. use the command \\[org-reveal] to show more context.
  687. Instead of t, this can also be an alist specifying this option for different
  688. contexts. See `org-show-hierarchy-above' for valid contexts."
  689. :group 'org-reveal-location
  690. :type org-context-choice)
  691. (defcustom org-show-entry-below '((default . nil))
  692. "Non-nil means show the entry below a headline when revealing a location.
  693. Org-mode often shows locations in an org-mode file which might have
  694. been invisible before. When this is set, the text below the headline that is
  695. exposed is also shown.
  696. By default this is off for all contexts.
  697. Instead of t, this can also be an alist specifying this option for different
  698. contexts. See `org-show-hierarchy-above' for valid contexts."
  699. :group 'org-reveal-location
  700. :type org-context-choice)
  701. (defcustom org-indirect-buffer-display 'other-window
  702. "How should indirect tree buffers be displayed?
  703. This applies to indirect buffers created with the commands
  704. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  705. Valid values are:
  706. current-window Display in the current window
  707. other-window Just display in another window.
  708. dedicated-frame Create one new frame, and re-use it each time.
  709. new-frame Make a new frame each time. Note that in this case
  710. previously-made indirect buffers are kept, and you need to
  711. kill these buffers yourself."
  712. :group 'org-structure
  713. :group 'org-agenda-windows
  714. :type '(choice
  715. (const :tag "In current window" current-window)
  716. (const :tag "In current frame, other window" other-window)
  717. (const :tag "Each time a new frame" new-frame)
  718. (const :tag "One dedicated frame" dedicated-frame)))
  719. (defcustom org-use-speed-commands nil
  720. "Non-nil means activate single letter commands at beginning of a headline.
  721. This may also be a function to test for appropriate locations where speed
  722. commands should be active."
  723. :group 'org-structure
  724. :type '(choice
  725. (const :tag "Never" nil)
  726. (const :tag "At beginning of headline stars" t)
  727. (function)))
  728. (defcustom org-speed-commands-user nil
  729. "Alist of additional speed commands.
  730. This list will be checked before `org-speed-commands-default'
  731. when the variable `org-use-speed-commands' is non-nil
  732. and when the cursor is at the beginning of a headline.
  733. The car if each entry is a string with a single letter, which must
  734. be assigned to `self-insert-command' in the global map.
  735. The cdr is either a command to be called interactively, a function
  736. to be called, or a form to be evaluated.
  737. An entry that is just a list with a single string will be interpreted
  738. as a descriptive headline that will be added when listing the speed
  739. commands in the Help buffer using the `?' speed command."
  740. :group 'org-structure
  741. :type '(repeat :value ("k" . ignore)
  742. (choice :value ("k" . ignore)
  743. (list :tag "Descriptive Headline" (string :tag "Headline"))
  744. (cons :tag "Letter and Command"
  745. (string :tag "Command letter")
  746. (choice
  747. (function)
  748. (sexp))))))
  749. (defgroup org-cycle nil
  750. "Options concerning visibility cycling in Org-mode."
  751. :tag "Org Cycle"
  752. :group 'org-structure)
  753. (defcustom org-cycle-skip-children-state-if-no-children t
  754. "Non-nil means skip CHILDREN state in entries that don't have any."
  755. :group 'org-cycle
  756. :type 'boolean)
  757. (defcustom org-cycle-max-level nil
  758. "Maximum level which should still be subject to visibility cycling.
  759. Levels higher than this will, for cycling, be treated as text, not a headline.
  760. When `org-odd-levels-only' is set, a value of N in this variable actually
  761. means 2N-1 stars as the limiting headline.
  762. When nil, cycle all levels.
  763. Note that the limiting level of cycling is also influenced by
  764. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  765. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  766. than its value."
  767. :group 'org-cycle
  768. :type '(choice
  769. (const :tag "No limit" nil)
  770. (integer :tag "Maximum level")))
  771. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  772. "Names of drawers. Drawers are not opened by cycling on the headline above.
  773. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  774. this:
  775. :DRAWERNAME:
  776. .....
  777. :END:
  778. The drawer \"PROPERTIES\" is special for capturing properties through
  779. the property API.
  780. Drawers can be defined on the per-file basis with a line like:
  781. #+DRAWERS: HIDDEN STATE PROPERTIES"
  782. :group 'org-structure
  783. :group 'org-cycle
  784. :type '(repeat (string :tag "Drawer Name")))
  785. (defcustom org-hide-block-startup nil
  786. "Non-nil means entering Org-mode will fold all blocks.
  787. This can also be set in on a per-file basis with
  788. #+STARTUP: hideblocks
  789. #+STARTUP: showblocks"
  790. :group 'org-startup
  791. :group 'org-cycle
  792. :type 'boolean)
  793. (defcustom org-cycle-global-at-bob nil
  794. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  795. This makes it possible to do global cycling without having to use S-TAB or
  796. \\[universal-argument] TAB. For this special case to work, the first line \
  797. of the buffer
  798. must not be a headline - it may be empty or some other text. When used in
  799. this way, `org-cycle-hook' is disables temporarily, to make sure the
  800. cursor stays at the beginning of the buffer.
  801. When this option is nil, don't do anything special at the beginning
  802. of the buffer."
  803. :group 'org-cycle
  804. :type 'boolean)
  805. (defcustom org-cycle-level-after-item/entry-creation t
  806. "Non-nil means cycle entry level or item indentation in new empty entries.
  807. When the cursor is at the end of an empty headline, i.e with only stars
  808. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  809. and then all possible ancestor states, before returning to the original state.
  810. This makes data entry extremely fast: M-RET to create a new headline,
  811. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  812. When the cursor is at the end of an empty plain list item, one TAB will
  813. make it a subitem, two or more tabs will back up to make this an item
  814. higher up in the item hierarchy."
  815. :group 'org-cycle
  816. :type 'boolean)
  817. (defcustom org-cycle-emulate-tab t
  818. "Where should `org-cycle' emulate TAB.
  819. nil Never
  820. white Only in completely white lines
  821. whitestart Only at the beginning of lines, before the first non-white char
  822. t Everywhere except in headlines
  823. exc-hl-bol Everywhere except at the start of a headline
  824. If TAB is used in a place where it does not emulate TAB, the current subtree
  825. visibility is cycled."
  826. :group 'org-cycle
  827. :type '(choice (const :tag "Never" nil)
  828. (const :tag "Only in completely white lines" white)
  829. (const :tag "Before first char in a line" whitestart)
  830. (const :tag "Everywhere except in headlines" t)
  831. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  832. ))
  833. (defcustom org-cycle-separator-lines 2
  834. "Number of empty lines needed to keep an empty line between collapsed trees.
  835. If you leave an empty line between the end of a subtree and the following
  836. headline, this empty line is hidden when the subtree is folded.
  837. Org-mode will leave (exactly) one empty line visible if the number of
  838. empty lines is equal or larger to the number given in this variable.
  839. So the default 2 means at least 2 empty lines after the end of a subtree
  840. are needed to produce free space between a collapsed subtree and the
  841. following headline.
  842. If the number is negative, and the number of empty lines is at least -N,
  843. all empty lines are shown.
  844. Special case: when 0, never leave empty lines in collapsed view."
  845. :group 'org-cycle
  846. :type 'integer)
  847. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  848. (defcustom org-pre-cycle-hook nil
  849. "Hook that is run before visibility cycling is happening.
  850. The function(s) in this hook must accept a single argument which indicates
  851. the new state that will be set right after running this hook. The
  852. argument is a symbol. Before a global state change, it can have the values
  853. `overview', `content', or `all'. Before a local state change, it can have
  854. the values `folded', `children', or `subtree'."
  855. :group 'org-cycle
  856. :type 'hook)
  857. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  858. org-cycle-hide-drawers
  859. org-cycle-show-empty-lines
  860. org-optimize-window-after-visibility-change)
  861. "Hook that is run after `org-cycle' has changed the buffer visibility.
  862. The function(s) in this hook must accept a single argument which indicates
  863. the new state that was set by the most recent `org-cycle' command. The
  864. argument is a symbol. After a global state change, it can have the values
  865. `overview', `content', or `all'. After a local state change, it can have
  866. the values `folded', `children', or `subtree'."
  867. :group 'org-cycle
  868. :type 'hook)
  869. (defgroup org-edit-structure nil
  870. "Options concerning structure editing in Org-mode."
  871. :tag "Org Edit Structure"
  872. :group 'org-structure)
  873. (defcustom org-odd-levels-only nil
  874. "Non-nil means skip even levels and only use odd levels for the outline.
  875. This has the effect that two stars are being added/taken away in
  876. promotion/demotion commands. It also influences how levels are
  877. handled by the exporters.
  878. Changing it requires restart of `font-lock-mode' to become effective
  879. for fontification also in regions already fontified.
  880. You may also set this on a per-file basis by adding one of the following
  881. lines to the buffer:
  882. #+STARTUP: odd
  883. #+STARTUP: oddeven"
  884. :group 'org-edit-structure
  885. :group 'org-appearance
  886. :type 'boolean)
  887. (defcustom org-adapt-indentation t
  888. "Non-nil means adapt indentation to outline node level.
  889. When this variable is set, Org assumes that you write outlines by
  890. indenting text in each node to align with the headline (after the stars).
  891. The following issues are influenced by this variable:
  892. - When this is set and the *entire* text in an entry is indented, the
  893. indentation is increased by one space in a demotion command, and
  894. decreased by one in a promotion command. If any line in the entry
  895. body starts with text at column 0, indentation is not changed at all.
  896. - Property drawers and planning information is inserted indented when
  897. this variable s set. When nil, they will not be indented.
  898. - TAB indents a line relative to context. The lines below a headline
  899. will be indented when this variable is set.
  900. Note that this is all about true indentation, by adding and removing
  901. space characters. See also `org-indent.el' which does level-dependent
  902. indentation in a virtual way, i.e. at display time in Emacs."
  903. :group 'org-edit-structure
  904. :type 'boolean)
  905. (defcustom org-special-ctrl-a/e nil
  906. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  907. When t, `C-a' will bring back the cursor to the beginning of the
  908. headline text, i.e. after the stars and after a possible TODO
  909. keyword. In an item, this will be the position after bullet and
  910. check-box, if any. When the cursor is already at that position,
  911. another `C-a' will bring it to the beginning of the line.
  912. `C-e' will jump to the end of the headline, ignoring the presence
  913. of tags in the headline. A second `C-e' will then jump to the
  914. true end of the line, after any tags. This also means that, when
  915. this variable is non-nil, `C-e' also will never jump beyond the
  916. end of the heading of a folded section, i.e. not after the
  917. ellipses.
  918. When set to the symbol `reversed', the first `C-a' or `C-e' works
  919. normally, going to the true line boundary first. Only a directly
  920. following, identical keypress will bring the cursor to the
  921. special positions.
  922. This may also be a cons cell where the behavior for `C-a' and
  923. `C-e' is set separately."
  924. :group 'org-edit-structure
  925. :type '(choice
  926. (const :tag "off" nil)
  927. (const :tag "on: after stars/bullet and before tags first" t)
  928. (const :tag "reversed: true line boundary first" reversed)
  929. (cons :tag "Set C-a and C-e separately"
  930. (choice :tag "Special C-a"
  931. (const :tag "off" nil)
  932. (const :tag "on: after stars/bullet first" t)
  933. (const :tag "reversed: before stars/bullet first" reversed))
  934. (choice :tag "Special C-e"
  935. (const :tag "off" nil)
  936. (const :tag "on: before tags first" t)
  937. (const :tag "reversed: after tags first" reversed)))))
  938. (if (fboundp 'defvaralias)
  939. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  940. (defcustom org-special-ctrl-k nil
  941. "Non-nil means `C-k' will behave specially in headlines.
  942. When nil, `C-k' will call the default `kill-line' command.
  943. When t, the following will happen while the cursor is in the headline:
  944. - When the cursor is at the beginning of a headline, kill the entire
  945. line and possible the folded subtree below the line.
  946. - When in the middle of the headline text, kill the headline up to the tags.
  947. - When after the headline text, kill the tags."
  948. :group 'org-edit-structure
  949. :type 'boolean)
  950. (defcustom org-ctrl-k-protect-subtree nil
  951. "Non-nil means, do not delete a hidden subtree with C-k.
  952. When set to the symbol `error', simply throw an error when C-k is
  953. used to kill (part-of) a headline that has hidden text behind it.
  954. Any other non-nil value will result in a query to the user, if it is
  955. OK to kill that hidden subtree. When nil, kill without remorse."
  956. :group 'org-edit-structure
  957. :version "24.1"
  958. :type '(choice
  959. (const :tag "Do not protect hidden subtrees" nil)
  960. (const :tag "Protect hidden subtrees with a security query" t)
  961. (const :tag "Never kill a hidden subtree with C-k" error)))
  962. (defcustom org-catch-invisible-edits nil
  963. "Check if in invisible region before inserting or deleting a character.
  964. Valid values are:
  965. nil Do not check, so just do invisible edits.
  966. error Throw an error and do nothing.
  967. show Make point visible, and do the requested edit.
  968. show-and-error Make point visible, then throw an error and abort the edit.
  969. smart Make point visible, and do insertion/deletion if it is
  970. adjacent to visible text and the change feels predictable.
  971. Never delete a previously invisible character or add in the
  972. middle or right after an invisible region. Basically, this
  973. allows insertion and backward-delete right before ellipses.
  974. FIXME: maybe in this case we should not even show?"
  975. :group 'org-edit-structure
  976. :version "24.1"
  977. :type '(choice
  978. (const :tag "Do not check" nil)
  979. (const :tag "Throw error when trying to edit" error)
  980. (const :tag "Unhide, but do not do the edit" show-and-error)
  981. (const :tag "Show invisible part and do the edit" show)
  982. (const :tag "Be smart and do the right thing" smart)))
  983. (defcustom org-yank-folded-subtrees t
  984. "Non-nil means when yanking subtrees, fold them.
  985. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  986. it starts with a heading and all other headings in it are either children
  987. or siblings, then fold all the subtrees. However, do this only if no
  988. text after the yank would be swallowed into a folded tree by this action."
  989. :group 'org-edit-structure
  990. :type 'boolean)
  991. (defcustom org-yank-adjusted-subtrees nil
  992. "Non-nil means when yanking subtrees, adjust the level.
  993. With this setting, `org-paste-subtree' is used to insert the subtree, see
  994. this function for details."
  995. :group 'org-edit-structure
  996. :type 'boolean)
  997. (defcustom org-M-RET-may-split-line '((default . t))
  998. "Non-nil means M-RET will split the line at the cursor position.
  999. When nil, it will go to the end of the line before making a
  1000. new line.
  1001. You may also set this option in a different way for different
  1002. contexts. Valid contexts are:
  1003. headline when creating a new headline
  1004. item when creating a new item
  1005. table in a table field
  1006. default the value to be used for all contexts not explicitly
  1007. customized"
  1008. :group 'org-structure
  1009. :group 'org-table
  1010. :type '(choice
  1011. (const :tag "Always" t)
  1012. (const :tag "Never" nil)
  1013. (repeat :greedy t :tag "Individual contexts"
  1014. (cons
  1015. (choice :tag "Context"
  1016. (const headline)
  1017. (const item)
  1018. (const table)
  1019. (const default))
  1020. (boolean)))))
  1021. (defcustom org-insert-heading-respect-content nil
  1022. "Non-nil means insert new headings after the current subtree.
  1023. When nil, the new heading is created directly after the current line.
  1024. The commands \\[org-insert-heading-respect-content] and
  1025. \\[org-insert-todo-heading-respect-content] turn this variable on
  1026. for the duration of the command."
  1027. :group 'org-structure
  1028. :type 'boolean)
  1029. (defcustom org-blank-before-new-entry '((heading . auto)
  1030. (plain-list-item . auto))
  1031. "Should `org-insert-heading' leave a blank line before new heading/item?
  1032. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1033. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1034. which case Org will look at the surrounding headings/items and try to
  1035. make an intelligent decision whether to insert a blank line or not.
  1036. For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
  1037. set, the setting here is ignored and no empty line is inserted, to avoid
  1038. breaking the list structure."
  1039. :group 'org-edit-structure
  1040. :type '(list
  1041. (cons (const heading)
  1042. (choice (const :tag "Never" nil)
  1043. (const :tag "Always" t)
  1044. (const :tag "Auto" auto)))
  1045. (cons (const plain-list-item)
  1046. (choice (const :tag "Never" nil)
  1047. (const :tag "Always" t)
  1048. (const :tag "Auto" auto)))))
  1049. (defcustom org-insert-heading-hook nil
  1050. "Hook being run after inserting a new heading."
  1051. :group 'org-edit-structure
  1052. :type 'hook)
  1053. (defcustom org-enable-fixed-width-editor t
  1054. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1055. This currently only means they are never auto-wrapped.
  1056. When nil, such lines will be treated like ordinary lines.
  1057. See also the QUOTE keyword."
  1058. :group 'org-edit-structure
  1059. :type 'boolean)
  1060. (defcustom org-goto-auto-isearch t
  1061. "Non-nil means typing characters in `org-goto' starts incremental search."
  1062. :group 'org-edit-structure
  1063. :type 'boolean)
  1064. (defgroup org-sparse-trees nil
  1065. "Options concerning sparse trees in Org-mode."
  1066. :tag "Org Sparse Trees"
  1067. :group 'org-structure)
  1068. (defcustom org-highlight-sparse-tree-matches t
  1069. "Non-nil means highlight all matches that define a sparse tree.
  1070. The highlights will automatically disappear the next time the buffer is
  1071. changed by an edit command."
  1072. :group 'org-sparse-trees
  1073. :type 'boolean)
  1074. (defcustom org-remove-highlights-with-change t
  1075. "Non-nil means any change to the buffer will remove temporary highlights.
  1076. Such highlights are created by `org-occur' and `org-clock-display'.
  1077. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1078. The highlights created by `org-preview-latex-fragment' always need
  1079. `C-c C-c' to be removed."
  1080. :group 'org-sparse-trees
  1081. :group 'org-time
  1082. :type 'boolean)
  1083. (defcustom org-occur-hook '(org-first-headline-recenter)
  1084. "Hook that is run after `org-occur' has constructed a sparse tree.
  1085. This can be used to recenter the window to show as much of the structure
  1086. as possible."
  1087. :group 'org-sparse-trees
  1088. :type 'hook)
  1089. (defgroup org-imenu-and-speedbar nil
  1090. "Options concerning imenu and speedbar in Org-mode."
  1091. :tag "Org Imenu and Speedbar"
  1092. :group 'org-structure)
  1093. (defcustom org-imenu-depth 2
  1094. "The maximum level for Imenu access to Org-mode headlines.
  1095. This also applied for speedbar access."
  1096. :group 'org-imenu-and-speedbar
  1097. :type 'integer)
  1098. (defgroup org-table nil
  1099. "Options concerning tables in Org-mode."
  1100. :tag "Org Table"
  1101. :group 'org)
  1102. (defcustom org-enable-table-editor 'optimized
  1103. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1104. When nil, such lines will be treated like ordinary lines.
  1105. When equal to the symbol `optimized', the table editor will be optimized to
  1106. do the following:
  1107. - Automatic overwrite mode in front of whitespace in table fields.
  1108. This makes the structure of the table stay in tact as long as the edited
  1109. field does not exceed the column width.
  1110. - Minimize the number of realigns. Normally, the table is aligned each time
  1111. TAB or RET are pressed to move to another field. With optimization this
  1112. happens only if changes to a field might have changed the column width.
  1113. Optimization requires replacing the functions `self-insert-command',
  1114. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1115. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1116. very good at guessing when a re-align will be necessary, but you can always
  1117. force one with \\[org-ctrl-c-ctrl-c].
  1118. If you would like to use the optimized version in Org-mode, but the
  1119. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1120. This variable can be used to turn on and off the table editor during a session,
  1121. but in order to toggle optimization, a restart is required.
  1122. See also the variable `org-table-auto-blank-field'."
  1123. :group 'org-table
  1124. :type '(choice
  1125. (const :tag "off" nil)
  1126. (const :tag "on" t)
  1127. (const :tag "on, optimized" optimized)))
  1128. (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
  1129. (version<= emacs-version "24.1"))
  1130. "Non-nil means cluster self-insert commands for undo when possible.
  1131. If this is set, then, like in the Emacs command loop, 20 consecutive
  1132. characters will be undone together.
  1133. This is configurable, because there is some impact on typing performance."
  1134. :group 'org-table
  1135. :type 'boolean)
  1136. (defcustom org-table-tab-recognizes-table.el t
  1137. "Non-nil means TAB will automatically notice a table.el table.
  1138. When it sees such a table, it moves point into it and - if necessary -
  1139. calls `table-recognize-table'."
  1140. :group 'org-table-editing
  1141. :type 'boolean)
  1142. (defgroup org-link nil
  1143. "Options concerning links in Org-mode."
  1144. :tag "Org Link"
  1145. :group 'org)
  1146. (defvar org-link-abbrev-alist-local nil
  1147. "Buffer-local version of `org-link-abbrev-alist', which see.
  1148. The value of this is taken from the #+LINK lines.")
  1149. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1150. (defcustom org-link-abbrev-alist nil
  1151. "Alist of link abbreviations.
  1152. The car of each element is a string, to be replaced at the start of a link.
  1153. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1154. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1155. [[linkkey:tag][description]]
  1156. The 'linkkey' must be a word word, starting with a letter, followed
  1157. by letters, numbers, '-' or '_'.
  1158. If REPLACE is a string, the tag will simply be appended to create the link.
  1159. If the string contains \"%s\", the tag will be inserted there. If the string
  1160. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1161. at that point (see the function `url-hexify-string'). If the string contains
  1162. the specifier \"%(my-function)\", then the custom function `my-function' will
  1163. be invoked: this function takes the tag as its only argument and must return
  1164. a string.
  1165. REPLACE may also be a function that will be called with the tag as the
  1166. only argument to create the link, which should be returned as a string.
  1167. See the manual for examples."
  1168. :group 'org-link
  1169. :type '(repeat
  1170. (cons
  1171. (string :tag "Protocol")
  1172. (choice
  1173. (string :tag "Format")
  1174. (function)))))
  1175. (defcustom org-descriptive-links t
  1176. "Non-nil means Org will display descriptive links.
  1177. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1178. \"Org Website\", hiding the link itself and just displaying its
  1179. description. When set to `nil', Org will display the full links
  1180. literally.
  1181. You can interactively set the value of this variable by calling
  1182. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1183. :group 'org-link
  1184. :type 'boolean)
  1185. (defcustom org-link-file-path-type 'adaptive
  1186. "How the path name in file links should be stored.
  1187. Valid values are:
  1188. relative Relative to the current directory, i.e. the directory of the file
  1189. into which the link is being inserted.
  1190. absolute Absolute path, if possible with ~ for home directory.
  1191. noabbrev Absolute path, no abbreviation of home directory.
  1192. adaptive Use relative path for files in the current directory and sub-
  1193. directories of it. For other files, use an absolute path."
  1194. :group 'org-link
  1195. :type '(choice
  1196. (const relative)
  1197. (const absolute)
  1198. (const noabbrev)
  1199. (const adaptive)))
  1200. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1201. "Types of links that should be activated in Org-mode files.
  1202. This is a list of symbols, each leading to the activation of a certain link
  1203. type. In principle, it does not hurt to turn on most link types - there may
  1204. be a small gain when turning off unused link types. The types are:
  1205. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1206. angle Links in angular brackets that may contain whitespace like
  1207. <bbdb:Carsten Dominik>.
  1208. plain Plain links in normal text, no whitespace, like http://google.com.
  1209. radio Text that is matched by a radio target, see manual for details.
  1210. tag Tag settings in a headline (link to tag search).
  1211. date Time stamps (link to calendar).
  1212. footnote Footnote labels.
  1213. Changing this variable requires a restart of Emacs to become effective."
  1214. :group 'org-link
  1215. :type '(set :greedy t
  1216. (const :tag "Double bracket links" bracket)
  1217. (const :tag "Angular bracket links" angle)
  1218. (const :tag "Plain text links" plain)
  1219. (const :tag "Radio target matches" radio)
  1220. (const :tag "Tags" tag)
  1221. (const :tag "Timestamps" date)
  1222. (const :tag "Footnotes" footnote)))
  1223. (defcustom org-make-link-description-function nil
  1224. "Function to use to generate link descriptions from links.
  1225. If nil the link location will be used. This function must take
  1226. two parameters; the first is the link and the second the
  1227. description `org-insert-link' has generated, and should return the
  1228. description to use."
  1229. :group 'org-link
  1230. :type 'function)
  1231. (defgroup org-link-store nil
  1232. "Options concerning storing links in Org-mode."
  1233. :tag "Org Store Link"
  1234. :group 'org-link)
  1235. (defcustom org-url-hexify-p t
  1236. "When non-nil, hexify URL when creating a link."
  1237. :type 'boolean
  1238. ;; :version "24.3"
  1239. :group 'org-link-store)
  1240. (defcustom org-email-link-description-format "Email %c: %.30s"
  1241. "Format of the description part of a link to an email or usenet message.
  1242. The following %-escapes will be replaced by corresponding information:
  1243. %F full \"From\" field
  1244. %f name, taken from \"From\" field, address if no name
  1245. %T full \"To\" field
  1246. %t first name in \"To\" field, address if no name
  1247. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1248. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1249. %s subject
  1250. %d date
  1251. %m message-id.
  1252. You may use normal field width specification between the % and the letter.
  1253. This is for example useful to limit the length of the subject.
  1254. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1255. :group 'org-link-store
  1256. :type 'string)
  1257. (defcustom org-from-is-user-regexp
  1258. (let (r1 r2)
  1259. (when (and user-mail-address (not (string= user-mail-address "")))
  1260. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1261. (when (and user-full-name (not (string= user-full-name "")))
  1262. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1263. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1264. "Regexp matched against the \"From:\" header of an email or usenet message.
  1265. It should match if the message is from the user him/herself."
  1266. :group 'org-link-store
  1267. :type 'regexp)
  1268. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1269. "Non-nil means storing a link to an Org file will use entry IDs.
  1270. Note that before this variable is even considered, org-id must be loaded,
  1271. so please customize `org-modules' and turn it on.
  1272. The variable can have the following values:
  1273. t Create an ID if needed to make a link to the current entry.
  1274. create-if-interactive
  1275. If `org-store-link' is called directly (interactively, as a user
  1276. command), do create an ID to support the link. But when doing the
  1277. job for remember, only use the ID if it already exists. The
  1278. purpose of this setting is to avoid proliferation of unwanted
  1279. IDs, just because you happen to be in an Org file when you
  1280. call `org-capture' that automatically and preemptively creates a
  1281. link. If you do want to get an ID link in a remember template to
  1282. an entry not having an ID, create it first by explicitly creating
  1283. a link to it, using `C-c C-l' first.
  1284. create-if-interactive-and-no-custom-id
  1285. Like create-if-interactive, but do not create an ID if there is
  1286. a CUSTOM_ID property defined in the entry. This is the default.
  1287. use-existing
  1288. Use existing ID, do not create one.
  1289. nil Never use an ID to make a link, instead link using a text search for
  1290. the headline text."
  1291. :group 'org-link-store
  1292. :type '(choice
  1293. (const :tag "Create ID to make link" t)
  1294. (const :tag "Create if storing link interactively"
  1295. create-if-interactive)
  1296. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1297. create-if-interactive-and-no-custom-id)
  1298. (const :tag "Only use existing" use-existing)
  1299. (const :tag "Do not use ID to create link" nil)))
  1300. (defcustom org-context-in-file-links t
  1301. "Non-nil means file links from `org-store-link' contain context.
  1302. A search string will be added to the file name with :: as separator and
  1303. used to find the context when the link is activated by the command
  1304. `org-open-at-point'. When this option is t, the entire active region
  1305. will be placed in the search string of the file link. If set to a
  1306. positive integer, only the first n lines of context will be stored.
  1307. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1308. negates this setting for the duration of the command."
  1309. :group 'org-link-store
  1310. :type '(choice boolean integer))
  1311. (defcustom org-keep-stored-link-after-insertion nil
  1312. "Non-nil means keep link in list for entire session.
  1313. The command `org-store-link' adds a link pointing to the current
  1314. location to an internal list. These links accumulate during a session.
  1315. The command `org-insert-link' can be used to insert links into any
  1316. Org-mode file (offering completion for all stored links). When this
  1317. option is nil, every link which has been inserted once using \\[org-insert-link]
  1318. will be removed from the list, to make completing the unused links
  1319. more efficient."
  1320. :group 'org-link-store
  1321. :type 'boolean)
  1322. (defgroup org-link-follow nil
  1323. "Options concerning following links in Org-mode."
  1324. :tag "Org Follow Link"
  1325. :group 'org-link)
  1326. (defcustom org-link-translation-function nil
  1327. "Function to translate links with different syntax to Org syntax.
  1328. This can be used to translate links created for example by the Planner
  1329. or emacs-wiki packages to Org syntax.
  1330. The function must accept two parameters, a TYPE containing the link
  1331. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1332. which is everything after the link protocol. It should return a cons
  1333. with possibly modified values of type and path.
  1334. Org contains a function for this, so if you set this variable to
  1335. `org-translate-link-from-planner', you should be able follow many
  1336. links created by planner."
  1337. :group 'org-link-follow
  1338. :type 'function)
  1339. (defcustom org-follow-link-hook nil
  1340. "Hook that is run after a link has been followed."
  1341. :group 'org-link-follow
  1342. :type 'hook)
  1343. (defcustom org-tab-follows-link nil
  1344. "Non-nil means on links TAB will follow the link.
  1345. Needs to be set before org.el is loaded.
  1346. This really should not be used, it does not make sense, and the
  1347. implementation is bad."
  1348. :group 'org-link-follow
  1349. :type 'boolean)
  1350. (defcustom org-return-follows-link nil
  1351. "Non-nil means on links RET will follow the link."
  1352. :group 'org-link-follow
  1353. :type 'boolean)
  1354. (defcustom org-mouse-1-follows-link
  1355. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1356. "Non-nil means mouse-1 on a link will follow the link.
  1357. A longer mouse click will still set point. Does not work on XEmacs.
  1358. Needs to be set before org.el is loaded."
  1359. :group 'org-link-follow
  1360. :type 'boolean)
  1361. (defcustom org-mark-ring-length 4
  1362. "Number of different positions to be recorded in the ring.
  1363. Changing this requires a restart of Emacs to work correctly."
  1364. :group 'org-link-follow
  1365. :type 'integer)
  1366. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1367. "Non-nil means internal links in Org files must exactly match a headline.
  1368. When nil, the link search tries to match a phrase with all words
  1369. in the search text."
  1370. :group 'org-link-follow
  1371. :version "24.1"
  1372. :type '(choice
  1373. (const :tag "Use fuzzy text search" nil)
  1374. (const :tag "Match only exact headline" t)
  1375. (const :tag "Match exact headline or query to create it"
  1376. query-to-create)))
  1377. (defcustom org-link-frame-setup
  1378. '((vm . vm-visit-folder-other-frame)
  1379. (vm-imap . vm-visit-imap-folder-other-frame)
  1380. (gnus . org-gnus-no-new-news)
  1381. (file . find-file-other-window)
  1382. (wl . wl-other-frame))
  1383. "Setup the frame configuration for following links.
  1384. When following a link with Emacs, it may often be useful to display
  1385. this link in another window or frame. This variable can be used to
  1386. set this up for the different types of links.
  1387. For VM, use any of
  1388. `vm-visit-folder'
  1389. `vm-visit-folder-other-window'
  1390. `vm-visit-folder-other-frame'
  1391. For Gnus, use any of
  1392. `gnus'
  1393. `gnus-other-frame'
  1394. `org-gnus-no-new-news'
  1395. For FILE, use any of
  1396. `find-file'
  1397. `find-file-other-window'
  1398. `find-file-other-frame'
  1399. For Wanderlust use any of
  1400. `wl'
  1401. `wl-other-frame'
  1402. For the calendar, use the variable `calendar-setup'.
  1403. For BBDB, it is currently only possible to display the matches in
  1404. another window."
  1405. :group 'org-link-follow
  1406. :type '(list
  1407. (cons (const vm)
  1408. (choice
  1409. (const vm-visit-folder)
  1410. (const vm-visit-folder-other-window)
  1411. (const vm-visit-folder-other-frame)))
  1412. (cons (const gnus)
  1413. (choice
  1414. (const gnus)
  1415. (const gnus-other-frame)
  1416. (const org-gnus-no-new-news)))
  1417. (cons (const file)
  1418. (choice
  1419. (const find-file)
  1420. (const find-file-other-window)
  1421. (const find-file-other-frame)))
  1422. (cons (const wl)
  1423. (choice
  1424. (const wl)
  1425. (const wl-other-frame)))))
  1426. (defcustom org-display-internal-link-with-indirect-buffer nil
  1427. "Non-nil means use indirect buffer to display infile links.
  1428. Activating internal links (from one location in a file to another location
  1429. in the same file) normally just jumps to the location. When the link is
  1430. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1431. is displayed in
  1432. another window. When this option is set, the other window actually displays
  1433. an indirect buffer clone of the current buffer, to avoid any visibility
  1434. changes to the current buffer."
  1435. :group 'org-link-follow
  1436. :type 'boolean)
  1437. (defcustom org-open-non-existing-files nil
  1438. "Non-nil means `org-open-file' will open non-existing files.
  1439. When nil, an error will be generated.
  1440. This variable applies only to external applications because they
  1441. might choke on non-existing files. If the link is to a file that
  1442. will be opened in Emacs, the variable is ignored."
  1443. :group 'org-link-follow
  1444. :type 'boolean)
  1445. (defcustom org-open-directory-means-index-dot-org nil
  1446. "Non-nil means a link to a directory really means to index.org.
  1447. When nil, following a directory link will run dired or open a finder/explorer
  1448. window on that directory."
  1449. :group 'org-link-follow
  1450. :type 'boolean)
  1451. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1452. "Function and arguments to call for following mailto links.
  1453. This is a list with the first element being a Lisp function, and the
  1454. remaining elements being arguments to the function. In string arguments,
  1455. %a will be replaced by the address, and %s will be replaced by the subject
  1456. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1457. :group 'org-link-follow
  1458. :type '(choice
  1459. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1460. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1461. (const :tag "message-mail" (message-mail "%a" "%s"))
  1462. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1463. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1464. "Non-nil means ask for confirmation before executing shell links.
  1465. Shell links can be dangerous: just think about a link
  1466. [[shell:rm -rf ~/*][Google Search]]
  1467. This link would show up in your Org-mode document as \"Google Search\",
  1468. but really it would remove your entire home directory.
  1469. Therefore we advise against setting this variable to nil.
  1470. Just change it to `y-or-n-p' if you want to confirm with a
  1471. single keystroke rather than having to type \"yes\"."
  1472. :group 'org-link-follow
  1473. :type '(choice
  1474. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1475. (const :tag "with y-or-n (faster)" y-or-n-p)
  1476. (const :tag "no confirmation (dangerous)" nil)))
  1477. (put 'org-confirm-shell-link-function
  1478. 'safe-local-variable
  1479. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1480. (defcustom org-confirm-shell-link-not-regexp ""
  1481. "A regexp to skip confirmation for shell links."
  1482. :group 'org-link-follow
  1483. :version "24.1"
  1484. :type 'regexp)
  1485. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1486. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1487. Elisp links can be dangerous: just think about a link
  1488. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1489. This link would show up in your Org-mode document as \"Google Search\",
  1490. but really it would remove your entire home directory.
  1491. Therefore we advise against setting this variable to nil.
  1492. Just change it to `y-or-n-p' if you want to confirm with a
  1493. single keystroke rather than having to type \"yes\"."
  1494. :group 'org-link-follow
  1495. :type '(choice
  1496. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1497. (const :tag "with y-or-n (faster)" y-or-n-p)
  1498. (const :tag "no confirmation (dangerous)" nil)))
  1499. (put 'org-confirm-shell-link-function
  1500. 'safe-local-variable
  1501. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1502. (defcustom org-confirm-elisp-link-not-regexp ""
  1503. "A regexp to skip confirmation for Elisp links."
  1504. :group 'org-link-follow
  1505. :version "24.1"
  1506. :type 'regexp)
  1507. (defconst org-file-apps-defaults-gnu
  1508. '((remote . emacs)
  1509. (system . mailcap)
  1510. (t . mailcap))
  1511. "Default file applications on a UNIX or GNU/Linux system.
  1512. See `org-file-apps'.")
  1513. (defconst org-file-apps-defaults-macosx
  1514. '((remote . emacs)
  1515. (t . "open %s")
  1516. (system . "open %s")
  1517. ("ps.gz" . "gv %s")
  1518. ("eps.gz" . "gv %s")
  1519. ("dvi" . "xdvi %s")
  1520. ("fig" . "xfig %s"))
  1521. "Default file applications on a MacOS X system.
  1522. The system \"open\" is known as a default, but we use X11 applications
  1523. for some files for which the OS does not have a good default.
  1524. See `org-file-apps'.")
  1525. (defconst org-file-apps-defaults-windowsnt
  1526. (list
  1527. '(remote . emacs)
  1528. (cons t
  1529. (list (if (featurep 'xemacs)
  1530. 'mswindows-shell-execute
  1531. 'w32-shell-execute)
  1532. "open" 'file))
  1533. (cons 'system
  1534. (list (if (featurep 'xemacs)
  1535. 'mswindows-shell-execute
  1536. 'w32-shell-execute)
  1537. "open" 'file)))
  1538. "Default file applications on a Windows NT system.
  1539. The system \"open\" is used for most files.
  1540. See `org-file-apps'.")
  1541. (defcustom org-file-apps
  1542. '(
  1543. (auto-mode . emacs)
  1544. ("\\.mm\\'" . default)
  1545. ("\\.x?html?\\'" . default)
  1546. ("\\.pdf\\'" . default)
  1547. )
  1548. "External applications for opening `file:path' items in a document.
  1549. Org-mode uses system defaults for different file types, but
  1550. you can use this variable to set the application for a given file
  1551. extension. The entries in this list are cons cells where the car identifies
  1552. files and the cdr the corresponding command. Possible values for the
  1553. file identifier are
  1554. \"string\" A string as a file identifier can be interpreted in different
  1555. ways, depending on its contents:
  1556. - Alphanumeric characters only:
  1557. Match links with this file extension.
  1558. Example: (\"pdf\" . \"evince %s\")
  1559. to open PDFs with evince.
  1560. - Regular expression: Match links where the
  1561. filename matches the regexp. If you want to
  1562. use groups here, use shy groups.
  1563. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1564. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1565. to open *.html and *.xhtml with firefox.
  1566. - Regular expression which contains (non-shy) groups:
  1567. Match links where the whole link, including \"::\", and
  1568. anything after that, matches the regexp.
  1569. In a custom command string, %1, %2, etc. are replaced with
  1570. the parts of the link that were matched by the groups.
  1571. For backwards compatibility, if a command string is given
  1572. that does not use any of the group matches, this case is
  1573. handled identically to the second one (i.e. match against
  1574. file name only).
  1575. In a custom lisp form, you can access the group matches with
  1576. (match-string n link).
  1577. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1578. to open [[file:document.pdf::5]] with evince at page 5.
  1579. `directory' Matches a directory
  1580. `remote' Matches a remote file, accessible through tramp or efs.
  1581. Remote files most likely should be visited through Emacs
  1582. because external applications cannot handle such paths.
  1583. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1584. so all files Emacs knows how to handle. Using this with
  1585. command `emacs' will open most files in Emacs. Beware that this
  1586. will also open html files inside Emacs, unless you add
  1587. (\"html\" . default) to the list as well.
  1588. t Default for files not matched by any of the other options.
  1589. `system' The system command to open files, like `open' on Windows
  1590. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1591. that will be selected if you call `C-c C-o' with a double
  1592. \\[universal-argument] \\[universal-argument] prefix.
  1593. Possible values for the command are:
  1594. `emacs' The file will be visited by the current Emacs process.
  1595. `default' Use the default application for this file type, which is the
  1596. association for t in the list, most likely in the system-specific
  1597. part.
  1598. This can be used to overrule an unwanted setting in the
  1599. system-specific variable.
  1600. `system' Use the system command for opening files, like \"open\".
  1601. This command is specified by the entry whose car is `system'.
  1602. Most likely, the system-specific version of this variable
  1603. does define this command, but you can overrule/replace it
  1604. here.
  1605. string A command to be executed by a shell; %s will be replaced
  1606. by the path to the file.
  1607. sexp A Lisp form which will be evaluated. The file path will
  1608. be available in the Lisp variable `file'.
  1609. For more examples, see the system specific constants
  1610. `org-file-apps-defaults-macosx'
  1611. `org-file-apps-defaults-windowsnt'
  1612. `org-file-apps-defaults-gnu'."
  1613. :group 'org-link-follow
  1614. :type '(repeat
  1615. (cons (choice :value ""
  1616. (string :tag "Extension")
  1617. (const :tag "System command to open files" system)
  1618. (const :tag "Default for unrecognized files" t)
  1619. (const :tag "Remote file" remote)
  1620. (const :tag "Links to a directory" directory)
  1621. (const :tag "Any files that have Emacs modes"
  1622. auto-mode))
  1623. (choice :value ""
  1624. (const :tag "Visit with Emacs" emacs)
  1625. (const :tag "Use default" default)
  1626. (const :tag "Use the system command" system)
  1627. (string :tag "Command")
  1628. (sexp :tag "Lisp form")))))
  1629. (defcustom org-doi-server-url "http://dx.doi.org/"
  1630. "The URL of the DOI server."
  1631. :type 'string
  1632. ;; :version "24.3"
  1633. :group 'org-link-follow)
  1634. (defgroup org-refile nil
  1635. "Options concerning refiling entries in Org-mode."
  1636. :tag "Org Refile"
  1637. :group 'org)
  1638. (defcustom org-directory "~/org"
  1639. "Directory with org files.
  1640. This is just a default location to look for Org files. There is no need
  1641. at all to put your files into this directory. It is only used in the
  1642. following situations:
  1643. 1. When a remember template specifies a target file that is not an
  1644. absolute path. The path will then be interpreted relative to
  1645. `org-directory'
  1646. 2. When a remember note is filed away in an interactive way (when exiting the
  1647. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1648. with `org-directory' as the default path."
  1649. :group 'org-refile
  1650. :group 'org-remember
  1651. :type 'directory)
  1652. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1653. "Default target for storing notes.
  1654. Used as a fall back file for org-remember.el and org-capture.el, for
  1655. templates that do not specify a target file."
  1656. :group 'org-refile
  1657. :group 'org-remember
  1658. :type '(choice
  1659. (const :tag "Default from remember-data-file" nil)
  1660. file))
  1661. (defcustom org-goto-interface 'outline
  1662. "The default interface to be used for `org-goto'.
  1663. Allowed values are:
  1664. outline The interface shows an outline of the relevant file
  1665. and the correct heading is found by moving through
  1666. the outline or by searching with incremental search.
  1667. outline-path-completion Headlines in the current buffer are offered via
  1668. completion. This is the interface also used by
  1669. the refile command."
  1670. :group 'org-refile
  1671. :type '(choice
  1672. (const :tag "Outline" outline)
  1673. (const :tag "Outline-path-completion" outline-path-completion)))
  1674. (defcustom org-goto-max-level 5
  1675. "Maximum target level when running `org-goto' with refile interface."
  1676. :group 'org-refile
  1677. :type 'integer)
  1678. (defcustom org-reverse-note-order nil
  1679. "Non-nil means store new notes at the beginning of a file or entry.
  1680. When nil, new notes will be filed to the end of a file or entry.
  1681. This can also be a list with cons cells of regular expressions that
  1682. are matched against file names, and values."
  1683. :group 'org-remember
  1684. :group 'org-refile
  1685. :type '(choice
  1686. (const :tag "Reverse always" t)
  1687. (const :tag "Reverse never" nil)
  1688. (repeat :tag "By file name regexp"
  1689. (cons regexp boolean))))
  1690. (defcustom org-log-refile nil
  1691. "Information to record when a task is refiled.
  1692. Possible values are:
  1693. nil Don't add anything
  1694. time Add a time stamp to the task
  1695. note Prompt for a note and add it with template `org-log-note-headings'
  1696. This option can also be set with on a per-file-basis with
  1697. #+STARTUP: nologrefile
  1698. #+STARTUP: logrefile
  1699. #+STARTUP: lognoterefile
  1700. You can have local logging settings for a subtree by setting the LOGGING
  1701. property to one or more of these keywords.
  1702. When bulk-refiling from the agenda, the value `note' is forbidden and
  1703. will temporarily be changed to `time'."
  1704. :group 'org-refile
  1705. :group 'org-progress
  1706. :version "24.1"
  1707. :type '(choice
  1708. (const :tag "No logging" nil)
  1709. (const :tag "Record timestamp" time)
  1710. (const :tag "Record timestamp with note." note)))
  1711. (defcustom org-refile-targets nil
  1712. "Targets for refiling entries with \\[org-refile].
  1713. This is a list of cons cells. Each cell contains:
  1714. - a specification of the files to be considered, either a list of files,
  1715. or a symbol whose function or variable value will be used to retrieve
  1716. a file name or a list of file names. If you use `org-agenda-files' for
  1717. that, all agenda files will be scanned for targets. Nil means consider
  1718. headings in the current buffer.
  1719. - A specification of how to find candidate refile targets. This may be
  1720. any of:
  1721. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1722. This tag has to be present in all target headlines, inheritance will
  1723. not be considered.
  1724. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1725. todo keyword.
  1726. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1727. headlines that are refiling targets.
  1728. - a cons cell (:level . N). Any headline of level N is considered a target.
  1729. Note that, when `org-odd-levels-only' is set, level corresponds to
  1730. order in hierarchy, not to the number of stars.
  1731. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1732. Note that, when `org-odd-levels-only' is set, level corresponds to
  1733. order in hierarchy, not to the number of stars.
  1734. Each element of this list generates a set of possible targets.
  1735. The union of these sets is presented (with completion) to
  1736. the user by `org-refile'.
  1737. You can set the variable `org-refile-target-verify-function' to a function
  1738. to verify each headline found by the simple criteria above.
  1739. When this variable is nil, all top-level headlines in the current buffer
  1740. are used, equivalent to the value `((nil . (:level . 1))'."
  1741. :group 'org-refile
  1742. :type '(repeat
  1743. (cons
  1744. (choice :value org-agenda-files
  1745. (const :tag "All agenda files" org-agenda-files)
  1746. (const :tag "Current buffer" nil)
  1747. (function) (variable) (file))
  1748. (choice :tag "Identify target headline by"
  1749. (cons :tag "Specific tag" (const :value :tag) (string))
  1750. (cons :tag "TODO keyword" (const :value :todo) (string))
  1751. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1752. (cons :tag "Level number" (const :value :level) (integer))
  1753. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1754. (defcustom org-refile-target-verify-function nil
  1755. "Function to verify if the headline at point should be a refile target.
  1756. The function will be called without arguments, with point at the
  1757. beginning of the headline. It should return t and leave point
  1758. where it is if the headline is a valid target for refiling.
  1759. If the target should not be selected, the function must return nil.
  1760. In addition to this, it may move point to a place from where the search
  1761. should be continued. For example, the function may decide that the entire
  1762. subtree of the current entry should be excluded and move point to the end
  1763. of the subtree."
  1764. :group 'org-refile
  1765. :type 'function)
  1766. (defcustom org-refile-use-cache nil
  1767. "Non-nil means cache refile targets to speed up the process.
  1768. The cache for a particular file will be updated automatically when
  1769. the buffer has been killed, or when any of the marker used for flagging
  1770. refile targets no longer points at a live buffer.
  1771. If you have added new entries to a buffer that might themselves be targets,
  1772. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1773. find that easier, `C-u C-u C-u C-c C-w'."
  1774. :group 'org-refile
  1775. :version "24.1"
  1776. :type 'boolean)
  1777. (defcustom org-refile-use-outline-path nil
  1778. "Non-nil means provide refile targets as paths.
  1779. So a level 3 headline will be available as level1/level2/level3.
  1780. When the value is `file', also include the file name (without directory)
  1781. into the path. In this case, you can also stop the completion after
  1782. the file name, to get entries inserted as top level in the file.
  1783. When `full-file-path', include the full file path."
  1784. :group 'org-refile
  1785. :type '(choice
  1786. (const :tag "Not" nil)
  1787. (const :tag "Yes" t)
  1788. (const :tag "Start with file name" file)
  1789. (const :tag "Start with full file path" full-file-path)))
  1790. (defcustom org-outline-path-complete-in-steps t
  1791. "Non-nil means complete the outline path in hierarchical steps.
  1792. When Org-mode uses the refile interface to select an outline path
  1793. \(see variable `org-refile-use-outline-path'), the completion of
  1794. the path can be done is a single go, or if can be done in steps down
  1795. the headline hierarchy. Going in steps is probably the best if you
  1796. do not use a special completion package like `ido' or `icicles'.
  1797. However, when using these packages, going in one step can be very
  1798. fast, while still showing the whole path to the entry."
  1799. :group 'org-refile
  1800. :type 'boolean)
  1801. (defcustom org-refile-allow-creating-parent-nodes nil
  1802. "Non-nil means allow to create new nodes as refile targets.
  1803. New nodes are then created by adding \"/new node name\" to the completion
  1804. of an existing node. When the value of this variable is `confirm',
  1805. new node creation must be confirmed by the user (recommended)
  1806. When nil, the completion must match an existing entry.
  1807. Note that, if the new heading is not seen by the criteria
  1808. listed in `org-refile-targets', multiple instances of the same
  1809. heading would be created by trying again to file under the new
  1810. heading."
  1811. :group 'org-refile
  1812. :type '(choice
  1813. (const :tag "Never" nil)
  1814. (const :tag "Always" t)
  1815. (const :tag "Prompt for confirmation" confirm)))
  1816. (defcustom org-refile-active-region-within-subtree nil
  1817. "Non-nil means also refile active region within a subtree.
  1818. By default `org-refile' doesn't allow refiling regions if they
  1819. don't contain a set of subtrees, but it might be convenient to
  1820. do so sometimes: in that case, the first line of the region is
  1821. converted to a headline before refiling."
  1822. :group 'org-refile
  1823. :version "24.1"
  1824. :type 'boolean)
  1825. (defgroup org-todo nil
  1826. "Options concerning TODO items in Org-mode."
  1827. :tag "Org TODO"
  1828. :group 'org)
  1829. (defgroup org-progress nil
  1830. "Options concerning Progress logging in Org-mode."
  1831. :tag "Org Progress"
  1832. :group 'org-time)
  1833. (defvar org-todo-interpretation-widgets
  1834. '((:tag "Sequence (cycling hits every state)" sequence)
  1835. (:tag "Type (cycling directly to DONE)" type))
  1836. "The available interpretation symbols for customizing `org-todo-keywords'.
  1837. Interested libraries should add to this list.")
  1838. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1839. "List of TODO entry keyword sequences and their interpretation.
  1840. \\<org-mode-map>This is a list of sequences.
  1841. Each sequence starts with a symbol, either `sequence' or `type',
  1842. indicating if the keywords should be interpreted as a sequence of
  1843. action steps, or as different types of TODO items. The first
  1844. keywords are states requiring action - these states will select a headline
  1845. for inclusion into the global TODO list Org-mode produces. If one of
  1846. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1847. signify that no further action is necessary. If \"|\" is not found,
  1848. the last keyword is treated as the only DONE state of the sequence.
  1849. The command \\[org-todo] cycles an entry through these states, and one
  1850. additional state where no keyword is present. For details about this
  1851. cycling, see the manual.
  1852. TODO keywords and interpretation can also be set on a per-file basis with
  1853. the special #+SEQ_TODO and #+TYP_TODO lines.
  1854. Each keyword can optionally specify a character for fast state selection
  1855. \(in combination with the variable `org-use-fast-todo-selection')
  1856. and specifiers for state change logging, using the same syntax that
  1857. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  1858. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1859. indicates to record a time stamp each time this state is selected.
  1860. Each keyword may also specify if a timestamp or a note should be
  1861. recorded when entering or leaving the state, by adding additional
  1862. characters in the parenthesis after the keyword. This looks like this:
  1863. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1864. record only the time of the state change. With X and Y being either
  1865. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1866. Y when leaving the state if and only if the *target* state does not
  1867. define X. You may omit any of the fast-selection key or X or /Y,
  1868. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1869. For backward compatibility, this variable may also be just a list
  1870. of keywords. In this case the interpretation (sequence or type) will be
  1871. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1872. :group 'org-todo
  1873. :group 'org-keywords
  1874. :type '(choice
  1875. (repeat :tag "Old syntax, just keywords"
  1876. (string :tag "Keyword"))
  1877. (repeat :tag "New syntax"
  1878. (cons
  1879. (choice
  1880. :tag "Interpretation"
  1881. ;;Quick and dirty way to see
  1882. ;;`org-todo-interpretations'. This takes the
  1883. ;;place of item arguments
  1884. :convert-widget
  1885. (lambda (widget)
  1886. (widget-put widget
  1887. :args (mapcar
  1888. #'(lambda (x)
  1889. (widget-convert
  1890. (cons 'const x)))
  1891. org-todo-interpretation-widgets))
  1892. widget))
  1893. (repeat
  1894. (string :tag "Keyword"))))))
  1895. (defvar org-todo-keywords-1 nil
  1896. "All TODO and DONE keywords active in a buffer.")
  1897. (make-variable-buffer-local 'org-todo-keywords-1)
  1898. (defvar org-todo-keywords-for-agenda nil)
  1899. (defvar org-done-keywords-for-agenda nil)
  1900. (defvar org-drawers-for-agenda nil)
  1901. (defvar org-todo-keyword-alist-for-agenda nil)
  1902. (defvar org-tag-alist-for-agenda nil)
  1903. (defvar org-agenda-contributing-files nil)
  1904. (defvar org-not-done-keywords nil)
  1905. (make-variable-buffer-local 'org-not-done-keywords)
  1906. (defvar org-done-keywords nil)
  1907. (make-variable-buffer-local 'org-done-keywords)
  1908. (defvar org-todo-heads nil)
  1909. (make-variable-buffer-local 'org-todo-heads)
  1910. (defvar org-todo-sets nil)
  1911. (make-variable-buffer-local 'org-todo-sets)
  1912. (defvar org-todo-log-states nil)
  1913. (make-variable-buffer-local 'org-todo-log-states)
  1914. (defvar org-todo-kwd-alist nil)
  1915. (make-variable-buffer-local 'org-todo-kwd-alist)
  1916. (defvar org-todo-key-alist nil)
  1917. (make-variable-buffer-local 'org-todo-key-alist)
  1918. (defvar org-todo-key-trigger nil)
  1919. (make-variable-buffer-local 'org-todo-key-trigger)
  1920. (defcustom org-todo-interpretation 'sequence
  1921. "Controls how TODO keywords are interpreted.
  1922. This variable is in principle obsolete and is only used for
  1923. backward compatibility, if the interpretation of todo keywords is
  1924. not given already in `org-todo-keywords'. See that variable for
  1925. more information."
  1926. :group 'org-todo
  1927. :group 'org-keywords
  1928. :type '(choice (const sequence)
  1929. (const type)))
  1930. (defcustom org-use-fast-todo-selection t
  1931. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1932. This variable describes if and under what circumstances the cycling
  1933. mechanism for TODO keywords will be replaced by a single-key, direct
  1934. selection scheme.
  1935. When nil, fast selection is never used.
  1936. When the symbol `prefix', it will be used when `org-todo' is called
  1937. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  1938. `C-u t' in an agenda buffer.
  1939. When t, fast selection is used by default. In this case, the prefix
  1940. argument forces cycling instead.
  1941. In all cases, the special interface is only used if access keys have
  1942. actually been assigned by the user, i.e. if keywords in the configuration
  1943. are followed by a letter in parenthesis, like TODO(t)."
  1944. :group 'org-todo
  1945. :type '(choice
  1946. (const :tag "Never" nil)
  1947. (const :tag "By default" t)
  1948. (const :tag "Only with C-u C-c C-t" prefix)))
  1949. (defcustom org-provide-todo-statistics t
  1950. "Non-nil means update todo statistics after insert and toggle.
  1951. ALL-HEADLINES means update todo statistics by including headlines
  1952. with no TODO keyword as well, counting them as not done.
  1953. A list of TODO keywords means the same, but skip keywords that are
  1954. not in this list.
  1955. When this is set, todo statistics is updated in the parent of the
  1956. current entry each time a todo state is changed."
  1957. :group 'org-todo
  1958. :type '(choice
  1959. (const :tag "Yes, only for TODO entries" t)
  1960. (const :tag "Yes, including all entries" 'all-headlines)
  1961. (repeat :tag "Yes, for TODOs in this list"
  1962. (string :tag "TODO keyword"))
  1963. (other :tag "No TODO statistics" nil)))
  1964. (defcustom org-hierarchical-todo-statistics t
  1965. "Non-nil means TODO statistics covers just direct children.
  1966. When nil, all entries in the subtree are considered.
  1967. This has only an effect if `org-provide-todo-statistics' is set.
  1968. To set this to nil for only a single subtree, use a COOKIE_DATA
  1969. property and include the word \"recursive\" into the value."
  1970. :group 'org-todo
  1971. :type 'boolean)
  1972. (defcustom org-after-todo-state-change-hook nil
  1973. "Hook which is run after the state of a TODO item was changed.
  1974. The new state (a string with a TODO keyword, or nil) is available in the
  1975. Lisp variable `org-state'."
  1976. :group 'org-todo
  1977. :type 'hook)
  1978. (defvar org-blocker-hook nil
  1979. "Hook for functions that are allowed to block a state change.
  1980. Each function gets as its single argument a property list, see
  1981. `org-trigger-hook' for more information about this list.
  1982. If any of the functions in this hook returns nil, the state change
  1983. is blocked.")
  1984. (defvar org-trigger-hook nil
  1985. "Hook for functions that are triggered by a state change.
  1986. Each function gets as its single argument a property list with at least
  1987. the following elements:
  1988. (:type type-of-change :position pos-at-entry-start
  1989. :from old-state :to new-state)
  1990. Depending on the type, more properties may be present.
  1991. This mechanism is currently implemented for:
  1992. TODO state changes
  1993. ------------------
  1994. :type todo-state-change
  1995. :from previous state (keyword as a string), or nil, or a symbol
  1996. 'todo' or 'done', to indicate the general type of state.
  1997. :to new state, like in :from")
  1998. (defcustom org-enforce-todo-dependencies nil
  1999. "Non-nil means undone TODO entries will block switching the parent to DONE.
  2000. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  2001. be blocked if any prior sibling is not yet done.
  2002. Finally, if the parent is blocked because of ordered siblings of its own,
  2003. the child will also be blocked."
  2004. :set (lambda (var val)
  2005. (set var val)
  2006. (if val
  2007. (add-hook 'org-blocker-hook
  2008. 'org-block-todo-from-children-or-siblings-or-parent)
  2009. (remove-hook 'org-blocker-hook
  2010. 'org-block-todo-from-children-or-siblings-or-parent)))
  2011. :group 'org-todo
  2012. :type 'boolean)
  2013. (defcustom org-enforce-todo-checkbox-dependencies nil
  2014. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2015. When this is nil, checkboxes have no influence on switching TODO states.
  2016. When non-nil, you first need to check off all check boxes before the TODO
  2017. entry can be switched to DONE.
  2018. This variable needs to be set before org.el is loaded, and you need to
  2019. restart Emacs after a change to make the change effective. The only way
  2020. to change is while Emacs is running is through the customize interface."
  2021. :set (lambda (var val)
  2022. (set var val)
  2023. (if val
  2024. (add-hook 'org-blocker-hook
  2025. 'org-block-todo-from-checkboxes)
  2026. (remove-hook 'org-blocker-hook
  2027. 'org-block-todo-from-checkboxes)))
  2028. :group 'org-todo
  2029. :type 'boolean)
  2030. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2031. "Non-nil means inserting a TODO heading is treated as state change.
  2032. So when the command \\[org-insert-todo-heading] is used, state change
  2033. logging will apply if appropriate. When nil, the new TODO item will
  2034. be inserted directly, and no logging will take place."
  2035. :group 'org-todo
  2036. :type 'boolean)
  2037. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2038. "Non-nil means switching TODO states with S-cursor counts as state change.
  2039. This is the default behavior. However, setting this to nil allows a
  2040. convenient way to select a TODO state and bypass any logging associated
  2041. with that."
  2042. :group 'org-todo
  2043. :type 'boolean)
  2044. (defcustom org-todo-state-tags-triggers nil
  2045. "Tag changes that should be triggered by TODO state changes.
  2046. This is a list. Each entry is
  2047. (state-change (tag . flag) .......)
  2048. State-change can be a string with a state, and empty string to indicate the
  2049. state that has no TODO keyword, or it can be one of the symbols `todo'
  2050. or `done', meaning any not-done or done state, respectively."
  2051. :group 'org-todo
  2052. :group 'org-tags
  2053. :type '(repeat
  2054. (cons (choice :tag "When changing to"
  2055. (const :tag "Not-done state" todo)
  2056. (const :tag "Done state" done)
  2057. (string :tag "State"))
  2058. (repeat
  2059. (cons :tag "Tag action"
  2060. (string :tag "Tag")
  2061. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2062. (defcustom org-log-done nil
  2063. "Information to record when a task moves to the DONE state.
  2064. Possible values are:
  2065. nil Don't add anything, just change the keyword
  2066. time Add a time stamp to the task
  2067. note Prompt for a note and add it with template `org-log-note-headings'
  2068. This option can also be set with on a per-file-basis with
  2069. #+STARTUP: nologdone
  2070. #+STARTUP: logdone
  2071. #+STARTUP: lognotedone
  2072. You can have local logging settings for a subtree by setting the LOGGING
  2073. property to one or more of these keywords."
  2074. :group 'org-todo
  2075. :group 'org-progress
  2076. :type '(choice
  2077. (const :tag "No logging" nil)
  2078. (const :tag "Record CLOSED timestamp" time)
  2079. (const :tag "Record CLOSED timestamp with note." note)))
  2080. ;; Normalize old uses of org-log-done.
  2081. (cond
  2082. ((eq org-log-done t) (setq org-log-done 'time))
  2083. ((and (listp org-log-done) (memq 'done org-log-done))
  2084. (setq org-log-done 'note)))
  2085. (defcustom org-log-reschedule nil
  2086. "Information to record when the scheduling date of a tasks is modified.
  2087. Possible values are:
  2088. nil Don't add anything, just change the date
  2089. time Add a time stamp to the task
  2090. note Prompt for a note and add it with template `org-log-note-headings'
  2091. This option can also be set with on a per-file-basis with
  2092. #+STARTUP: nologreschedule
  2093. #+STARTUP: logreschedule
  2094. #+STARTUP: lognotereschedule"
  2095. :group 'org-todo
  2096. :group 'org-progress
  2097. :type '(choice
  2098. (const :tag "No logging" nil)
  2099. (const :tag "Record timestamp" time)
  2100. (const :tag "Record timestamp with note." note)))
  2101. (defcustom org-log-redeadline nil
  2102. "Information to record when the deadline date of a tasks is modified.
  2103. Possible values are:
  2104. nil Don't add anything, just change the date
  2105. time Add a time stamp to the task
  2106. note Prompt for a note and add it with template `org-log-note-headings'
  2107. This option can also be set with on a per-file-basis with
  2108. #+STARTUP: nologredeadline
  2109. #+STARTUP: logredeadline
  2110. #+STARTUP: lognoteredeadline
  2111. You can have local logging settings for a subtree by setting the LOGGING
  2112. property to one or more of these keywords."
  2113. :group 'org-todo
  2114. :group 'org-progress
  2115. :type '(choice
  2116. (const :tag "No logging" nil)
  2117. (const :tag "Record timestamp" time)
  2118. (const :tag "Record timestamp with note." note)))
  2119. (defcustom org-log-note-clock-out nil
  2120. "Non-nil means record a note when clocking out of an item.
  2121. This can also be configured on a per-file basis by adding one of
  2122. the following lines anywhere in the buffer:
  2123. #+STARTUP: lognoteclock-out
  2124. #+STARTUP: nolognoteclock-out"
  2125. :group 'org-todo
  2126. :group 'org-progress
  2127. :type 'boolean)
  2128. (defcustom org-log-done-with-time t
  2129. "Non-nil means the CLOSED time stamp will contain date and time.
  2130. When nil, only the date will be recorded."
  2131. :group 'org-progress
  2132. :type 'boolean)
  2133. (defcustom org-log-note-headings
  2134. '((done . "CLOSING NOTE %t")
  2135. (state . "State %-12s from %-12S %t")
  2136. (note . "Note taken on %t")
  2137. (reschedule . "Rescheduled from %S on %t")
  2138. (delschedule . "Not scheduled, was %S on %t")
  2139. (redeadline . "New deadline from %S on %t")
  2140. (deldeadline . "Removed deadline, was %S on %t")
  2141. (refile . "Refiled on %t")
  2142. (clock-out . ""))
  2143. "Headings for notes added to entries.
  2144. The value is an alist, with the car being a symbol indicating the note
  2145. context, and the cdr is the heading to be used. The heading may also be the
  2146. empty string.
  2147. %t in the heading will be replaced by a time stamp.
  2148. %T will be an active time stamp instead the default inactive one
  2149. %d will be replaced by a short-format time stamp.
  2150. %D will be replaced by an active short-format time stamp.
  2151. %s will be replaced by the new TODO state, in double quotes.
  2152. %S will be replaced by the old TODO state, in double quotes.
  2153. %u will be replaced by the user name.
  2154. %U will be replaced by the full user name.
  2155. In fact, it is not a good idea to change the `state' entry, because
  2156. agenda log mode depends on the format of these entries."
  2157. :group 'org-todo
  2158. :group 'org-progress
  2159. :type '(list :greedy t
  2160. (cons (const :tag "Heading when closing an item" done) string)
  2161. (cons (const :tag
  2162. "Heading when changing todo state (todo sequence only)"
  2163. state) string)
  2164. (cons (const :tag "Heading when just taking a note" note) string)
  2165. (cons (const :tag "Heading when clocking out" clock-out) string)
  2166. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2167. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2168. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2169. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2170. (cons (const :tag "Heading when refiling" refile) string)))
  2171. (unless (assq 'note org-log-note-headings)
  2172. (push '(note . "%t") org-log-note-headings))
  2173. (defcustom org-log-into-drawer nil
  2174. "Non-nil means insert state change notes and time stamps into a drawer.
  2175. When nil, state changes notes will be inserted after the headline and
  2176. any scheduling and clock lines, but not inside a drawer.
  2177. The value of this variable should be the name of the drawer to use.
  2178. LOGBOOK is proposed as the default drawer for this purpose, you can
  2179. also set this to a string to define the drawer of your choice.
  2180. A value of t is also allowed, representing \"LOGBOOK\".
  2181. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2182. will be ignored.
  2183. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2184. a subtree."
  2185. :group 'org-todo
  2186. :group 'org-progress
  2187. :type '(choice
  2188. (const :tag "Not into a drawer" nil)
  2189. (const :tag "LOGBOOK" t)
  2190. (string :tag "Other")))
  2191. (if (fboundp 'defvaralias)
  2192. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  2193. (defun org-log-into-drawer ()
  2194. "Return the value of `org-log-into-drawer', but let properties overrule.
  2195. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2196. used instead of the default value."
  2197. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
  2198. (cond
  2199. ((or (not p) (equal p "nil")) org-log-into-drawer)
  2200. ((equal p "t") "LOGBOOK")
  2201. (t p))))
  2202. (defcustom org-log-state-notes-insert-after-drawers nil
  2203. "Non-nil means insert state change notes after any drawers in entry.
  2204. Only the drawers that *immediately* follow the headline and the
  2205. deadline/scheduled line are skipped.
  2206. When nil, insert notes right after the heading and perhaps the line
  2207. with deadline/scheduling if present.
  2208. This variable will have no effect if `org-log-into-drawer' is
  2209. set."
  2210. :group 'org-todo
  2211. :group 'org-progress
  2212. :type 'boolean)
  2213. (defcustom org-log-states-order-reversed t
  2214. "Non-nil means the latest state note will be directly after heading.
  2215. When nil, the state change notes will be ordered according to time."
  2216. :group 'org-todo
  2217. :group 'org-progress
  2218. :type 'boolean)
  2219. (defcustom org-todo-repeat-to-state nil
  2220. "The TODO state to which a repeater should return the repeating task.
  2221. By default this is the first task in a TODO sequence, or the previous state
  2222. in a TODO_TYP set. But you can specify another task here.
  2223. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2224. :group 'org-todo
  2225. :version "24.1"
  2226. :type '(choice (const :tag "Head of sequence" nil)
  2227. (string :tag "Specific state")))
  2228. (defcustom org-log-repeat 'time
  2229. "Non-nil means record moving through the DONE state when triggering repeat.
  2230. An auto-repeating task is immediately switched back to TODO when
  2231. marked DONE. If you are not logging state changes (by adding \"@\"
  2232. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2233. record a closing note, there will be no record of the task moving
  2234. through DONE. This variable forces taking a note anyway.
  2235. nil Don't force a record
  2236. time Record a time stamp
  2237. note Prompt for a note and add it with template `org-log-note-headings'
  2238. This option can also be set with on a per-file-basis with
  2239. #+STARTUP: nologrepeat
  2240. #+STARTUP: logrepeat
  2241. #+STARTUP: lognoterepeat
  2242. You can have local logging settings for a subtree by setting the LOGGING
  2243. property to one or more of these keywords."
  2244. :group 'org-todo
  2245. :group 'org-progress
  2246. :type '(choice
  2247. (const :tag "Don't force a record" nil)
  2248. (const :tag "Force recording the DONE state" time)
  2249. (const :tag "Force recording a note with the DONE state" note)))
  2250. (defgroup org-priorities nil
  2251. "Priorities in Org-mode."
  2252. :tag "Org Priorities"
  2253. :group 'org-todo)
  2254. (defcustom org-enable-priority-commands t
  2255. "Non-nil means priority commands are active.
  2256. When nil, these commands will be disabled, so that you never accidentally
  2257. set a priority."
  2258. :group 'org-priorities
  2259. :type 'boolean)
  2260. (defcustom org-highest-priority ?A
  2261. "The highest priority of TODO items. A character like ?A, ?B etc.
  2262. Must have a smaller ASCII number than `org-lowest-priority'."
  2263. :group 'org-priorities
  2264. :type 'character)
  2265. (defcustom org-lowest-priority ?C
  2266. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2267. Must have a larger ASCII number than `org-highest-priority'."
  2268. :group 'org-priorities
  2269. :type 'character)
  2270. (defcustom org-default-priority ?B
  2271. "The default priority of TODO items.
  2272. This is the priority an item gets if no explicit priority is given.
  2273. When starting to cycle on an empty priority the first step in the cycle
  2274. depends on `org-priority-start-cycle-with-default'. The resulting first
  2275. step priority must not exceed the range from `org-highest-priority' to
  2276. `org-lowest-priority' which means that `org-default-priority' has to be
  2277. in this range exclusive or inclusive the range boundaries. Else the
  2278. first step refuses to set the default and the second will fall back
  2279. to (depending on the command used) the highest or lowest priority."
  2280. :group 'org-priorities
  2281. :type 'character)
  2282. (defcustom org-priority-start-cycle-with-default t
  2283. "Non-nil means start with default priority when starting to cycle.
  2284. When this is nil, the first step in the cycle will be (depending on the
  2285. command used) one higher or lower than the default priority.
  2286. See also `org-default-priority'."
  2287. :group 'org-priorities
  2288. :type 'boolean)
  2289. (defcustom org-get-priority-function nil
  2290. "Function to extract the priority from a string.
  2291. The string is normally the headline. If this is nil Org computes the
  2292. priority from the priority cookie like [#A] in the headline. It returns
  2293. an integer, increasing by 1000 for each priority level.
  2294. The user can set a different function here, which should take a string
  2295. as an argument and return the numeric priority."
  2296. :group 'org-priorities
  2297. :version "24.1"
  2298. :type 'function)
  2299. (defgroup org-time nil
  2300. "Options concerning time stamps and deadlines in Org-mode."
  2301. :tag "Org Time"
  2302. :group 'org)
  2303. (defcustom org-insert-labeled-timestamps-at-point nil
  2304. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2305. When nil, these labeled time stamps are forces into the second line of an
  2306. entry, just after the headline. When scheduling from the global TODO list,
  2307. the time stamp will always be forced into the second line."
  2308. :group 'org-time
  2309. :type 'boolean)
  2310. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2311. "Formats for `format-time-string' which are used for time stamps.
  2312. It is not recommended to change this constant.")
  2313. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2314. "Number of minutes to round time stamps to.
  2315. These are two values, the first applies when first creating a time stamp.
  2316. The second applies when changing it with the commands `S-up' and `S-down'.
  2317. When changing the time stamp, this means that it will change in steps
  2318. of N minutes, as given by the second value.
  2319. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2320. numbers should be factors of 60, so for example 5, 10, 15.
  2321. When this is larger than 1, you can still force an exact time stamp by using
  2322. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2323. and by using a prefix arg to `S-up/down' to specify the exact number
  2324. of minutes to shift."
  2325. :group 'org-time
  2326. :get #'(lambda (var) ; Make sure both elements are there
  2327. (if (integerp (default-value var))
  2328. (list (default-value var) 5)
  2329. (default-value var)))
  2330. :type '(list
  2331. (integer :tag "when inserting times")
  2332. (integer :tag "when modifying times")))
  2333. ;; Normalize old customizations of this variable.
  2334. (when (integerp org-time-stamp-rounding-minutes)
  2335. (setq org-time-stamp-rounding-minutes
  2336. (list org-time-stamp-rounding-minutes
  2337. org-time-stamp-rounding-minutes)))
  2338. (defcustom org-display-custom-times nil
  2339. "Non-nil means overlay custom formats over all time stamps.
  2340. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2341. To turn this on on a per-file basis, insert anywhere in the file:
  2342. #+STARTUP: customtime"
  2343. :group 'org-time
  2344. :set 'set-default
  2345. :type 'sexp)
  2346. (make-variable-buffer-local 'org-display-custom-times)
  2347. (defcustom org-time-stamp-custom-formats
  2348. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2349. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2350. These are overlaid over the default ISO format if the variable
  2351. `org-display-custom-times' is set. Time like %H:%M should be at the
  2352. end of the second format. The custom formats are also honored by export
  2353. commands, if custom time display is turned on at the time of export."
  2354. :group 'org-time
  2355. :type 'sexp)
  2356. (defun org-time-stamp-format (&optional long inactive)
  2357. "Get the right format for a time string."
  2358. (let ((f (if long (cdr org-time-stamp-formats)
  2359. (car org-time-stamp-formats))))
  2360. (if inactive
  2361. (concat "[" (substring f 1 -1) "]")
  2362. f)))
  2363. (defcustom org-time-clocksum-format "%d:%02d"
  2364. "The format string used when creating CLOCKSUM lines.
  2365. This is also used when org-mode generates a time duration."
  2366. :group 'org-time
  2367. :type 'string)
  2368. (defcustom org-time-clocksum-use-fractional nil
  2369. "If non-nil, \\[org-clock-display] uses fractional times.
  2370. org-mode generates a time duration."
  2371. :group 'org-time
  2372. :type 'boolean)
  2373. (defcustom org-time-clocksum-fractional-format "%.2f"
  2374. "The format string used when creating CLOCKSUM lines, or when
  2375. org-mode generates a time duration."
  2376. :group 'org-time
  2377. :type 'string)
  2378. (defcustom org-deadline-warning-days 14
  2379. "No. of days before expiration during which a deadline becomes active.
  2380. This variable governs the display in sparse trees and in the agenda.
  2381. When 0 or negative, it means use this number (the absolute value of it)
  2382. even if a deadline has a different individual lead time specified.
  2383. Custom commands can set this variable in the options section."
  2384. :group 'org-time
  2385. :group 'org-agenda-daily/weekly
  2386. :type 'integer)
  2387. (defcustom org-read-date-prefer-future t
  2388. "Non-nil means assume future for incomplete date input from user.
  2389. This affects the following situations:
  2390. 1. The user gives a month but not a year.
  2391. For example, if it is April and you enter \"feb 2\", this will be read
  2392. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2393. 2. The user gives a day, but no month.
  2394. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2395. read this as the third of *next* month. However, if you enter \"17\",
  2396. it will be considered as *this* month.
  2397. If you set this variable to the symbol `time', then also the following
  2398. will work:
  2399. 3. If the user gives a time.
  2400. If the time is before now, it will be interpreted as tomorrow.
  2401. Currently none of this works for ISO week specifications.
  2402. When this option is nil, the current day, month and year will always be
  2403. used as defaults.
  2404. See also `org-agenda-jump-prefer-future'."
  2405. :group 'org-time
  2406. :type '(choice
  2407. (const :tag "Never" nil)
  2408. (const :tag "Check month and day" t)
  2409. (const :tag "Check month, day, and time" time)))
  2410. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2411. "Should the agenda jump command prefer the future for incomplete dates?
  2412. The default is to do the same as configured in `org-read-date-prefer-future'.
  2413. But you can also set a deviating value here.
  2414. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2415. :group 'org-agenda
  2416. :group 'org-time
  2417. :version "24.1"
  2418. :type '(choice
  2419. (const :tag "Use org-read-date-prefer-future"
  2420. org-read-date-prefer-future)
  2421. (const :tag "Never" nil)
  2422. (const :tag "Always" t)))
  2423. (defcustom org-read-date-force-compatible-dates t
  2424. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2425. Depending on the system Emacs is running on, certain dates cannot
  2426. be represented with the type used internally to represent time.
  2427. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2428. correctly. Some systems allow for earlier dates, some for later,
  2429. some for both. One way to find out it to insert any date into an
  2430. Org buffer, putting the cursor on the year and hitting S-up and
  2431. S-down to test the range.
  2432. When this variable is set to t, the date/time prompt will not let
  2433. you specify dates outside the 1970-2037 range, so it is certain that
  2434. these dates will work in whatever version of Emacs you are
  2435. running, and also that you can move a file from one Emacs implementation
  2436. to another. WHenever Org is forcing the year for you, it will display
  2437. a message and beep.
  2438. When this variable is nil, Org will check if the date is
  2439. representable in the specific Emacs implementation you are using.
  2440. If not, it will force a year, usually the current year, and beep
  2441. to remind you. Currently this setting is not recommended because
  2442. the likelihood that you will open your Org files in an Emacs that
  2443. has limited date range is not negligible.
  2444. A workaround for this problem is to use diary sexp dates for time
  2445. stamps outside of this range."
  2446. :group 'org-time
  2447. :version "24.1"
  2448. :type 'boolean)
  2449. (defcustom org-read-date-display-live t
  2450. "Non-nil means display current interpretation of date prompt live.
  2451. This display will be in an overlay, in the minibuffer."
  2452. :group 'org-time
  2453. :type 'boolean)
  2454. (defcustom org-read-date-popup-calendar t
  2455. "Non-nil means pop up a calendar when prompting for a date.
  2456. In the calendar, the date can be selected with mouse-1. However, the
  2457. minibuffer will also be active, and you can simply enter the date as well.
  2458. When nil, only the minibuffer will be available."
  2459. :group 'org-time
  2460. :type 'boolean)
  2461. (if (fboundp 'defvaralias)
  2462. (defvaralias 'org-popup-calendar-for-date-prompt
  2463. 'org-read-date-popup-calendar))
  2464. (defcustom org-read-date-minibuffer-setup-hook nil
  2465. "Hook to be used to set up keys for the date/time interface.
  2466. Add key definitions to `minibuffer-local-map', which will be a temporary
  2467. copy."
  2468. :group 'org-time
  2469. :type 'hook)
  2470. (defcustom org-extend-today-until 0
  2471. "The hour when your day really ends. Must be an integer.
  2472. This has influence for the following applications:
  2473. - When switching the agenda to \"today\". It it is still earlier than
  2474. the time given here, the day recognized as TODAY is actually yesterday.
  2475. - When a date is read from the user and it is still before the time given
  2476. here, the current date and time will be assumed to be yesterday, 23:59.
  2477. Also, timestamps inserted in remember templates follow this rule.
  2478. IMPORTANT: This is a feature whose implementation is and likely will
  2479. remain incomplete. Really, it is only here because past midnight seems to
  2480. be the favorite working time of John Wiegley :-)"
  2481. :group 'org-time
  2482. :type 'integer)
  2483. (defcustom org-use-effective-time nil
  2484. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2485. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2486. \"effective time\" of any timestamps between midnight and 8am will be
  2487. 23:59 of the previous day."
  2488. :group 'org-time
  2489. :version "24.1"
  2490. :type 'boolean)
  2491. (defcustom org-edit-timestamp-down-means-later nil
  2492. "Non-nil means S-down will increase the time in a time stamp.
  2493. When nil, S-up will increase."
  2494. :group 'org-time
  2495. :type 'boolean)
  2496. (defcustom org-calendar-follow-timestamp-change t
  2497. "Non-nil means make the calendar window follow timestamp changes.
  2498. When a timestamp is modified and the calendar window is visible, it will be
  2499. moved to the new date."
  2500. :group 'org-time
  2501. :type 'boolean)
  2502. (defgroup org-tags nil
  2503. "Options concerning tags in Org-mode."
  2504. :tag "Org Tags"
  2505. :group 'org)
  2506. (defcustom org-tag-alist nil
  2507. "List of tags allowed in Org-mode files.
  2508. When this list is nil, Org-mode will base TAG input on what is already in the
  2509. buffer.
  2510. The value of this variable is an alist, the car of each entry must be a
  2511. keyword as a string, the cdr may be a character that is used to select
  2512. that tag through the fast-tag-selection interface.
  2513. See the manual for details."
  2514. :group 'org-tags
  2515. :type '(repeat
  2516. (choice
  2517. (cons (string :tag "Tag name")
  2518. (character :tag "Access char"))
  2519. (list :tag "Start radio group"
  2520. (const :startgroup)
  2521. (option (string :tag "Group description")))
  2522. (list :tag "End radio group"
  2523. (const :endgroup)
  2524. (option (string :tag "Group description")))
  2525. (const :tag "New line" (:newline)))))
  2526. (defcustom org-tag-persistent-alist nil
  2527. "List of tags that will always appear in all Org-mode files.
  2528. This is in addition to any in buffer settings or customizations
  2529. of `org-tag-alist'.
  2530. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2531. The value of this variable is an alist, the car of each entry must be a
  2532. keyword as a string, the cdr may be a character that is used to select
  2533. that tag through the fast-tag-selection interface.
  2534. See the manual for details.
  2535. To disable these tags on a per-file basis, insert anywhere in the file:
  2536. #+STARTUP: noptag"
  2537. :group 'org-tags
  2538. :type '(repeat
  2539. (choice
  2540. (cons (string :tag "Tag name")
  2541. (character :tag "Access char"))
  2542. (const :tag "Start radio group" (:startgroup))
  2543. (const :tag "End radio group" (:endgroup))
  2544. (const :tag "New line" (:newline)))))
  2545. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2546. "If non-nil, always offer completion for all tags of all agenda files.
  2547. Instead of customizing this variable directly, you might want to
  2548. set it locally for capture buffers, because there no list of
  2549. tags in that file can be created dynamically (there are none).
  2550. (add-hook 'org-capture-mode-hook
  2551. (lambda ()
  2552. (set (make-local-variable
  2553. 'org-complete-tags-always-offer-all-agenda-tags)
  2554. t)))"
  2555. :group 'org-tags
  2556. :version "24.1"
  2557. :type 'boolean)
  2558. (defvar org-file-tags nil
  2559. "List of tags that can be inherited by all entries in the file.
  2560. The tags will be inherited if the variable `org-use-tag-inheritance'
  2561. says they should be.
  2562. This variable is populated from #+FILETAGS lines.")
  2563. (defcustom org-use-fast-tag-selection 'auto
  2564. "Non-nil means use fast tag selection scheme.
  2565. This is a special interface to select and deselect tags with single keys.
  2566. When nil, fast selection is never used.
  2567. When the symbol `auto', fast selection is used if and only if selection
  2568. characters for tags have been configured, either through the variable
  2569. `org-tag-alist' or through a #+TAGS line in the buffer.
  2570. When t, fast selection is always used and selection keys are assigned
  2571. automatically if necessary."
  2572. :group 'org-tags
  2573. :type '(choice
  2574. (const :tag "Always" t)
  2575. (const :tag "Never" nil)
  2576. (const :tag "When selection characters are configured" 'auto)))
  2577. (defcustom org-fast-tag-selection-single-key nil
  2578. "Non-nil means fast tag selection exits after first change.
  2579. When nil, you have to press RET to exit it.
  2580. During fast tag selection, you can toggle this flag with `C-c'.
  2581. This variable can also have the value `expert'. In this case, the window
  2582. displaying the tags menu is not even shown, until you press C-c again."
  2583. :group 'org-tags
  2584. :type '(choice
  2585. (const :tag "No" nil)
  2586. (const :tag "Yes" t)
  2587. (const :tag "Expert" expert)))
  2588. (defvar org-fast-tag-selection-include-todo nil
  2589. "Non-nil means fast tags selection interface will also offer TODO states.
  2590. This is an undocumented feature, you should not rely on it.")
  2591. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2592. "The column to which tags should be indented in a headline.
  2593. If this number is positive, it specifies the column. If it is negative,
  2594. it means that the tags should be flushright to that column. For example,
  2595. -80 works well for a normal 80 character screen.
  2596. When 0, place tags directly after headline text, with only one space in
  2597. between."
  2598. :group 'org-tags
  2599. :type 'integer)
  2600. (defcustom org-auto-align-tags t
  2601. "Non-nil keeps tags aligned when modifying headlines.
  2602. Some operations (i.e. demoting) change the length of a headline and
  2603. therefore shift the tags around. With this option turned on, after
  2604. each such operation the tags are again aligned to `org-tags-column'."
  2605. :group 'org-tags
  2606. :type 'boolean)
  2607. (defcustom org-use-tag-inheritance t
  2608. "Non-nil means tags in levels apply also for sublevels.
  2609. When nil, only the tags directly given in a specific line apply there.
  2610. This may also be a list of tags that should be inherited, or a regexp that
  2611. matches tags that should be inherited. Additional control is possible
  2612. with the variable `org-tags-exclude-from-inheritance' which gives an
  2613. explicit list of tags to be excluded from inheritance., even if the value of
  2614. `org-use-tag-inheritance' would select it for inheritance.
  2615. If this option is t, a match early-on in a tree can lead to a large
  2616. number of matches in the subtree when constructing the agenda or creating
  2617. a sparse tree. If you only want to see the first match in a tree during
  2618. a search, check out the variable `org-tags-match-list-sublevels'."
  2619. :group 'org-tags
  2620. :type '(choice
  2621. (const :tag "Not" nil)
  2622. (const :tag "Always" t)
  2623. (repeat :tag "Specific tags" (string :tag "Tag"))
  2624. (regexp :tag "Tags matched by regexp")))
  2625. (defcustom org-tags-exclude-from-inheritance nil
  2626. "List of tags that should never be inherited.
  2627. This is a way to exclude a few tags from inheritance. For way to do
  2628. the opposite, to actively allow inheritance for selected tags,
  2629. see the variable `org-use-tag-inheritance'."
  2630. :group 'org-tags
  2631. :type '(repeat (string :tag "Tag")))
  2632. (defun org-tag-inherit-p (tag)
  2633. "Check if TAG is one that should be inherited."
  2634. (cond
  2635. ((member tag org-tags-exclude-from-inheritance) nil)
  2636. ((eq org-use-tag-inheritance t) t)
  2637. ((not org-use-tag-inheritance) nil)
  2638. ((stringp org-use-tag-inheritance)
  2639. (string-match org-use-tag-inheritance tag))
  2640. ((listp org-use-tag-inheritance)
  2641. (member tag org-use-tag-inheritance))
  2642. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2643. (defcustom org-tags-match-list-sublevels t
  2644. "Non-nil means list also sublevels of headlines matching a search.
  2645. This variable applies to tags/property searches, and also to stuck
  2646. projects because this search is based on a tags match as well.
  2647. When set to the symbol `indented', sublevels are indented with
  2648. leading dots.
  2649. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2650. the sublevels of a headline matching a tag search often also match
  2651. the same search. Listing all of them can create very long lists.
  2652. Setting this variable to nil causes subtrees of a match to be skipped.
  2653. This variable is semi-obsolete and probably should always be true. It
  2654. is better to limit inheritance to certain tags using the variables
  2655. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2656. :group 'org-tags
  2657. :type '(choice
  2658. (const :tag "No, don't list them" nil)
  2659. (const :tag "Yes, do list them" t)
  2660. (const :tag "List them, indented with leading dots" indented)))
  2661. (defcustom org-tags-sort-function nil
  2662. "When set, tags are sorted using this function as a comparator."
  2663. :group 'org-tags
  2664. :type '(choice
  2665. (const :tag "No sorting" nil)
  2666. (const :tag "Alphabetical" string<)
  2667. (const :tag "Reverse alphabetical" string>)
  2668. (function :tag "Custom function" nil)))
  2669. (defvar org-tags-history nil
  2670. "History of minibuffer reads for tags.")
  2671. (defvar org-last-tags-completion-table nil
  2672. "The last used completion table for tags.")
  2673. (defvar org-after-tags-change-hook nil
  2674. "Hook that is run after the tags in a line have changed.")
  2675. (defgroup org-properties nil
  2676. "Options concerning properties in Org-mode."
  2677. :tag "Org Properties"
  2678. :group 'org)
  2679. (defcustom org-property-format "%-10s %s"
  2680. "How property key/value pairs should be formatted by `indent-line'.
  2681. When `indent-line' hits a property definition, it will format the line
  2682. according to this format, mainly to make sure that the values are
  2683. lined-up with respect to each other."
  2684. :group 'org-properties
  2685. :type 'string)
  2686. (defcustom org-properties-postprocess-alist nil
  2687. "Alist of properties and functions to adjust inserted values.
  2688. Elements of this alist must be of the form
  2689. ([string] [function])
  2690. where [string] must be a property name and [function] must be a
  2691. lambda expression: this lambda expression must take one argument,
  2692. the value to adjust, and return the new value as a string.
  2693. For example, this element will allow the property \"Remaining\"
  2694. to be updated wrt the relation between the \"Effort\" property
  2695. and the clock summary:
  2696. ((\"Remaining\" (lambda(value)
  2697. (let ((clocksum (org-clock-sum-current-item))
  2698. (effort (org-duration-string-to-minutes
  2699. (org-entry-get (point) \"Effort\"))))
  2700. (org-minutes-to-hh:mm-string (- effort clocksum))))))"
  2701. :group 'org-properties
  2702. :version "24.1"
  2703. :type '(alist :key-type (string :tag "Property")
  2704. :value-type (function :tag "Function")))
  2705. (defcustom org-use-property-inheritance nil
  2706. "Non-nil means properties apply also for sublevels.
  2707. This setting is chiefly used during property searches. Turning it on can
  2708. cause significant overhead when doing a search, which is why it is not
  2709. on by default.
  2710. When nil, only the properties directly given in the current entry count.
  2711. When t, every property is inherited. The value may also be a list of
  2712. properties that should have inheritance, or a regular expression matching
  2713. properties that should be inherited.
  2714. However, note that some special properties use inheritance under special
  2715. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2716. and the properties ending in \"_ALL\" when they are used as descriptor
  2717. for valid values of a property.
  2718. Note for programmers:
  2719. When querying an entry with `org-entry-get', you can control if inheritance
  2720. should be used. By default, `org-entry-get' looks only at the local
  2721. properties. You can request inheritance by setting the inherit argument
  2722. to t (to force inheritance) or to `selective' (to respect the setting
  2723. in this variable)."
  2724. :group 'org-properties
  2725. :type '(choice
  2726. (const :tag "Not" nil)
  2727. (const :tag "Always" t)
  2728. (repeat :tag "Specific properties" (string :tag "Property"))
  2729. (regexp :tag "Properties matched by regexp")))
  2730. (defun org-property-inherit-p (property)
  2731. "Check if PROPERTY is one that should be inherited."
  2732. (cond
  2733. ((eq org-use-property-inheritance t) t)
  2734. ((not org-use-property-inheritance) nil)
  2735. ((stringp org-use-property-inheritance)
  2736. (string-match org-use-property-inheritance property))
  2737. ((listp org-use-property-inheritance)
  2738. (member property org-use-property-inheritance))
  2739. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2740. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2741. "The default column format, if no other format has been defined.
  2742. This variable can be set on the per-file basis by inserting a line
  2743. #+COLUMNS: %25ITEM ....."
  2744. :group 'org-properties
  2745. :type 'string)
  2746. (defcustom org-columns-ellipses ".."
  2747. "The ellipses to be used when a field in column view is truncated.
  2748. When this is the empty string, as many characters as possible are shown,
  2749. but then there will be no visual indication that the field has been truncated.
  2750. When this is a string of length N, the last N characters of a truncated
  2751. field are replaced by this string. If the column is narrower than the
  2752. ellipses string, only part of the ellipses string will be shown."
  2753. :group 'org-properties
  2754. :type 'string)
  2755. (defcustom org-columns-modify-value-for-display-function nil
  2756. "Function that modifies values for display in column view.
  2757. For example, it can be used to cut out a certain part from a time stamp.
  2758. The function must take 2 arguments:
  2759. column-title The title of the column (*not* the property name)
  2760. value The value that should be modified.
  2761. The function should return the value that should be displayed,
  2762. or nil if the normal value should be used."
  2763. :group 'org-properties
  2764. :type 'function)
  2765. (defcustom org-effort-property "Effort"
  2766. "The property that is being used to keep track of effort estimates.
  2767. Effort estimates given in this property need to have the format H:MM."
  2768. :group 'org-properties
  2769. :group 'org-progress
  2770. :type '(string :tag "Property"))
  2771. (defconst org-global-properties-fixed
  2772. '(("VISIBILITY_ALL" . "folded children content all")
  2773. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2774. "List of property/value pairs that can be inherited by any entry.
  2775. These are fixed values, for the preset properties. The user variable
  2776. that can be used to add to this list is `org-global-properties'.
  2777. The entries in this list are cons cells where the car is a property
  2778. name and cdr is a string with the value. If the value represents
  2779. multiple items like an \"_ALL\" property, separate the items by
  2780. spaces.")
  2781. (defcustom org-global-properties nil
  2782. "List of property/value pairs that can be inherited by any entry.
  2783. This list will be combined with the constant `org-global-properties-fixed'.
  2784. The entries in this list are cons cells where the car is a property
  2785. name and cdr is a string with the value.
  2786. You can set buffer-local values for the same purpose in the variable
  2787. `org-file-properties' this by adding lines like
  2788. #+PROPERTY: NAME VALUE"
  2789. :group 'org-properties
  2790. :type '(repeat
  2791. (cons (string :tag "Property")
  2792. (string :tag "Value"))))
  2793. (defvar org-file-properties nil
  2794. "List of property/value pairs that can be inherited by any entry.
  2795. Valid for the current buffer.
  2796. This variable is populated from #+PROPERTY lines.")
  2797. (make-variable-buffer-local 'org-file-properties)
  2798. (defgroup org-agenda nil
  2799. "Options concerning agenda views in Org-mode."
  2800. :tag "Org Agenda"
  2801. :group 'org)
  2802. (defvar org-category nil
  2803. "Variable used by org files to set a category for agenda display.
  2804. Such files should use a file variable to set it, for example
  2805. # -*- mode: org; org-category: \"ELisp\"
  2806. or contain a special line
  2807. #+CATEGORY: ELisp
  2808. If the file does not specify a category, then file's base name
  2809. is used instead.")
  2810. (make-variable-buffer-local 'org-category)
  2811. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  2812. (defcustom org-agenda-files nil
  2813. "The files to be used for agenda display.
  2814. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2815. \\[org-remove-file]. You can also use customize to edit the list.
  2816. If an entry is a directory, all files in that directory that are matched by
  2817. `org-agenda-file-regexp' will be part of the file list.
  2818. If the value of the variable is not a list but a single file name, then
  2819. the list of agenda files is actually stored and maintained in that file, one
  2820. agenda file per line. In this file paths can be given relative to
  2821. `org-directory'. Tilde expansion and environment variable substitution
  2822. are also made."
  2823. :group 'org-agenda
  2824. :type '(choice
  2825. (repeat :tag "List of files and directories" file)
  2826. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2827. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2828. "Regular expression to match files for `org-agenda-files'.
  2829. If any element in the list in that variable contains a directory instead
  2830. of a normal file, all files in that directory that are matched by this
  2831. regular expression will be included."
  2832. :group 'org-agenda
  2833. :type 'regexp)
  2834. (defcustom org-agenda-text-search-extra-files nil
  2835. "List of extra files to be searched by text search commands.
  2836. These files will be search in addition to the agenda files by the
  2837. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2838. Note that these files will only be searched for text search commands,
  2839. not for the other agenda views like todo lists, tag searches or the weekly
  2840. agenda. This variable is intended to list notes and possibly archive files
  2841. that should also be searched by these two commands.
  2842. In fact, if the first element in the list is the symbol `agenda-archives',
  2843. than all archive files of all agenda files will be added to the search
  2844. scope."
  2845. :group 'org-agenda
  2846. :type '(set :greedy t
  2847. (const :tag "Agenda Archives" agenda-archives)
  2848. (repeat :inline t (file))))
  2849. (if (fboundp 'defvaralias)
  2850. (defvaralias 'org-agenda-multi-occur-extra-files
  2851. 'org-agenda-text-search-extra-files))
  2852. (defcustom org-agenda-skip-unavailable-files nil
  2853. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2854. A nil value means to remove them, after a query, from the list."
  2855. :group 'org-agenda
  2856. :type 'boolean)
  2857. (defcustom org-calendar-to-agenda-key [?c]
  2858. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2859. The command `org-calendar-goto-agenda' will be bound to this key. The
  2860. default is the character `c' because then `c' can be used to switch back and
  2861. forth between agenda and calendar."
  2862. :group 'org-agenda
  2863. :type 'sexp)
  2864. (defcustom org-calendar-agenda-action-key [?k]
  2865. "The key to be installed in `calendar-mode-map' for agenda-action.
  2866. The command `org-agenda-action' will be bound to this key. The
  2867. default is the character `k' because we use the same key in the agenda."
  2868. :group 'org-agenda
  2869. :type 'sexp)
  2870. (defcustom org-calendar-insert-diary-entry-key [?i]
  2871. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2872. This option is irrelevant until `org-agenda-diary-file' has been configured
  2873. to point to an Org-mode file. When that is the case, the command
  2874. `org-agenda-diary-entry' will be bound to the key given here, by default
  2875. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2876. if you want to continue doing this, you need to change this to a different
  2877. key."
  2878. :group 'org-agenda
  2879. :type 'sexp)
  2880. (defcustom org-agenda-diary-file 'diary-file
  2881. "File to which to add new entries with the `i' key in agenda and calendar.
  2882. When this is the symbol `diary-file', the functionality in the Emacs
  2883. calendar will be used to add entries to the `diary-file'. But when this
  2884. points to a file, `org-agenda-diary-entry' will be used instead."
  2885. :group 'org-agenda
  2886. :type '(choice
  2887. (const :tag "The standard Emacs diary file" diary-file)
  2888. (file :tag "Special Org file diary entries")))
  2889. (eval-after-load "calendar"
  2890. '(progn
  2891. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2892. 'org-calendar-goto-agenda)
  2893. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2894. 'org-agenda-action)
  2895. (add-hook 'calendar-mode-hook
  2896. (lambda ()
  2897. (unless (eq org-agenda-diary-file 'diary-file)
  2898. (define-key calendar-mode-map
  2899. org-calendar-insert-diary-entry-key
  2900. 'org-agenda-diary-entry))))))
  2901. (defgroup org-latex nil
  2902. "Options for embedding LaTeX code into Org-mode."
  2903. :tag "Org LaTeX"
  2904. :group 'org)
  2905. (defcustom org-format-latex-options
  2906. '(:foreground default :background default :scale 1.0
  2907. :html-foreground "Black" :html-background "Transparent"
  2908. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2909. "Options for creating images from LaTeX fragments.
  2910. This is a property list with the following properties:
  2911. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2912. `default' means use the foreground of the default face.
  2913. `auto' means use the foreground from the text face.
  2914. :background the background color, or \"Transparent\".
  2915. `default' means use the background of the default face.
  2916. `auto' means use the background from the text face.
  2917. :scale a scaling factor for the size of the images, to get more pixels
  2918. :html-foreground, :html-background, :html-scale
  2919. the same numbers for HTML export.
  2920. :matchers a list indicating which matchers should be used to
  2921. find LaTeX fragments. Valid members of this list are:
  2922. \"begin\" find environments
  2923. \"$1\" find single characters surrounded by $.$
  2924. \"$\" find math expressions surrounded by $...$
  2925. \"$$\" find math expressions surrounded by $$....$$
  2926. \"\\(\" find math expressions surrounded by \\(...\\)
  2927. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2928. :group 'org-latex
  2929. :type 'plist)
  2930. (defcustom org-format-latex-signal-error t
  2931. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2932. When nil, just push out a message."
  2933. :group 'org-latex
  2934. :version "24.1"
  2935. :type 'boolean)
  2936. (defcustom org-latex-to-mathml-jar-file nil
  2937. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  2938. Use this to specify additional executable file say a jar file.
  2939. When using MathToWeb as the converter, specify the full-path to
  2940. your mathtoweb.jar file."
  2941. :group 'org-latex
  2942. :version "24.1"
  2943. :type '(choice
  2944. (const :tag "None" nil)
  2945. (file :tag "JAR file" :must-match t)))
  2946. (defcustom org-latex-to-mathml-convert-command nil
  2947. "Command to convert LaTeX fragments to MathML.
  2948. Replace format-specifiers in the command as noted below and use
  2949. `shell-command' to convert LaTeX to MathML.
  2950. %j: Executable file in fully expanded form as specified by
  2951. `org-latex-to-mathml-jar-file'.
  2952. %I: Input LaTeX file in fully expanded form
  2953. %o: Output MathML file
  2954. This command is used by `org-create-math-formula'.
  2955. When using MathToWeb as the converter, set this to
  2956. \"java -jar %j -unicode -force -df %o %I\"."
  2957. :group 'org-latex
  2958. :version "24.1"
  2959. :type '(choice
  2960. (const :tag "None" nil)
  2961. (string :tag "\nShell command")))
  2962. (defcustom org-latex-create-formula-image-program 'dvipng
  2963. "Program to convert LaTeX fragments with.
  2964. dvipng Process the LaTeX fragments to dvi file, then convert
  2965. dvi files to png files using dvipng.
  2966. This will also include processing of non-math environments.
  2967. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  2968. to convert pdf files to png files"
  2969. :group 'org-latex
  2970. :version "24.1"
  2971. :type '(choice
  2972. (const :tag "dvipng" dvipng)
  2973. (const :tag "imagemagick" imagemagick)))
  2974. (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
  2975. "Path to store latex preview images. A relative path here creates many
  2976. directories relative to the processed org files paths. An absolute path
  2977. puts all preview images at the same place."
  2978. :group 'org-latex
  2979. ;; :version "24.3"
  2980. :type 'string)
  2981. (defun org-format-latex-mathml-available-p ()
  2982. "Return t if `org-latex-to-mathml-convert-command' is usable."
  2983. (save-match-data
  2984. (when (and (boundp 'org-latex-to-mathml-convert-command)
  2985. org-latex-to-mathml-convert-command)
  2986. (let ((executable (car (split-string
  2987. org-latex-to-mathml-convert-command))))
  2988. (when (executable-find executable)
  2989. (if (string-match
  2990. "%j" org-latex-to-mathml-convert-command)
  2991. (file-readable-p org-latex-to-mathml-jar-file)
  2992. t))))))
  2993. (defcustom org-format-latex-header "\\documentclass{article}
  2994. \\usepackage[usenames]{color}
  2995. \\usepackage{amsmath}
  2996. \\usepackage[mathscr]{eucal}
  2997. \\pagestyle{empty} % do not remove
  2998. \[PACKAGES]
  2999. \[DEFAULT-PACKAGES]
  3000. % The settings below are copied from fullpage.sty
  3001. \\setlength{\\textwidth}{\\paperwidth}
  3002. \\addtolength{\\textwidth}{-3cm}
  3003. \\setlength{\\oddsidemargin}{1.5cm}
  3004. \\addtolength{\\oddsidemargin}{-2.54cm}
  3005. \\setlength{\\evensidemargin}{\\oddsidemargin}
  3006. \\setlength{\\textheight}{\\paperheight}
  3007. \\addtolength{\\textheight}{-\\headheight}
  3008. \\addtolength{\\textheight}{-\\headsep}
  3009. \\addtolength{\\textheight}{-\\footskip}
  3010. \\addtolength{\\textheight}{-3cm}
  3011. \\setlength{\\topmargin}{1.5cm}
  3012. \\addtolength{\\topmargin}{-2.54cm}"
  3013. "The document header used for processing LaTeX fragments.
  3014. It is imperative that this header make sure that no page number
  3015. appears on the page. The package defined in the variables
  3016. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  3017. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  3018. will be appended."
  3019. :group 'org-latex
  3020. :type 'string)
  3021. (defvar org-format-latex-header-extra nil)
  3022. (defun org-set-packages-alist (var val)
  3023. "Set the packages alist and make sure it has 3 elements per entry."
  3024. (set var (mapcar (lambda (x)
  3025. (if (and (consp x) (= (length x) 2))
  3026. (list (car x) (nth 1 x) t)
  3027. x))
  3028. val)))
  3029. (defun org-get-packages-alist (var)
  3030. "Get the packages alist and make sure it has 3 elements per entry."
  3031. (mapcar (lambda (x)
  3032. (if (and (consp x) (= (length x) 2))
  3033. (list (car x) (nth 1 x) t)
  3034. x))
  3035. (default-value var)))
  3036. ;; The following variables are defined here because is it also used
  3037. ;; when formatting latex fragments. Originally it was part of the
  3038. ;; LaTeX exporter, which is why the name includes "export".
  3039. (defcustom org-export-latex-default-packages-alist
  3040. '(("AUTO" "inputenc" t)
  3041. ("T1" "fontenc" t)
  3042. ("" "fixltx2e" nil)
  3043. ("" "graphicx" t)
  3044. ("" "longtable" nil)
  3045. ("" "float" nil)
  3046. ("" "wrapfig" nil)
  3047. ("" "soul" t)
  3048. ("" "textcomp" t)
  3049. ("" "marvosym" t)
  3050. ("" "wasysym" t)
  3051. ("" "latexsym" t)
  3052. ("" "amssymb" t)
  3053. ("" "hyperref" nil)
  3054. "\\tolerance=1000"
  3055. )
  3056. "Alist of default packages to be inserted in the header.
  3057. Change this only if one of the packages here causes an incompatibility
  3058. with another package you are using.
  3059. The packages in this list are needed by one part or another of Org-mode
  3060. to function properly.
  3061. - inputenc, fontenc: for basic font and character selection
  3062. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  3063. for interpreting the entities in `org-entities'. You can skip some of these
  3064. packages if you don't use any of the symbols in it.
  3065. - graphicx: for including images
  3066. - float, wrapfig: for figure placement
  3067. - longtable: for long tables
  3068. - hyperref: for cross references
  3069. Therefore you should not modify this variable unless you know what you
  3070. are doing. The one reason to change it anyway is that you might be loading
  3071. some other package that conflicts with one of the default packages.
  3072. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  3073. If SNIPPET-FLAG is t, the package also needs to be included when
  3074. compiling LaTeX snippets into images for inclusion into HTML."
  3075. :group 'org-export-latex
  3076. :set 'org-set-packages-alist
  3077. :get 'org-get-packages-alist
  3078. :version "24.1"
  3079. :type '(repeat
  3080. (choice
  3081. (list :tag "options/package pair"
  3082. (string :tag "options")
  3083. (string :tag "package")
  3084. (boolean :tag "Snippet"))
  3085. (string :tag "A line of LaTeX"))))
  3086. (defcustom org-export-latex-packages-alist nil
  3087. "Alist of packages to be inserted in every LaTeX header.
  3088. These will be inserted after `org-export-latex-default-packages-alist'.
  3089. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  3090. SNIPPET-FLAG, when t, indicates that this package is also needed when
  3091. turning LaTeX snippets into images for inclusion into HTML.
  3092. Make sure that you only list packages here which:
  3093. - you want in every file
  3094. - do not conflict with the default packages in
  3095. `org-export-latex-default-packages-alist'
  3096. - do not conflict with the setup in `org-format-latex-header'."
  3097. :group 'org-export-latex
  3098. :set 'org-set-packages-alist
  3099. :get 'org-get-packages-alist
  3100. :type '(repeat
  3101. (choice
  3102. (list :tag "options/package pair"
  3103. (string :tag "options")
  3104. (string :tag "package")
  3105. (boolean :tag "Snippet"))
  3106. (string :tag "A line of LaTeX"))))
  3107. (defgroup org-appearance nil
  3108. "Settings for Org-mode appearance."
  3109. :tag "Org Appearance"
  3110. :group 'org)
  3111. (defcustom org-level-color-stars-only nil
  3112. "Non-nil means fontify only the stars in each headline.
  3113. When nil, the entire headline is fontified.
  3114. Changing it requires restart of `font-lock-mode' to become effective
  3115. also in regions already fontified."
  3116. :group 'org-appearance
  3117. :type 'boolean)
  3118. (defcustom org-hide-leading-stars nil
  3119. "Non-nil means hide the first N-1 stars in a headline.
  3120. This works by using the face `org-hide' for these stars. This
  3121. face is white for a light background, and black for a dark
  3122. background. You may have to customize the face `org-hide' to
  3123. make this work.
  3124. Changing it requires restart of `font-lock-mode' to become effective
  3125. also in regions already fontified.
  3126. You may also set this on a per-file basis by adding one of the following
  3127. lines to the buffer:
  3128. #+STARTUP: hidestars
  3129. #+STARTUP: showstars"
  3130. :group 'org-appearance
  3131. :type 'boolean)
  3132. (defcustom org-hidden-keywords nil
  3133. "List of symbols corresponding to keywords to be hidden the org buffer.
  3134. For example, a value '(title) for this list will make the document's title
  3135. appear in the buffer without the initial #+TITLE: keyword."
  3136. :group 'org-appearance
  3137. :version "24.1"
  3138. :type '(set (const :tag "#+AUTHOR" author)
  3139. (const :tag "#+DATE" date)
  3140. (const :tag "#+EMAIL" email)
  3141. (const :tag "#+TITLE" title)))
  3142. (defcustom org-custom-properties nil
  3143. "List of properties (as strings) with a special meaning.
  3144. The default use of these custom properties is to let the user
  3145. hide them with `org-toggle-custom-properties-visibility'."
  3146. :group 'org-properties
  3147. :group 'org-appearance
  3148. ;; :version "24.3"
  3149. :type '(repeat (string :tag "Property Name")))
  3150. (defcustom org-fontify-done-headline nil
  3151. "Non-nil means change the face of a headline if it is marked DONE.
  3152. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3153. When this is non-nil, the headline after the keyword is set to the
  3154. `org-headline-done' as an additional indication."
  3155. :group 'org-appearance
  3156. :type 'boolean)
  3157. (defcustom org-fontify-emphasized-text t
  3158. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3159. Changing this variable requires a restart of Emacs to take effect."
  3160. :group 'org-appearance
  3161. :type 'boolean)
  3162. (defcustom org-fontify-whole-heading-line nil
  3163. "Non-nil means fontify the whole line for headings.
  3164. This is useful when setting a background color for the
  3165. org-level-* faces."
  3166. :group 'org-appearance
  3167. :type 'boolean)
  3168. (defcustom org-highlight-latex-fragments-and-specials nil
  3169. "Non-nil means fontify what is treated specially by the exporters."
  3170. :group 'org-appearance
  3171. :type 'boolean)
  3172. (defcustom org-hide-emphasis-markers nil
  3173. "Non-nil mean font-lock should hide the emphasis marker characters."
  3174. :group 'org-appearance
  3175. :type 'boolean)
  3176. (defcustom org-pretty-entities nil
  3177. "Non-nil means show entities as UTF8 characters.
  3178. When nil, the \\name form remains in the buffer."
  3179. :group 'org-appearance
  3180. :version "24.1"
  3181. :type 'boolean)
  3182. (defcustom org-pretty-entities-include-sub-superscripts t
  3183. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3184. :group 'org-appearance
  3185. :version "24.1"
  3186. :type 'boolean)
  3187. (defvar org-emph-re nil
  3188. "Regular expression for matching emphasis.
  3189. After a match, the match groups contain these elements:
  3190. 0 The match of the full regular expression, including the characters
  3191. before and after the proper match
  3192. 1 The character before the proper match, or empty at beginning of line
  3193. 2 The proper match, including the leading and trailing markers
  3194. 3 The leading marker like * or /, indicating the type of highlighting
  3195. 4 The text between the emphasis markers, not including the markers
  3196. 5 The character after the match, empty at the end of a line")
  3197. (defvar org-verbatim-re nil
  3198. "Regular expression for matching verbatim text.")
  3199. (defvar org-emphasis-regexp-components) ; defined just below
  3200. (defvar org-emphasis-alist) ; defined just below
  3201. (defun org-set-emph-re (var val)
  3202. "Set variable and compute the emphasis regular expression."
  3203. (set var val)
  3204. (when (and (boundp 'org-emphasis-alist)
  3205. (boundp 'org-emphasis-regexp-components)
  3206. org-emphasis-alist org-emphasis-regexp-components)
  3207. (let* ((e org-emphasis-regexp-components)
  3208. (pre (car e))
  3209. (post (nth 1 e))
  3210. (border (nth 2 e))
  3211. (body (nth 3 e))
  3212. (nl (nth 4 e))
  3213. (body1 (concat body "*?"))
  3214. (markers (mapconcat 'car org-emphasis-alist ""))
  3215. (vmarkers (mapconcat
  3216. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  3217. org-emphasis-alist "")))
  3218. ;; make sure special characters appear at the right position in the class
  3219. (if (string-match "\\^" markers)
  3220. (setq markers (concat (replace-match "" t t markers) "^")))
  3221. (if (string-match "-" markers)
  3222. (setq markers (concat (replace-match "" t t markers) "-")))
  3223. (if (string-match "\\^" vmarkers)
  3224. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3225. (if (string-match "-" vmarkers)
  3226. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3227. (if (> nl 0)
  3228. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3229. (int-to-string nl) "\\}")))
  3230. ;; Make the regexp
  3231. (setq org-emph-re
  3232. (concat "\\([" pre "]\\|^\\)"
  3233. "\\("
  3234. "\\([" markers "]\\)"
  3235. "\\("
  3236. "[^" border "]\\|"
  3237. "[^" border "]"
  3238. body1
  3239. "[^" border "]"
  3240. "\\)"
  3241. "\\3\\)"
  3242. "\\([" post "]\\|$\\)"))
  3243. (setq org-verbatim-re
  3244. (concat "\\([" pre "]\\|^\\)"
  3245. "\\("
  3246. "\\([" vmarkers "]\\)"
  3247. "\\("
  3248. "[^" border "]\\|"
  3249. "[^" border "]"
  3250. body1
  3251. "[^" border "]"
  3252. "\\)"
  3253. "\\3\\)"
  3254. "\\([" post "]\\|$\\)")))))
  3255. (defcustom org-emphasis-regexp-components
  3256. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3257. "Components used to build the regular expression for emphasis.
  3258. This is a list with five entries. Terminology: In an emphasis string
  3259. like \" *strong word* \", we call the initial space PREMATCH, the final
  3260. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3261. and \"trong wor\" is the body. The different components in this variable
  3262. specify what is allowed/forbidden in each part:
  3263. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3264. post Chars allowed as postmatch. End of line will be allowed too.
  3265. border The chars *forbidden* as border characters.
  3266. body-regexp A regexp like \".\" to match a body character. Don't use
  3267. non-shy groups here, and don't allow newline here.
  3268. newline The maximum number of newlines allowed in an emphasis exp.
  3269. Use customize to modify this, or restart Emacs after changing it."
  3270. :group 'org-appearance
  3271. :set 'org-set-emph-re
  3272. :type '(list
  3273. (sexp :tag "Allowed chars in pre ")
  3274. (sexp :tag "Allowed chars in post ")
  3275. (sexp :tag "Forbidden chars in border ")
  3276. (sexp :tag "Regexp for body ")
  3277. (integer :tag "number of newlines allowed")
  3278. (option (boolean :tag "Please ignore this button"))))
  3279. (defcustom org-emphasis-alist
  3280. `(("*" bold "<b>" "</b>")
  3281. ("/" italic "<i>" "</i>")
  3282. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  3283. ("=" org-code "<code>" "</code>" verbatim)
  3284. ("~" org-verbatim "<code>" "</code>" verbatim)
  3285. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  3286. "<del>" "</del>")
  3287. )
  3288. "Special syntax for emphasized text.
  3289. Text starting and ending with a special character will be emphasized, for
  3290. example *bold*, _underlined_ and /italic/. This variable sets the marker
  3291. characters, the face to be used by font-lock for highlighting in Org-mode
  3292. Emacs buffers, and the HTML tags to be used for this.
  3293. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  3294. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  3295. Use customize to modify this, or restart Emacs after changing it."
  3296. :group 'org-appearance
  3297. :set 'org-set-emph-re
  3298. :type '(repeat
  3299. (list
  3300. (string :tag "Marker character")
  3301. (choice
  3302. (face :tag "Font-lock-face")
  3303. (plist :tag "Face property list"))
  3304. (string :tag "HTML start tag")
  3305. (string :tag "HTML end tag")
  3306. (option (const verbatim)))))
  3307. (defvar org-protecting-blocks
  3308. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  3309. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3310. This is needed for font-lock setup.")
  3311. ;;; Miscellaneous options
  3312. (defgroup org-completion nil
  3313. "Completion in Org-mode."
  3314. :tag "Org Completion"
  3315. :group 'org)
  3316. (defcustom org-completion-use-ido nil
  3317. "Non-nil means use ido completion wherever possible.
  3318. Note that `ido-mode' must be active for this variable to be relevant.
  3319. If you decide to turn this variable on, you might well want to turn off
  3320. `org-outline-path-complete-in-steps'.
  3321. See also `org-completion-use-iswitchb'."
  3322. :group 'org-completion
  3323. :type 'boolean)
  3324. (defcustom org-completion-use-iswitchb nil
  3325. "Non-nil means use iswitchb completion wherever possible.
  3326. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3327. If you decide to turn this variable on, you might well want to turn off
  3328. `org-outline-path-complete-in-steps'.
  3329. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3330. :group 'org-completion
  3331. :type 'boolean)
  3332. (defcustom org-completion-fallback-command 'hippie-expand
  3333. "The expansion command called by \\[pcomplete] in normal context.
  3334. Normal means, no org-mode-specific context."
  3335. :group 'org-completion
  3336. :type 'function)
  3337. ;;; Functions and variables from their packages
  3338. ;; Declared here to avoid compiler warnings
  3339. ;; XEmacs only
  3340. (defvar outline-mode-menu-heading)
  3341. (defvar outline-mode-menu-show)
  3342. (defvar outline-mode-menu-hide)
  3343. (defvar zmacs-regions) ; XEmacs regions
  3344. ;; Emacs only
  3345. (defvar mark-active)
  3346. ;; Various packages
  3347. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3348. (declare-function calendar-forward-day "cal-move" (arg))
  3349. (declare-function calendar-goto-date "cal-move" (date))
  3350. (declare-function calendar-goto-today "cal-move" ())
  3351. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3352. (defvar calc-embedded-close-formula)
  3353. (defvar calc-embedded-open-formula)
  3354. (declare-function cdlatex-tab "ext:cdlatex" ())
  3355. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3356. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3357. (defvar font-lock-unfontify-region-function)
  3358. (declare-function iswitchb-read-buffer "iswitchb"
  3359. (prompt &optional default require-match start matches-set))
  3360. (defvar iswitchb-temp-buflist)
  3361. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3362. (defvar org-agenda-tags-todo-honor-ignore-options)
  3363. (declare-function org-agenda-skip "org-agenda" ())
  3364. (declare-function
  3365. org-agenda-format-item "org-agenda"
  3366. (extra txt &optional category tags dotime noprefix remove-re habitp))
  3367. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3368. (declare-function org-agenda-change-all-lines "org-agenda"
  3369. (newhead hdmarker &optional fixface just-this))
  3370. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3371. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3372. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3373. (beg end))
  3374. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3375. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3376. "org-agenda" (&optional end))
  3377. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3378. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3379. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3380. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3381. (declare-function org-indent-mode "org-indent" (&optional arg))
  3382. (declare-function parse-time-string "parse-time" (string))
  3383. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3384. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3385. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3386. (defvar remember-data-file)
  3387. (defvar texmathp-why)
  3388. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3389. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3390. (defvar w3m-current-url)
  3391. (defvar w3m-current-title)
  3392. (defvar org-latex-regexps)
  3393. ;;; Autoload and prepare some org modules
  3394. ;; Some table stuff that needs to be defined here, because it is used
  3395. ;; by the functions setting up org-mode or checking for table context.
  3396. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3397. "Detect an org-type or table-type table.")
  3398. (defconst org-table-line-regexp "^[ \t]*|"
  3399. "Detect an org-type table line.")
  3400. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3401. "Detect an org-type table line.")
  3402. (defconst org-table-hline-regexp "^[ \t]*|-"
  3403. "Detect an org-type table hline.")
  3404. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3405. "Detect a table-type table hline.")
  3406. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3407. "Detect the first line outside a table when searching from within it.
  3408. This works for both table types.")
  3409. ;; Autoload the functions in org-table.el that are needed by functions here.
  3410. (eval-and-compile
  3411. (org-autoload "org-table"
  3412. '(org-table-align org-table-begin org-table-blank-field
  3413. org-table-convert org-table-convert-region org-table-copy-down
  3414. org-table-copy-region org-table-create
  3415. org-table-create-or-convert-from-region
  3416. org-table-create-with-table.el org-table-current-dline
  3417. org-table-cut-region org-table-delete-column org-table-edit-field
  3418. org-table-edit-formulas org-table-end org-table-eval-formula
  3419. org-table-export org-table-field-info
  3420. org-table-get-stored-formulas org-table-goto-column
  3421. org-table-hline-and-move org-table-import org-table-insert-column
  3422. org-table-insert-hline org-table-insert-row org-table-iterate
  3423. org-table-justify-field-maybe org-table-kill-row
  3424. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  3425. org-table-move-column org-table-move-column-left
  3426. org-table-move-column-right org-table-move-row
  3427. org-table-move-row-down org-table-move-row-up
  3428. org-table-next-field org-table-next-row org-table-paste-rectangle
  3429. org-table-previous-field org-table-recalculate
  3430. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  3431. org-table-toggle-coordinate-overlays
  3432. org-table-toggle-formula-debugger org-table-wrap-region
  3433. orgtbl-mode turn-on-orgtbl org-table-to-lisp
  3434. orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
  3435. orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
  3436. (defun org-at-table-p (&optional table-type)
  3437. "Return t if the cursor is inside an org-type table.
  3438. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3439. (if org-enable-table-editor
  3440. (save-excursion
  3441. (beginning-of-line 1)
  3442. (looking-at (if table-type org-table-any-line-regexp
  3443. org-table-line-regexp)))
  3444. nil))
  3445. (defsubst org-table-p () (org-at-table-p))
  3446. (defun org-at-table.el-p ()
  3447. "Return t if and only if we are at a table.el table."
  3448. (and (org-at-table-p 'any)
  3449. (save-excursion
  3450. (goto-char (org-table-begin 'any))
  3451. (looking-at org-table1-hline-regexp))))
  3452. (defun org-table-recognize-table.el ()
  3453. "If there is a table.el table nearby, recognize it and move into it."
  3454. (if org-table-tab-recognizes-table.el
  3455. (if (org-at-table.el-p)
  3456. (progn
  3457. (beginning-of-line 1)
  3458. (if (looking-at org-table-dataline-regexp)
  3459. nil
  3460. (if (looking-at org-table1-hline-regexp)
  3461. (progn
  3462. (beginning-of-line 2)
  3463. (if (looking-at org-table-any-border-regexp)
  3464. (beginning-of-line -1)))))
  3465. (if (re-search-forward "|" (org-table-end t) t)
  3466. (progn
  3467. (require 'table)
  3468. (if (table--at-cell-p (point))
  3469. t
  3470. (message "recognizing table.el table...")
  3471. (table-recognize-table)
  3472. (message "recognizing table.el table...done")))
  3473. (error "This should not happen"))
  3474. t)
  3475. nil)
  3476. nil))
  3477. (defun org-at-table-hline-p ()
  3478. "Return t if the cursor is inside a hline in a table."
  3479. (if org-enable-table-editor
  3480. (save-excursion
  3481. (beginning-of-line 1)
  3482. (looking-at org-table-hline-regexp))
  3483. nil))
  3484. (defvar org-table-clean-did-remove-column nil)
  3485. (defun org-table-map-tables (function &optional quietly)
  3486. "Apply FUNCTION to the start of all tables in the buffer."
  3487. (save-excursion
  3488. (save-restriction
  3489. (widen)
  3490. (goto-char (point-min))
  3491. (while (re-search-forward org-table-any-line-regexp nil t)
  3492. (unless quietly
  3493. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3494. (beginning-of-line 1)
  3495. (when (and (looking-at org-table-line-regexp)
  3496. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3497. (not (org-in-block-p '("src" "example"))))
  3498. (save-excursion (funcall function))
  3499. (or (looking-at org-table-line-regexp)
  3500. (forward-char 1)))
  3501. (re-search-forward org-table-any-border-regexp nil 1))))
  3502. (unless quietly (message "Mapping tables: done")))
  3503. ;; Declare and autoload functions from org-exp.el & Co
  3504. (declare-function org-default-export-plist "org-exp")
  3505. (declare-function org-infile-export-plist "org-exp")
  3506. (declare-function org-get-current-options "org-exp")
  3507. (eval-and-compile
  3508. (org-autoload "org-exp"
  3509. '(org-export org-export-visible
  3510. org-insert-export-options-template
  3511. org-table-clean-before-export))
  3512. (org-autoload "org-ascii"
  3513. '(org-export-as-ascii org-export-ascii-preprocess
  3514. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3515. org-export-region-as-ascii))
  3516. (org-autoload "org-latex"
  3517. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3518. org-replace-region-by-latex org-export-region-as-latex
  3519. org-export-as-latex org-export-as-pdf
  3520. org-export-as-pdf-and-open))
  3521. (org-autoload "org-html"
  3522. '(org-export-as-html-and-open
  3523. org-export-as-html-batch org-export-as-html-to-buffer
  3524. org-replace-region-by-html org-export-region-as-html
  3525. org-export-as-html))
  3526. (org-autoload "org-docbook"
  3527. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3528. org-replace-region-by-docbook org-export-region-as-docbook
  3529. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3530. org-export-as-docbook))
  3531. (org-autoload "org-icalendar"
  3532. '(org-export-icalendar-this-file
  3533. org-export-icalendar-all-agenda-files
  3534. org-export-icalendar-combine-agenda-files))
  3535. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3536. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3537. ;; Declare and autoload functions from org-agenda.el
  3538. (eval-and-compile
  3539. (org-autoload "org-agenda"
  3540. '(org-agenda org-agenda-list org-search-view
  3541. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3542. org-diary org-agenda-to-appt
  3543. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3544. ;; Autoload org-remember
  3545. (eval-and-compile
  3546. (org-autoload "org-remember"
  3547. '(org-remember-insinuate org-remember-annotation
  3548. org-remember-apply-template org-remember org-remember-handler)))
  3549. (eval-and-compile
  3550. (org-autoload "org-capture"
  3551. '(org-capture org-capture-insert-template-here
  3552. org-capture-import-remember-templates)))
  3553. ;; Autoload org-clock.el
  3554. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3555. (beg end))
  3556. (declare-function org-clock-update-mode-line "org-clock" ())
  3557. (declare-function org-resolve-clocks "org-clock"
  3558. (&optional also-non-dangling-p prompt last-valid))
  3559. (defvar org-clock-start-time)
  3560. (defvar org-clock-marker (make-marker)
  3561. "Marker recording the last clock-in.")
  3562. (defvar org-clock-hd-marker (make-marker)
  3563. "Marker recording the last clock-in, but the headline position.")
  3564. (defvar org-clock-heading ""
  3565. "The heading of the current clock entry.")
  3566. (defun org-clock-is-active ()
  3567. "Return non-nil if clock is currently running.
  3568. The return value is actually the clock marker."
  3569. (marker-buffer org-clock-marker))
  3570. (eval-and-compile
  3571. (org-autoload
  3572. "org-clock"
  3573. '(org-clock-in org-clock-out org-clock-cancel
  3574. org-clock-goto org-clock-sum org-clock-display
  3575. org-clock-remove-overlays org-clock-report
  3576. org-clocktable-shift org-dblock-write:clocktable
  3577. org-get-clocktable org-resolve-clocks)))
  3578. (defun org-clock-update-time-maybe ()
  3579. "If this is a CLOCK line, update it and return t.
  3580. Otherwise, return nil."
  3581. (interactive)
  3582. (save-excursion
  3583. (beginning-of-line 1)
  3584. (skip-chars-forward " \t")
  3585. (when (looking-at org-clock-string)
  3586. (let ((re (concat "[ \t]*" org-clock-string
  3587. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3588. "\\([ \t]*=>.*\\)?\\)?"))
  3589. ts te h m s neg)
  3590. (cond
  3591. ((not (looking-at re))
  3592. nil)
  3593. ((not (match-end 2))
  3594. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3595. (> org-clock-marker (point))
  3596. (<= org-clock-marker (point-at-eol)))
  3597. ;; The clock is running here
  3598. (setq org-clock-start-time
  3599. (apply 'encode-time
  3600. (org-parse-time-string (match-string 1))))
  3601. (org-clock-update-mode-line)))
  3602. (t
  3603. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3604. (end-of-line 1)
  3605. (setq ts (match-string 1)
  3606. te (match-string 3))
  3607. (setq s (- (org-float-time
  3608. (apply 'encode-time (org-parse-time-string te)))
  3609. (org-float-time
  3610. (apply 'encode-time (org-parse-time-string ts))))
  3611. neg (< s 0)
  3612. s (abs s)
  3613. h (floor (/ s 3600))
  3614. s (- s (* 3600 h))
  3615. m (floor (/ s 60))
  3616. s (- s (* 60 s)))
  3617. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3618. t))))))
  3619. (defun org-check-running-clock ()
  3620. "Check if the current buffer contains the running clock.
  3621. If yes, offer to stop it and to save the buffer with the changes."
  3622. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3623. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3624. (buffer-name))))
  3625. (org-clock-out)
  3626. (when (y-or-n-p "Save changed buffer?")
  3627. (save-buffer))))
  3628. (defun org-clocktable-try-shift (dir n)
  3629. "Check if this line starts a clock table, if yes, shift the time block."
  3630. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3631. (org-clocktable-shift dir n)))
  3632. ;; Autoload org-timer.el
  3633. (eval-and-compile
  3634. (org-autoload
  3635. "org-timer"
  3636. '(org-timer-start org-timer org-timer-item
  3637. org-timer-change-times-in-region
  3638. org-timer-set-timer
  3639. org-timer-reset-timers
  3640. org-timer-show-remaining-time)))
  3641. ;; Autoload org-feed.el
  3642. (eval-and-compile
  3643. (org-autoload
  3644. "org-feed"
  3645. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3646. ;; Autoload org-indent.el
  3647. ;; Define the variable already here, to make sure we have it.
  3648. (defvar org-indent-mode nil
  3649. "Non-nil if Org-Indent mode is enabled.
  3650. Use the command `org-indent-mode' to change this variable.")
  3651. (eval-and-compile
  3652. (org-autoload
  3653. "org-indent"
  3654. '(org-indent-mode)))
  3655. ;; Autoload org-mobile.el
  3656. (eval-and-compile
  3657. (org-autoload
  3658. "org-mobile"
  3659. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3660. ;; Autoload archiving code
  3661. ;; The stuff that is needed for cycling and tags has to be defined here.
  3662. (defgroup org-archive nil
  3663. "Options concerning archiving in Org-mode."
  3664. :tag "Org Archive"
  3665. :group 'org-structure)
  3666. (defcustom org-archive-location "%s_archive::"
  3667. "The location where subtrees should be archived.
  3668. The value of this variable is a string, consisting of two parts,
  3669. separated by a double-colon. The first part is a filename and
  3670. the second part is a headline.
  3671. When the filename is omitted, archiving happens in the same file.
  3672. %s in the filename will be replaced by the current file
  3673. name (without the directory part). Archiving to a different file
  3674. is useful to keep archived entries from contributing to the
  3675. Org-mode Agenda.
  3676. The archived entries will be filed as subtrees of the specified
  3677. headline. When the headline is omitted, the subtrees are simply
  3678. filed away at the end of the file, as top-level entries. Also in
  3679. the heading you can use %s to represent the file name, this can be
  3680. useful when using the same archive for a number of different files.
  3681. Here are a few examples:
  3682. \"%s_archive::\"
  3683. If the current file is Projects.org, archive in file
  3684. Projects.org_archive, as top-level trees. This is the default.
  3685. \"::* Archived Tasks\"
  3686. Archive in the current file, under the top-level headline
  3687. \"* Archived Tasks\".
  3688. \"~/org/archive.org::\"
  3689. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3690. \"~/org/archive.org::* From %s\"
  3691. Archive in file ~/org/archive.org (absolute path), under headlines
  3692. \"From FILENAME\" where file name is the current file name.
  3693. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3694. The \"datetree/\" string is special, signifying to archive
  3695. items to the datetree. Items are placed in either the CLOSED
  3696. date of the item, or the current date if there is no CLOSED date.
  3697. The heading will be a subentry to the current date. There doesn't
  3698. need to be a heading, but there always needs to be a slash after
  3699. datetree. For example, to store archived items directly in the
  3700. datetree, use \"~/org/datetree.org::datetree/\".
  3701. \"basement::** Finished Tasks\"
  3702. Archive in file ./basement (relative path), as level 3 trees
  3703. below the level 2 heading \"** Finished Tasks\".
  3704. You may set this option on a per-file basis by adding to the buffer a
  3705. line like
  3706. #+ARCHIVE: basement::** Finished Tasks
  3707. You may also define it locally for a subtree by setting an ARCHIVE property
  3708. in the entry. If such a property is found in an entry, or anywhere up
  3709. the hierarchy, it will be used."
  3710. :group 'org-archive
  3711. :type 'string)
  3712. (defcustom org-archive-tag "ARCHIVE"
  3713. "The tag that marks a subtree as archived.
  3714. An archived subtree does not open during visibility cycling, and does
  3715. not contribute to the agenda listings.
  3716. After changing this, font-lock must be restarted in the relevant buffers to
  3717. get the proper fontification."
  3718. :group 'org-archive
  3719. :group 'org-keywords
  3720. :type 'string)
  3721. (defcustom org-agenda-skip-archived-trees t
  3722. "Non-nil means the agenda will skip any items located in archived trees.
  3723. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3724. variable is no longer recommended, you should leave it at the value t.
  3725. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3726. :group 'org-archive
  3727. :group 'org-agenda-skip
  3728. :type 'boolean)
  3729. (defcustom org-columns-skip-archived-trees t
  3730. "Non-nil means ignore archived trees when creating column view."
  3731. :group 'org-archive
  3732. :group 'org-properties
  3733. :type 'boolean)
  3734. (defcustom org-cycle-open-archived-trees nil
  3735. "Non-nil means `org-cycle' will open archived trees.
  3736. An archived tree is a tree marked with the tag ARCHIVE.
  3737. When nil, archived trees will stay folded. You can still open them with
  3738. normal outline commands like `show-all', but not with the cycling commands."
  3739. :group 'org-archive
  3740. :group 'org-cycle
  3741. :type 'boolean)
  3742. (defcustom org-sparse-tree-open-archived-trees nil
  3743. "Non-nil means sparse tree construction shows matches in archived trees.
  3744. When nil, matches in these trees are highlighted, but the trees are kept in
  3745. collapsed state."
  3746. :group 'org-archive
  3747. :group 'org-sparse-trees
  3748. :type 'boolean)
  3749. (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
  3750. "The default date type when building a sparse tree.
  3751. When this is nil, a date is a scheduled or a deadline timestamp.
  3752. Otherwise, these types are allowed:
  3753. all: all timestamps
  3754. active: only active timestamps (<...>)
  3755. inactive: only inactive timestamps (<...)
  3756. scheduled: only scheduled timestamps
  3757. deadline: only deadline timestamps"
  3758. :type '(choice (const :tag "Scheduled or deadline" 'scheduled-or-deadline)
  3759. (const :tag "All timestamps" all)
  3760. (const :tag "Only active timestamps" active)
  3761. (const :tag "Only inactive timestamps" inactive)
  3762. (const :tag "Only scheduled timestamps" scheduled)
  3763. (const :tag "Only deadline timestamps" deadline))
  3764. ;; :version "24.3"
  3765. :group 'org-sparse-trees)
  3766. (defun org-cycle-hide-archived-subtrees (state)
  3767. "Re-hide all archived subtrees after a visibility state change."
  3768. (when (and (not org-cycle-open-archived-trees)
  3769. (not (memq state '(overview folded))))
  3770. (save-excursion
  3771. (let* ((globalp (memq state '(contents all)))
  3772. (beg (if globalp (point-min) (point)))
  3773. (end (if globalp (point-max) (org-end-of-subtree t))))
  3774. (org-hide-archived-subtrees beg end)
  3775. (goto-char beg)
  3776. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3777. (message "%s" (substitute-command-keys
  3778. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3779. (defun org-force-cycle-archived ()
  3780. "Cycle subtree even if it is archived."
  3781. (interactive)
  3782. (setq this-command 'org-cycle)
  3783. (let ((org-cycle-open-archived-trees t))
  3784. (call-interactively 'org-cycle)))
  3785. (defun org-hide-archived-subtrees (beg end)
  3786. "Re-hide all archived subtrees after a visibility state change."
  3787. (save-excursion
  3788. (let* ((re (concat ":" org-archive-tag ":")))
  3789. (goto-char beg)
  3790. (while (re-search-forward re end t)
  3791. (when (org-at-heading-p)
  3792. (org-flag-subtree t)
  3793. (org-end-of-subtree t))))))
  3794. (declare-function outline-end-of-heading "outline" ())
  3795. (declare-function outline-flag-region "outline" (from to flag))
  3796. (defun org-flag-subtree (flag)
  3797. (save-excursion
  3798. (org-back-to-heading t)
  3799. (outline-end-of-heading)
  3800. (outline-flag-region (point)
  3801. (progn (org-end-of-subtree t) (point))
  3802. flag)))
  3803. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3804. (eval-and-compile
  3805. (org-autoload "org-archive"
  3806. '(org-add-archive-files org-archive-subtree
  3807. org-archive-to-archive-sibling org-toggle-archive-tag
  3808. org-archive-subtree-default
  3809. org-archive-subtree-default-with-confirmation)))
  3810. ;; Autoload Column View Code
  3811. (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
  3812. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  3813. (declare-function org-columns-compute "org-colview" (property))
  3814. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3815. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3816. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3817. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3818. ;; Autoload ID code
  3819. (declare-function org-id-store-link "org-id")
  3820. (declare-function org-id-locations-load "org-id")
  3821. (declare-function org-id-locations-save "org-id")
  3822. (defvar org-id-track-globally)
  3823. (org-autoload "org-id"
  3824. '(org-id-get-create org-id-new org-id-copy org-id-get
  3825. org-id-get-with-outline-path-completion
  3826. org-id-get-with-outline-drilling org-id-store-link
  3827. org-id-goto org-id-find org-id-store-link))
  3828. ;; Autoload Plotting Code
  3829. (org-autoload "org-plot"
  3830. '(org-plot/gnuplot))
  3831. ;;; Variables for pre-computed regular expressions, all buffer local
  3832. (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
  3833. "Matches first line of a hidden block.")
  3834. (make-variable-buffer-local 'org-drawer-regexp)
  3835. (defvar org-todo-regexp nil
  3836. "Matches any of the TODO state keywords.")
  3837. (make-variable-buffer-local 'org-todo-regexp)
  3838. (defvar org-not-done-regexp nil
  3839. "Matches any of the TODO state keywords except the last one.")
  3840. (make-variable-buffer-local 'org-not-done-regexp)
  3841. (defvar org-not-done-heading-regexp nil
  3842. "Matches a TODO headline that is not done.")
  3843. (make-variable-buffer-local 'org-not-done-regexp)
  3844. (defvar org-todo-line-regexp nil
  3845. "Matches a headline and puts TODO state into group 2 if present.")
  3846. (make-variable-buffer-local 'org-todo-line-regexp)
  3847. (defvar org-complex-heading-regexp nil
  3848. "Matches a headline and puts everything into groups:
  3849. group 1: the stars
  3850. group 2: The todo keyword, maybe
  3851. group 3: Priority cookie
  3852. group 4: True headline
  3853. group 5: Tags")
  3854. (make-variable-buffer-local 'org-complex-heading-regexp)
  3855. (defvar org-complex-heading-regexp-format nil
  3856. "Printf format to make regexp to match an exact headline.
  3857. This regexp will match the headline of any node which has the
  3858. exact headline text that is put into the format, but may have any
  3859. TODO state, priority and tags.")
  3860. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3861. (defvar org-todo-line-tags-regexp nil
  3862. "Matches a headline and puts TODO state into group 2 if present.
  3863. Also put tags into group 4 if tags are present.")
  3864. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3865. (defvar org-ds-keyword-length 12
  3866. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  3867. (make-variable-buffer-local 'org-ds-keyword-length)
  3868. (defvar org-deadline-regexp nil
  3869. "Matches the DEADLINE keyword.")
  3870. (make-variable-buffer-local 'org-deadline-regexp)
  3871. (defvar org-deadline-time-regexp nil
  3872. "Matches the DEADLINE keyword together with a time stamp.")
  3873. (make-variable-buffer-local 'org-deadline-time-regexp)
  3874. (defvar org-deadline-line-regexp nil
  3875. "Matches the DEADLINE keyword and the rest of the line.")
  3876. (make-variable-buffer-local 'org-deadline-line-regexp)
  3877. (defvar org-scheduled-regexp nil
  3878. "Matches the SCHEDULED keyword.")
  3879. (make-variable-buffer-local 'org-scheduled-regexp)
  3880. (defvar org-scheduled-time-regexp nil
  3881. "Matches the SCHEDULED keyword together with a time stamp.")
  3882. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3883. (defvar org-closed-time-regexp nil
  3884. "Matches the CLOSED keyword together with a time stamp.")
  3885. (make-variable-buffer-local 'org-closed-time-regexp)
  3886. (defvar org-keyword-time-regexp nil
  3887. "Matches any of the 4 keywords, together with the time stamp.")
  3888. (make-variable-buffer-local 'org-keyword-time-regexp)
  3889. (defvar org-keyword-time-not-clock-regexp nil
  3890. "Matches any of the 3 keywords, together with the time stamp.")
  3891. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3892. (defvar org-maybe-keyword-time-regexp nil
  3893. "Matches a timestamp, possibly preceded by a keyword.")
  3894. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3895. (defvar org-all-time-keywords nil
  3896. "List of time keywords.")
  3897. (make-variable-buffer-local 'org-all-time-keywords)
  3898. (defconst org-plain-time-of-day-regexp
  3899. (concat
  3900. "\\(\\<[012]?[0-9]"
  3901. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3902. "\\(--?"
  3903. "\\(\\<[012]?[0-9]"
  3904. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3905. "\\)?")
  3906. "Regular expression to match a plain time or time range.
  3907. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3908. groups carry important information:
  3909. 0 the full match
  3910. 1 the first time, range or not
  3911. 8 the second time, if it is a range.")
  3912. (defconst org-plain-time-extension-regexp
  3913. (concat
  3914. "\\(\\<[012]?[0-9]"
  3915. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3916. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3917. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3918. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3919. groups carry important information:
  3920. 0 the full match
  3921. 7 hours of duration
  3922. 9 minutes of duration")
  3923. (defconst org-stamp-time-of-day-regexp
  3924. (concat
  3925. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3926. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3927. "\\(--?"
  3928. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3929. "Regular expression to match a timestamp time or time range.
  3930. After a match, the following groups carry important information:
  3931. 0 the full match
  3932. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3933. 2 the first time, range or not
  3934. 4 the second time, if it is a range.")
  3935. (defconst org-startup-options
  3936. '(("fold" org-startup-folded t)
  3937. ("overview" org-startup-folded t)
  3938. ("nofold" org-startup-folded nil)
  3939. ("showall" org-startup-folded nil)
  3940. ("showeverything" org-startup-folded showeverything)
  3941. ("content" org-startup-folded content)
  3942. ("indent" org-startup-indented t)
  3943. ("noindent" org-startup-indented nil)
  3944. ("hidestars" org-hide-leading-stars t)
  3945. ("showstars" org-hide-leading-stars nil)
  3946. ("odd" org-odd-levels-only t)
  3947. ("oddeven" org-odd-levels-only nil)
  3948. ("align" org-startup-align-all-tables t)
  3949. ("noalign" org-startup-align-all-tables nil)
  3950. ("inlineimages" org-startup-with-inline-images t)
  3951. ("noinlineimages" org-startup-with-inline-images nil)
  3952. ("customtime" org-display-custom-times t)
  3953. ("logdone" org-log-done time)
  3954. ("lognotedone" org-log-done note)
  3955. ("nologdone" org-log-done nil)
  3956. ("lognoteclock-out" org-log-note-clock-out t)
  3957. ("nolognoteclock-out" org-log-note-clock-out nil)
  3958. ("logrepeat" org-log-repeat state)
  3959. ("lognoterepeat" org-log-repeat note)
  3960. ("nologrepeat" org-log-repeat nil)
  3961. ("logreschedule" org-log-reschedule time)
  3962. ("lognotereschedule" org-log-reschedule note)
  3963. ("nologreschedule" org-log-reschedule nil)
  3964. ("logredeadline" org-log-redeadline time)
  3965. ("lognoteredeadline" org-log-redeadline note)
  3966. ("nologredeadline" org-log-redeadline nil)
  3967. ("logrefile" org-log-refile time)
  3968. ("lognoterefile" org-log-refile note)
  3969. ("nologrefile" org-log-refile nil)
  3970. ("fninline" org-footnote-define-inline t)
  3971. ("nofninline" org-footnote-define-inline nil)
  3972. ("fnlocal" org-footnote-section nil)
  3973. ("fnauto" org-footnote-auto-label t)
  3974. ("fnprompt" org-footnote-auto-label nil)
  3975. ("fnconfirm" org-footnote-auto-label confirm)
  3976. ("fnplain" org-footnote-auto-label plain)
  3977. ("fnadjust" org-footnote-auto-adjust t)
  3978. ("nofnadjust" org-footnote-auto-adjust nil)
  3979. ("constcgs" constants-unit-system cgs)
  3980. ("constSI" constants-unit-system SI)
  3981. ("noptag" org-tag-persistent-alist nil)
  3982. ("hideblocks" org-hide-block-startup t)
  3983. ("nohideblocks" org-hide-block-startup nil)
  3984. ("beamer" org-startup-with-beamer-mode t)
  3985. ("entitiespretty" org-pretty-entities t)
  3986. ("entitiesplain" org-pretty-entities nil))
  3987. "Variable associated with STARTUP options for org-mode.
  3988. Each element is a list of three items: the startup options (as written
  3989. in the #+STARTUP line), the corresponding variable, and the value to set
  3990. this variable to if the option is found. An optional forth element PUSH
  3991. means to push this value onto the list in the variable.")
  3992. (defun org-update-property-plist (key val props)
  3993. "Update PROPS with KEY and VAL."
  3994. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  3995. (key (if appending (substring key 0 (- (length key) 1)) key))
  3996. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  3997. (previous (cdr (assoc key props))))
  3998. (if appending
  3999. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  4000. (cons (cons key val) remainder))))
  4001. (defconst org-block-regexp
  4002. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  4003. "Regular expression for hiding blocks.")
  4004. (defconst org-heading-keyword-regexp-format
  4005. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4006. "Printf format for a regexp matching an headline with some keyword.
  4007. This regexp will match the headline of any node which has the
  4008. exact keyword that is put into the format. The keyword isn't in
  4009. any group by default, but the stars and the body are.")
  4010. (defconst org-heading-keyword-maybe-regexp-format
  4011. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4012. "Printf format for a regexp matching an headline, possibly with some keyword.
  4013. This regexp can match any headline with the specified keyword, or
  4014. without a keyword. The keyword isn't in any group by default,
  4015. but the stars and the body are.")
  4016. (defun org-set-regexps-and-options ()
  4017. "Precompute regular expressions for current buffer."
  4018. (when (derived-mode-p 'org-mode)
  4019. (org-set-local 'org-todo-kwd-alist nil)
  4020. (org-set-local 'org-todo-key-alist nil)
  4021. (org-set-local 'org-todo-key-trigger nil)
  4022. (org-set-local 'org-todo-keywords-1 nil)
  4023. (org-set-local 'org-done-keywords nil)
  4024. (org-set-local 'org-todo-heads nil)
  4025. (org-set-local 'org-todo-sets nil)
  4026. (org-set-local 'org-todo-log-states nil)
  4027. (org-set-local 'org-file-properties nil)
  4028. (org-set-local 'org-file-tags nil)
  4029. (let ((re (org-make-options-regexp
  4030. '("CATEGORY" "TODO" "COLUMNS"
  4031. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  4032. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  4033. "OPTIONS")
  4034. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  4035. (splitre "[ \t]+")
  4036. (scripts org-use-sub-superscripts)
  4037. kwds kws0 kwsa key log value cat arch tags const links hw dws
  4038. tail sep kws1 prio props ftags drawers beamer-p
  4039. ext-setup-or-nil setup-contents (start 0))
  4040. (save-excursion
  4041. (save-restriction
  4042. (widen)
  4043. (goto-char (point-min))
  4044. (while (or (and ext-setup-or-nil
  4045. (string-match re ext-setup-or-nil start)
  4046. (setq start (match-end 0)))
  4047. (and (setq ext-setup-or-nil nil start 0)
  4048. (re-search-forward re nil t)))
  4049. (setq key (upcase (match-string 1 ext-setup-or-nil))
  4050. value (org-match-string-no-properties 2 ext-setup-or-nil))
  4051. (if (stringp value) (setq value (org-trim value)))
  4052. (cond
  4053. ((equal key "CATEGORY")
  4054. (setq cat value))
  4055. ((member key '("SEQ_TODO" "TODO"))
  4056. (push (cons 'sequence (org-split-string value splitre)) kwds))
  4057. ((equal key "TYP_TODO")
  4058. (push (cons 'type (org-split-string value splitre)) kwds))
  4059. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  4060. ;; general TODO-like setup
  4061. (push (cons (intern (downcase (match-string 1 key)))
  4062. (org-split-string value splitre)) kwds))
  4063. ((equal key "TAGS")
  4064. (setq tags (append tags (if tags '("\\n") nil)
  4065. (org-split-string value splitre))))
  4066. ((equal key "COLUMNS")
  4067. (org-set-local 'org-columns-default-format value))
  4068. ((equal key "LINK")
  4069. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4070. (push (cons (match-string 1 value)
  4071. (org-trim (match-string 2 value)))
  4072. links)))
  4073. ((equal key "PRIORITIES")
  4074. (setq prio (org-split-string value " +")))
  4075. ((equal key "PROPERTY")
  4076. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4077. (setq props (org-update-property-plist (match-string 1 value)
  4078. (match-string 2 value)
  4079. props))))
  4080. ((equal key "FILETAGS")
  4081. (when (string-match "\\S-" value)
  4082. (setq ftags
  4083. (append
  4084. ftags
  4085. (apply 'append
  4086. (mapcar (lambda (x) (org-split-string x ":"))
  4087. (org-split-string value)))))))
  4088. ((equal key "DRAWERS")
  4089. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  4090. ((equal key "CONSTANTS")
  4091. (setq const (append const (org-split-string value splitre))))
  4092. ((equal key "STARTUP")
  4093. (let ((opts (org-split-string value splitre))
  4094. l var val)
  4095. (while (setq l (pop opts))
  4096. (when (setq l (assoc l org-startup-options))
  4097. (setq var (nth 1 l) val (nth 2 l))
  4098. (if (not (nth 3 l))
  4099. (set (make-local-variable var) val)
  4100. (if (not (listp (symbol-value var)))
  4101. (set (make-local-variable var) nil))
  4102. (set (make-local-variable var) (symbol-value var))
  4103. (add-to-list var val))))))
  4104. ((equal key "ARCHIVE")
  4105. (setq arch value)
  4106. (remove-text-properties 0 (length arch)
  4107. '(face t fontified t) arch))
  4108. ((equal key "LATEX_CLASS")
  4109. (setq beamer-p (equal value "beamer")))
  4110. ((equal key "OPTIONS")
  4111. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  4112. (setq scripts (read (match-string 2 value)))))
  4113. ((equal key "SETUPFILE")
  4114. (setq setup-contents (org-file-contents
  4115. (expand-file-name
  4116. (org-remove-double-quotes value))
  4117. 'noerror))
  4118. (if (not ext-setup-or-nil)
  4119. (setq ext-setup-or-nil setup-contents start 0)
  4120. (setq ext-setup-or-nil
  4121. (concat (substring ext-setup-or-nil 0 start)
  4122. "\n" setup-contents "\n"
  4123. (substring ext-setup-or-nil start)))))))
  4124. ;; search for property blocks
  4125. (goto-char (point-min))
  4126. (while (re-search-forward org-block-regexp nil t)
  4127. (when (equal "PROPERTY" (upcase (match-string 1)))
  4128. (setq value (replace-regexp-in-string
  4129. "[\n\r]" " " (match-string 4)))
  4130. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4131. (setq props (org-update-property-plist (match-string 1 value)
  4132. (match-string 2 value)
  4133. props)))))))
  4134. (org-set-local 'org-use-sub-superscripts scripts)
  4135. (when cat
  4136. (org-set-local 'org-category (intern cat))
  4137. (push (cons "CATEGORY" cat) props))
  4138. (when prio
  4139. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  4140. (setq prio (mapcar 'string-to-char prio))
  4141. (org-set-local 'org-highest-priority (nth 0 prio))
  4142. (org-set-local 'org-lowest-priority (nth 1 prio))
  4143. (org-set-local 'org-default-priority (nth 2 prio)))
  4144. (and props (org-set-local 'org-file-properties (nreverse props)))
  4145. (and ftags (org-set-local 'org-file-tags
  4146. (mapcar 'org-add-prop-inherited ftags)))
  4147. (and drawers (org-set-local 'org-drawers drawers))
  4148. (and arch (org-set-local 'org-archive-location arch))
  4149. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4150. ;; Process the TODO keywords
  4151. (unless kwds
  4152. ;; Use the global values as if they had been given locally.
  4153. (setq kwds (default-value 'org-todo-keywords))
  4154. (if (stringp (car kwds))
  4155. (setq kwds (list (cons org-todo-interpretation
  4156. (default-value 'org-todo-keywords)))))
  4157. (setq kwds (reverse kwds)))
  4158. (setq kwds (nreverse kwds))
  4159. (let (inter kws kw)
  4160. (while (setq kws (pop kwds))
  4161. (let ((kws (or
  4162. (run-hook-with-args-until-success
  4163. 'org-todo-setup-filter-hook kws)
  4164. kws)))
  4165. (setq inter (pop kws) sep (member "|" kws)
  4166. kws0 (delete "|" (copy-sequence kws))
  4167. kwsa nil
  4168. kws1 (mapcar
  4169. (lambda (x)
  4170. ;; 1 2
  4171. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4172. (progn
  4173. (setq kw (match-string 1 x)
  4174. key (and (match-end 2) (match-string 2 x))
  4175. log (org-extract-log-state-settings x))
  4176. (push (cons kw (and key (string-to-char key))) kwsa)
  4177. (and log (push log org-todo-log-states))
  4178. kw)
  4179. (error "Invalid TODO keyword %s" x)))
  4180. kws0)
  4181. kwsa (if kwsa (append '((:startgroup))
  4182. (nreverse kwsa)
  4183. '((:endgroup))))
  4184. hw (car kws1)
  4185. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4186. tail (list inter hw (car dws) (org-last dws))))
  4187. (add-to-list 'org-todo-heads hw 'append)
  4188. (push kws1 org-todo-sets)
  4189. (setq org-done-keywords (append org-done-keywords dws nil))
  4190. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4191. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4192. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4193. (setq org-todo-sets (nreverse org-todo-sets)
  4194. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4195. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4196. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4197. ;; Process the constants
  4198. (when const
  4199. (let (e cst)
  4200. (while (setq e (pop const))
  4201. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  4202. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  4203. (setq org-table-formula-constants-local cst)))
  4204. ;; Process the tags.
  4205. (when tags
  4206. (let (e tgs)
  4207. (while (setq e (pop tags))
  4208. (cond
  4209. ((equal e "{") (push '(:startgroup) tgs))
  4210. ((equal e "}") (push '(:endgroup) tgs))
  4211. ((equal e "\\n") (push '(:newline) tgs))
  4212. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4213. (push (cons (match-string 1 e)
  4214. (string-to-char (match-string 2 e)))
  4215. tgs))
  4216. (t (push (list e) tgs))))
  4217. (org-set-local 'org-tag-alist nil)
  4218. (while (setq e (pop tgs))
  4219. (or (and (stringp (car e))
  4220. (assoc (car e) org-tag-alist))
  4221. (push e org-tag-alist)))))
  4222. ;; Compute the regular expressions and other local variables.
  4223. ;; Using `org-outline-regexp-bol' would complicate them much,
  4224. ;; because of the fixed white space at the end of that string.
  4225. (if (not org-done-keywords)
  4226. (setq org-done-keywords (and org-todo-keywords-1
  4227. (list (org-last org-todo-keywords-1)))))
  4228. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4229. (length org-scheduled-string)
  4230. (length org-clock-string)
  4231. (length org-closed-string)))
  4232. org-drawer-regexp
  4233. (concat "^[ \t]*:\\("
  4234. (mapconcat 'regexp-quote org-drawers "\\|")
  4235. "\\):[ \t]*$")
  4236. org-not-done-keywords
  4237. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4238. org-todo-regexp
  4239. (concat "\\("
  4240. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4241. "\\)")
  4242. org-not-done-regexp
  4243. (concat "\\("
  4244. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4245. "\\)")
  4246. org-not-done-heading-regexp
  4247. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4248. org-todo-line-regexp
  4249. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4250. org-complex-heading-regexp
  4251. (concat "^\\(\\*+\\)"
  4252. "\\(?: +" org-todo-regexp "\\)?"
  4253. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4254. "\\(?: +\\(.*?\\)\\)??"
  4255. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4256. "[ \t]*$")
  4257. org-complex-heading-regexp-format
  4258. (concat "^\\(\\*+\\)"
  4259. "\\(?: +" org-todo-regexp "\\)?"
  4260. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4261. "\\(?: +"
  4262. ;; Stats cookies can be stuck to body.
  4263. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4264. "\\(%s\\)"
  4265. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4266. "\\)"
  4267. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4268. "[ \t]*$")
  4269. org-todo-line-tags-regexp
  4270. (concat "^\\(\\*+\\)"
  4271. "\\(?: +" org-todo-regexp "\\)?"
  4272. "\\(?: +\\(.*?\\)\\)??"
  4273. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4274. "[ \t]*$")
  4275. org-deadline-regexp (concat "\\<" org-deadline-string)
  4276. org-deadline-time-regexp
  4277. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4278. org-deadline-line-regexp
  4279. (concat "\\<\\(" org-deadline-string "\\).*")
  4280. org-scheduled-regexp
  4281. (concat "\\<" org-scheduled-string)
  4282. org-scheduled-time-regexp
  4283. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4284. org-closed-time-regexp
  4285. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4286. org-keyword-time-regexp
  4287. (concat "\\<\\(" org-scheduled-string
  4288. "\\|" org-deadline-string
  4289. "\\|" org-closed-string
  4290. "\\|" org-clock-string "\\)"
  4291. " *[[<]\\([^]>]+\\)[]>]")
  4292. org-keyword-time-not-clock-regexp
  4293. (concat "\\<\\(" org-scheduled-string
  4294. "\\|" org-deadline-string
  4295. "\\|" org-closed-string
  4296. "\\)"
  4297. " *[[<]\\([^]>]+\\)[]>]")
  4298. org-maybe-keyword-time-regexp
  4299. (concat "\\(\\<\\(" org-scheduled-string
  4300. "\\|" org-deadline-string
  4301. "\\|" org-closed-string
  4302. "\\|" org-clock-string "\\)\\)?"
  4303. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4304. org-all-time-keywords
  4305. (mapcar (lambda (w) (substring w 0 -1))
  4306. (list org-scheduled-string org-deadline-string
  4307. org-clock-string org-closed-string))
  4308. )
  4309. (org-compute-latex-and-specials-regexp)
  4310. (org-set-font-lock-defaults))))
  4311. (defun org-file-contents (file &optional noerror)
  4312. "Return the contents of FILE, as a string."
  4313. (if (or (not file)
  4314. (not (file-readable-p file)))
  4315. (if noerror
  4316. (progn
  4317. (message "Cannot read file \"%s\"" file)
  4318. (ding) (sit-for 2)
  4319. "")
  4320. (error "Cannot read file \"%s\"" file))
  4321. (with-temp-buffer
  4322. (insert-file-contents file)
  4323. (buffer-string))))
  4324. (defun org-extract-log-state-settings (x)
  4325. "Extract the log state setting from a TODO keyword string.
  4326. This will extract info from a string like \"WAIT(w@/!)\"."
  4327. (let (kw key log1 log2)
  4328. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4329. (setq kw (match-string 1 x)
  4330. key (and (match-end 2) (match-string 2 x))
  4331. log1 (and (match-end 3) (match-string 3 x))
  4332. log2 (and (match-end 4) (match-string 4 x)))
  4333. (and (or log1 log2)
  4334. (list kw
  4335. (and log1 (if (equal log1 "!") 'time 'note))
  4336. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4337. (defun org-remove-keyword-keys (list)
  4338. "Remove a pair of parenthesis at the end of each string in LIST."
  4339. (mapcar (lambda (x)
  4340. (if (string-match "(.*)$" x)
  4341. (substring x 0 (match-beginning 0))
  4342. x))
  4343. list))
  4344. (defun org-assign-fast-keys (alist)
  4345. "Assign fast keys to a keyword-key alist.
  4346. Respect keys that are already there."
  4347. (let (new e (alt ?0))
  4348. (while (setq e (pop alist))
  4349. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  4350. (cdr e)) ;; Key already assigned.
  4351. (push e new)
  4352. (let ((clist (string-to-list (downcase (car e))))
  4353. (used (append new alist)))
  4354. (when (= (car clist) ?@)
  4355. (pop clist))
  4356. (while (and clist (rassoc (car clist) used))
  4357. (pop clist))
  4358. (unless clist
  4359. (while (rassoc alt used)
  4360. (incf alt)))
  4361. (push (cons (car e) (or (car clist) alt)) new))))
  4362. (nreverse new)))
  4363. ;;; Some variables used in various places
  4364. (defvar org-window-configuration nil
  4365. "Used in various places to store a window configuration.")
  4366. (defvar org-selected-window nil
  4367. "Used in various places to store a window configuration.")
  4368. (defvar org-finish-function nil
  4369. "Function to be called when `C-c C-c' is used.
  4370. This is for getting out of special buffers like remember.")
  4371. ;; FIXME: Occasionally check by commenting these, to make sure
  4372. ;; no other functions uses these, forgetting to let-bind them.
  4373. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4374. (defvar org-last-state)
  4375. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4376. ;; Defined somewhere in this file, but used before definition.
  4377. (defvar org-entities) ;; defined in org-entities.el
  4378. (defvar org-struct-menu)
  4379. (defvar org-org-menu)
  4380. (defvar org-tbl-menu)
  4381. ;;;; Define the Org-mode
  4382. ;; We use a before-change function to check if a table might need
  4383. ;; an update.
  4384. (defvar org-table-may-need-update t
  4385. "Indicates that a table might need an update.
  4386. This variable is set by `org-before-change-function'.
  4387. `org-table-align' sets it back to nil.")
  4388. (defun org-before-change-function (beg end)
  4389. "Every change indicates that a table might need an update."
  4390. (setq org-table-may-need-update t))
  4391. (defvar org-mode-map)
  4392. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4393. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4394. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4395. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4396. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4397. (defvar org-table-buffer-is-an nil)
  4398. (defvar bidi-paragraph-direction)
  4399. (defvar buffer-face-mode-face)
  4400. (require 'outline)
  4401. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4402. (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"))
  4403. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  4404. ;; Other stuff we need.
  4405. (require 'time-date)
  4406. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4407. (require 'easymenu)
  4408. (require 'overlay)
  4409. (require 'org-macs)
  4410. (require 'org-entities)
  4411. ;; (require 'org-compat) moved higher up in the file before it is first used
  4412. (require 'org-faces)
  4413. (require 'org-list)
  4414. (require 'org-pcomplete)
  4415. (require 'org-src)
  4416. (require 'org-footnote)
  4417. ;; babel
  4418. (require 'ob)
  4419. (require 'ob-table)
  4420. (require 'ob-lob)
  4421. (require 'ob-ref)
  4422. (require 'ob-tangle)
  4423. (require 'ob-comint)
  4424. (require 'ob-keys)
  4425. ;;;###autoload
  4426. (define-derived-mode org-mode outline-mode "Org"
  4427. "Outline-based notes management and organizer, alias
  4428. \"Carsten's outline-mode for keeping track of everything.\"
  4429. Org-mode develops organizational tasks around a NOTES file which
  4430. contains information about projects as plain text. Org-mode is
  4431. implemented on top of outline-mode, which is ideal to keep the content
  4432. of large files well structured. It supports ToDo items, deadlines and
  4433. time stamps, which magically appear in the diary listing of the Emacs
  4434. calendar. Tables are easily created with a built-in table editor.
  4435. Plain text URL-like links connect to websites, emails (VM), Usenet
  4436. messages (Gnus), BBDB entries, and any files related to the project.
  4437. For printing and sharing of notes, an Org-mode file (or a part of it)
  4438. can be exported as a structured ASCII or HTML file.
  4439. The following commands are available:
  4440. \\{org-mode-map}"
  4441. ;; Get rid of Outline menus, they are not needed
  4442. ;; Need to do this here because define-derived-mode sets up
  4443. ;; the keymap so late. Still, it is a waste to call this each time
  4444. ;; we switch another buffer into org-mode.
  4445. (if (featurep 'xemacs)
  4446. (when (boundp 'outline-mode-menu-heading)
  4447. ;; Assume this is Greg's port, it uses easymenu
  4448. (easy-menu-remove outline-mode-menu-heading)
  4449. (easy-menu-remove outline-mode-menu-show)
  4450. (easy-menu-remove outline-mode-menu-hide))
  4451. (define-key org-mode-map [menu-bar headings] 'undefined)
  4452. (define-key org-mode-map [menu-bar hide] 'undefined)
  4453. (define-key org-mode-map [menu-bar show] 'undefined))
  4454. (org-load-modules-maybe)
  4455. (easy-menu-add org-org-menu)
  4456. (easy-menu-add org-tbl-menu)
  4457. (org-install-agenda-files-menu)
  4458. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4459. (add-to-invisibility-spec '(org-cwidth))
  4460. (add-to-invisibility-spec '(org-hide-block . t))
  4461. (when (featurep 'xemacs)
  4462. (org-set-local 'line-move-ignore-invisible t))
  4463. (org-set-local 'outline-regexp org-outline-regexp)
  4464. (org-set-local 'outline-level 'org-outline-level)
  4465. (setq bidi-paragraph-direction 'left-to-right)
  4466. (when (and org-ellipsis
  4467. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4468. (fboundp 'make-glyph-code))
  4469. (unless org-display-table
  4470. (setq org-display-table (make-display-table)))
  4471. (set-display-table-slot
  4472. org-display-table 4
  4473. (vconcat (mapcar
  4474. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4475. org-ellipsis)))
  4476. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4477. (setq buffer-display-table org-display-table))
  4478. (org-set-regexps-and-options)
  4479. (when (and org-tag-faces (not org-tags-special-faces-re))
  4480. ;; tag faces set outside customize.... force initialization.
  4481. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4482. ;; Calc embedded
  4483. (org-set-local 'calc-embedded-open-mode "# ")
  4484. (modify-syntax-entry ?@ "w")
  4485. (modify-syntax-entry ?\" "\"")
  4486. (if org-startup-truncated (setq truncate-lines t))
  4487. (org-set-local 'font-lock-unfontify-region-function
  4488. 'org-unfontify-region)
  4489. ;; Activate before-change-function
  4490. (org-set-local 'org-table-may-need-update t)
  4491. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4492. 'local)
  4493. ;; Check for running clock before killing a buffer
  4494. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4495. ;; Initialize macros templates.
  4496. (org-macro-initialize-templates)
  4497. ;; Initialize radio targets.
  4498. (org-update-radio-target-regexp)
  4499. ;; Indentation.
  4500. (org-set-local 'indent-line-function 'org-indent-line)
  4501. (org-set-local 'indent-region-function 'org-indent-region)
  4502. ;; Filling and auto-filling.
  4503. (org-setup-filling)
  4504. ;; Comments.
  4505. (org-setup-comments-handling)
  4506. ;; Beginning/end of defun
  4507. (org-set-local 'beginning-of-defun-function 'org-back-to-heading)
  4508. (org-set-local 'end-of-defun-function (lambda () (interactive) (org-end-of-subtree nil t)))
  4509. ;; Next error for sparse trees
  4510. (org-set-local 'next-error-function 'org-occur-next-match)
  4511. ;; Make sure dependence stuff works reliably, even for users who set it
  4512. ;; too late :-(
  4513. (if org-enforce-todo-dependencies
  4514. (add-hook 'org-blocker-hook
  4515. 'org-block-todo-from-children-or-siblings-or-parent)
  4516. (remove-hook 'org-blocker-hook
  4517. 'org-block-todo-from-children-or-siblings-or-parent))
  4518. (if org-enforce-todo-checkbox-dependencies
  4519. (add-hook 'org-blocker-hook
  4520. 'org-block-todo-from-checkboxes)
  4521. (remove-hook 'org-blocker-hook
  4522. 'org-block-todo-from-checkboxes))
  4523. ;; Align options lines
  4524. (org-set-local
  4525. 'align-mode-rules-list
  4526. '((org-in-buffer-settings
  4527. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4528. (modes . '(org-mode)))))
  4529. ;; Imenu
  4530. (org-set-local 'imenu-create-index-function
  4531. 'org-imenu-get-tree)
  4532. ;; Make isearch reveal context
  4533. (if (or (featurep 'xemacs)
  4534. (not (boundp 'outline-isearch-open-invisible-function)))
  4535. ;; Emacs 21 and XEmacs make use of the hook
  4536. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4537. ;; Emacs 22 deals with this through a special variable
  4538. (org-set-local 'outline-isearch-open-invisible-function
  4539. (lambda (&rest ignore) (org-show-context 'isearch))))
  4540. ;; Turn on org-beamer-mode?
  4541. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  4542. ;; Setup the pcomplete hooks
  4543. (set (make-local-variable 'pcomplete-command-completion-function)
  4544. 'org-pcomplete-initial)
  4545. (set (make-local-variable 'pcomplete-command-name-function)
  4546. 'org-command-at-point)
  4547. (set (make-local-variable 'pcomplete-default-completion-function)
  4548. 'ignore)
  4549. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4550. 'org-parse-arguments)
  4551. (set (make-local-variable 'pcomplete-termination-string) "")
  4552. (when (>= emacs-major-version 23)
  4553. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4554. ;; If empty file that did not turn on org-mode automatically, make it to.
  4555. (if (and org-insert-mode-line-in-empty-file
  4556. (org-called-interactively-p 'any)
  4557. (= (point-min) (point-max)))
  4558. (insert "# -*- mode: org -*-\n\n"))
  4559. (unless org-inhibit-startup
  4560. (when org-startup-align-all-tables
  4561. (let ((bmp (buffer-modified-p)))
  4562. (org-table-map-tables 'org-table-align 'quietly)
  4563. (set-buffer-modified-p bmp)))
  4564. (when org-startup-with-inline-images
  4565. (org-display-inline-images))
  4566. (when org-startup-indented
  4567. (require 'org-indent)
  4568. (org-indent-mode 1))
  4569. (unless org-inhibit-startup-visibility-stuff
  4570. (org-set-startup-visibility))))
  4571. (when (fboundp 'abbrev-table-put)
  4572. (abbrev-table-put org-mode-abbrev-table
  4573. :parents (list text-mode-abbrev-table)))
  4574. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4575. (defun org-current-time ()
  4576. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4577. (if (> (car org-time-stamp-rounding-minutes) 1)
  4578. (let ((r (car org-time-stamp-rounding-minutes))
  4579. (time (decode-time)))
  4580. (apply 'encode-time
  4581. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4582. (nthcdr 2 time))))
  4583. (current-time)))
  4584. (defun org-today ()
  4585. "Return today date, considering `org-extend-today-until'."
  4586. (time-to-days
  4587. (time-subtract (current-time)
  4588. (list 0 (* 3600 org-extend-today-until) 0))))
  4589. ;;;; Font-Lock stuff, including the activators
  4590. (defvar org-mouse-map (make-sparse-keymap))
  4591. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4592. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4593. (when org-mouse-1-follows-link
  4594. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4595. (when org-tab-follows-link
  4596. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4597. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4598. (require 'font-lock)
  4599. (defconst org-non-link-chars "]\t\n\r<>")
  4600. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4601. "shell" "elisp" "doi" "message"))
  4602. (defvar org-link-types-re nil
  4603. "Matches a link that has a url-like prefix like \"http:\"")
  4604. (defvar org-link-re-with-space nil
  4605. "Matches a link with spaces, optional angular brackets around it.")
  4606. (defvar org-link-re-with-space2 nil
  4607. "Matches a link with spaces, optional angular brackets around it.")
  4608. (defvar org-link-re-with-space3 nil
  4609. "Matches a link with spaces, only for internal part in bracket links.")
  4610. (defvar org-angle-link-re nil
  4611. "Matches link with angular brackets, spaces are allowed.")
  4612. (defvar org-plain-link-re nil
  4613. "Matches plain link, without spaces.")
  4614. (defvar org-bracket-link-regexp nil
  4615. "Matches a link in double brackets.")
  4616. (defvar org-bracket-link-analytic-regexp nil
  4617. "Regular expression used to analyze links.
  4618. Here is what the match groups contain after a match:
  4619. 1: http:
  4620. 2: http
  4621. 3: path
  4622. 4: [desc]
  4623. 5: desc")
  4624. (defvar org-bracket-link-analytic-regexp++ nil
  4625. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4626. (defvar org-any-link-re nil
  4627. "Regular expression matching any link.")
  4628. (defcustom org-match-sexp-depth 3
  4629. "Number of stacked braces for sub/superscript matching.
  4630. This has to be set before loading org.el to be effective."
  4631. :group 'org-export-translation ; ??????????????????????????/
  4632. :type 'integer)
  4633. (defun org-create-multibrace-regexp (left right n)
  4634. "Create a regular expression which will match a balanced sexp.
  4635. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4636. as single character strings.
  4637. The regexp returned will match the entire expression including the
  4638. delimiters. It will also define a single group which contains the
  4639. match except for the outermost delimiters. The maximum depth of
  4640. stacked delimiters is N. Escaping delimiters is not possible."
  4641. (let* ((nothing (concat "[^" left right "]*?"))
  4642. (or "\\|")
  4643. (re nothing)
  4644. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4645. (while (> n 1)
  4646. (setq n (1- n)
  4647. re (concat re or next)
  4648. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4649. (concat left "\\(" re "\\)" right)))
  4650. (defvar org-match-substring-regexp
  4651. (concat
  4652. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4653. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4654. "\\|"
  4655. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4656. "\\|"
  4657. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4658. "The regular expression matching a sub- or superscript.")
  4659. (defvar org-match-substring-with-braces-regexp
  4660. (concat
  4661. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4662. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4663. "\\)")
  4664. "The regular expression matching a sub- or superscript, forcing braces.")
  4665. (defun org-make-link-regexps ()
  4666. "Update the link regular expressions.
  4667. This should be called after the variable `org-link-types' has changed."
  4668. (setq org-link-types-re
  4669. (concat
  4670. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4671. org-link-re-with-space
  4672. (concat
  4673. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4674. "\\([^" org-non-link-chars " ]"
  4675. "[^" org-non-link-chars "]*"
  4676. "[^" org-non-link-chars " ]\\)>?")
  4677. org-link-re-with-space2
  4678. (concat
  4679. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4680. "\\([^" org-non-link-chars " ]"
  4681. "[^\t\n\r]*"
  4682. "[^" org-non-link-chars " ]\\)>?")
  4683. org-link-re-with-space3
  4684. (concat
  4685. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4686. "\\([^" org-non-link-chars " ]"
  4687. "[^\t\n\r]*\\)")
  4688. org-angle-link-re
  4689. (concat
  4690. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4691. "\\([^" org-non-link-chars " ]"
  4692. "[^" org-non-link-chars "]*"
  4693. "\\)>")
  4694. org-plain-link-re
  4695. (concat
  4696. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4697. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4698. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4699. org-bracket-link-regexp
  4700. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4701. org-bracket-link-analytic-regexp
  4702. (concat
  4703. "\\[\\["
  4704. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4705. "\\([^]]+\\)"
  4706. "\\]"
  4707. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4708. "\\]")
  4709. org-bracket-link-analytic-regexp++
  4710. (concat
  4711. "\\[\\["
  4712. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4713. "\\([^]]+\\)"
  4714. "\\]"
  4715. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4716. "\\]")
  4717. org-any-link-re
  4718. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4719. org-angle-link-re "\\)\\|\\("
  4720. org-plain-link-re "\\)")))
  4721. (org-make-link-regexps)
  4722. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  4723. "Regular expression for fast time stamp matching.")
  4724. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  4725. "Regular expression for fast time stamp matching.")
  4726. (defconst org-ts-regexp0
  4727. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4728. "Regular expression matching time strings for analysis.
  4729. This one does not require the space after the date, so it can be used
  4730. on a string that terminates immediately after the date.")
  4731. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4732. "Regular expression matching time strings for analysis.")
  4733. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4734. "Regular expression matching time stamps, with groups.")
  4735. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4736. "Regular expression matching time stamps (also [..]), with groups.")
  4737. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4738. "Regular expression matching a time stamp range.")
  4739. (defconst org-tr-regexp-both
  4740. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4741. "Regular expression matching a time stamp range.")
  4742. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4743. org-ts-regexp "\\)?")
  4744. "Regular expression matching a time stamp or time stamp range.")
  4745. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4746. org-ts-regexp-both "\\)?")
  4747. "Regular expression matching a time stamp or time stamp range.
  4748. The time stamps may be either active or inactive.")
  4749. (defvar org-emph-face nil)
  4750. (defun org-do-emphasis-faces (limit)
  4751. "Run through the buffer and add overlays to emphasized strings."
  4752. (let (rtn a)
  4753. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4754. (if (not (= (char-after (match-beginning 3))
  4755. (char-after (match-beginning 4))))
  4756. (progn
  4757. (setq rtn t)
  4758. (setq a (assoc (match-string 3) org-emphasis-alist))
  4759. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4760. 'face
  4761. (nth 1 a))
  4762. (and (nth 4 a)
  4763. (org-remove-flyspell-overlays-in
  4764. (match-beginning 0) (match-end 0)))
  4765. (add-text-properties (match-beginning 2) (match-end 2)
  4766. '(font-lock-multiline t org-emphasis t))
  4767. (when org-hide-emphasis-markers
  4768. (add-text-properties (match-end 4) (match-beginning 5)
  4769. '(invisible org-link))
  4770. (add-text-properties (match-beginning 3) (match-end 3)
  4771. '(invisible org-link)))))
  4772. (backward-char 1))
  4773. rtn))
  4774. (defun org-emphasize (&optional char)
  4775. "Insert or change an emphasis, i.e. a font like bold or italic.
  4776. If there is an active region, change that region to a new emphasis.
  4777. If there is no region, just insert the marker characters and position
  4778. the cursor between them.
  4779. CHAR should be either the marker character, or the first character of the
  4780. HTML tag associated with that emphasis. If CHAR is a space, the means
  4781. to remove the emphasis of the selected region.
  4782. If char is not given (for example in an interactive call) it
  4783. will be prompted for."
  4784. (interactive)
  4785. (let ((eal org-emphasis-alist) e det
  4786. (erc org-emphasis-regexp-components)
  4787. (prompt "")
  4788. (string "") beg end move tag c s)
  4789. (if (org-region-active-p)
  4790. (setq beg (region-beginning) end (region-end)
  4791. string (buffer-substring beg end))
  4792. (setq move t))
  4793. (while (setq e (pop eal))
  4794. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4795. c (aref tag 0))
  4796. (push (cons c (string-to-char (car e))) det)
  4797. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4798. (substring tag 1)))))
  4799. (setq det (nreverse det))
  4800. (unless char
  4801. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4802. (setq char (read-char-exclusive)))
  4803. (setq char (or (cdr (assoc char det)) char))
  4804. (if (equal char ?\ )
  4805. (setq s "" move nil)
  4806. (unless (assoc (char-to-string char) org-emphasis-alist)
  4807. (error "No such emphasis marker: \"%c\"" char))
  4808. (setq s (char-to-string char)))
  4809. (while (and (> (length string) 1)
  4810. (equal (substring string 0 1) (substring string -1))
  4811. (assoc (substring string 0 1) org-emphasis-alist))
  4812. (setq string (substring string 1 -1)))
  4813. (setq string (concat s string s))
  4814. (if beg (delete-region beg end))
  4815. (unless (or (bolp)
  4816. (string-match (concat "[" (nth 0 erc) "\n]")
  4817. (char-to-string (char-before (point)))))
  4818. (insert " "))
  4819. (unless (or (eobp)
  4820. (string-match (concat "[" (nth 1 erc) "\n]")
  4821. (char-to-string (char-after (point)))))
  4822. (insert " ") (backward-char 1))
  4823. (insert string)
  4824. (and move (backward-char 1))))
  4825. (defconst org-nonsticky-props
  4826. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4827. (defsubst org-rear-nonsticky-at (pos)
  4828. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4829. (defun org-activate-plain-links (limit)
  4830. "Run through the buffer and add overlays to links."
  4831. (catch 'exit
  4832. (let (f)
  4833. (if (and (re-search-forward (concat org-plain-link-re) limit t)
  4834. (or (not (member 'bracket org-activate-links))
  4835. (save-excursion
  4836. (save-match-data
  4837. (goto-char (match-beginning 0))
  4838. (not (looking-back "\\[\\["))))))
  4839. (progn
  4840. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4841. (setq f (get-text-property (match-beginning 0) 'face))
  4842. (if (or (eq f 'org-tag)
  4843. (and (listp f) (memq 'org-tag f)))
  4844. nil
  4845. (add-text-properties (match-beginning 0) (match-end 0)
  4846. (list 'mouse-face 'highlight
  4847. 'face 'org-link
  4848. 'keymap org-mouse-map))
  4849. (org-rear-nonsticky-at (match-end 0)))
  4850. t)))))
  4851. (defun org-activate-code (limit)
  4852. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  4853. (progn
  4854. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4855. (remove-text-properties (match-beginning 0) (match-end 0)
  4856. '(display t invisible t intangible t))
  4857. t)))
  4858. (defcustom org-src-fontify-natively nil
  4859. "When non-nil, fontify code in code blocks."
  4860. :type 'boolean
  4861. :version "24.1"
  4862. :group 'org-appearance
  4863. :group 'org-babel)
  4864. (defcustom org-allow-promoting-top-level-subtree nil
  4865. "When non-nil, allow promoting a top level subtree.
  4866. The leading star of the top level headline will be replaced
  4867. by a #."
  4868. :type 'boolean
  4869. :version "24.1"
  4870. :group 'org-appearance)
  4871. (defun org-fontify-meta-lines-and-blocks (limit)
  4872. (condition-case nil
  4873. (org-fontify-meta-lines-and-blocks-1 limit)
  4874. (error (message "org-mode fontification error"))))
  4875. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  4876. "Fontify #+ lines and blocks, in the correct ways."
  4877. (let ((case-fold-search t))
  4878. (if (re-search-forward
  4879. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  4880. limit t)
  4881. (let ((beg (match-beginning 0))
  4882. (block-start (match-end 0))
  4883. (block-end nil)
  4884. (lang (match-string 7))
  4885. (beg1 (line-beginning-position 2))
  4886. (dc1 (downcase (match-string 2)))
  4887. (dc3 (downcase (match-string 3)))
  4888. end end1 quoting block-type ovl)
  4889. (cond
  4890. ((member dc1 '("+html:" "+ascii:" "+latex:" "+docbook:"))
  4891. ;; a single line of backend-specific content
  4892. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4893. (remove-text-properties (match-beginning 0) (match-end 0)
  4894. '(display t invisible t intangible t))
  4895. (add-text-properties (match-beginning 1) (match-end 3)
  4896. '(font-lock-fontified t face org-meta-line))
  4897. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  4898. '(font-lock-fontified t face org-block))
  4899. ; for backend-specific code
  4900. t)
  4901. ((and (match-end 4) (equal dc3 "+begin"))
  4902. ;; Truly a block
  4903. (setq block-type (downcase (match-string 5))
  4904. quoting (member block-type org-protecting-blocks))
  4905. (when (re-search-forward
  4906. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4907. nil t) ;; on purpose, we look further than LIMIT
  4908. (setq end (min (point-max) (match-end 0))
  4909. end1 (min (point-max) (1- (match-beginning 0))))
  4910. (setq block-end (match-beginning 0))
  4911. (when quoting
  4912. (remove-text-properties beg end
  4913. '(display t invisible t intangible t)))
  4914. (add-text-properties
  4915. beg end
  4916. '(font-lock-fontified t font-lock-multiline t))
  4917. (add-text-properties beg beg1 '(face org-meta-line))
  4918. (add-text-properties end1 (min (point-max) (1+ end))
  4919. '(face org-meta-line)) ; for end_src
  4920. (cond
  4921. ((and lang (not (string= lang "")) org-src-fontify-natively)
  4922. (org-src-font-lock-fontify-block lang block-start block-end)
  4923. ;; remove old background overlays
  4924. (mapc (lambda (ov)
  4925. (if (eq (overlay-get ov 'face) 'org-block-background)
  4926. (delete-overlay ov)))
  4927. (overlays-at (/ (+ beg1 block-end) 2)))
  4928. ;; add a background overlay
  4929. (setq ovl (make-overlay beg1 block-end))
  4930. (overlay-put ovl 'face 'org-block-background)
  4931. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  4932. (quoting
  4933. (add-text-properties beg1 (min (point-max) (1+ end1))
  4934. '(face org-block))) ; end of source block
  4935. ((not org-fontify-quote-and-verse-blocks))
  4936. ((string= block-type "quote")
  4937. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  4938. ((string= block-type "verse")
  4939. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  4940. (add-text-properties beg beg1 '(face org-block-begin-line))
  4941. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  4942. '(face org-block-end-line))
  4943. t))
  4944. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  4945. (add-text-properties
  4946. beg (match-end 3)
  4947. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4948. '(font-lock-fontified t invisible t)
  4949. '(font-lock-fontified t face org-document-info-keyword)))
  4950. (add-text-properties
  4951. (match-beginning 6) (match-end 6)
  4952. (if (string-equal dc1 "+title:")
  4953. '(font-lock-fontified t face org-document-title)
  4954. '(font-lock-fontified t face org-document-info))))
  4955. ((or (equal dc1 "+results")
  4956. (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
  4957. "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
  4958. "+call:" "+header:" "+headers:" "+name:"))
  4959. (and (match-end 4) (equal dc3 "+attr")))
  4960. (add-text-properties
  4961. beg (match-end 0)
  4962. '(font-lock-fontified t face org-meta-line))
  4963. t)
  4964. ((member dc3 '(" " ""))
  4965. (add-text-properties
  4966. beg (match-end 0)
  4967. '(font-lock-fontified t face font-lock-comment-face)))
  4968. ((not (member (char-after beg) '(?\ ?\t)))
  4969. ;; just any other in-buffer setting, but not indented
  4970. (add-text-properties
  4971. beg (match-end 0)
  4972. '(font-lock-fontified t face org-meta-line))
  4973. t)
  4974. (t nil))))))
  4975. (defun org-strip-protective-commas (beg end)
  4976. "Strip protective commas between BEG and END in the current buffer."
  4977. (interactive "r")
  4978. (save-excursion
  4979. (save-match-data
  4980. (goto-char beg)
  4981. (let ((front-line (save-excursion
  4982. (re-search-forward
  4983. "[^[:space:]]" end t)
  4984. (goto-char (match-beginning 0))
  4985. (current-column))))
  4986. (while (re-search-forward "^[ \t]*\\(,\\)\\([*]\\|#\\)" end t)
  4987. (goto-char (match-beginning 1))
  4988. (when (= (current-column) front-line)
  4989. (replace-match "" nil nil nil 1)))))))
  4990. (defun org-activate-angle-links (limit)
  4991. "Run through the buffer and add overlays to links."
  4992. (if (re-search-forward org-angle-link-re limit t)
  4993. (progn
  4994. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4995. (add-text-properties (match-beginning 0) (match-end 0)
  4996. (list 'mouse-face 'highlight
  4997. 'keymap org-mouse-map))
  4998. (org-rear-nonsticky-at (match-end 0))
  4999. t)))
  5000. (defun org-activate-footnote-links (limit)
  5001. "Run through the buffer and add overlays to footnotes."
  5002. (let ((fn (org-footnote-next-reference-or-definition limit)))
  5003. (when fn
  5004. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  5005. (org-remove-flyspell-overlays-in beg end)
  5006. (add-text-properties beg end
  5007. (list 'mouse-face 'highlight
  5008. 'keymap org-mouse-map
  5009. 'help-echo
  5010. (if (= (point-at-bol) beg)
  5011. "Footnote definition"
  5012. "Footnote reference")
  5013. 'font-lock-fontified t
  5014. 'font-lock-multiline t
  5015. 'face 'org-footnote))))))
  5016. (defun org-activate-bracket-links (limit)
  5017. "Run through the buffer and add overlays to bracketed links."
  5018. (if (re-search-forward org-bracket-link-regexp limit t)
  5019. (let* ((help (concat "LINK: "
  5020. (org-match-string-no-properties 1)))
  5021. ;; FIXME: above we should remove the escapes.
  5022. ;; but that requires another match, protecting match data,
  5023. ;; a lot of overhead for font-lock.
  5024. (ip (org-maybe-intangible
  5025. (list 'invisible 'org-link
  5026. 'keymap org-mouse-map 'mouse-face 'highlight
  5027. 'font-lock-multiline t 'help-echo help)))
  5028. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  5029. 'font-lock-multiline t 'help-echo help)))
  5030. ;; We need to remove the invisible property here. Table narrowing
  5031. ;; may have made some of this invisible.
  5032. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5033. (remove-text-properties (match-beginning 0) (match-end 0)
  5034. '(invisible nil))
  5035. (if (match-end 3)
  5036. (progn
  5037. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  5038. (org-rear-nonsticky-at (match-beginning 3))
  5039. (add-text-properties (match-beginning 3) (match-end 3) vp)
  5040. (org-rear-nonsticky-at (match-end 3))
  5041. (add-text-properties (match-end 3) (match-end 0) ip)
  5042. (org-rear-nonsticky-at (match-end 0)))
  5043. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  5044. (org-rear-nonsticky-at (match-beginning 1))
  5045. (add-text-properties (match-beginning 1) (match-end 1) vp)
  5046. (org-rear-nonsticky-at (match-end 1))
  5047. (add-text-properties (match-end 1) (match-end 0) ip)
  5048. (org-rear-nonsticky-at (match-end 0)))
  5049. t)))
  5050. (defun org-activate-dates (limit)
  5051. "Run through the buffer and add overlays to dates."
  5052. (if (re-search-forward org-tsr-regexp-both limit t)
  5053. (progn
  5054. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5055. (add-text-properties (match-beginning 0) (match-end 0)
  5056. (list 'mouse-face 'highlight
  5057. 'keymap org-mouse-map))
  5058. (org-rear-nonsticky-at (match-end 0))
  5059. (when org-display-custom-times
  5060. (if (match-end 3)
  5061. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5062. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5063. t)))
  5064. (defvar org-target-link-regexp nil
  5065. "Regular expression matching radio targets in plain text.")
  5066. (make-variable-buffer-local 'org-target-link-regexp)
  5067. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  5068. "Regular expression matching a link target.")
  5069. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  5070. "Regular expression matching a radio target.")
  5071. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  5072. "Regular expression matching any target.")
  5073. (defun org-activate-target-links (limit)
  5074. "Run through the buffer and add overlays to target matches."
  5075. (when org-target-link-regexp
  5076. (let ((case-fold-search t))
  5077. (if (re-search-forward org-target-link-regexp limit t)
  5078. (progn
  5079. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5080. (add-text-properties (match-beginning 0) (match-end 0)
  5081. (list 'mouse-face 'highlight
  5082. 'keymap org-mouse-map
  5083. 'help-echo "Radio target link"
  5084. 'org-linked-text t))
  5085. (org-rear-nonsticky-at (match-end 0))
  5086. t)))))
  5087. (defun org-update-radio-target-regexp ()
  5088. "Find all radio targets in this file and update the regular expression."
  5089. (interactive)
  5090. (when (memq 'radio org-activate-links)
  5091. (setq org-target-link-regexp
  5092. (org-make-target-link-regexp (org-all-targets 'radio)))
  5093. (org-restart-font-lock)))
  5094. (defun org-hide-wide-columns (limit)
  5095. (let (s e)
  5096. (setq s (text-property-any (point) (or limit (point-max))
  5097. 'org-cwidth t))
  5098. (when s
  5099. (setq e (next-single-property-change s 'org-cwidth))
  5100. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5101. (goto-char e)
  5102. t)))
  5103. (defvar org-latex-and-specials-regexp nil
  5104. "Regular expression for highlighting export special stuff.")
  5105. (defvar org-match-substring-regexp)
  5106. (defvar org-match-substring-with-braces-regexp)
  5107. ;; This should be with the exporter code, but we also use if for font-locking
  5108. (defconst org-export-html-special-string-regexps
  5109. '(("\\\\-" . "&shy;")
  5110. ("---\\([^-]\\)" . "&mdash;\\1")
  5111. ("--\\([^-]\\)" . "&ndash;\\1")
  5112. ("\\.\\.\\." . "&hellip;"))
  5113. "Regular expressions for special string conversion.")
  5114. (defun org-compute-latex-and-specials-regexp ()
  5115. "Compute regular expression for stuff treated specially by exporters."
  5116. (if (not org-highlight-latex-fragments-and-specials)
  5117. (org-set-local 'org-latex-and-specials-regexp nil)
  5118. (require 'org-exp)
  5119. (let*
  5120. ((matchers (plist-get org-format-latex-options :matchers))
  5121. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  5122. org-latex-regexps)))
  5123. (org-export-allow-BIND nil)
  5124. (options (org-combine-plists (org-default-export-plist)
  5125. (org-infile-export-plist)))
  5126. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  5127. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  5128. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  5129. (org-export-html-expand (plist-get options :expand-quoted-html))
  5130. (org-export-with-special-strings (plist-get options :special-strings))
  5131. (re-sub
  5132. (cond
  5133. ((equal org-export-with-sub-superscripts '{})
  5134. (list org-match-substring-with-braces-regexp))
  5135. (org-export-with-sub-superscripts
  5136. (list org-match-substring-regexp))))
  5137. (re-latex
  5138. (if org-export-with-LaTeX-fragments
  5139. (mapcar (lambda (x) (nth 1 x)) latexs)))
  5140. (re-macros
  5141. (if org-export-with-TeX-macros
  5142. (list (concat "\\\\"
  5143. (regexp-opt
  5144. (append
  5145. (delq nil
  5146. (mapcar 'car-safe
  5147. (append org-entities-user
  5148. org-entities)))
  5149. (if (boundp 'org-latex-entities)
  5150. (mapcar (lambda (x)
  5151. (or (car-safe x) x))
  5152. org-latex-entities)
  5153. nil))
  5154. 'words))) ; FIXME
  5155. ))
  5156. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  5157. (re-special (if org-export-with-special-strings
  5158. (mapcar (lambda (x) (car x))
  5159. org-export-html-special-string-regexps)))
  5160. (re-rest
  5161. (delq nil
  5162. (list
  5163. (if org-export-html-expand "@<[^>\n]+>")
  5164. ))))
  5165. (org-set-local
  5166. 'org-latex-and-specials-regexp
  5167. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  5168. re-rest) "\\|")))))
  5169. (defun org-do-latex-and-special-faces (limit)
  5170. "Run through the buffer and add overlays to links."
  5171. (when org-latex-and-specials-regexp
  5172. (let (rtn d)
  5173. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  5174. limit t))
  5175. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5176. 'face))
  5177. '(org-code org-verbatim underline)))
  5178. (progn
  5179. (setq rtn t
  5180. d (cond ((member (char-after (1+ (match-beginning 0)))
  5181. '(?_ ?^)) 1)
  5182. (t 0)))
  5183. (font-lock-prepend-text-property
  5184. (+ d (match-beginning 0)) (match-end 0)
  5185. 'face 'org-latex-and-export-specials)
  5186. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  5187. '(font-lock-multiline t)))))
  5188. rtn)))
  5189. (defun org-restart-font-lock ()
  5190. "Restart `font-lock-mode', to force refontification."
  5191. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5192. (font-lock-mode -1)
  5193. (font-lock-mode 1)))
  5194. (defun org-all-targets (&optional radio)
  5195. "Return a list of all targets in this file.
  5196. With optional argument RADIO, only find radio targets."
  5197. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  5198. rtn)
  5199. (save-excursion
  5200. (goto-char (point-min))
  5201. (while (re-search-forward re nil t)
  5202. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  5203. rtn)))
  5204. (defun org-make-target-link-regexp (targets)
  5205. "Make regular expression matching all strings in TARGETS.
  5206. The regular expression finds the targets also if there is a line break
  5207. between words."
  5208. (and targets
  5209. (concat
  5210. "\\<\\("
  5211. (mapconcat
  5212. (lambda (x)
  5213. (setq x (regexp-quote x))
  5214. (while (string-match " +" x)
  5215. (setq x (replace-match "\\s-+" t t x)))
  5216. x)
  5217. targets
  5218. "\\|")
  5219. "\\)\\>")))
  5220. (defun org-activate-tags (limit)
  5221. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5222. (progn
  5223. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5224. (add-text-properties (match-beginning 1) (match-end 1)
  5225. (list 'mouse-face 'highlight
  5226. 'keymap org-mouse-map))
  5227. (org-rear-nonsticky-at (match-end 1))
  5228. t)))
  5229. (defun org-outline-level ()
  5230. "Compute the outline level of the heading at point.
  5231. This function assumes that the cursor is at the beginning of a line matched
  5232. by `outline-regexp'. Otherwise it returns garbage.
  5233. If this is called at a normal headline, the level is the number of stars.
  5234. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5235. (save-excursion
  5236. (looking-at org-outline-regexp)
  5237. (1- (- (match-end 0) (match-beginning 0)))))
  5238. (defvar org-font-lock-keywords nil)
  5239. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  5240. "Regular expression matching a property line.")
  5241. (defvar org-font-lock-hook nil
  5242. "Functions to be called for special font lock stuff.")
  5243. (defvar org-font-lock-set-keywords-hook nil
  5244. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5245. This is called after `org-font-lock-extra-keywords' is defined, but before
  5246. it is installed to be used by font lock. This can be useful if something
  5247. needs to be inserted at a specific position in the font-lock sequence.")
  5248. (defun org-font-lock-hook (limit)
  5249. (run-hook-with-args 'org-font-lock-hook limit))
  5250. (defun org-set-font-lock-defaults ()
  5251. (let* ((em org-fontify-emphasized-text)
  5252. (lk org-activate-links)
  5253. (org-font-lock-extra-keywords
  5254. (list
  5255. ;; Call the hook
  5256. '(org-font-lock-hook)
  5257. ;; Headlines
  5258. `(,(if org-fontify-whole-heading-line
  5259. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5260. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5261. (1 (org-get-level-face 1))
  5262. (2 (org-get-level-face 2))
  5263. (3 (org-get-level-face 3)))
  5264. ;; Table lines
  5265. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5266. (1 'org-table t))
  5267. ;; Table internals
  5268. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5269. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5270. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5271. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5272. ;; Drawers
  5273. (list org-drawer-regexp '(0 'org-special-keyword t))
  5274. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5275. ;; Properties
  5276. (list org-property-re
  5277. '(1 'org-special-keyword t)
  5278. '(3 'org-property-value t))
  5279. ;; Links
  5280. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5281. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5282. (if (memq 'plain lk) '(org-activate-plain-links))
  5283. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5284. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5285. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5286. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5287. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5288. '(org-hide-wide-columns (0 nil append))
  5289. ;; TODO keyword
  5290. (list (format org-heading-keyword-regexp-format
  5291. org-todo-regexp)
  5292. '(2 (org-get-todo-face 2) t))
  5293. ;; DONE
  5294. (if org-fontify-done-headline
  5295. (list (format org-heading-keyword-regexp-format
  5296. (concat
  5297. "\\(?:"
  5298. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5299. "\\)"))
  5300. '(2 'org-headline-done t))
  5301. nil)
  5302. ;; Priorities
  5303. '(org-font-lock-add-priority-faces)
  5304. ;; Tags
  5305. '(org-font-lock-add-tag-faces)
  5306. ;; Special keywords
  5307. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5308. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5309. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5310. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5311. ;; Emphasis
  5312. (if em
  5313. (if (featurep 'xemacs)
  5314. '(org-do-emphasis-faces (0 nil append))
  5315. '(org-do-emphasis-faces)))
  5316. ;; Checkboxes
  5317. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5318. 1 'org-checkbox prepend)
  5319. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5320. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5321. (0 (org-get-checkbox-statistics-face) t)))
  5322. ;; Description list items
  5323. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5324. 1 'org-list-dt prepend)
  5325. ;; ARCHIVEd headings
  5326. (list (concat
  5327. org-outline-regexp-bol
  5328. "\\(.*:" org-archive-tag ":.*\\)")
  5329. '(1 'org-archived prepend))
  5330. ;; Specials
  5331. '(org-do-latex-and-special-faces)
  5332. '(org-fontify-entities)
  5333. '(org-raise-scripts)
  5334. ;; Code
  5335. '(org-activate-code (1 'org-code t))
  5336. ;; COMMENT
  5337. (list (format org-heading-keyword-regexp-format
  5338. (concat "\\("
  5339. org-comment-string "\\|" org-quote-string
  5340. "\\)"))
  5341. '(2 'org-special-keyword t))
  5342. ;; Blocks and meta lines
  5343. '(org-fontify-meta-lines-and-blocks)
  5344. )))
  5345. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5346. (run-hooks 'org-font-lock-set-keywords-hook)
  5347. ;; Now set the full font-lock-keywords
  5348. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5349. (org-set-local 'font-lock-defaults
  5350. '(org-font-lock-keywords t nil nil backward-paragraph))
  5351. (kill-local-variable 'font-lock-keywords) nil))
  5352. (defun org-toggle-pretty-entities ()
  5353. "Toggle the composition display of entities as UTF8 characters."
  5354. (interactive)
  5355. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5356. (org-restart-font-lock)
  5357. (if org-pretty-entities
  5358. (message "Entities are displayed as UTF8 characters")
  5359. (save-restriction
  5360. (widen)
  5361. (org-decompose-region (point-min) (point-max))
  5362. (message "Entities are displayed plain"))))
  5363. (defvar org-custom-properties-overlays nil
  5364. "List of overlays used for custom properties.")
  5365. (make-variable-buffer-local 'org-custom-properties-overlays)
  5366. (defun org-toggle-custom-properties-visibility ()
  5367. "Display or hide properties in `org-custom-properties'."
  5368. (interactive)
  5369. (if org-custom-properties-overlays
  5370. (progn (mapc 'delete-overlay org-custom-properties-overlays)
  5371. (setq org-custom-properties-overlays nil))
  5372. (unless (not org-custom-properties)
  5373. (save-excursion
  5374. (save-restriction
  5375. (widen)
  5376. (goto-char (point-min))
  5377. (while (re-search-forward org-property-re nil t)
  5378. (mapc (lambda(p)
  5379. (when (equal p (substring (match-string 1) 1 -1))
  5380. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5381. (overlay-put o 'invisible t)
  5382. (overlay-put o 'org-custom-property t)
  5383. (push o org-custom-properties-overlays))))
  5384. org-custom-properties)))))))
  5385. (defun org-fontify-entities (limit)
  5386. "Find an entity to fontify."
  5387. (let (ee)
  5388. (when org-pretty-entities
  5389. (catch 'match
  5390. (while (re-search-forward
  5391. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5392. limit t)
  5393. (if (and (not (org-in-indented-comment-line))
  5394. (setq ee (org-entity-get (match-string 1)))
  5395. (= (length (nth 6 ee)) 1))
  5396. (let*
  5397. ((end (if (equal (match-string 2) "{}")
  5398. (match-end 2)
  5399. (match-end 1))))
  5400. (add-text-properties
  5401. (match-beginning 0) end
  5402. (list 'font-lock-fontified t))
  5403. (compose-region (match-beginning 0) end
  5404. (nth 6 ee) nil)
  5405. (backward-char 1)
  5406. (throw 'match t))))
  5407. nil))))
  5408. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5409. "Fontify string S like in Org-mode."
  5410. (with-temp-buffer
  5411. (insert s)
  5412. (let ((org-odd-levels-only odd-levels))
  5413. (org-mode)
  5414. (font-lock-fontify-buffer)
  5415. (buffer-string))))
  5416. (defvar org-m nil)
  5417. (defvar org-l nil)
  5418. (defvar org-f nil)
  5419. (defun org-get-level-face (n)
  5420. "Get the right face for match N in font-lock matching of headlines."
  5421. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5422. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5423. (if org-cycle-level-faces
  5424. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5425. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5426. (cond
  5427. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5428. ((eq n 2) org-f)
  5429. (t (if org-level-color-stars-only nil org-f))))
  5430. (defun org-get-todo-face (kwd)
  5431. "Get the right face for a TODO keyword KWD.
  5432. If KWD is a number, get the corresponding match group."
  5433. (if (numberp kwd) (setq kwd (match-string kwd)))
  5434. (or (org-face-from-face-or-color
  5435. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5436. (and (member kwd org-done-keywords) 'org-done)
  5437. 'org-todo))
  5438. (defun org-face-from-face-or-color (context inherit face-or-color)
  5439. "Create a face list that inherits INHERIT, but sets the foreground color.
  5440. When FACE-OR-COLOR is not a string, just return it."
  5441. (if (stringp face-or-color)
  5442. (list :inherit inherit
  5443. (cdr (assoc context org-faces-easy-properties))
  5444. face-or-color)
  5445. face-or-color))
  5446. (defun org-font-lock-add-tag-faces (limit)
  5447. "Add the special tag faces."
  5448. (when (and org-tag-faces org-tags-special-faces-re)
  5449. (while (re-search-forward org-tags-special-faces-re limit t)
  5450. (add-text-properties (match-beginning 1) (match-end 1)
  5451. (list 'face (org-get-tag-face 1)
  5452. 'font-lock-fontified t))
  5453. (backward-char 1))))
  5454. (defun org-font-lock-add-priority-faces (limit)
  5455. "Add the special priority faces."
  5456. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5457. (when (save-match-data (org-at-heading-p))
  5458. (add-text-properties
  5459. (match-beginning 0) (match-end 0)
  5460. (list 'face (or (org-face-from-face-or-color
  5461. 'priority 'org-special-keyword
  5462. (cdr (assoc (char-after (match-beginning 1))
  5463. org-priority-faces)))
  5464. 'org-special-keyword)
  5465. 'font-lock-fontified t)))))
  5466. (defun org-get-tag-face (kwd)
  5467. "Get the right face for a TODO keyword KWD.
  5468. If KWD is a number, get the corresponding match group."
  5469. (if (numberp kwd) (setq kwd (match-string kwd)))
  5470. (or (org-face-from-face-or-color
  5471. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5472. 'org-tag))
  5473. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5474. "Remove fontification and activation overlays from links."
  5475. (font-lock-default-unfontify-region beg end)
  5476. (let* ((buffer-undo-list t)
  5477. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5478. (inhibit-modification-hooks t)
  5479. deactivate-mark buffer-file-name buffer-file-truename)
  5480. (org-decompose-region beg end)
  5481. (remove-text-properties beg end
  5482. '(mouse-face t keymap t org-linked-text t
  5483. invisible t intangible t
  5484. org-no-flyspell t org-emphasis t))
  5485. (org-remove-font-lock-display-properties beg end)))
  5486. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5487. ((raise 0.3) (height 0.7))
  5488. ((raise -0.5))
  5489. ((raise 0.5)))
  5490. "Display properties for showing superscripts and subscripts.")
  5491. (defun org-remove-font-lock-display-properties (beg end)
  5492. "Remove specific display properties that have been added by font lock.
  5493. The will remove the raise properties that are used to show superscripts
  5494. and subscripts."
  5495. (let (next prop)
  5496. (while (< beg end)
  5497. (setq next (next-single-property-change beg 'display nil end)
  5498. prop (get-text-property beg 'display))
  5499. (if (member prop org-script-display)
  5500. (put-text-property beg next 'display nil))
  5501. (setq beg next))))
  5502. (defun org-raise-scripts (limit)
  5503. "Add raise properties to sub/superscripts."
  5504. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5505. (if (re-search-forward
  5506. (if (eq org-use-sub-superscripts t)
  5507. org-match-substring-regexp
  5508. org-match-substring-with-braces-regexp)
  5509. limit t)
  5510. (let* ((pos (point)) table-p comment-p
  5511. (mpos (match-beginning 3))
  5512. (emph-p (get-text-property mpos 'org-emphasis))
  5513. (link-p (get-text-property mpos 'mouse-face))
  5514. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5515. (goto-char (point-at-bol))
  5516. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5517. comment-p (org-looking-at-p "[ \t]*#"))
  5518. (goto-char pos)
  5519. ;; FIXME: Should we go back one character here, for a_b^c
  5520. ;; (goto-char (1- pos)) ;????????????????????
  5521. (if (or comment-p emph-p link-p keyw-p)
  5522. t
  5523. (put-text-property (match-beginning 3) (match-end 0)
  5524. 'display
  5525. (if (equal (char-after (match-beginning 2)) ?^)
  5526. (nth (if table-p 3 1) org-script-display)
  5527. (nth (if table-p 2 0) org-script-display)))
  5528. (add-text-properties (match-beginning 2) (match-end 2)
  5529. (list 'invisible t
  5530. 'org-dwidth t 'org-dwidth-n 1))
  5531. (if (and (eq (char-after (match-beginning 3)) ?{)
  5532. (eq (char-before (match-end 3)) ?}))
  5533. (progn
  5534. (add-text-properties
  5535. (match-beginning 3) (1+ (match-beginning 3))
  5536. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5537. (add-text-properties
  5538. (1- (match-end 3)) (match-end 3)
  5539. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5540. t)))))
  5541. ;;;; Visibility cycling, including org-goto and indirect buffer
  5542. ;;; Cycling
  5543. (defvar org-cycle-global-status nil)
  5544. (make-variable-buffer-local 'org-cycle-global-status)
  5545. (defvar org-cycle-subtree-status nil)
  5546. (make-variable-buffer-local 'org-cycle-subtree-status)
  5547. ;;;###autoload
  5548. (defvar org-inlinetask-min-level)
  5549. (defun org-cycle (&optional arg)
  5550. "TAB-action and visibility cycling for Org-mode.
  5551. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5552. is outline visibility cycling, but it also invokes other actions
  5553. in special contexts.
  5554. - When this function is called with a prefix argument, rotate the entire
  5555. buffer through 3 states (global cycling)
  5556. 1. OVERVIEW: Show only top-level headlines.
  5557. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5558. 3. SHOW ALL: Show everything.
  5559. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5560. determined by the variable `org-startup-folded', and by any VISIBILITY
  5561. properties in the buffer.
  5562. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5563. including any drawers.
  5564. - When inside a table, re-align the table and move to the next field.
  5565. - When point is at the beginning of a headline, rotate the subtree started
  5566. by this line through 3 different states (local cycling)
  5567. 1. FOLDED: Only the main headline is shown.
  5568. 2. CHILDREN: The main headline and the direct children are shown.
  5569. From this state, you can move to one of the children
  5570. and zoom in further.
  5571. 3. SUBTREE: Show the entire subtree, including body text.
  5572. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5573. - When point is at the beginning of an empty headline and the variable
  5574. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5575. of the headline by demoting and promoting it to likely levels. This
  5576. speeds up creation document structure by pressing TAB once or several
  5577. times right after creating a new headline.
  5578. - When there is a numeric prefix, go up to a heading with level ARG, do
  5579. a `show-subtree' and return to the previous cursor position. If ARG
  5580. is negative, go up that many levels.
  5581. - When point is not at the beginning of a headline, execute the global
  5582. binding for TAB, which is re-indenting the line. See the option
  5583. `org-cycle-emulate-tab' for details.
  5584. - Special case: if point is at the beginning of the buffer and there is
  5585. no headline in line 1, this function will act as if called with prefix arg
  5586. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5587. But only if also the variable `org-cycle-global-at-bob' is t."
  5588. (interactive "P")
  5589. (org-load-modules-maybe)
  5590. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5591. (and org-cycle-level-after-item/entry-creation
  5592. (or (org-cycle-level)
  5593. (org-cycle-item-indentation))))
  5594. (let* ((limit-level
  5595. (or org-cycle-max-level
  5596. (and (boundp 'org-inlinetask-min-level)
  5597. org-inlinetask-min-level
  5598. (1- org-inlinetask-min-level))))
  5599. (nstars (and limit-level
  5600. (if org-odd-levels-only
  5601. (and limit-level (1- (* limit-level 2)))
  5602. limit-level)))
  5603. (org-outline-regexp
  5604. (if (not (derived-mode-p 'org-mode))
  5605. outline-regexp
  5606. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5607. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5608. (not (looking-at org-outline-regexp))))
  5609. (org-cycle-hook
  5610. (if bob-special
  5611. (delq 'org-optimize-window-after-visibility-change
  5612. (copy-sequence org-cycle-hook))
  5613. org-cycle-hook))
  5614. (pos (point)))
  5615. (if (or bob-special (equal arg '(4)))
  5616. ;; special case: use global cycling
  5617. (setq arg t))
  5618. (cond
  5619. ((equal arg '(16))
  5620. (setq last-command 'dummy)
  5621. (org-set-startup-visibility)
  5622. (message "Startup visibility, plus VISIBILITY properties"))
  5623. ((equal arg '(64))
  5624. (show-all)
  5625. (message "Entire buffer visible, including drawers"))
  5626. ;; Table: enter it or move to the next field.
  5627. ((org-at-table-p 'any)
  5628. (if (org-at-table.el-p)
  5629. (message "Use C-c ' to edit table.el tables")
  5630. (if arg (org-table-edit-field t)
  5631. (org-table-justify-field-maybe)
  5632. (call-interactively 'org-table-next-field))))
  5633. ((run-hook-with-args-until-success
  5634. 'org-tab-after-check-for-table-hook))
  5635. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5636. ((eq arg t) (org-cycle-internal-global))
  5637. ;; Drawers: delegate to `org-flag-drawer'.
  5638. ((and org-drawers org-drawer-regexp
  5639. (save-excursion
  5640. (beginning-of-line 1)
  5641. (looking-at org-drawer-regexp)))
  5642. (org-flag-drawer ; toggle block visibility
  5643. (not (get-char-property (match-end 0) 'invisible))))
  5644. ;; Show-subtree, ARG levels up from here.
  5645. ((integerp arg)
  5646. (save-excursion
  5647. (org-back-to-heading)
  5648. (outline-up-heading (if (< arg 0) (- arg)
  5649. (- (funcall outline-level) arg)))
  5650. (org-show-subtree)))
  5651. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5652. ((and (featurep 'org-inlinetask)
  5653. (org-inlinetask-at-task-p)
  5654. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5655. (org-inlinetask-toggle-visibility))
  5656. ((org-try-cdlatex-tab))
  5657. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5658. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5659. (save-excursion (beginning-of-line 1)
  5660. (looking-at org-outline-regexp)))
  5661. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5662. (org-cycle-internal-local))
  5663. ;; From there: TAB emulation and template completion.
  5664. (buffer-read-only (org-back-to-heading))
  5665. ((run-hook-with-args-until-success
  5666. 'org-tab-after-check-for-cycling-hook))
  5667. ((org-try-structure-completion))
  5668. ((run-hook-with-args-until-success
  5669. 'org-tab-before-tab-emulation-hook))
  5670. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5671. (or (not (bolp))
  5672. (not (looking-at org-outline-regexp))))
  5673. (call-interactively (global-key-binding "\t")))
  5674. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5675. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5676. (or (and (eq org-cycle-emulate-tab 'white)
  5677. (= (match-end 0) (point-at-eol)))
  5678. (and (eq org-cycle-emulate-tab 'whitestart)
  5679. (>= (match-end 0) pos))))
  5680. t
  5681. (eq org-cycle-emulate-tab t))
  5682. (call-interactively (global-key-binding "\t")))
  5683. (t (save-excursion
  5684. (org-back-to-heading)
  5685. (org-cycle)))))))
  5686. (defun org-cycle-internal-global ()
  5687. "Do the global cycling action."
  5688. ;; Hack to avoid display of messages for .org attachments in Gnus
  5689. (let ((ga (string-match "\\*fontification" (buffer-name))))
  5690. (cond
  5691. ((and (eq last-command this-command)
  5692. (eq org-cycle-global-status 'overview))
  5693. ;; We just created the overview - now do table of contents
  5694. ;; This can be slow in very large buffers, so indicate action
  5695. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5696. (unless ga (message "CONTENTS..."))
  5697. (org-content)
  5698. (unless ga (message "CONTENTS...done"))
  5699. (setq org-cycle-global-status 'contents)
  5700. (run-hook-with-args 'org-cycle-hook 'contents))
  5701. ((and (eq last-command this-command)
  5702. (eq org-cycle-global-status 'contents))
  5703. ;; We just showed the table of contents - now show everything
  5704. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5705. (show-all)
  5706. (unless ga (message "SHOW ALL"))
  5707. (setq org-cycle-global-status 'all)
  5708. (run-hook-with-args 'org-cycle-hook 'all))
  5709. (t
  5710. ;; Default action: go to overview
  5711. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5712. (org-overview)
  5713. (unless ga (message "OVERVIEW"))
  5714. (setq org-cycle-global-status 'overview)
  5715. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5716. (defun org-cycle-internal-local ()
  5717. "Do the local cycling action."
  5718. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5719. ;; First, determine end of headline (EOH), end of subtree or item
  5720. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5721. (save-excursion
  5722. (if (org-at-item-p)
  5723. (progn
  5724. (beginning-of-line)
  5725. (setq struct (org-list-struct))
  5726. (setq eoh (point-at-eol))
  5727. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5728. (setq has-children (org-list-has-child-p (point) struct)))
  5729. (org-back-to-heading)
  5730. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5731. (setq eos (save-excursion
  5732. (org-end-of-subtree t)
  5733. (unless (eobp)
  5734. (skip-chars-forward " \t\n"))
  5735. (if (eobp) (point) (1- (point)))))
  5736. (setq has-children
  5737. (or (save-excursion
  5738. (let ((level (funcall outline-level)))
  5739. (outline-next-heading)
  5740. (and (org-at-heading-p t)
  5741. (> (funcall outline-level) level))))
  5742. (save-excursion
  5743. (org-list-search-forward (org-item-beginning-re) eos t)))))
  5744. ;; Determine end invisible part of buffer (EOL)
  5745. (beginning-of-line 2)
  5746. ;; XEmacs doesn't have `next-single-char-property-change'
  5747. (if (featurep 'xemacs)
  5748. (while (and (not (eobp)) ;; this is like `next-line'
  5749. (get-char-property (1- (point)) 'invisible))
  5750. (beginning-of-line 2))
  5751. (while (and (not (eobp)) ;; this is like `next-line'
  5752. (get-char-property (1- (point)) 'invisible))
  5753. (goto-char (next-single-char-property-change (point) 'invisible))
  5754. (and (eolp) (beginning-of-line 2))))
  5755. (setq eol (point)))
  5756. ;; Find out what to do next and set `this-command'
  5757. (cond
  5758. ((= eos eoh)
  5759. ;; Nothing is hidden behind this heading
  5760. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5761. (message "EMPTY ENTRY")
  5762. (setq org-cycle-subtree-status nil)
  5763. (save-excursion
  5764. (goto-char eos)
  5765. (outline-next-heading)
  5766. (if (outline-invisible-p) (org-flag-heading nil))))
  5767. ((and (or (>= eol eos)
  5768. (not (string-match "\\S-" (buffer-substring eol eos))))
  5769. (or has-children
  5770. (not (setq children-skipped
  5771. org-cycle-skip-children-state-if-no-children))))
  5772. ;; Entire subtree is hidden in one line: children view
  5773. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5774. (if (org-at-item-p)
  5775. (org-list-set-item-visibility (point-at-bol) struct 'children)
  5776. (org-show-entry)
  5777. (org-with-limited-levels (show-children))
  5778. ;; FIXME: This slows down the func way too much.
  5779. ;; How keep drawers hidden in subtree anyway?
  5780. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  5781. ;; (org-cycle-hide-drawers 'subtree))
  5782. ;; Fold every list in subtree to top-level items.
  5783. (when (eq org-cycle-include-plain-lists 'integrate)
  5784. (save-excursion
  5785. (org-back-to-heading)
  5786. (while (org-list-search-forward (org-item-beginning-re) eos t)
  5787. (beginning-of-line 1)
  5788. (let* ((struct (org-list-struct))
  5789. (prevs (org-list-prevs-alist struct))
  5790. (end (org-list-get-bottom-point struct)))
  5791. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  5792. (org-list-get-all-items (point) struct prevs))
  5793. (goto-char end))))))
  5794. (message "CHILDREN")
  5795. (save-excursion
  5796. (goto-char eos)
  5797. (outline-next-heading)
  5798. (if (outline-invisible-p) (org-flag-heading nil)))
  5799. (setq org-cycle-subtree-status 'children)
  5800. (run-hook-with-args 'org-cycle-hook 'children))
  5801. ((or children-skipped
  5802. (and (eq last-command this-command)
  5803. (eq org-cycle-subtree-status 'children)))
  5804. ;; We just showed the children, or no children are there,
  5805. ;; now show everything.
  5806. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5807. (outline-flag-region eoh eos nil)
  5808. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5809. (setq org-cycle-subtree-status 'subtree)
  5810. (run-hook-with-args 'org-cycle-hook 'subtree))
  5811. (t
  5812. ;; Default action: hide the subtree.
  5813. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5814. (outline-flag-region eoh eos t)
  5815. (message "FOLDED")
  5816. (setq org-cycle-subtree-status 'folded)
  5817. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5818. ;;;###autoload
  5819. (defun org-global-cycle (&optional arg)
  5820. "Cycle the global visibility. For details see `org-cycle'.
  5821. With \\[universal-argument] prefix arg, switch to startup visibility.
  5822. With a numeric prefix, show all headlines up to that level."
  5823. (interactive "P")
  5824. (let ((org-cycle-include-plain-lists
  5825. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  5826. (cond
  5827. ((integerp arg)
  5828. (show-all)
  5829. (hide-sublevels arg)
  5830. (setq org-cycle-global-status 'contents))
  5831. ((equal arg '(4))
  5832. (org-set-startup-visibility)
  5833. (message "Startup visibility, plus VISIBILITY properties."))
  5834. (t
  5835. (org-cycle '(4))))))
  5836. (defun org-set-startup-visibility ()
  5837. "Set the visibility required by startup options and properties."
  5838. (cond
  5839. ((eq org-startup-folded t)
  5840. (org-cycle '(4)))
  5841. ((eq org-startup-folded 'content)
  5842. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5843. (org-cycle '(4)) (org-cycle '(4)))))
  5844. (unless (eq org-startup-folded 'showeverything)
  5845. (if org-hide-block-startup (org-hide-block-all))
  5846. (org-set-visibility-according-to-property 'no-cleanup)
  5847. (org-cycle-hide-archived-subtrees 'all)
  5848. (org-cycle-hide-drawers 'all)
  5849. (org-cycle-show-empty-lines t)))
  5850. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5851. "Switch subtree visibilities according to :VISIBILITY: property."
  5852. (interactive)
  5853. (let (org-show-entry-below state)
  5854. (save-excursion
  5855. (goto-char (point-min))
  5856. (while (re-search-forward
  5857. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5858. nil t)
  5859. (setq state (match-string 1))
  5860. (save-excursion
  5861. (org-back-to-heading t)
  5862. (hide-subtree)
  5863. (org-reveal)
  5864. (cond
  5865. ((equal state '("fold" "folded"))
  5866. (hide-subtree))
  5867. ((equal state "children")
  5868. (org-show-hidden-entry)
  5869. (show-children))
  5870. ((equal state "content")
  5871. (save-excursion
  5872. (save-restriction
  5873. (org-narrow-to-subtree)
  5874. (org-content))))
  5875. ((member state '("all" "showall"))
  5876. (show-subtree)))))
  5877. (unless no-cleanup
  5878. (org-cycle-hide-archived-subtrees 'all)
  5879. (org-cycle-hide-drawers 'all)
  5880. (org-cycle-show-empty-lines 'all)))))
  5881. ;; This function uses outline-regexp instead of the more fundamental
  5882. ;; org-outline-regexp so that org-cycle-global works outside of Org
  5883. ;; buffers, where outline-regexp is needed.
  5884. (defun org-overview ()
  5885. "Switch to overview mode, showing only top-level headlines.
  5886. Really, this shows all headlines with level equal or greater than the level
  5887. of the first headline in the buffer. This is important, because if the
  5888. first headline is not level one, then (hide-sublevels 1) gives confusing
  5889. results."
  5890. (interactive)
  5891. (let ((level (save-excursion
  5892. (goto-char (point-min))
  5893. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5894. (progn
  5895. (goto-char (match-beginning 0))
  5896. (funcall outline-level))))))
  5897. (and level (hide-sublevels level))))
  5898. (defun org-content (&optional arg)
  5899. "Show all headlines in the buffer, like a table of contents.
  5900. With numerical argument N, show content up to level N."
  5901. (interactive "P")
  5902. (save-excursion
  5903. ;; Visit all headings and show their offspring
  5904. (and (integerp arg) (org-overview))
  5905. (goto-char (point-max))
  5906. (catch 'exit
  5907. (while (and (progn (condition-case nil
  5908. (outline-previous-visible-heading 1)
  5909. (error (goto-char (point-min))))
  5910. t)
  5911. (looking-at org-outline-regexp))
  5912. (if (integerp arg)
  5913. (show-children (1- arg))
  5914. (show-branches))
  5915. (if (bobp) (throw 'exit nil))))))
  5916. (defun org-optimize-window-after-visibility-change (state)
  5917. "Adjust the window after a change in outline visibility.
  5918. This function is the default value of the hook `org-cycle-hook'."
  5919. (when (get-buffer-window (current-buffer))
  5920. (cond
  5921. ((eq state 'content) nil)
  5922. ((eq state 'all) nil)
  5923. ((eq state 'folded) nil)
  5924. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5925. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5926. (defun org-remove-empty-overlays-at (pos)
  5927. "Remove outline overlays that do not contain non-white stuff."
  5928. (mapc
  5929. (lambda (o)
  5930. (and (eq 'outline (overlay-get o 'invisible))
  5931. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5932. (overlay-end o))))
  5933. (delete-overlay o)))
  5934. (overlays-at pos)))
  5935. (defun org-clean-visibility-after-subtree-move ()
  5936. "Fix visibility issues after moving a subtree."
  5937. ;; First, find a reasonable region to look at:
  5938. ;; Start two siblings above, end three below
  5939. (let* ((beg (save-excursion
  5940. (and (org-get-last-sibling)
  5941. (org-get-last-sibling))
  5942. (point)))
  5943. (end (save-excursion
  5944. (and (org-get-next-sibling)
  5945. (org-get-next-sibling)
  5946. (org-get-next-sibling))
  5947. (if (org-at-heading-p)
  5948. (point-at-eol)
  5949. (point))))
  5950. (level (looking-at "\\*+"))
  5951. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5952. (save-excursion
  5953. (save-restriction
  5954. (narrow-to-region beg end)
  5955. (when re
  5956. ;; Properly fold already folded siblings
  5957. (goto-char (point-min))
  5958. (while (re-search-forward re nil t)
  5959. (if (and (not (outline-invisible-p))
  5960. (save-excursion
  5961. (goto-char (point-at-eol)) (outline-invisible-p)))
  5962. (hide-entry))))
  5963. (org-cycle-show-empty-lines 'overview)
  5964. (org-cycle-hide-drawers 'overview)))))
  5965. (defun org-cycle-show-empty-lines (state)
  5966. "Show empty lines above all visible headlines.
  5967. The region to be covered depends on STATE when called through
  5968. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5969. entire buffer covered. Note that an empty line is only shown if there
  5970. are at least `org-cycle-separator-lines' empty lines before the headline."
  5971. (when (not (= org-cycle-separator-lines 0))
  5972. (save-excursion
  5973. (let* ((n (abs org-cycle-separator-lines))
  5974. (re (cond
  5975. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5976. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5977. (t (let ((ns (number-to-string (- n 2))))
  5978. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5979. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5980. beg end b e)
  5981. (cond
  5982. ((memq state '(overview contents t))
  5983. (setq beg (point-min) end (point-max)))
  5984. ((memq state '(children folded))
  5985. (setq beg (point) end (progn (org-end-of-subtree t t)
  5986. (beginning-of-line 2)
  5987. (point)))))
  5988. (when beg
  5989. (goto-char beg)
  5990. (while (re-search-forward re end t)
  5991. (unless (get-char-property (match-end 1) 'invisible)
  5992. (setq e (match-end 1))
  5993. (if (< org-cycle-separator-lines 0)
  5994. (setq b (save-excursion
  5995. (goto-char (match-beginning 0))
  5996. (org-back-over-empty-lines)
  5997. (if (save-excursion
  5998. (goto-char (max (point-min) (1- (point))))
  5999. (org-at-heading-p))
  6000. (1- (point))
  6001. (point))))
  6002. (setq b (match-beginning 1)))
  6003. (outline-flag-region b e nil)))))))
  6004. ;; Never hide empty lines at the end of the file.
  6005. (save-excursion
  6006. (goto-char (point-max))
  6007. (outline-previous-heading)
  6008. (outline-end-of-heading)
  6009. (if (and (looking-at "[ \t\n]+")
  6010. (= (match-end 0) (point-max)))
  6011. (outline-flag-region (point) (match-end 0) nil))))
  6012. (defun org-show-empty-lines-in-parent ()
  6013. "Move to the parent and re-show empty lines before visible headlines."
  6014. (save-excursion
  6015. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  6016. (org-cycle-show-empty-lines context))))
  6017. (defun org-files-list ()
  6018. "Return `org-agenda-files' list, plus all open org-mode files.
  6019. This is useful for operations that need to scan all of a user's
  6020. open and agenda-wise Org files."
  6021. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  6022. (dolist (buf (buffer-list))
  6023. (with-current-buffer buf
  6024. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  6025. (let ((file (expand-file-name (buffer-file-name))))
  6026. (unless (member file files)
  6027. (push file files))))))
  6028. files))
  6029. (defsubst org-entry-beginning-position ()
  6030. "Return the beginning position of the current entry."
  6031. (save-excursion (outline-back-to-heading t) (point)))
  6032. (defsubst org-entry-end-position ()
  6033. "Return the end position of the current entry."
  6034. (save-excursion (outline-next-heading) (point)))
  6035. (defun org-cycle-hide-drawers (state)
  6036. "Re-hide all drawers after a visibility state change."
  6037. (when (and (derived-mode-p 'org-mode)
  6038. (not (memq state '(overview folded contents))))
  6039. (save-excursion
  6040. (let* ((globalp (memq state '(contents all)))
  6041. (beg (if globalp (point-min) (point)))
  6042. (end (if globalp (point-max)
  6043. (if (eq state 'children)
  6044. (save-excursion (outline-next-heading) (point))
  6045. (org-end-of-subtree t)))))
  6046. (goto-char beg)
  6047. (while (re-search-forward org-drawer-regexp end t)
  6048. (org-flag-drawer t))))))
  6049. (defun org-flag-drawer (flag)
  6050. "When FLAG is non-nil, hide the drawer we are within.
  6051. Otherwise make it visible."
  6052. (save-excursion
  6053. (beginning-of-line 1)
  6054. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  6055. (let ((b (match-end 0)))
  6056. (if (re-search-forward
  6057. "^[ \t]*:END:"
  6058. (save-excursion (outline-next-heading) (point)) t)
  6059. (outline-flag-region b (point-at-eol) flag)
  6060. (error ":END: line missing at position %s" b))))))
  6061. (defun org-subtree-end-visible-p ()
  6062. "Is the end of the current subtree visible?"
  6063. (pos-visible-in-window-p
  6064. (save-excursion (org-end-of-subtree t) (point))))
  6065. (defun org-first-headline-recenter (&optional N)
  6066. "Move cursor to the first headline and recenter the headline.
  6067. Optional argument N means put the headline into the Nth line of the window."
  6068. (goto-char (point-min))
  6069. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6070. (beginning-of-line)
  6071. (recenter (prefix-numeric-value N))))
  6072. ;;; Saving and restoring visibility
  6073. (defun org-outline-overlay-data (&optional use-markers)
  6074. "Return a list of the locations of all outline overlays.
  6075. These are overlays with the `invisible' property value `outline'.
  6076. The return value is a list of cons cells, with start and stop
  6077. positions for each overlay.
  6078. If USE-MARKERS is set, return the positions as markers."
  6079. (let (beg end)
  6080. (save-excursion
  6081. (save-restriction
  6082. (widen)
  6083. (delq nil
  6084. (mapcar (lambda (o)
  6085. (when (eq (overlay-get o 'invisible) 'outline)
  6086. (setq beg (overlay-start o)
  6087. end (overlay-end o))
  6088. (and beg end (> end beg)
  6089. (if use-markers
  6090. (cons (move-marker (make-marker) beg)
  6091. (move-marker (make-marker) end))
  6092. (cons beg end)))))
  6093. (overlays-in (point-min) (point-max))))))))
  6094. (defun org-set-outline-overlay-data (data)
  6095. "Create visibility overlays for all positions in DATA.
  6096. DATA should have been made by `org-outline-overlay-data'."
  6097. (let (o)
  6098. (save-excursion
  6099. (save-restriction
  6100. (widen)
  6101. (show-all)
  6102. (mapc (lambda (c)
  6103. (outline-flag-region (car c) (cdr c) t))
  6104. data)))))
  6105. ;;; Folding of blocks
  6106. (defvar org-hide-block-overlays nil
  6107. "Overlays hiding blocks.")
  6108. (make-variable-buffer-local 'org-hide-block-overlays)
  6109. (defun org-block-map (function &optional start end)
  6110. "Call FUNCTION at the head of all source blocks in the current buffer.
  6111. Optional arguments START and END can be used to limit the range."
  6112. (let ((start (or start (point-min)))
  6113. (end (or end (point-max))))
  6114. (save-excursion
  6115. (goto-char start)
  6116. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6117. (save-excursion
  6118. (save-match-data
  6119. (goto-char (match-beginning 0))
  6120. (funcall function)))))))
  6121. (defun org-hide-block-toggle-all ()
  6122. "Toggle the visibility of all blocks in the current buffer."
  6123. (org-block-map #'org-hide-block-toggle))
  6124. (defun org-hide-block-all ()
  6125. "Fold all blocks in the current buffer."
  6126. (interactive)
  6127. (org-show-block-all)
  6128. (org-block-map #'org-hide-block-toggle-maybe))
  6129. (defun org-show-block-all ()
  6130. "Unfold all blocks in the current buffer."
  6131. (interactive)
  6132. (mapc 'delete-overlay org-hide-block-overlays)
  6133. (setq org-hide-block-overlays nil))
  6134. (defun org-hide-block-toggle-maybe ()
  6135. "Toggle visibility of block at point."
  6136. (interactive)
  6137. (let ((case-fold-search t))
  6138. (if (save-excursion
  6139. (beginning-of-line 1)
  6140. (looking-at org-block-regexp))
  6141. (progn (org-hide-block-toggle)
  6142. t) ;; to signal that we took action
  6143. nil))) ;; to signal that we did not
  6144. (defun org-hide-block-toggle (&optional force)
  6145. "Toggle the visibility of the current block."
  6146. (interactive)
  6147. (save-excursion
  6148. (beginning-of-line)
  6149. (if (re-search-forward org-block-regexp nil t)
  6150. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6151. (end (match-end 0)) ;; end of entire body
  6152. ov)
  6153. (if (memq t (mapcar (lambda (overlay)
  6154. (eq (overlay-get overlay 'invisible)
  6155. 'org-hide-block))
  6156. (overlays-at start)))
  6157. (if (or (not force) (eq force 'off))
  6158. (mapc (lambda (ov)
  6159. (when (member ov org-hide-block-overlays)
  6160. (setq org-hide-block-overlays
  6161. (delq ov org-hide-block-overlays)))
  6162. (when (eq (overlay-get ov 'invisible)
  6163. 'org-hide-block)
  6164. (delete-overlay ov)))
  6165. (overlays-at start)))
  6166. (setq ov (make-overlay start end))
  6167. (overlay-put ov 'invisible 'org-hide-block)
  6168. ;; make the block accessible to isearch
  6169. (overlay-put
  6170. ov 'isearch-open-invisible
  6171. (lambda (ov)
  6172. (when (member ov org-hide-block-overlays)
  6173. (setq org-hide-block-overlays
  6174. (delq ov org-hide-block-overlays)))
  6175. (when (eq (overlay-get ov 'invisible)
  6176. 'org-hide-block)
  6177. (delete-overlay ov))))
  6178. (push ov org-hide-block-overlays)))
  6179. (error "Not looking at a source block"))))
  6180. ;; org-tab-after-check-for-cycling-hook
  6181. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6182. ;; Remove overlays when changing major mode
  6183. (add-hook 'org-mode-hook
  6184. (lambda () (org-add-hook 'change-major-mode-hook
  6185. 'org-show-block-all 'append 'local)))
  6186. ;;; Org-goto
  6187. (defvar org-goto-window-configuration nil)
  6188. (defvar org-goto-marker nil)
  6189. (defvar org-goto-map
  6190. (let ((map (make-sparse-keymap)))
  6191. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  6192. (while (setq cmd (pop cmds))
  6193. (substitute-key-definition cmd cmd map global-map)))
  6194. (suppress-keymap map)
  6195. (org-defkey map "\C-m" 'org-goto-ret)
  6196. (org-defkey map [(return)] 'org-goto-ret)
  6197. (org-defkey map [(left)] 'org-goto-left)
  6198. (org-defkey map [(right)] 'org-goto-right)
  6199. (org-defkey map [(control ?g)] 'org-goto-quit)
  6200. (org-defkey map "\C-i" 'org-cycle)
  6201. (org-defkey map [(tab)] 'org-cycle)
  6202. (org-defkey map [(down)] 'outline-next-visible-heading)
  6203. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6204. (if org-goto-auto-isearch
  6205. (if (fboundp 'define-key-after)
  6206. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6207. nil)
  6208. (org-defkey map "q" 'org-goto-quit)
  6209. (org-defkey map "n" 'outline-next-visible-heading)
  6210. (org-defkey map "p" 'outline-previous-visible-heading)
  6211. (org-defkey map "f" 'outline-forward-same-level)
  6212. (org-defkey map "b" 'outline-backward-same-level)
  6213. (org-defkey map "u" 'outline-up-heading))
  6214. (org-defkey map "/" 'org-occur)
  6215. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6216. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6217. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6218. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6219. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6220. map))
  6221. (defconst org-goto-help
  6222. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  6223. RET=jump to location [Q]uit and return to previous location
  6224. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6225. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6226. ;; FIXME: Docstring does not mention both interfaces
  6227. (defun org-goto (&optional alternative-interface)
  6228. "Look up a different location in the current file, keeping current visibility.
  6229. When you want look-up or go to a different location in a
  6230. document, the fastest way is often to fold the entire buffer and
  6231. then dive into the tree. This method has the disadvantage, that
  6232. the previous location will be folded, which may not be what you
  6233. want.
  6234. This command works around this by showing a copy of the current
  6235. buffer in an indirect buffer, in overview mode. You can dive
  6236. into the tree in that copy, use org-occur and incremental search
  6237. to find a location. When pressing RET or `Q', the command
  6238. returns to the original buffer in which the visibility is still
  6239. unchanged. After RET it will also jump to the location selected
  6240. in the indirect buffer and expose the headline hierarchy above.
  6241. With a prefix argument, use the alternative interface: e.g. if
  6242. `org-goto-interface' is 'outline use 'outline-path-completion."
  6243. (interactive "P")
  6244. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6245. (org-refile-use-outline-path t)
  6246. (org-refile-target-verify-function nil)
  6247. (interface
  6248. (if (not alternative-interface)
  6249. org-goto-interface
  6250. (if (eq org-goto-interface 'outline)
  6251. 'outline-path-completion
  6252. 'outline)))
  6253. (org-goto-start-pos (point))
  6254. (selected-point
  6255. (if (eq interface 'outline)
  6256. (car (org-get-location (current-buffer) org-goto-help))
  6257. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6258. (org-refile-check-position pa)
  6259. (nth 3 pa)))))
  6260. (if selected-point
  6261. (progn
  6262. (org-mark-ring-push org-goto-start-pos)
  6263. (goto-char selected-point)
  6264. (if (or (outline-invisible-p) (org-invisible-p2))
  6265. (org-show-context 'org-goto)))
  6266. (message "Quit"))))
  6267. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6268. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6269. (defvar org-goto-local-auto-isearch-map) ; defined below
  6270. (defun org-get-location (buf help)
  6271. "Let the user select a location in the Org-mode buffer BUF.
  6272. This function uses a recursive edit. It returns the selected position
  6273. or nil."
  6274. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6275. (isearch-hide-immediately nil)
  6276. (isearch-search-fun-function
  6277. (lambda () 'org-goto-local-search-headings))
  6278. (org-goto-selected-point org-goto-exit-command)
  6279. (pop-up-frames nil)
  6280. (special-display-buffer-names nil)
  6281. (special-display-regexps nil)
  6282. (special-display-function nil))
  6283. (save-excursion
  6284. (save-window-excursion
  6285. (delete-other-windows)
  6286. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6287. (org-pop-to-buffer-same-window
  6288. (condition-case nil
  6289. (make-indirect-buffer (current-buffer) "*org-goto*")
  6290. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6291. (with-output-to-temp-buffer "*Help*"
  6292. (princ help))
  6293. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  6294. (setq buffer-read-only nil)
  6295. (let ((org-startup-truncated t)
  6296. (org-startup-folded nil)
  6297. (org-startup-align-all-tables nil))
  6298. (org-mode)
  6299. (org-overview))
  6300. (setq buffer-read-only t)
  6301. (if (and (boundp 'org-goto-start-pos)
  6302. (integer-or-marker-p org-goto-start-pos))
  6303. (let ((org-show-hierarchy-above t)
  6304. (org-show-siblings t)
  6305. (org-show-following-heading t))
  6306. (goto-char org-goto-start-pos)
  6307. (and (outline-invisible-p) (org-show-context)))
  6308. (goto-char (point-min)))
  6309. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6310. (message "Select location and press RET")
  6311. (use-local-map org-goto-map)
  6312. (recursive-edit)
  6313. ))
  6314. (kill-buffer "*org-goto*")
  6315. (cons org-goto-selected-point org-goto-exit-command)))
  6316. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6317. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6318. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6319. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6320. (defun org-goto-local-search-headings (string bound noerror)
  6321. "Search and make sure that any matches are in headlines."
  6322. (catch 'return
  6323. (while (if isearch-forward
  6324. (search-forward string bound noerror)
  6325. (search-backward string bound noerror))
  6326. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6327. (and (member :headline context)
  6328. (not (member :tags context))))
  6329. (throw 'return (point))))))
  6330. (defun org-goto-local-auto-isearch ()
  6331. "Start isearch."
  6332. (interactive)
  6333. (goto-char (point-min))
  6334. (let ((keys (this-command-keys)))
  6335. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6336. (isearch-mode t)
  6337. (isearch-process-search-char (string-to-char keys)))))
  6338. (defun org-goto-ret (&optional arg)
  6339. "Finish `org-goto' by going to the new location."
  6340. (interactive "P")
  6341. (setq org-goto-selected-point (point)
  6342. org-goto-exit-command 'return)
  6343. (throw 'exit nil))
  6344. (defun org-goto-left ()
  6345. "Finish `org-goto' by going to the new location."
  6346. (interactive)
  6347. (if (org-at-heading-p)
  6348. (progn
  6349. (beginning-of-line 1)
  6350. (setq org-goto-selected-point (point)
  6351. org-goto-exit-command 'left)
  6352. (throw 'exit nil))
  6353. (error "Not on a heading")))
  6354. (defun org-goto-right ()
  6355. "Finish `org-goto' by going to the new location."
  6356. (interactive)
  6357. (if (org-at-heading-p)
  6358. (progn
  6359. (setq org-goto-selected-point (point)
  6360. org-goto-exit-command 'right)
  6361. (throw 'exit nil))
  6362. (error "Not on a heading")))
  6363. (defun org-goto-quit ()
  6364. "Finish `org-goto' without cursor motion."
  6365. (interactive)
  6366. (setq org-goto-selected-point nil)
  6367. (setq org-goto-exit-command 'quit)
  6368. (throw 'exit nil))
  6369. ;;; Indirect buffer display of subtrees
  6370. (defvar org-indirect-dedicated-frame nil
  6371. "This is the frame being used for indirect tree display.")
  6372. (defvar org-last-indirect-buffer nil)
  6373. (defun org-tree-to-indirect-buffer (&optional arg)
  6374. "Create indirect buffer and narrow it to current subtree.
  6375. With numerical prefix ARG, go up to this level and then take that tree.
  6376. If ARG is negative, go up that many levels.
  6377. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6378. indirect buffer previously made with this command, to avoid proliferation of
  6379. indirect buffers. However, when you call the command with a \
  6380. \\[universal-argument] prefix, or
  6381. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6382. is kept so that you can work with several indirect buffers at the same time.
  6383. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6384. \\[universal-argument] prefix also
  6385. requests that a new frame be made for the new buffer, so that the dedicated
  6386. frame is not changed."
  6387. (interactive "P")
  6388. (let ((cbuf (current-buffer))
  6389. (cwin (selected-window))
  6390. (pos (point))
  6391. beg end level heading ibuf)
  6392. (save-excursion
  6393. (org-back-to-heading t)
  6394. (when (numberp arg)
  6395. (setq level (org-outline-level))
  6396. (if (< arg 0) (setq arg (+ level arg)))
  6397. (while (> (setq level (org-outline-level)) arg)
  6398. (outline-up-heading 1 t)))
  6399. (setq beg (point)
  6400. heading (org-get-heading))
  6401. (org-end-of-subtree t t)
  6402. (if (org-at-heading-p) (backward-char 1))
  6403. (setq end (point)))
  6404. (if (and (buffer-live-p org-last-indirect-buffer)
  6405. (not (eq org-indirect-buffer-display 'new-frame))
  6406. (not arg))
  6407. (kill-buffer org-last-indirect-buffer))
  6408. (setq ibuf (org-get-indirect-buffer cbuf)
  6409. org-last-indirect-buffer ibuf)
  6410. (cond
  6411. ((or (eq org-indirect-buffer-display 'new-frame)
  6412. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6413. (select-frame (make-frame))
  6414. (delete-other-windows)
  6415. (org-pop-to-buffer-same-window ibuf)
  6416. (org-set-frame-title heading))
  6417. ((eq org-indirect-buffer-display 'dedicated-frame)
  6418. (raise-frame
  6419. (select-frame (or (and org-indirect-dedicated-frame
  6420. (frame-live-p org-indirect-dedicated-frame)
  6421. org-indirect-dedicated-frame)
  6422. (setq org-indirect-dedicated-frame (make-frame)))))
  6423. (delete-other-windows)
  6424. (org-pop-to-buffer-same-window ibuf)
  6425. (org-set-frame-title (concat "Indirect: " heading)))
  6426. ((eq org-indirect-buffer-display 'current-window)
  6427. (org-pop-to-buffer-same-window ibuf))
  6428. ((eq org-indirect-buffer-display 'other-window)
  6429. (pop-to-buffer ibuf))
  6430. (t (error "Invalid value")))
  6431. (if (featurep 'xemacs)
  6432. (save-excursion (org-mode) (turn-on-font-lock)))
  6433. (narrow-to-region beg end)
  6434. (show-all)
  6435. (goto-char pos)
  6436. (run-hook-with-args 'org-cycle-hook 'all)
  6437. (and (window-live-p cwin) (select-window cwin))))
  6438. (defun org-get-indirect-buffer (&optional buffer)
  6439. (setq buffer (or buffer (current-buffer)))
  6440. (let ((n 1) (base (buffer-name buffer)) bname)
  6441. (while (buffer-live-p
  6442. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6443. (setq n (1+ n)))
  6444. (condition-case nil
  6445. (make-indirect-buffer buffer bname 'clone)
  6446. (error (make-indirect-buffer buffer bname)))))
  6447. (defun org-set-frame-title (title)
  6448. "Set the title of the current frame to the string TITLE."
  6449. ;; FIXME: how to name a single frame in XEmacs???
  6450. (unless (featurep 'xemacs)
  6451. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6452. ;;;; Structure editing
  6453. ;;; Inserting headlines
  6454. (defun org-previous-line-empty-p ()
  6455. (save-excursion
  6456. (and (not (bobp))
  6457. (or (beginning-of-line 0) t)
  6458. (save-match-data
  6459. (looking-at "[ \t]*$")))))
  6460. (defun org-insert-heading (&optional force-heading invisible-ok)
  6461. "Insert a new heading or item with same depth at point.
  6462. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  6463. If point is at the beginning of a headline, insert a sibling before the
  6464. current headline. If point is not at the beginning, split the line,
  6465. create the new headline with the text in the current line after point
  6466. \(but see also the variable `org-M-RET-may-split-line').
  6467. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6468. This is important for non-interactive uses of the command."
  6469. (interactive "P")
  6470. (if (or (= (buffer-size) 0)
  6471. (and (not (save-excursion
  6472. (and (ignore-errors (org-back-to-heading invisible-ok))
  6473. (org-at-heading-p))))
  6474. (or force-heading (not (org-in-item-p)))))
  6475. (progn
  6476. (insert "\n* ")
  6477. (run-hooks 'org-insert-heading-hook))
  6478. (when (or force-heading (not (org-insert-item)))
  6479. (let* ((empty-line-p nil)
  6480. (level nil)
  6481. (on-heading (org-at-heading-p))
  6482. (head (save-excursion
  6483. (condition-case nil
  6484. (progn
  6485. (org-back-to-heading invisible-ok)
  6486. (when (and (not on-heading)
  6487. (featurep 'org-inlinetask)
  6488. (integerp org-inlinetask-min-level)
  6489. (>= (length (match-string 0))
  6490. org-inlinetask-min-level))
  6491. ;; Find a heading level before the inline task
  6492. (while (and (setq level (org-up-heading-safe))
  6493. (>= level org-inlinetask-min-level)))
  6494. (if (org-at-heading-p)
  6495. (org-back-to-heading invisible-ok)
  6496. (error "This should not happen")))
  6497. (setq empty-line-p (org-previous-line-empty-p))
  6498. (match-string 0))
  6499. (error "*"))))
  6500. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6501. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6502. pos hide-previous previous-pos)
  6503. (cond
  6504. ((and (org-at-heading-p) (bolp)
  6505. (or (bobp)
  6506. (save-excursion (backward-char 1) (not (outline-invisible-p)))))
  6507. ;; insert before the current line
  6508. (open-line (if blank 2 1)))
  6509. ((and (bolp)
  6510. (not org-insert-heading-respect-content)
  6511. (or (bobp)
  6512. (save-excursion
  6513. (backward-char 1) (not (outline-invisible-p)))))
  6514. ;; insert right here
  6515. nil)
  6516. (t
  6517. ;; somewhere in the line
  6518. (save-excursion
  6519. (setq previous-pos (point-at-bol))
  6520. (end-of-line)
  6521. (setq hide-previous (outline-invisible-p)))
  6522. (and org-insert-heading-respect-content (org-show-subtree))
  6523. (let ((split
  6524. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  6525. (save-excursion
  6526. (let ((p (point)))
  6527. (goto-char (point-at-bol))
  6528. (and (looking-at org-complex-heading-regexp)
  6529. (match-beginning 4)
  6530. (> p (match-beginning 4)))))))
  6531. tags pos)
  6532. (cond
  6533. (org-insert-heading-respect-content
  6534. (org-end-of-subtree nil t)
  6535. (when (featurep 'org-inlinetask)
  6536. (while (and (not (eobp))
  6537. (looking-at "\\(\\*+\\)[ \t]+")
  6538. (>= (length (match-string 1))
  6539. org-inlinetask-min-level))
  6540. (org-end-of-subtree nil t)))
  6541. (or (bolp) (newline))
  6542. (or (org-previous-line-empty-p)
  6543. (and blank (newline)))
  6544. (open-line 1))
  6545. ((org-at-heading-p)
  6546. (when hide-previous
  6547. (show-children)
  6548. (org-show-entry))
  6549. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  6550. (setq tags (and (match-end 2) (match-string 2)))
  6551. (and (match-end 1)
  6552. (delete-region (match-beginning 1) (match-end 1)))
  6553. (setq pos (point-at-bol))
  6554. (or split (end-of-line 1))
  6555. (delete-horizontal-space)
  6556. (if (string-match "\\`\\*+\\'"
  6557. (buffer-substring (point-at-bol) (point)))
  6558. (insert " "))
  6559. (newline (if blank 2 1))
  6560. (when tags
  6561. (save-excursion
  6562. (goto-char pos)
  6563. (end-of-line 1)
  6564. (insert " " tags)
  6565. (org-set-tags nil 'align))))
  6566. (t
  6567. (or split (end-of-line 1))
  6568. (newline (if blank 2 1)))))))
  6569. (insert head) (just-one-space)
  6570. (setq pos (point))
  6571. (end-of-line 1)
  6572. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  6573. (when (and org-insert-heading-respect-content hide-previous)
  6574. (save-excursion
  6575. (goto-char previous-pos)
  6576. (hide-subtree)))
  6577. (run-hooks 'org-insert-heading-hook)))))
  6578. (defun org-get-heading (&optional no-tags no-todo)
  6579. "Return the heading of the current entry, without the stars.
  6580. When NO-TAGS is non-nil, don't include tags.
  6581. When NO-TODO is non-nil, don't include TODO keywords."
  6582. (save-excursion
  6583. (org-back-to-heading t)
  6584. (cond
  6585. ((and no-tags no-todo)
  6586. (looking-at org-complex-heading-regexp)
  6587. (match-string 4))
  6588. (no-tags
  6589. (looking-at (concat org-outline-regexp
  6590. "\\(.*?\\)"
  6591. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6592. (match-string 1))
  6593. (no-todo
  6594. (looking-at org-todo-line-regexp)
  6595. (match-string 3))
  6596. (t (looking-at org-heading-regexp)
  6597. (match-string 2)))))
  6598. (defun org-heading-components ()
  6599. "Return the components of the current heading.
  6600. This is a list with the following elements:
  6601. - the level as an integer
  6602. - the reduced level, different if `org-odd-levels-only' is set.
  6603. - the TODO keyword, or nil
  6604. - the priority character, like ?A, or nil if no priority is given
  6605. - the headline text itself, or the tags string if no headline text
  6606. - the tags string, or nil."
  6607. (save-excursion
  6608. (org-back-to-heading t)
  6609. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  6610. (list (length (match-string 1))
  6611. (org-reduced-level (length (match-string 1)))
  6612. (org-match-string-no-properties 2)
  6613. (and (match-end 3) (aref (match-string 3) 2))
  6614. (org-match-string-no-properties 4)
  6615. (org-match-string-no-properties 5)))))
  6616. (defun org-get-entry ()
  6617. "Get the entry text, after heading, entire subtree."
  6618. (save-excursion
  6619. (org-back-to-heading t)
  6620. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6621. (defun org-insert-heading-after-current ()
  6622. "Insert a new heading with same level as current, after current subtree."
  6623. (interactive)
  6624. (org-back-to-heading)
  6625. (org-insert-heading)
  6626. (org-move-subtree-down)
  6627. (end-of-line 1))
  6628. (defun org-insert-heading-respect-content ()
  6629. (interactive)
  6630. (let ((org-insert-heading-respect-content t))
  6631. (org-insert-heading t)))
  6632. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6633. (interactive "P")
  6634. (let ((org-insert-heading-respect-content t))
  6635. (org-insert-todo-heading force-state t)))
  6636. (defun org-insert-todo-heading (arg &optional force-heading)
  6637. "Insert a new heading with the same level and TODO state as current heading.
  6638. If the heading has no TODO state, or if the state is DONE, use the first
  6639. state (TODO by default). Also with prefix arg, force first state."
  6640. (interactive "P")
  6641. (when (or force-heading (not (org-insert-item 'checkbox)))
  6642. (org-insert-heading force-heading)
  6643. (save-excursion
  6644. (org-back-to-heading)
  6645. (outline-previous-heading)
  6646. (looking-at org-todo-line-regexp))
  6647. (let*
  6648. ((new-mark-x
  6649. (if (or arg
  6650. (not (match-beginning 2))
  6651. (member (match-string 2) org-done-keywords))
  6652. (car org-todo-keywords-1)
  6653. (match-string 2)))
  6654. (new-mark
  6655. (or
  6656. (run-hook-with-args-until-success
  6657. 'org-todo-get-default-hook new-mark-x nil)
  6658. new-mark-x)))
  6659. (beginning-of-line 1)
  6660. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6661. (if org-treat-insert-todo-heading-as-state-change
  6662. (org-todo new-mark)
  6663. (insert new-mark " "))))
  6664. (when org-provide-todo-statistics
  6665. (org-update-parent-todo-statistics))))
  6666. (defun org-insert-subheading (arg)
  6667. "Insert a new subheading and demote it.
  6668. Works for outline headings and for plain lists alike."
  6669. (interactive "P")
  6670. (org-insert-heading arg)
  6671. (cond
  6672. ((org-at-heading-p) (org-do-demote))
  6673. ((org-at-item-p) (org-indent-item))))
  6674. (defun org-insert-todo-subheading (arg)
  6675. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6676. Works for outline headings and for plain lists alike."
  6677. (interactive "P")
  6678. (org-insert-todo-heading arg)
  6679. (cond
  6680. ((org-at-heading-p) (org-do-demote))
  6681. ((org-at-item-p) (org-indent-item))))
  6682. ;;; Promotion and Demotion
  6683. (defvar org-after-demote-entry-hook nil
  6684. "Hook run after an entry has been demoted.
  6685. The cursor will be at the beginning of the entry.
  6686. When a subtree is being demoted, the hook will be called for each node.")
  6687. (defvar org-after-promote-entry-hook nil
  6688. "Hook run after an entry has been promoted.
  6689. The cursor will be at the beginning of the entry.
  6690. When a subtree is being promoted, the hook will be called for each node.")
  6691. (defun org-promote-subtree ()
  6692. "Promote the entire subtree.
  6693. See also `org-promote'."
  6694. (interactive)
  6695. (save-excursion
  6696. (org-with-limited-levels (org-map-tree 'org-promote)))
  6697. (org-fix-position-after-promote))
  6698. (defun org-demote-subtree ()
  6699. "Demote the entire subtree. See `org-demote'.
  6700. See also `org-promote'."
  6701. (interactive)
  6702. (save-excursion
  6703. (org-with-limited-levels (org-map-tree 'org-demote)))
  6704. (org-fix-position-after-promote))
  6705. (defun org-do-promote ()
  6706. "Promote the current heading higher up the tree.
  6707. If the region is active in `transient-mark-mode', promote all headings
  6708. in the region."
  6709. (interactive)
  6710. (save-excursion
  6711. (if (org-region-active-p)
  6712. (org-map-region 'org-promote (region-beginning) (region-end))
  6713. (org-promote)))
  6714. (org-fix-position-after-promote))
  6715. (defun org-do-demote ()
  6716. "Demote the current heading lower down the tree.
  6717. If the region is active in `transient-mark-mode', demote all headings
  6718. in the region."
  6719. (interactive)
  6720. (save-excursion
  6721. (if (org-region-active-p)
  6722. (org-map-region 'org-demote (region-beginning) (region-end))
  6723. (org-demote)))
  6724. (org-fix-position-after-promote))
  6725. (defun org-fix-position-after-promote ()
  6726. "Make sure that after pro/demotion cursor position is right."
  6727. (let ((pos (point)))
  6728. (when (save-excursion
  6729. (beginning-of-line 1)
  6730. (looking-at org-todo-line-regexp)
  6731. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6732. (cond ((eobp) (insert " "))
  6733. ((eolp) (insert " "))
  6734. ((equal (char-after) ?\ ) (forward-char 1))))))
  6735. (defun org-current-level ()
  6736. "Return the level of the current entry, or nil if before the first headline.
  6737. The level is the number of stars at the beginning of the headline."
  6738. (save-excursion
  6739. (org-with-limited-levels
  6740. (if (ignore-errors (org-back-to-heading t))
  6741. (funcall outline-level)))))
  6742. (defun org-get-previous-line-level ()
  6743. "Return the outline depth of the last headline before the current line.
  6744. Returns 0 for the first headline in the buffer, and nil if before the
  6745. first headline."
  6746. (let ((current-level (org-current-level))
  6747. (prev-level (when (> (line-number-at-pos) 1)
  6748. (save-excursion
  6749. (beginning-of-line 0)
  6750. (org-current-level)))))
  6751. (cond ((null current-level) nil) ; Before first headline
  6752. ((null prev-level) 0) ; At first headline
  6753. (prev-level))))
  6754. (defun org-reduced-level (l)
  6755. "Compute the effective level of a heading.
  6756. This takes into account the setting of `org-odd-levels-only'."
  6757. (cond
  6758. ((zerop l) 0)
  6759. (org-odd-levels-only (1+ (floor (/ l 2))))
  6760. (t l)))
  6761. (defun org-level-increment ()
  6762. "Return the number of stars that will be added or removed at a
  6763. time to headlines when structure editing, based on the value of
  6764. `org-odd-levels-only'."
  6765. (if org-odd-levels-only 2 1))
  6766. (defun org-get-valid-level (level &optional change)
  6767. "Rectify a level change under the influence of `org-odd-levels-only'
  6768. LEVEL is a current level, CHANGE is by how much the level should be
  6769. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6770. even level numbers will become the next higher odd number."
  6771. (if org-odd-levels-only
  6772. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6773. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6774. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6775. (max 1 (+ level (or change 0)))))
  6776. (if (boundp 'define-obsolete-function-alias)
  6777. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6778. (define-obsolete-function-alias 'org-get-legal-level
  6779. 'org-get-valid-level)
  6780. (define-obsolete-function-alias 'org-get-legal-level
  6781. 'org-get-valid-level "23.1")))
  6782. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  6783. ;; ̀org-with-limited-levels'
  6784. (defun org-promote ()
  6785. "Promote the current heading higher up the tree.
  6786. If the region is active in `transient-mark-mode', promote all headings
  6787. in the region."
  6788. (org-back-to-heading t)
  6789. (let* ((level (save-match-data (funcall outline-level)))
  6790. (after-change-functions (remove 'flyspell-after-change-function
  6791. after-change-functions))
  6792. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6793. (diff (abs (- level (length up-head) -1))))
  6794. (cond ((and (= level 1) org-called-with-limited-levels
  6795. org-allow-promoting-top-level-subtree)
  6796. (replace-match "# " nil t))
  6797. ((= level 1)
  6798. (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6799. (t (replace-match up-head nil t)))
  6800. ;; Fixup tag positioning
  6801. (unless (= level 1)
  6802. (and org-auto-align-tags (org-set-tags nil t))
  6803. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  6804. (run-hooks 'org-after-promote-entry-hook)))
  6805. (defun org-demote ()
  6806. "Demote the current heading lower down the tree.
  6807. If the region is active in `transient-mark-mode', demote all headings
  6808. in the region."
  6809. (org-back-to-heading t)
  6810. (let* ((level (save-match-data (funcall outline-level)))
  6811. (after-change-functions (remove 'flyspell-after-change-function
  6812. after-change-functions))
  6813. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6814. (diff (abs (- level (length down-head) -1))))
  6815. (replace-match down-head nil t)
  6816. ;; Fixup tag positioning
  6817. (and org-auto-align-tags (org-set-tags nil t))
  6818. (if org-adapt-indentation (org-fixup-indentation diff))
  6819. (run-hooks 'org-after-demote-entry-hook)))
  6820. (defun org-cycle-level ()
  6821. "Cycle the level of an empty headline through possible states.
  6822. This goes first to child, then to parent, level, then up the hierarchy.
  6823. After top level, it switches back to sibling level."
  6824. (interactive)
  6825. (let ((org-adapt-indentation nil))
  6826. (when (org-point-at-end-of-empty-headline)
  6827. (setq this-command 'org-cycle-level) ; Only needed for caching
  6828. (let ((cur-level (org-current-level))
  6829. (prev-level (org-get-previous-line-level)))
  6830. (cond
  6831. ;; If first headline in file, promote to top-level.
  6832. ((= prev-level 0)
  6833. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6834. do (org-do-promote)))
  6835. ;; If same level as prev, demote one.
  6836. ((= prev-level cur-level)
  6837. (org-do-demote))
  6838. ;; If parent is top-level, promote to top level if not already.
  6839. ((= prev-level 1)
  6840. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6841. do (org-do-promote)))
  6842. ;; If top-level, return to prev-level.
  6843. ((= cur-level 1)
  6844. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6845. do (org-do-demote)))
  6846. ;; If less than prev-level, promote one.
  6847. ((< cur-level prev-level)
  6848. (org-do-promote))
  6849. ;; If deeper than prev-level, promote until higher than
  6850. ;; prev-level.
  6851. ((> cur-level prev-level)
  6852. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6853. do (org-do-promote))))
  6854. t))))
  6855. (defun org-map-tree (fun)
  6856. "Call FUN for every heading underneath the current one."
  6857. (org-back-to-heading)
  6858. (let ((level (funcall outline-level)))
  6859. (save-excursion
  6860. (funcall fun)
  6861. (while (and (progn
  6862. (outline-next-heading)
  6863. (> (funcall outline-level) level))
  6864. (not (eobp)))
  6865. (funcall fun)))))
  6866. (defun org-map-region (fun beg end)
  6867. "Call FUN for every heading between BEG and END."
  6868. (let ((org-ignore-region t))
  6869. (save-excursion
  6870. (setq end (copy-marker end))
  6871. (goto-char beg)
  6872. (if (and (re-search-forward org-outline-regexp-bol nil t)
  6873. (< (point) end))
  6874. (funcall fun))
  6875. (while (and (progn
  6876. (outline-next-heading)
  6877. (< (point) end))
  6878. (not (eobp)))
  6879. (funcall fun)))))
  6880. (defvar org-property-end-re) ; silence byte-compiler
  6881. (defun org-fixup-indentation (diff)
  6882. "Change the indentation in the current entry by DIFF.
  6883. However, if any line in the current entry has no indentation, or if it
  6884. would end up with no indentation after the change, nothing at all is done."
  6885. (save-excursion
  6886. (let ((end (save-excursion (outline-next-heading)
  6887. (point-marker)))
  6888. (prohibit (if (> diff 0)
  6889. "^\\S-"
  6890. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6891. col)
  6892. (unless (save-excursion (end-of-line 1)
  6893. (re-search-forward prohibit end t))
  6894. (while (and (< (point) end)
  6895. (re-search-forward "^[ \t]+" end t))
  6896. (goto-char (match-end 0))
  6897. (setq col (current-column))
  6898. (if (< diff 0) (replace-match ""))
  6899. (org-indent-to-column (+ diff col))))
  6900. (move-marker end nil))))
  6901. (defun org-convert-to-odd-levels ()
  6902. "Convert an org-mode file with all levels allowed to one with odd levels.
  6903. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6904. level 5 etc."
  6905. (interactive)
  6906. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6907. (let ((outline-level 'org-outline-level)
  6908. (org-odd-levels-only nil) n)
  6909. (save-excursion
  6910. (goto-char (point-min))
  6911. (while (re-search-forward "^\\*\\*+ " nil t)
  6912. (setq n (- (length (match-string 0)) 2))
  6913. (while (>= (setq n (1- n)) 0)
  6914. (org-demote))
  6915. (end-of-line 1))))))
  6916. (defun org-convert-to-oddeven-levels ()
  6917. "Convert an org-mode file with only odd levels to one with odd/even levels.
  6918. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6919. file contains a section with an even level, conversion would
  6920. destroy the structure of the file. An error is signaled in this
  6921. case."
  6922. (interactive)
  6923. (goto-char (point-min))
  6924. ;; First check if there are no even levels
  6925. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6926. (org-show-context t)
  6927. (error "Not all levels are odd in this file. Conversion not possible"))
  6928. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6929. (let ((outline-regexp org-outline-regexp)
  6930. (outline-level 'org-outline-level)
  6931. (org-odd-levels-only nil) n)
  6932. (save-excursion
  6933. (goto-char (point-min))
  6934. (while (re-search-forward "^\\*\\*+ " nil t)
  6935. (setq n (/ (1- (length (match-string 0))) 2))
  6936. (while (>= (setq n (1- n)) 0)
  6937. (org-promote))
  6938. (end-of-line 1))))))
  6939. (defun org-tr-level (n)
  6940. "Make N odd if required."
  6941. (if org-odd-levels-only (1+ (/ n 2)) n))
  6942. ;;; Vertical tree motion, cutting and pasting of subtrees
  6943. (defun org-move-subtree-up (&optional arg)
  6944. "Move the current subtree up past ARG headlines of the same level."
  6945. (interactive "p")
  6946. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6947. (defun org-move-subtree-down (&optional arg)
  6948. "Move the current subtree down past ARG headlines of the same level."
  6949. (interactive "p")
  6950. (setq arg (prefix-numeric-value arg))
  6951. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6952. 'org-get-last-sibling))
  6953. (ins-point (make-marker))
  6954. (cnt (abs arg))
  6955. (col (current-column))
  6956. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6957. ;; Select the tree
  6958. (org-back-to-heading)
  6959. (setq beg0 (point))
  6960. (save-excursion
  6961. (setq ne-beg (org-back-over-empty-lines))
  6962. (setq beg (point)))
  6963. (save-match-data
  6964. (save-excursion (outline-end-of-heading)
  6965. (setq folded (outline-invisible-p)))
  6966. (outline-end-of-subtree))
  6967. (outline-next-heading)
  6968. (setq ne-end (org-back-over-empty-lines))
  6969. (setq end (point))
  6970. (goto-char beg0)
  6971. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6972. ;; include less whitespace
  6973. (save-excursion
  6974. (goto-char beg)
  6975. (forward-line (- ne-beg ne-end))
  6976. (setq beg (point))))
  6977. ;; Find insertion point, with error handling
  6978. (while (> cnt 0)
  6979. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  6980. (progn (goto-char beg0)
  6981. (error "Cannot move past superior level or buffer limit")))
  6982. (setq cnt (1- cnt)))
  6983. (if (> arg 0)
  6984. ;; Moving forward - still need to move over subtree
  6985. (progn (org-end-of-subtree t t)
  6986. (save-excursion
  6987. (org-back-over-empty-lines)
  6988. (or (bolp) (newline)))))
  6989. (setq ne-ins (org-back-over-empty-lines))
  6990. (move-marker ins-point (point))
  6991. (setq txt (buffer-substring beg end))
  6992. (org-save-markers-in-region beg end)
  6993. (delete-region beg end)
  6994. (org-remove-empty-overlays-at beg)
  6995. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6996. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6997. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6998. (let ((bbb (point)))
  6999. (insert-before-markers txt)
  7000. (org-reinstall-markers-in-region bbb)
  7001. (move-marker ins-point bbb))
  7002. (or (bolp) (insert "\n"))
  7003. (setq ins-end (point))
  7004. (goto-char ins-point)
  7005. (org-skip-whitespace)
  7006. (when (and (< arg 0)
  7007. (org-first-sibling-p)
  7008. (> ne-ins ne-beg))
  7009. ;; Move whitespace back to beginning
  7010. (save-excursion
  7011. (goto-char ins-end)
  7012. (let ((kill-whole-line t))
  7013. (kill-line (- ne-ins ne-beg)) (point)))
  7014. (insert (make-string (- ne-ins ne-beg) ?\n)))
  7015. (move-marker ins-point nil)
  7016. (if folded
  7017. (hide-subtree)
  7018. (org-show-entry)
  7019. (show-children)
  7020. (org-cycle-hide-drawers 'children))
  7021. (org-clean-visibility-after-subtree-move)
  7022. ;; move back to the initial column we were at
  7023. (move-to-column col)))
  7024. (defvar org-subtree-clip ""
  7025. "Clipboard for cut and paste of subtrees.
  7026. This is actually only a copy of the kill, because we use the normal kill
  7027. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  7028. (defvar org-subtree-clip-folded nil
  7029. "Was the last copied subtree folded?
  7030. This is used to fold the tree back after pasting.")
  7031. (defun org-cut-subtree (&optional n)
  7032. "Cut the current subtree into the clipboard.
  7033. With prefix arg N, cut this many sequential subtrees.
  7034. This is a short-hand for marking the subtree and then cutting it."
  7035. (interactive "p")
  7036. (org-copy-subtree n 'cut))
  7037. (defun org-copy-subtree (&optional n cut force-store-markers)
  7038. "Cut the current subtree into the clipboard.
  7039. With prefix arg N, cut this many sequential subtrees.
  7040. This is a short-hand for marking the subtree and then copying it.
  7041. If CUT is non-nil, actually cut the subtree.
  7042. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  7043. of some markers in the region, even if CUT is non-nil. This is
  7044. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  7045. (interactive "p")
  7046. (let (beg end folded (beg0 (point)))
  7047. (if (org-called-interactively-p 'any)
  7048. (org-back-to-heading nil) ; take what looks like a subtree
  7049. (org-back-to-heading t)) ; take what is really there
  7050. (org-back-over-empty-lines)
  7051. (setq beg (point))
  7052. (skip-chars-forward " \t\r\n")
  7053. (save-match-data
  7054. (save-excursion (outline-end-of-heading)
  7055. (setq folded (outline-invisible-p)))
  7056. (condition-case nil
  7057. (org-forward-heading-same-level (1- n) t)
  7058. (error nil))
  7059. (org-end-of-subtree t t))
  7060. (org-back-over-empty-lines)
  7061. (setq end (point))
  7062. (goto-char beg0)
  7063. (when (> end beg)
  7064. (setq org-subtree-clip-folded folded)
  7065. (when (or cut force-store-markers)
  7066. (org-save-markers-in-region beg end))
  7067. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7068. (setq org-subtree-clip (current-kill 0))
  7069. (message "%s: Subtree(s) with %d characters"
  7070. (if cut "Cut" "Copied")
  7071. (length org-subtree-clip)))))
  7072. (defun org-paste-subtree (&optional level tree for-yank)
  7073. "Paste the clipboard as a subtree, with modification of headline level.
  7074. The entire subtree is promoted or demoted in order to match a new headline
  7075. level.
  7076. If the cursor is at the beginning of a headline, the same level as
  7077. that headline is used to paste the tree
  7078. If not, the new level is derived from the *visible* headings
  7079. before and after the insertion point, and taken to be the inferior headline
  7080. level of the two. So if the previous visible heading is level 3 and the
  7081. next is level 4 (or vice versa), level 4 will be used for insertion.
  7082. This makes sure that the subtree remains an independent subtree and does
  7083. not swallow low level entries.
  7084. You can also force a different level, either by using a numeric prefix
  7085. argument, or by inserting the heading marker by hand. For example, if the
  7086. cursor is after \"*****\", then the tree will be shifted to level 5.
  7087. If optional TREE is given, use this text instead of the kill ring.
  7088. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7089. move back over whitespace before inserting, and move point to the end of
  7090. the inserted text when done."
  7091. (interactive "P")
  7092. (setq tree (or tree (and kill-ring (current-kill 0))))
  7093. (unless (org-kill-is-subtree-p tree)
  7094. (error "%s"
  7095. (substitute-command-keys
  7096. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7097. (org-with-limited-levels
  7098. (let* ((visp (not (outline-invisible-p)))
  7099. (txt tree)
  7100. (^re_ "\\(\\*+\\)[ \t]*")
  7101. (old-level (if (string-match org-outline-regexp-bol txt)
  7102. (- (match-end 0) (match-beginning 0) 1)
  7103. -1))
  7104. (force-level (cond (level (prefix-numeric-value level))
  7105. ((and (looking-at "[ \t]*$")
  7106. (string-match
  7107. "^\\*+$" (buffer-substring
  7108. (point-at-bol) (point))))
  7109. (- (match-end 1) (match-beginning 1)))
  7110. ((and (bolp)
  7111. (looking-at org-outline-regexp))
  7112. (- (match-end 0) (point) 1))))
  7113. (previous-level (save-excursion
  7114. (condition-case nil
  7115. (progn
  7116. (outline-previous-visible-heading 1)
  7117. (if (looking-at ^re_)
  7118. (- (match-end 0) (match-beginning 0) 1)
  7119. 1))
  7120. (error 1))))
  7121. (next-level (save-excursion
  7122. (condition-case nil
  7123. (progn
  7124. (or (looking-at org-outline-regexp)
  7125. (outline-next-visible-heading 1))
  7126. (if (looking-at ^re_)
  7127. (- (match-end 0) (match-beginning 0) 1)
  7128. 1))
  7129. (error 1))))
  7130. (new-level (or force-level (max previous-level next-level)))
  7131. (shift (if (or (= old-level -1)
  7132. (= new-level -1)
  7133. (= old-level new-level))
  7134. 0
  7135. (- new-level old-level)))
  7136. (delta (if (> shift 0) -1 1))
  7137. (func (if (> shift 0) 'org-demote 'org-promote))
  7138. (org-odd-levels-only nil)
  7139. beg end newend)
  7140. ;; Remove the forced level indicator
  7141. (if force-level
  7142. (delete-region (point-at-bol) (point)))
  7143. ;; Paste
  7144. (beginning-of-line (if (bolp) 1 2))
  7145. (unless for-yank (org-back-over-empty-lines))
  7146. (setq beg (point))
  7147. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7148. (insert-before-markers txt)
  7149. (unless (string-match "\n\\'" txt) (insert "\n"))
  7150. (setq newend (point))
  7151. (org-reinstall-markers-in-region beg)
  7152. (setq end (point))
  7153. (goto-char beg)
  7154. (skip-chars-forward " \t\n\r")
  7155. (setq beg (point))
  7156. (if (and (outline-invisible-p) visp)
  7157. (save-excursion (outline-show-heading)))
  7158. ;; Shift if necessary
  7159. (unless (= shift 0)
  7160. (save-restriction
  7161. (narrow-to-region beg end)
  7162. (while (not (= shift 0))
  7163. (org-map-region func (point-min) (point-max))
  7164. (setq shift (+ delta shift)))
  7165. (goto-char (point-min))
  7166. (setq newend (point-max))))
  7167. (when (or (org-called-interactively-p 'interactive) for-yank)
  7168. (message "Clipboard pasted as level %d subtree" new-level))
  7169. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7170. kill-ring
  7171. (eq org-subtree-clip (current-kill 0))
  7172. org-subtree-clip-folded)
  7173. ;; The tree was folded before it was killed/copied
  7174. (hide-subtree))
  7175. (and for-yank (goto-char newend)))))
  7176. (defun org-kill-is-subtree-p (&optional txt)
  7177. "Check if the current kill is an outline subtree, or a set of trees.
  7178. Returns nil if kill does not start with a headline, or if the first
  7179. headline level is not the largest headline level in the tree.
  7180. So this will actually accept several entries of equal levels as well,
  7181. which is OK for `org-paste-subtree'.
  7182. If optional TXT is given, check this string instead of the current kill."
  7183. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7184. (re (org-get-limited-outline-regexp))
  7185. (^re (concat "^" re))
  7186. (start-level (and kill
  7187. (string-match
  7188. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7189. kill)
  7190. (- (match-end 2) (match-beginning 2) 1)))
  7191. (start (1+ (or (match-beginning 2) -1))))
  7192. (if (not start-level)
  7193. (progn
  7194. nil) ;; does not even start with a heading
  7195. (catch 'exit
  7196. (while (setq start (string-match ^re kill (1+ start)))
  7197. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7198. (throw 'exit nil)))
  7199. t))))
  7200. (defvar org-markers-to-move nil
  7201. "Markers that should be moved with a cut-and-paste operation.
  7202. Those markers are stored together with their positions relative to
  7203. the start of the region.")
  7204. (defun org-save-markers-in-region (beg end)
  7205. "Check markers in region.
  7206. If these markers are between BEG and END, record their position relative
  7207. to BEG, so that after moving the block of text, we can put the markers back
  7208. into place.
  7209. This function gets called just before an entry or tree gets cut from the
  7210. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7211. called immediately, to move the markers with the entries."
  7212. (setq org-markers-to-move nil)
  7213. (when (featurep 'org-clock)
  7214. (org-clock-save-markers-for-cut-and-paste beg end))
  7215. (when (featurep 'org-agenda)
  7216. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7217. (defun org-check-and-save-marker (marker beg end)
  7218. "Check if MARKER is between BEG and END.
  7219. If yes, remember the marker and the distance to BEG."
  7220. (when (and (marker-buffer marker)
  7221. (equal (marker-buffer marker) (current-buffer)))
  7222. (if (and (>= marker beg) (< marker end))
  7223. (push (cons marker (- marker beg)) org-markers-to-move))))
  7224. (defun org-reinstall-markers-in-region (beg)
  7225. "Move all remembered markers to their position relative to BEG."
  7226. (mapc (lambda (x)
  7227. (move-marker (car x) (+ beg (cdr x))))
  7228. org-markers-to-move)
  7229. (setq org-markers-to-move nil))
  7230. (defun org-narrow-to-subtree ()
  7231. "Narrow buffer to the current subtree."
  7232. (interactive)
  7233. (save-excursion
  7234. (save-match-data
  7235. (org-with-limited-levels
  7236. (narrow-to-region
  7237. (progn (org-back-to-heading t) (point))
  7238. (progn (org-end-of-subtree t t)
  7239. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7240. (point)))))))
  7241. (defun org-narrow-to-block ()
  7242. "Narrow buffer to the current block."
  7243. (interactive)
  7244. (let* ((case-fold-search t)
  7245. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7246. "^[ \t]*#\\+end_.*")))
  7247. (if blockp
  7248. (narrow-to-region (car blockp) (cdr blockp))
  7249. (error "Not in a block"))))
  7250. (eval-when-compile
  7251. (defvar org-property-drawer-re))
  7252. (defvar org-property-start-re) ;; defined below
  7253. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7254. "Clone the task (subtree) at point N times.
  7255. The clones will be inserted as siblings.
  7256. In interactive use, the user will be prompted for the number of
  7257. clones to be produced, and for a time SHIFT, which may be a
  7258. repeater as used in time stamps, for example `+3d'.
  7259. When a valid repeater is given and the entry contains any time
  7260. stamps, the clones will become a sequence in time, with time
  7261. stamps in the subtree shifted for each clone produced. If SHIFT
  7262. is nil or the empty string, time stamps will be left alone. The
  7263. ID property of the original subtree is removed.
  7264. If the original subtree did contain time stamps with a repeater,
  7265. the following will happen:
  7266. - the repeater will be removed in each clone
  7267. - an additional clone will be produced, with the current, unshifted
  7268. date(s) in the entry.
  7269. - the original entry will be placed *after* all the clones, with
  7270. repeater intact.
  7271. - the start days in the repeater in the original entry will be shifted
  7272. to past the last clone.
  7273. In this way you can spell out a number of instances of a repeating task,
  7274. and still retain the repeater to cover future instances of the task."
  7275. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  7276. (let (beg end template task idprop
  7277. shift-n shift-what doshift nmin nmax (n-no-remove -1)
  7278. (drawer-re org-drawer-regexp))
  7279. (if (not (and (integerp n) (> n 0)))
  7280. (error "Invalid number of replications %s" n))
  7281. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7282. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7283. shift)))
  7284. (error "Invalid shift specification %s" shift))
  7285. (when doshift
  7286. (setq shift-n (string-to-number (match-string 1 shift))
  7287. shift-what (cdr (assoc (match-string 2 shift)
  7288. '(("d" . day) ("w" . week)
  7289. ("m" . month) ("y" . year))))))
  7290. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7291. (setq nmin 1 nmax n)
  7292. (org-back-to-heading t)
  7293. (setq beg (point))
  7294. (setq idprop (org-entry-get nil "ID"))
  7295. (org-end-of-subtree t t)
  7296. (or (bolp) (insert "\n"))
  7297. (setq end (point))
  7298. (setq template (buffer-substring beg end))
  7299. (when (and doshift
  7300. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7301. (delete-region beg end)
  7302. (setq end beg)
  7303. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7304. (goto-char end)
  7305. (loop for n from nmin to nmax do
  7306. ;; prepare clone
  7307. (with-temp-buffer
  7308. (insert template)
  7309. (org-mode)
  7310. (goto-char (point-min))
  7311. (org-show-subtree)
  7312. (and idprop (if org-clone-delete-id
  7313. (org-entry-delete nil "ID")
  7314. (org-id-get-create t)))
  7315. (unless (= n 0)
  7316. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7317. (kill-whole-line))
  7318. (goto-char (point-min))
  7319. (while (re-search-forward drawer-re nil t)
  7320. (mapc (lambda (d)
  7321. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7322. (goto-char (point-min))
  7323. (when doshift
  7324. (while (re-search-forward org-ts-regexp-both nil t)
  7325. (org-timestamp-change (* n shift-n) shift-what))
  7326. (unless (= n n-no-remove)
  7327. (goto-char (point-min))
  7328. (while (re-search-forward org-ts-regexp nil t)
  7329. (save-excursion
  7330. (goto-char (match-beginning 0))
  7331. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7332. (delete-region (match-beginning 1) (match-end 1)))))))
  7333. (setq task (buffer-string)))
  7334. (insert task))
  7335. (goto-char beg)))
  7336. ;;; Outline Sorting
  7337. (defun org-sort (with-case)
  7338. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7339. Optional argument WITH-CASE means sort case-sensitively."
  7340. (interactive "P")
  7341. (cond
  7342. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7343. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7344. (t
  7345. (org-call-with-arg 'org-sort-entries with-case))))
  7346. (defun org-sort-remove-invisible (s)
  7347. (remove-text-properties 0 (length s) org-rm-props s)
  7348. (while (string-match org-bracket-link-regexp s)
  7349. (setq s (replace-match (if (match-end 2)
  7350. (match-string 3 s)
  7351. (match-string 1 s)) t t s)))
  7352. s)
  7353. (defvar org-priority-regexp) ; defined later in the file
  7354. (defvar org-after-sorting-entries-or-items-hook nil
  7355. "Hook that is run after a bunch of entries or items have been sorted.
  7356. When children are sorted, the cursor is in the parent line when this
  7357. hook gets called. When a region or a plain list is sorted, the cursor
  7358. will be in the first entry of the sorted region/list.")
  7359. (defun org-sort-entries
  7360. (&optional with-case sorting-type getkey-func compare-func property)
  7361. "Sort entries on a certain level of an outline tree.
  7362. If there is an active region, the entries in the region are sorted.
  7363. Else, if the cursor is before the first entry, sort the top-level items.
  7364. Else, the children of the entry at point are sorted.
  7365. Sorting can be alphabetically, numerically, by date/time as given by
  7366. a time stamp, by a property or by priority.
  7367. The command prompts for the sorting type unless it has been given to the
  7368. function through the SORTING-TYPE argument, which needs to be a character,
  7369. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  7370. precise meaning of each character:
  7371. n Numerically, by converting the beginning of the entry/item to a number.
  7372. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7373. t By date/time, either the first active time stamp in the entry, or, if
  7374. none exist, by the first inactive one.
  7375. s By the scheduled date/time.
  7376. d By deadline date/time.
  7377. c By creation time, which is assumed to be the first inactive time stamp
  7378. at the beginning of a line.
  7379. p By priority according to the cookie.
  7380. r By the value of a property.
  7381. Capital letters will reverse the sort order.
  7382. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7383. called with point at the beginning of the record. It must return either
  7384. a string or a number that should serve as the sorting key for that record.
  7385. Comparing entries ignores case by default. However, with an optional argument
  7386. WITH-CASE, the sorting considers case as well."
  7387. (interactive "P")
  7388. (let ((case-func (if with-case 'identity 'downcase))
  7389. start beg end stars re re2
  7390. txt what tmp)
  7391. ;; Find beginning and end of region to sort
  7392. (cond
  7393. ((org-region-active-p)
  7394. ;; we will sort the region
  7395. (setq end (region-end)
  7396. what "region")
  7397. (goto-char (region-beginning))
  7398. (if (not (org-at-heading-p)) (outline-next-heading))
  7399. (setq start (point)))
  7400. ((or (org-at-heading-p)
  7401. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7402. ;; we will sort the children of the current headline
  7403. (org-back-to-heading)
  7404. (setq start (point)
  7405. end (progn (org-end-of-subtree t t)
  7406. (or (bolp) (insert "\n"))
  7407. (org-back-over-empty-lines)
  7408. (point))
  7409. what "children")
  7410. (goto-char start)
  7411. (show-subtree)
  7412. (outline-next-heading))
  7413. (t
  7414. ;; we will sort the top-level entries in this file
  7415. (goto-char (point-min))
  7416. (or (org-at-heading-p) (outline-next-heading))
  7417. (setq start (point))
  7418. (goto-char (point-max))
  7419. (beginning-of-line 1)
  7420. (when (looking-at ".*?\\S-")
  7421. ;; File ends in a non-white line
  7422. (end-of-line 1)
  7423. (insert "\n"))
  7424. (setq end (point-max))
  7425. (setq what "top-level")
  7426. (goto-char start)
  7427. (show-all)))
  7428. (setq beg (point))
  7429. (if (>= beg end) (error "Nothing to sort"))
  7430. (looking-at "\\(\\*+\\)")
  7431. (setq stars (match-string 1)
  7432. re (concat "^" (regexp-quote stars) " +")
  7433. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7434. txt (buffer-substring beg end))
  7435. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7436. (if (and (not (equal stars "*")) (string-match re2 txt))
  7437. (error "Region to sort contains a level above the first entry"))
  7438. (unless sorting-type
  7439. (message
  7440. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7441. [t]ime [s]cheduled [d]eadline [c]reated
  7442. A/N/T/S/D/C/P/O/F means reversed:"
  7443. what)
  7444. (setq sorting-type (read-char-exclusive))
  7445. (and (= (downcase sorting-type) ?f)
  7446. (setq getkey-func
  7447. (org-icompleting-read "Sort using function: "
  7448. obarray 'fboundp t nil nil))
  7449. (setq getkey-func (intern getkey-func)))
  7450. (and (= (downcase sorting-type) ?r)
  7451. (setq property
  7452. (org-icompleting-read "Property: "
  7453. (mapcar 'list (org-buffer-property-keys t))
  7454. nil t))))
  7455. (message "Sorting entries...")
  7456. (save-restriction
  7457. (narrow-to-region start end)
  7458. (let ((dcst (downcase sorting-type))
  7459. (case-fold-search nil)
  7460. (now (current-time)))
  7461. (sort-subr
  7462. (/= dcst sorting-type)
  7463. ;; This function moves to the beginning character of the "record" to
  7464. ;; be sorted.
  7465. (lambda nil
  7466. (if (re-search-forward re nil t)
  7467. (goto-char (match-beginning 0))
  7468. (goto-char (point-max))))
  7469. ;; This function moves to the last character of the "record" being
  7470. ;; sorted.
  7471. (lambda nil
  7472. (save-match-data
  7473. (condition-case nil
  7474. (outline-forward-same-level 1)
  7475. (error
  7476. (goto-char (point-max))))))
  7477. ;; This function returns the value that gets sorted against.
  7478. (lambda nil
  7479. (cond
  7480. ((= dcst ?n)
  7481. (if (looking-at org-complex-heading-regexp)
  7482. (string-to-number (match-string 4))
  7483. nil))
  7484. ((= dcst ?a)
  7485. (if (looking-at org-complex-heading-regexp)
  7486. (funcall case-func (match-string 4))
  7487. nil))
  7488. ((= dcst ?t)
  7489. (let ((end (save-excursion (outline-next-heading) (point))))
  7490. (if (or (re-search-forward org-ts-regexp end t)
  7491. (re-search-forward org-ts-regexp-both end t))
  7492. (org-time-string-to-seconds (match-string 0))
  7493. (org-float-time now))))
  7494. ((= dcst ?c)
  7495. (let ((end (save-excursion (outline-next-heading) (point))))
  7496. (if (re-search-forward
  7497. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7498. end t)
  7499. (org-time-string-to-seconds (match-string 0))
  7500. (org-float-time now))))
  7501. ((= dcst ?s)
  7502. (let ((end (save-excursion (outline-next-heading) (point))))
  7503. (if (re-search-forward org-scheduled-time-regexp end t)
  7504. (org-time-string-to-seconds (match-string 1))
  7505. (org-float-time now))))
  7506. ((= dcst ?d)
  7507. (let ((end (save-excursion (outline-next-heading) (point))))
  7508. (if (re-search-forward org-deadline-time-regexp end t)
  7509. (org-time-string-to-seconds (match-string 1))
  7510. (org-float-time now))))
  7511. ((= dcst ?p)
  7512. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7513. (string-to-char (match-string 2))
  7514. org-default-priority))
  7515. ((= dcst ?r)
  7516. (or (org-entry-get nil property) ""))
  7517. ((= dcst ?o)
  7518. (if (looking-at org-complex-heading-regexp)
  7519. (- 9999 (length (member (match-string 2)
  7520. org-todo-keywords-1)))))
  7521. ((= dcst ?f)
  7522. (if getkey-func
  7523. (progn
  7524. (setq tmp (funcall getkey-func))
  7525. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7526. tmp)
  7527. (error "Invalid key function `%s'" getkey-func)))
  7528. (t (error "Invalid sorting type `%c'" sorting-type))))
  7529. nil
  7530. (cond
  7531. ((= dcst ?a) 'string<)
  7532. ((= dcst ?f) compare-func)
  7533. ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
  7534. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7535. (message "Sorting entries...done")))
  7536. (defun org-do-sort (table what &optional with-case sorting-type)
  7537. "Sort TABLE of WHAT according to SORTING-TYPE.
  7538. The user will be prompted for the SORTING-TYPE if the call to this
  7539. function does not specify it. WHAT is only for the prompt, to indicate
  7540. what is being sorted. The sorting key will be extracted from
  7541. the car of the elements of the table.
  7542. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7543. (unless sorting-type
  7544. (message
  7545. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  7546. what)
  7547. (setq sorting-type (read-char-exclusive)))
  7548. (let ((dcst (downcase sorting-type))
  7549. extractfun comparefun)
  7550. ;; Define the appropriate functions
  7551. (cond
  7552. ((= dcst ?n)
  7553. (setq extractfun 'string-to-number
  7554. comparefun (if (= dcst sorting-type) '< '>)))
  7555. ((= dcst ?a)
  7556. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7557. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7558. comparefun (if (= dcst sorting-type)
  7559. 'string<
  7560. (lambda (a b) (and (not (string< a b))
  7561. (not (string= a b)))))))
  7562. ((= dcst ?t)
  7563. (setq extractfun
  7564. (lambda (x)
  7565. (if (or (string-match org-ts-regexp x)
  7566. (string-match org-ts-regexp-both x))
  7567. (org-float-time
  7568. (org-time-string-to-time (match-string 0 x)))
  7569. 0))
  7570. comparefun (if (= dcst sorting-type) '< '>)))
  7571. (t (error "Invalid sorting type `%c'" sorting-type)))
  7572. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7573. table)
  7574. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7575. ;;; The orgstruct minor mode
  7576. ;; Define a minor mode which can be used in other modes in order to
  7577. ;; integrate the org-mode structure editing commands.
  7578. ;; This is really a hack, because the org-mode structure commands use
  7579. ;; keys which normally belong to the major mode. Here is how it
  7580. ;; works: The minor mode defines all the keys necessary to operate the
  7581. ;; structure commands, but wraps the commands into a function which
  7582. ;; tests if the cursor is currently at a headline or a plain list
  7583. ;; item. If that is the case, the structure command is used,
  7584. ;; temporarily setting many Org-mode variables like regular
  7585. ;; expressions for filling etc. However, when any of those keys is
  7586. ;; used at a different location, function uses `key-binding' to look
  7587. ;; up if the key has an associated command in another currently active
  7588. ;; keymap (minor modes, major mode, global), and executes that
  7589. ;; command. There might be problems if any of the keys is otherwise
  7590. ;; used as a prefix key.
  7591. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  7592. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  7593. ;; addresses this by checking explicitly for both bindings.
  7594. (defvar orgstruct-mode-map (make-sparse-keymap)
  7595. "Keymap for the minor `orgstruct-mode'.")
  7596. (defvar org-local-vars nil
  7597. "List of local variables, for use by `orgstruct-mode'.")
  7598. ;;;###autoload
  7599. (define-minor-mode orgstruct-mode
  7600. "Toggle the minor mode `orgstruct-mode'.
  7601. This mode is for using Org-mode structure commands in other
  7602. modes. The following keys behave as if Org-mode were active, if
  7603. the cursor is on a headline, or on a plain list item (both as
  7604. defined by Org-mode).
  7605. M-up Move entry/item up
  7606. M-down Move entry/item down
  7607. M-left Promote
  7608. M-right Demote
  7609. M-S-up Move entry/item up
  7610. M-S-down Move entry/item down
  7611. M-S-left Promote subtree
  7612. M-S-right Demote subtree
  7613. M-q Fill paragraph and items like in Org-mode
  7614. C-c ^ Sort entries
  7615. C-c - Cycle list bullet
  7616. TAB Cycle item visibility
  7617. M-RET Insert new heading/item
  7618. S-M-RET Insert new TODO heading / Checkbox item
  7619. C-c C-c Set tags / toggle checkbox"
  7620. nil " OrgStruct" nil
  7621. (org-load-modules-maybe)
  7622. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7623. ;;;###autoload
  7624. (defun turn-on-orgstruct ()
  7625. "Unconditionally turn on `orgstruct-mode'."
  7626. (orgstruct-mode 1))
  7627. (defvar org-fb-vars nil)
  7628. (make-variable-buffer-local 'org-fb-vars)
  7629. (defun orgstruct++-mode (&optional arg)
  7630. "Toggle `orgstruct-mode', the enhanced version of it.
  7631. In addition to setting orgstruct-mode, this also exports all
  7632. indentation and autofilling variables from org-mode into the
  7633. buffer. It will also recognize item context in multiline items."
  7634. (interactive "P")
  7635. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7636. (if (< arg 1)
  7637. (progn (orgstruct-mode -1)
  7638. (mapc (lambda(v)
  7639. (org-set-local (car v)
  7640. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  7641. org-fb-vars))
  7642. (orgstruct-mode 1)
  7643. (setq org-fb-vars nil)
  7644. (let (var val)
  7645. (mapc
  7646. (lambda (x)
  7647. (when (string-match
  7648. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
  7649. (symbol-name (car x)))
  7650. (setq var (car x) val (nth 1 x))
  7651. (push (list var `(quote ,(eval var))) org-fb-vars)
  7652. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7653. org-local-vars)
  7654. (org-set-local 'orgstruct-is-++ t))))
  7655. (defvar orgstruct-is-++ nil
  7656. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  7657. (make-variable-buffer-local 'orgstruct-is-++)
  7658. ;;;###autoload
  7659. (defun turn-on-orgstruct++ ()
  7660. "Unconditionally turn on `orgstruct++-mode'."
  7661. (orgstruct++-mode 1))
  7662. (defun orgstruct-error ()
  7663. "Error when there is no default binding for a structure key."
  7664. (interactive)
  7665. (error "This key has no function outside structure elements"))
  7666. (defun orgstruct-setup ()
  7667. "Setup orgstruct keymaps."
  7668. (let ((nfunc 0)
  7669. (bindings
  7670. (list
  7671. '([(meta up)] org-metaup)
  7672. '([(meta down)] org-metadown)
  7673. '([(meta left)] org-metaleft)
  7674. '([(meta right)] org-metaright)
  7675. '([(meta shift up)] org-shiftmetaup)
  7676. '([(meta shift down)] org-shiftmetadown)
  7677. '([(meta shift left)] org-shiftmetaleft)
  7678. '([(meta shift right)] org-shiftmetaright)
  7679. '([?\e (up)] org-metaup)
  7680. '([?\e (down)] org-metadown)
  7681. '([?\e (left)] org-metaleft)
  7682. '([?\e (right)] org-metaright)
  7683. '([?\e (shift up)] org-shiftmetaup)
  7684. '([?\e (shift down)] org-shiftmetadown)
  7685. '([?\e (shift left)] org-shiftmetaleft)
  7686. '([?\e (shift right)] org-shiftmetaright)
  7687. '([(shift up)] org-shiftup)
  7688. '([(shift down)] org-shiftdown)
  7689. '([(shift left)] org-shiftleft)
  7690. '([(shift right)] org-shiftright)
  7691. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7692. '("\M-q" fill-paragraph)
  7693. '("\C-c^" org-sort)
  7694. '("\C-c-" org-cycle-list-bullet)))
  7695. elt key fun cmd)
  7696. (while (setq elt (pop bindings))
  7697. (setq nfunc (1+ nfunc))
  7698. (setq key (org-key (car elt))
  7699. fun (nth 1 elt)
  7700. cmd (orgstruct-make-binding fun nfunc key))
  7701. (org-defkey orgstruct-mode-map key cmd))
  7702. ;; Prevent an error for users who forgot to make autoloads
  7703. (require 'org-element)
  7704. ;; Special treatment needed for TAB and RET
  7705. (org-defkey orgstruct-mode-map [(tab)]
  7706. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7707. (org-defkey orgstruct-mode-map "\C-i"
  7708. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7709. (org-defkey orgstruct-mode-map "\M-\C-m"
  7710. (orgstruct-make-binding 'org-insert-heading 105
  7711. "\M-\C-m" [(meta return)]))
  7712. (org-defkey orgstruct-mode-map [(meta return)]
  7713. (orgstruct-make-binding 'org-insert-heading 106
  7714. [(meta return)] "\M-\C-m"))
  7715. (org-defkey orgstruct-mode-map [(shift meta return)]
  7716. (orgstruct-make-binding 'org-insert-todo-heading 107
  7717. [(meta return)] "\M-\C-m"))
  7718. (org-defkey orgstruct-mode-map "\e\C-m"
  7719. (orgstruct-make-binding 'org-insert-heading 108
  7720. "\e\C-m" [?\e (return)]))
  7721. (org-defkey orgstruct-mode-map [?\e (return)]
  7722. (orgstruct-make-binding 'org-insert-heading 109
  7723. [?\e (return)] "\e\C-m"))
  7724. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7725. (orgstruct-make-binding 'org-insert-todo-heading 110
  7726. [?\e (return)] "\e\C-m"))
  7727. (unless org-local-vars
  7728. (setq org-local-vars (org-get-local-variables)))
  7729. t))
  7730. (defun orgstruct-make-binding (fun n &rest keys)
  7731. "Create a function for binding in the structure minor mode.
  7732. FUN is the command to call inside a table. N is used to create a unique
  7733. command name. KEYS are keys that should be checked in for a command
  7734. to execute outside of tables."
  7735. (eval
  7736. (list 'defun
  7737. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7738. '(arg)
  7739. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7740. "Outside of structure, run the binding of `"
  7741. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7742. "'.")
  7743. '(interactive "p")
  7744. (list 'if
  7745. `(org-context-p 'headline 'item
  7746. (and orgstruct-is-++
  7747. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7748. 'item-body))
  7749. (list 'org-run-like-in-org-mode (list 'quote fun))
  7750. (list 'let '(orgstruct-mode)
  7751. (list 'call-interactively
  7752. (append '(or)
  7753. (mapcar (lambda (k)
  7754. (list 'key-binding k))
  7755. keys)
  7756. '('orgstruct-error))))))))
  7757. (defun org-contextualize-keys (alist contexts)
  7758. "Return valid elements in ALIST depending on CONTEXTS.
  7759. `org-agenda-custom-commands' or `org-capture-templates' are the
  7760. values used for ALIST, and `org-agenda-custom-commands-contexts'
  7761. or `org-capture-templates-contexts' are the associated contexts
  7762. definitions."
  7763. (let ((contexts
  7764. ;; normalize contexts
  7765. (mapcar
  7766. (lambda(c) (cond ((listp (cadr c))
  7767. (list (car c) (car c) (cadr c)))
  7768. ((string= "" (cadr c))
  7769. (list (car c) (car c) (caddr c)))
  7770. (t c))) contexts))
  7771. (a alist) c r s)
  7772. ;; loop over all commands or templates
  7773. (while (setq c (pop a))
  7774. (let (vrules repl)
  7775. (cond
  7776. ((not (assoc (car c) contexts))
  7777. (push c r))
  7778. ((and (assoc (car c) contexts)
  7779. (setq vrules (org-contextualize-validate-key
  7780. (car c) contexts)))
  7781. (mapc (lambda (vr)
  7782. (when (not (equal (car vr) (cadr vr)))
  7783. (setq repl vr))) vrules)
  7784. (if (not repl) (push c r)
  7785. (push (cadr repl) s)
  7786. (push
  7787. (cons (car c)
  7788. (cdr (or (assoc (cadr repl) alist)
  7789. (error "Undefined key `%s' as contextual replacement for `%s'"
  7790. (cadr repl) (car c)))))
  7791. r))))))
  7792. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  7793. (delq
  7794. nil
  7795. (delete-dups
  7796. (mapcar (lambda (x)
  7797. (let ((tpl (car x)))
  7798. (when (not (delq
  7799. nil
  7800. (mapcar (lambda(y)
  7801. (equal y tpl)) s))) x)))
  7802. (reverse r))))))
  7803. (defun org-contextualize-validate-key (key contexts)
  7804. "Check CONTEXTS for agenda or capture KEY."
  7805. (let (r rr res)
  7806. (while (setq r (pop contexts))
  7807. (mapc
  7808. (lambda (rr)
  7809. (when
  7810. (and (equal key (car r))
  7811. (if (functionp rr) (funcall rr)
  7812. (or (and (eq (car rr) 'in-file)
  7813. (buffer-file-name)
  7814. (string-match (cdr rr) (buffer-file-name)))
  7815. (and (eq (car rr) 'in-mode)
  7816. (string-match (cdr rr) (symbol-name major-mode)))
  7817. (when (and (eq (car rr) 'not-in-file)
  7818. (buffer-file-name))
  7819. (not (string-match (cdr rr) (buffer-file-name))))
  7820. (when (eq (car rr) 'not-in-mode)
  7821. (not (string-match (cdr rr) (symbol-name major-mode)))))))
  7822. (push r res)))
  7823. (car (last r))))
  7824. (delete-dups (delq nil res))))
  7825. (defun org-context-p (&rest contexts)
  7826. "Check if local context is any of CONTEXTS.
  7827. Possible values in the list of contexts are `table', `headline', and `item'."
  7828. (let ((pos (point)))
  7829. (goto-char (point-at-bol))
  7830. (prog1 (or (and (memq 'table contexts)
  7831. (looking-at "[ \t]*|"))
  7832. (and (memq 'headline contexts)
  7833. (looking-at org-outline-regexp))
  7834. (and (memq 'item contexts)
  7835. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7836. (and (memq 'item-body contexts)
  7837. (org-in-item-p)))
  7838. (goto-char pos))))
  7839. (defun org-get-local-variables ()
  7840. "Return a list of all local variables in an Org mode buffer."
  7841. (let (varlist)
  7842. (with-current-buffer (get-buffer-create "*Org tmp*")
  7843. (erase-buffer)
  7844. (org-mode)
  7845. (setq varlist (buffer-local-variables)))
  7846. (kill-buffer "*Org tmp*")
  7847. (delq nil
  7848. (mapcar
  7849. (lambda (x)
  7850. (setq x
  7851. (if (symbolp x)
  7852. (list x)
  7853. (list (car x) (list 'quote (cdr x)))))
  7854. (if (string-match
  7855. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  7856. (symbol-name (car x)))
  7857. x nil))
  7858. varlist))))
  7859. (defun org-clone-local-variables (from-buffer &optional regexp)
  7860. "Clone local variables from FROM-BUFFER.
  7861. Optional argument REGEXP selects variables to clone."
  7862. (mapc
  7863. (lambda (pair)
  7864. (and (symbolp (car pair))
  7865. (or (null regexp)
  7866. (string-match regexp (symbol-name (car pair))))
  7867. (set (make-local-variable (car pair))
  7868. (cdr pair))))
  7869. (buffer-local-variables from-buffer)))
  7870. ;;;###autoload
  7871. (defun org-run-like-in-org-mode (cmd)
  7872. "Run a command, pretending that the current buffer is in Org-mode.
  7873. This will temporarily bind local variables that are typically bound in
  7874. Org-mode to the values they have in Org-mode, and then interactively
  7875. call CMD."
  7876. (org-load-modules-maybe)
  7877. (unless org-local-vars
  7878. (setq org-local-vars (org-get-local-variables)))
  7879. (eval (list 'let org-local-vars
  7880. (list 'call-interactively (list 'quote cmd)))))
  7881. ;;;; Archiving
  7882. (defun org-get-category (&optional pos force-refresh)
  7883. "Get the category applying to position POS."
  7884. (save-match-data
  7885. (if force-refresh (org-refresh-category-properties))
  7886. (let ((pos (or pos (point))))
  7887. (or (get-text-property pos 'org-category)
  7888. (progn (org-refresh-category-properties)
  7889. (get-text-property pos 'org-category))))))
  7890. (defun org-refresh-category-properties ()
  7891. "Refresh category text properties in the buffer."
  7892. (let ((case-fold-search t)
  7893. (inhibit-read-only t)
  7894. (def-cat (cond
  7895. ((null org-category)
  7896. (if buffer-file-name
  7897. (file-name-sans-extension
  7898. (file-name-nondirectory buffer-file-name))
  7899. "???"))
  7900. ((symbolp org-category) (symbol-name org-category))
  7901. (t org-category)))
  7902. beg end cat pos optionp)
  7903. (org-unmodified
  7904. (save-excursion
  7905. (save-restriction
  7906. (widen)
  7907. (goto-char (point-min))
  7908. (put-text-property (point) (point-max) 'org-category def-cat)
  7909. (while (re-search-forward
  7910. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7911. (setq pos (match-end 0)
  7912. optionp (equal (char-after (match-beginning 0)) ?#)
  7913. cat (org-trim (match-string 2)))
  7914. (if optionp
  7915. (setq beg (point-at-bol) end (point-max))
  7916. (org-back-to-heading t)
  7917. (setq beg (point) end (org-end-of-subtree t t)))
  7918. (put-text-property beg end 'org-category cat)
  7919. (put-text-property beg end 'org-category-position beg)
  7920. (goto-char pos)))))))
  7921. ;;;; Link Stuff
  7922. ;;; Link abbreviations
  7923. (defun org-link-expand-abbrev (link)
  7924. "Apply replacements as defined in `org-link-abbrev-alist'."
  7925. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  7926. (let* ((key (match-string 1 link))
  7927. (as (or (assoc key org-link-abbrev-alist-local)
  7928. (assoc key org-link-abbrev-alist)))
  7929. (tag (and (match-end 2) (match-string 3 link)))
  7930. rpl)
  7931. (if (not as)
  7932. link
  7933. (setq rpl (cdr as))
  7934. (cond
  7935. ((symbolp rpl) (funcall rpl tag))
  7936. ((string-match "%(\\([^)]+\\))" rpl)
  7937. (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
  7938. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7939. ((string-match "%h" rpl)
  7940. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7941. (t (concat rpl tag)))))
  7942. link))
  7943. ;;; Storing and inserting links
  7944. (defvar org-insert-link-history nil
  7945. "Minibuffer history for links inserted with `org-insert-link'.")
  7946. (defvar org-stored-links nil
  7947. "Contains the links stored with `org-store-link'.")
  7948. (defvar org-store-link-plist nil
  7949. "Plist with info about the most recently link created with `org-store-link'.")
  7950. (defvar org-link-protocols nil
  7951. "Link protocols added to Org-mode using `org-add-link-type'.")
  7952. (defvar org-store-link-functions nil
  7953. "List of functions that are called to create and store a link.
  7954. Each function will be called in turn until one returns a non-nil
  7955. value. Each function should check if it is responsible for creating
  7956. this link (for example by looking at the major mode).
  7957. If not, it must exit and return nil.
  7958. If yes, it should return a non-nil value after a calling
  7959. `org-store-link-props' with a list of properties and values.
  7960. Special properties are:
  7961. :type The link prefix, like \"http\". This must be given.
  7962. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7963. This is obligatory as well.
  7964. :description Optional default description for the second pair
  7965. of brackets in an Org-mode link. The user can still change
  7966. this when inserting this link into an Org-mode buffer.
  7967. In addition to these, any additional properties can be specified
  7968. and then used in remember templates.")
  7969. (defun org-add-link-type (type &optional follow export)
  7970. "Add TYPE to the list of `org-link-types'.
  7971. Re-compute all regular expressions depending on `org-link-types'
  7972. FOLLOW and EXPORT are two functions.
  7973. FOLLOW should take the link path as the single argument and do whatever
  7974. is necessary to follow the link, for example find a file or display
  7975. a mail message.
  7976. EXPORT should format the link path for export to one of the export formats.
  7977. It should be a function accepting three arguments:
  7978. path the path of the link, the text after the prefix (like \"http:\")
  7979. desc the description of the link, if any, or a description added by
  7980. org-export-normalize-links if there is none
  7981. format the export format, a symbol like `html' or `latex' or `ascii'..
  7982. The function may use the FORMAT information to return different values
  7983. depending on the format. The return value will be put literally into
  7984. the exported file. If the return value is nil, this means Org should
  7985. do what it normally does with links which do not have EXPORT defined.
  7986. Org-mode has a built-in default for exporting links. If you are happy with
  7987. this default, there is no need to define an export function for the link
  7988. type. For a simple example of an export function, see `org-bbdb.el'."
  7989. (add-to-list 'org-link-types type t)
  7990. (org-make-link-regexps)
  7991. (if (assoc type org-link-protocols)
  7992. (setcdr (assoc type org-link-protocols) (list follow export))
  7993. (push (list type follow export) org-link-protocols)))
  7994. (defvar org-agenda-buffer-name)
  7995. ;;;###autoload
  7996. (defun org-store-link (arg)
  7997. "\\<org-mode-map>Store an org-link to the current location.
  7998. This link is added to `org-stored-links' and can later be inserted
  7999. into an org-buffer with \\[org-insert-link].
  8000. For some link types, a prefix arg is interpreted:
  8001. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  8002. For file links, arg negates `org-context-in-file-links'."
  8003. (interactive "P")
  8004. (org-load-modules-maybe)
  8005. (setq org-store-link-plist nil) ; reset
  8006. (org-with-limited-levels
  8007. (let (link cpltxt desc description search txt custom-id agenda-link)
  8008. (cond
  8009. ((run-hook-with-args-until-success 'org-store-link-functions)
  8010. (setq link (plist-get org-store-link-plist :link)
  8011. desc (or (plist-get org-store-link-plist :description) link)))
  8012. ((org-src-edit-buffer-p)
  8013. (let (label gc)
  8014. (while (or (not label)
  8015. (save-excursion
  8016. (save-restriction
  8017. (widen)
  8018. (goto-char (point-min))
  8019. (re-search-forward
  8020. (regexp-quote (format org-coderef-label-format label))
  8021. nil t))))
  8022. (when label (message "Label exists already") (sit-for 2))
  8023. (setq label (read-string "Code line label: " label)))
  8024. (end-of-line 1)
  8025. (setq link (format org-coderef-label-format label))
  8026. (setq gc (- 79 (length link)))
  8027. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  8028. (insert link)
  8029. (setq link (concat "(" label ")") desc nil)))
  8030. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  8031. ;; We are in the agenda, link to referenced location
  8032. (let ((m (or (get-text-property (point) 'org-hd-marker)
  8033. (get-text-property (point) 'org-marker))))
  8034. (when m
  8035. (org-with-point-at m
  8036. (setq agenda-link
  8037. (if (org-called-interactively-p 'any)
  8038. (call-interactively 'org-store-link)
  8039. (org-store-link nil)))))))
  8040. ((eq major-mode 'calendar-mode)
  8041. (let ((cd (calendar-cursor-to-date)))
  8042. (setq link
  8043. (format-time-string
  8044. (car org-time-stamp-formats)
  8045. (apply 'encode-time
  8046. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  8047. nil nil nil))))
  8048. (org-store-link-props :type "calendar" :date cd)))
  8049. ((eq major-mode 'help-mode)
  8050. (setq link (concat "help:" (save-excursion
  8051. (goto-char (point-min))
  8052. (looking-at "^[^ ]+")
  8053. (match-string 0))))
  8054. (org-store-link-props :type "help"))
  8055. ((eq major-mode 'w3-mode)
  8056. (setq cpltxt (if (and (buffer-name)
  8057. (not (string-match "Untitled" (buffer-name))))
  8058. (buffer-name)
  8059. (url-view-url t))
  8060. link (url-view-url t))
  8061. (org-store-link-props :type "w3" :url (url-view-url t)))
  8062. ((eq major-mode 'w3m-mode)
  8063. (setq cpltxt (or w3m-current-title w3m-current-url)
  8064. link w3m-current-url)
  8065. (org-store-link-props :type "w3m" :url (url-view-url t)))
  8066. ((setq search (run-hook-with-args-until-success
  8067. 'org-create-file-search-functions))
  8068. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  8069. "::" search))
  8070. (setq cpltxt (or description link)))
  8071. ((eq major-mode 'image-mode)
  8072. (setq cpltxt (concat "file:"
  8073. (abbreviate-file-name buffer-file-name))
  8074. link cpltxt)
  8075. (org-store-link-props :type "image" :file buffer-file-name))
  8076. ((eq major-mode 'dired-mode)
  8077. ;; link to the file in the current line
  8078. (let ((file (dired-get-filename nil t)))
  8079. (setq file (if file
  8080. (abbreviate-file-name
  8081. (expand-file-name (dired-get-filename nil t)))
  8082. ;; otherwise, no file so use current directory.
  8083. default-directory))
  8084. (setq cpltxt (concat "file:" file)
  8085. link cpltxt)))
  8086. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  8087. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  8088. (cond
  8089. ((org-in-regexp "<<\\(.*?\\)>>")
  8090. (setq cpltxt
  8091. (concat "file:"
  8092. (abbreviate-file-name
  8093. (buffer-file-name (buffer-base-buffer)))
  8094. "::" (match-string 1))
  8095. link cpltxt))
  8096. ((and (featurep 'org-id)
  8097. (or (eq org-link-to-org-use-id t)
  8098. (and (org-called-interactively-p 'any)
  8099. (or (eq org-link-to-org-use-id 'create-if-interactive)
  8100. (and (eq org-link-to-org-use-id
  8101. 'create-if-interactive-and-no-custom-id)
  8102. (not custom-id))))
  8103. (and org-link-to-org-use-id (org-entry-get nil "ID"))))
  8104. ;; We can make a link using the ID.
  8105. (setq link (condition-case nil
  8106. (prog1 (org-id-store-link)
  8107. (setq desc (plist-get org-store-link-plist :description)))
  8108. (error
  8109. ;; probably before first headline, link to file only
  8110. (concat "file:"
  8111. (abbreviate-file-name
  8112. (buffer-file-name (buffer-base-buffer))))))))
  8113. (t
  8114. ;; Just link to current headline
  8115. (setq cpltxt (concat "file:"
  8116. (abbreviate-file-name
  8117. (buffer-file-name (buffer-base-buffer)))))
  8118. ;; Add a context search string
  8119. (when (org-xor org-context-in-file-links arg)
  8120. (setq txt (cond
  8121. ((org-at-heading-p) nil)
  8122. ((org-region-active-p)
  8123. (buffer-substring (region-beginning) (region-end)))))
  8124. (when (or (null txt) (string-match "\\S-" txt))
  8125. (setq cpltxt
  8126. (concat cpltxt "::"
  8127. (condition-case nil
  8128. (org-make-org-heading-search-string txt)
  8129. (error "")))
  8130. desc (or (nth 4 (ignore-errors
  8131. (org-heading-components))) "NONE"))))
  8132. (if (string-match "::\\'" cpltxt)
  8133. (setq cpltxt (substring cpltxt 0 -2)))
  8134. (setq link cpltxt))))
  8135. ((buffer-file-name (buffer-base-buffer))
  8136. ;; Just link to this file here.
  8137. (setq cpltxt (concat "file:"
  8138. (abbreviate-file-name
  8139. (buffer-file-name (buffer-base-buffer)))))
  8140. ;; Add a context string
  8141. (when (org-xor org-context-in-file-links arg)
  8142. (setq txt (if (org-region-active-p)
  8143. (buffer-substring (region-beginning) (region-end))
  8144. (buffer-substring (point-at-bol) (point-at-eol))))
  8145. ;; Only use search option if there is some text.
  8146. (when (string-match "\\S-" txt)
  8147. (setq cpltxt
  8148. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8149. desc "NONE")))
  8150. (setq link cpltxt))
  8151. ((org-called-interactively-p 'interactive)
  8152. (error "Cannot link to a buffer which is not visiting a file"))
  8153. (t (setq link nil)))
  8154. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8155. (setq link (or link cpltxt)
  8156. desc (or desc cpltxt))
  8157. (if (equal desc "NONE") (setq desc nil))
  8158. (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
  8159. (progn
  8160. (setq org-stored-links
  8161. (cons (list link desc) org-stored-links))
  8162. (message "Stored: %s" (or desc link))
  8163. (when custom-id
  8164. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  8165. "::#" custom-id))
  8166. (setq org-stored-links
  8167. (cons (list link desc) org-stored-links))))
  8168. (or agenda-link (and link (org-make-link-string link desc)))))))
  8169. (defun org-store-link-props (&rest plist)
  8170. "Store link properties, extract names and addresses."
  8171. (let (x adr)
  8172. (when (setq x (plist-get plist :from))
  8173. (setq adr (mail-extract-address-components x))
  8174. (setq plist (plist-put plist :fromname (car adr)))
  8175. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8176. (when (setq x (plist-get plist :to))
  8177. (setq adr (mail-extract-address-components x))
  8178. (setq plist (plist-put plist :toname (car adr)))
  8179. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8180. (let ((from (plist-get plist :from))
  8181. (to (plist-get plist :to)))
  8182. (when (and from to org-from-is-user-regexp)
  8183. (setq plist
  8184. (plist-put plist :fromto
  8185. (if (string-match org-from-is-user-regexp from)
  8186. (concat "to %t")
  8187. (concat "from %f"))))))
  8188. (setq org-store-link-plist plist))
  8189. (defun org-add-link-props (&rest plist)
  8190. "Add these properties to the link property list."
  8191. (let (key value)
  8192. (while plist
  8193. (setq key (pop plist) value (pop plist))
  8194. (setq org-store-link-plist
  8195. (plist-put org-store-link-plist key value)))))
  8196. (defun org-email-link-description (&optional fmt)
  8197. "Return the description part of an email link.
  8198. This takes information from `org-store-link-plist' and formats it
  8199. according to FMT (default from `org-email-link-description-format')."
  8200. (setq fmt (or fmt org-email-link-description-format))
  8201. (let* ((p org-store-link-plist)
  8202. (to (plist-get p :toaddress))
  8203. (from (plist-get p :fromaddress))
  8204. (table
  8205. (list
  8206. (cons "%c" (plist-get p :fromto))
  8207. (cons "%F" (plist-get p :from))
  8208. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8209. (cons "%T" (plist-get p :to))
  8210. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8211. (cons "%s" (plist-get p :subject))
  8212. (cons "%d" (plist-get p :date))
  8213. (cons "%m" (plist-get p :message-id)))))
  8214. (when (string-match "%c" fmt)
  8215. ;; Check if the user wrote this message
  8216. (if (and org-from-is-user-regexp from to
  8217. (save-match-data (string-match org-from-is-user-regexp from)))
  8218. (setq fmt (replace-match "to %t" t t fmt))
  8219. (setq fmt (replace-match "from %f" t t fmt))))
  8220. (org-replace-escapes fmt table)))
  8221. (defun org-make-org-heading-search-string (&optional string heading)
  8222. "Make search string for STRING or current headline."
  8223. (interactive)
  8224. (let ((s (or string (org-get-heading)))
  8225. (lines org-context-in-file-links))
  8226. (unless (and string (not heading))
  8227. ;; We are using a headline, clean up garbage in there.
  8228. (if (string-match org-todo-regexp s)
  8229. (setq s (replace-match "" t t s)))
  8230. (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
  8231. (setq s (replace-match "" t t s)))
  8232. (setq s (org-trim s))
  8233. (if (string-match (concat "^\\(" org-quote-string "\\|"
  8234. org-comment-string "\\)") s)
  8235. (setq s (replace-match "" t t s)))
  8236. (while (string-match org-ts-regexp s)
  8237. (setq s (replace-match "" t t s))))
  8238. (or string (setq s (concat "*" s))) ; Add * for headlines
  8239. (when (and string (integerp lines) (> lines 0))
  8240. (let ((slines (org-split-string s "\n")))
  8241. (when (< lines (length slines))
  8242. (setq s (mapconcat
  8243. 'identity
  8244. (reverse (nthcdr (- (length slines) lines)
  8245. (reverse slines))) "\n")))))
  8246. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8247. (defun org-make-link-string (link &optional description)
  8248. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8249. (unless (string-match "\\S-" link)
  8250. (error "Empty link"))
  8251. (when (and description
  8252. (stringp description)
  8253. (not (string-match "\\S-" description)))
  8254. (setq description nil))
  8255. (when (stringp description)
  8256. ;; Remove brackets from the description, they are fatal.
  8257. (while (string-match "\\[" description)
  8258. (setq description (replace-match "{" t t description)))
  8259. (while (string-match "\\]" description)
  8260. (setq description (replace-match "}" t t description))))
  8261. (when (equal link description)
  8262. ;; No description needed, it is identical
  8263. (setq description nil))
  8264. (when (and (not description)
  8265. (not (string-match (org-image-file-name-regexp) link))
  8266. (not (equal link (org-link-escape link))))
  8267. (setq description (org-extract-attributes link)))
  8268. (setq link
  8269. (cond ((string-match (org-image-file-name-regexp) link) link)
  8270. ((string-match org-link-types-re link)
  8271. (concat (match-string 1 link)
  8272. (org-link-escape (substring link (match-end 1)))))
  8273. (t (org-link-escape link))))
  8274. (concat "[[" link "]"
  8275. (if description (concat "[" description "]") "")
  8276. "]"))
  8277. (defconst org-link-escape-chars
  8278. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  8279. "List of characters that should be escaped in link.
  8280. This is the list that is used for internal purposes.")
  8281. (defconst org-link-escape-chars-browser
  8282. '(?\ )
  8283. "List of escapes for characters that are problematic in links.
  8284. This is the list that is used before handing over to the browser.")
  8285. (defun org-link-escape (text &optional table merge)
  8286. "Return percent escaped representation of TEXT.
  8287. TEXT is a string with the text to escape.
  8288. Optional argument TABLE is a list with characters that should be
  8289. escaped. When nil, `org-link-escape-chars' is used.
  8290. If optional argument MERGE is set, merge TABLE into
  8291. `org-link-escape-chars'."
  8292. (cond
  8293. ((and table merge)
  8294. (mapc (lambda (defchr)
  8295. (unless (member defchr table)
  8296. (setq table (cons defchr table)))) org-link-escape-chars))
  8297. ((null table)
  8298. (setq table org-link-escape-chars)))
  8299. (mapconcat
  8300. (lambda (char)
  8301. (if (or (member char table)
  8302. (and (or (< char 32) (= char 37) (> char 126))
  8303. org-url-hexify-p))
  8304. (mapconcat (lambda (sequence-element)
  8305. (format "%%%.2X" sequence-element))
  8306. (or (encode-coding-char char 'utf-8)
  8307. (error "Unable to percent escape character: %s"
  8308. (char-to-string char))) "")
  8309. (char-to-string char))) text ""))
  8310. (defun org-link-unescape (str)
  8311. "Unhex hexified Unicode strings as returned from the JavaScript function
  8312. encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
  8313. (unless (and (null str) (string= "" str))
  8314. (let ((pos 0) (case-fold-search t) unhexed)
  8315. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8316. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8317. (setq str (replace-match unhexed t t str))
  8318. (setq pos (+ pos (length unhexed))))))
  8319. str)
  8320. (defun org-link-unescape-compound (hex)
  8321. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
  8322. Note: this function also decodes single byte encodings like
  8323. `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
  8324. (save-match-data
  8325. (let* ((bytes (cdr (split-string hex "%")))
  8326. (ret "")
  8327. (eat 0)
  8328. (sum 0))
  8329. (while bytes
  8330. (let* ((val (string-to-number (pop bytes) 16))
  8331. (shift-xor
  8332. (if (= 0 eat)
  8333. (cond
  8334. ((>= val 252) (cons 6 252))
  8335. ((>= val 248) (cons 5 248))
  8336. ((>= val 240) (cons 4 240))
  8337. ((>= val 224) (cons 3 224))
  8338. ((>= val 192) (cons 2 192))
  8339. (t (cons 0 0)))
  8340. (cons 6 128))))
  8341. (if (>= val 192) (setq eat (car shift-xor)))
  8342. (setq val (logxor val (cdr shift-xor)))
  8343. (setq sum (+ (lsh sum (car shift-xor)) val))
  8344. (if (> eat 0) (setq eat (- eat 1)))
  8345. (cond
  8346. ((= 0 eat) ;multi byte
  8347. (setq ret (concat ret (org-char-to-string sum)))
  8348. (setq sum 0))
  8349. ((not bytes) ; single byte(s)
  8350. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8351. )) ;; end (while bytes
  8352. ret )))
  8353. (defun org-link-unescape-single-byte-sequence (hex)
  8354. "Unhexify hex-encoded single byte character sequences."
  8355. (mapconcat (lambda (byte)
  8356. (char-to-string (string-to-number byte 16)))
  8357. (cdr (split-string hex "%")) ""))
  8358. (defun org-xor (a b)
  8359. "Exclusive or."
  8360. (if a (not b) b))
  8361. (defun org-fixup-message-id-for-http (s)
  8362. "Replace special characters in a message id, so it can be used in an http query."
  8363. (when (string-match "%" s)
  8364. (setq s (mapconcat (lambda (c)
  8365. (if (eq c ?%)
  8366. "%25"
  8367. (char-to-string c)))
  8368. s "")))
  8369. (while (string-match "<" s)
  8370. (setq s (replace-match "%3C" t t s)))
  8371. (while (string-match ">" s)
  8372. (setq s (replace-match "%3E" t t s)))
  8373. (while (string-match "@" s)
  8374. (setq s (replace-match "%40" t t s)))
  8375. s)
  8376. (defun org-link-prettify (link)
  8377. "Return a human-readable representation of LINK.
  8378. The car of LINK must be a raw link the cdr of LINK must be either
  8379. a link description or nil."
  8380. (let ((desc (or (cadr link) "<no description>")))
  8381. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8382. "<" (car link) ">")))
  8383. ;;;###autoload
  8384. (defun org-insert-link-global ()
  8385. "Insert a link like Org-mode does.
  8386. This command can be called in any mode to insert a link in Org-mode syntax."
  8387. (interactive)
  8388. (org-load-modules-maybe)
  8389. (org-run-like-in-org-mode 'org-insert-link))
  8390. (defun org-insert-all-links (&optional keep)
  8391. "Insert all links in `org-stored-links'."
  8392. (interactive "P")
  8393. (let ((links (copy-sequence org-stored-links)) l)
  8394. (while (setq l (if keep (pop links) (pop org-stored-links)))
  8395. (insert "- ")
  8396. (org-insert-link nil (car l) (cadr l))
  8397. (insert "\n"))))
  8398. (defun org-link-fontify-links-to-this-file ()
  8399. "Fontify links to the current file in `org-stored-links'."
  8400. (let ((f (buffer-file-name)) a b)
  8401. (setq a (mapcar (lambda(l)
  8402. (let ((ll (car l)))
  8403. (when (and (string-match "^file:\\(.+\\)::" ll)
  8404. (equal f (expand-file-name (match-string 1 ll))))
  8405. ll)))
  8406. org-stored-links))
  8407. (when (featurep 'org-id)
  8408. (setq b (mapcar (lambda(l)
  8409. (let ((ll (car l)))
  8410. (when (and (string-match "^id:\\(.+\\)$" ll)
  8411. (equal f (expand-file-name
  8412. (or (org-id-find-id-file
  8413. (match-string 1 ll)) ""))))
  8414. ll)))
  8415. org-stored-links)))
  8416. (mapcar (lambda(l)
  8417. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  8418. (delq nil (append a b)))))
  8419. (defvar org-link-links-in-this-file nil)
  8420. (defun org-insert-link (&optional complete-file link-location default-description)
  8421. "Insert a link. At the prompt, enter the link.
  8422. Completion can be used to insert any of the link protocol prefixes like
  8423. http or ftp in use.
  8424. The history can be used to select a link previously stored with
  8425. `org-store-link'. When the empty string is entered (i.e. if you just
  8426. press RET at the prompt), the link defaults to the most recently
  8427. stored link. As SPC triggers completion in the minibuffer, you need to
  8428. use M-SPC or C-q SPC to force the insertion of a space character.
  8429. You will also be prompted for a description, and if one is given, it will
  8430. be displayed in the buffer instead of the link.
  8431. If there is already a link at point, this command will allow you to edit link
  8432. and description parts.
  8433. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8434. be selected using completion. The path to the file will be relative to the
  8435. current directory if the file is in the current directory or a subdirectory.
  8436. Otherwise, the link will be the absolute path as completed in the minibuffer
  8437. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8438. option `org-link-file-path-type'.
  8439. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8440. the current directory or below.
  8441. With three \\[universal-argument] prefixes, negate the meaning of
  8442. `org-keep-stored-link-after-insertion'.
  8443. If `org-make-link-description-function' is non-nil, this function will be
  8444. called with the link target, and the result will be the default
  8445. link description.
  8446. If the LINK-LOCATION parameter is non-nil, this value will be
  8447. used as the link location instead of reading one interactively.
  8448. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8449. be used as the default description."
  8450. (interactive "P")
  8451. (let* ((wcf (current-window-configuration))
  8452. (region (if (org-region-active-p)
  8453. (buffer-substring (region-beginning) (region-end))))
  8454. (remove (and region (list (region-beginning) (region-end))))
  8455. (desc region)
  8456. tmphist ; byte-compile incorrectly complains about this
  8457. (link link-location)
  8458. (abbrevs org-link-abbrev-alist-local)
  8459. entry file all-prefixes auto-desc)
  8460. (cond
  8461. (link-location) ; specified by arg, just use it.
  8462. ((org-in-regexp org-bracket-link-regexp 1)
  8463. ;; We do have a link at point, and we are going to edit it.
  8464. (setq remove (list (match-beginning 0) (match-end 0)))
  8465. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8466. (setq link (read-string "Link: "
  8467. (org-link-unescape
  8468. (org-match-string-no-properties 1)))))
  8469. ((or (org-in-regexp org-angle-link-re)
  8470. (org-in-regexp org-plain-link-re))
  8471. ;; Convert to bracket link
  8472. (setq remove (list (match-beginning 0) (match-end 0))
  8473. link (read-string "Link: "
  8474. (org-remove-angle-brackets (match-string 0)))))
  8475. ((member complete-file '((4) (16)))
  8476. ;; Completing read for file names.
  8477. (setq link (org-file-complete-link complete-file)))
  8478. (t
  8479. ;; Read link, with completion for stored links.
  8480. (org-link-fontify-links-to-this-file)
  8481. (org-switch-to-buffer-other-window "*Org Links*")
  8482. (with-current-buffer "*Org Links*"
  8483. (erase-buffer)
  8484. (insert "Insert a link.
  8485. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  8486. (when org-stored-links
  8487. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  8488. (insert (mapconcat 'org-link-prettify
  8489. (reverse org-stored-links) "\n")))
  8490. (goto-char (point-min)))
  8491. (let ((cw (selected-window)))
  8492. (select-window (get-buffer-window "*Org Links*" 'visible))
  8493. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  8494. (unless (pos-visible-in-window-p (point-max))
  8495. (org-fit-window-to-buffer))
  8496. (and (window-live-p cw) (select-window cw)))
  8497. ;; Fake a link history, containing the stored links.
  8498. (setq tmphist (append (mapcar 'car org-stored-links)
  8499. org-insert-link-history))
  8500. (setq all-prefixes (append (mapcar 'car abbrevs)
  8501. (mapcar 'car org-link-abbrev-alist)
  8502. org-link-types))
  8503. (unwind-protect
  8504. (progn
  8505. (setq link
  8506. (let ((org-completion-use-ido nil)
  8507. (org-completion-use-iswitchb nil))
  8508. (org-completing-read
  8509. "Link: "
  8510. (append
  8511. (mapcar (lambda (x) (list (concat x ":")))
  8512. all-prefixes)
  8513. (mapcar 'car org-stored-links)
  8514. (mapcar 'cadr org-stored-links))
  8515. nil nil nil
  8516. 'tmphist
  8517. (caar org-stored-links))))
  8518. (if (not (string-match "\\S-" link))
  8519. (error "No link selected"))
  8520. (mapc (lambda(l)
  8521. (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
  8522. org-stored-links)
  8523. (if (or (member link all-prefixes)
  8524. (and (equal ":" (substring link -1))
  8525. (member (substring link 0 -1) all-prefixes)
  8526. (setq link (substring link 0 -1))))
  8527. (setq link (org-link-try-special-completion link))))
  8528. (set-window-configuration wcf)
  8529. (kill-buffer "*Org Links*"))
  8530. (setq entry (assoc link org-stored-links))
  8531. (or entry (push link org-insert-link-history))
  8532. (setq desc (or desc (nth 1 entry)))))
  8533. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  8534. (not org-keep-stored-link-after-insertion))
  8535. (setq org-stored-links (delq (assoc link org-stored-links)
  8536. org-stored-links)))
  8537. (if (string-match org-plain-link-re link)
  8538. ;; URL-like link, normalize the use of angular brackets.
  8539. (setq link (org-remove-angle-brackets link)))
  8540. ;; Check if we are linking to the current file with a search option
  8541. ;; If yes, simplify the link by using only the search option.
  8542. (when (and buffer-file-name
  8543. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  8544. (let* ((path (match-string 1 link))
  8545. (case-fold-search nil)
  8546. (search (match-string 2 link)))
  8547. (save-match-data
  8548. (if (equal (file-truename buffer-file-name) (file-truename path))
  8549. ;; We are linking to this same file, with a search option
  8550. (setq link search)))))
  8551. ;; Check if we can/should use a relative path. If yes, simplify the link
  8552. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  8553. (let* ((type (match-string 1 link))
  8554. (path (match-string 2 link))
  8555. (origpath path)
  8556. (case-fold-search nil))
  8557. (cond
  8558. ((or (eq org-link-file-path-type 'absolute)
  8559. (equal complete-file '(16)))
  8560. (setq path (abbreviate-file-name (expand-file-name path))))
  8561. ((eq org-link-file-path-type 'noabbrev)
  8562. (setq path (expand-file-name path)))
  8563. ((eq org-link-file-path-type 'relative)
  8564. (setq path (file-relative-name path)))
  8565. (t
  8566. (save-match-data
  8567. (if (string-match (concat "^" (regexp-quote
  8568. (expand-file-name
  8569. (file-name-as-directory
  8570. default-directory))))
  8571. (expand-file-name path))
  8572. ;; We are linking a file with relative path name.
  8573. (setq path (substring (expand-file-name path)
  8574. (match-end 0)))
  8575. (setq path (abbreviate-file-name (expand-file-name path)))))))
  8576. (setq link (concat type path))
  8577. (if (equal desc origpath)
  8578. (setq desc path))))
  8579. (if org-make-link-description-function
  8580. (setq desc (funcall org-make-link-description-function link desc))
  8581. (if default-description (setq desc default-description)
  8582. (setq desc (or (and auto-desc desc)
  8583. (read-string "Description: " desc)))))
  8584. (unless (string-match "\\S-" desc) (setq desc nil))
  8585. (if remove (apply 'delete-region remove))
  8586. (insert (org-make-link-string link desc))))
  8587. (defun org-link-try-special-completion (type)
  8588. "If there is completion support for link type TYPE, offer it."
  8589. (let ((fun (intern (concat "org-" type "-complete-link"))))
  8590. (if (functionp fun)
  8591. (funcall fun)
  8592. (read-string "Link (no completion support): " (concat type ":")))))
  8593. (defun org-file-complete-link (&optional arg)
  8594. "Create a file link using completion."
  8595. (let (file link)
  8596. (setq file (read-file-name "File: "))
  8597. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  8598. (pwd1 (file-name-as-directory (abbreviate-file-name
  8599. (expand-file-name ".")))))
  8600. (cond
  8601. ((equal arg '(16))
  8602. (setq link (concat
  8603. "file:"
  8604. (abbreviate-file-name (expand-file-name file)))))
  8605. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  8606. (setq link (concat "file:" (match-string 1 file))))
  8607. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  8608. (expand-file-name file))
  8609. (setq link (concat
  8610. "file:" (match-string 1 (expand-file-name file)))))
  8611. (t (setq link (concat "file:" file)))))
  8612. link))
  8613. (defun org-completing-read (&rest args)
  8614. "Completing-read with SPACE being a normal character."
  8615. (let ((enable-recursive-minibuffers t)
  8616. (minibuffer-local-completion-map
  8617. (copy-keymap minibuffer-local-completion-map)))
  8618. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  8619. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  8620. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  8621. (apply 'org-icompleting-read args)))
  8622. (defun org-completing-read-no-i (&rest args)
  8623. (let (org-completion-use-ido org-completion-use-iswitchb)
  8624. (apply 'org-completing-read args)))
  8625. (defun org-iswitchb-completing-read (prompt choices &rest args)
  8626. "Use iswitch as a completing-read replacement to choose from choices.
  8627. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  8628. from."
  8629. (let* ((iswitchb-use-virtual-buffers nil)
  8630. (iswitchb-make-buflist-hook
  8631. (lambda ()
  8632. (setq iswitchb-temp-buflist choices))))
  8633. (iswitchb-read-buffer prompt)))
  8634. (defun org-icompleting-read (&rest args)
  8635. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  8636. (org-without-partial-completion
  8637. (if (and org-completion-use-ido
  8638. (fboundp 'ido-completing-read)
  8639. (boundp 'ido-mode) ido-mode
  8640. (listp (second args)))
  8641. (let ((ido-enter-matching-directory nil))
  8642. (apply 'ido-completing-read (concat (car args))
  8643. (if (consp (car (nth 1 args)))
  8644. (mapcar 'car (nth 1 args))
  8645. (nth 1 args))
  8646. (cddr args)))
  8647. (if (and org-completion-use-iswitchb
  8648. (boundp 'iswitchb-mode) iswitchb-mode
  8649. (listp (second args)))
  8650. (apply 'org-iswitchb-completing-read (concat (car args))
  8651. (if (consp (car (nth 1 args)))
  8652. (mapcar 'car (nth 1 args))
  8653. (nth 1 args))
  8654. (cddr args))
  8655. (apply 'completing-read args)))))
  8656. (defun org-extract-attributes (s)
  8657. "Extract the attributes cookie from a string and set as text property."
  8658. (let (a attr (start 0) key value)
  8659. (save-match-data
  8660. (when (string-match "{{\\([^}]+\\)}}$" s)
  8661. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  8662. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  8663. (setq key (match-string 1 a) value (match-string 2 a)
  8664. start (match-end 0)
  8665. attr (plist-put attr (intern key) value))))
  8666. (org-add-props s nil 'org-attr attr))
  8667. s))
  8668. (defun org-extract-attributes-from-string (tag)
  8669. (let (key value attr)
  8670. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  8671. (setq key (match-string 1 tag) value (match-string 2 tag)
  8672. tag (replace-match "" t t tag)
  8673. attr (plist-put attr (intern key) value)))
  8674. (cons tag attr)))
  8675. (defun org-attributes-to-string (plist)
  8676. "Format a property list into an HTML attribute list."
  8677. (let ((s "") key value)
  8678. (while plist
  8679. (setq key (pop plist) value (pop plist))
  8680. (and value
  8681. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  8682. s))
  8683. ;;; Opening/following a link
  8684. (defvar org-link-search-failed nil)
  8685. (defvar org-open-link-functions nil
  8686. "Hook for functions finding a plain text link.
  8687. These functions must take a single argument, the link content.
  8688. They will be called for links that look like [[link text][description]]
  8689. when LINK TEXT does not have a protocol like \"http:\" and does not look
  8690. like a filename (e.g. \"./blue.png\").
  8691. These functions will be called *before* Org attempts to resolve the
  8692. link by doing text searches in the current buffer - so if you want a
  8693. link \"[[target]]\" to still find \"<<target>>\", your function should
  8694. handle this as a special case.
  8695. When the function does handle the link, it must return a non-nil value.
  8696. If it decides that it is not responsible for this link, it must return
  8697. nil to indicate that that Org-mode can continue with other options
  8698. like exact and fuzzy text search.")
  8699. (defun org-next-link ()
  8700. "Move forward to the next link.
  8701. If the link is in hidden text, expose it."
  8702. (interactive)
  8703. (when (and org-link-search-failed (eq this-command last-command))
  8704. (goto-char (point-min))
  8705. (message "Link search wrapped back to beginning of buffer"))
  8706. (setq org-link-search-failed nil)
  8707. (let* ((pos (point))
  8708. (ct (org-context))
  8709. (a (assoc :link ct)))
  8710. (if a (goto-char (nth 2 a)))
  8711. (if (re-search-forward org-any-link-re nil t)
  8712. (progn
  8713. (goto-char (match-beginning 0))
  8714. (if (outline-invisible-p) (org-show-context)))
  8715. (goto-char pos)
  8716. (setq org-link-search-failed t)
  8717. (error "No further link found"))))
  8718. (defun org-previous-link ()
  8719. "Move backward to the previous link.
  8720. If the link is in hidden text, expose it."
  8721. (interactive)
  8722. (when (and org-link-search-failed (eq this-command last-command))
  8723. (goto-char (point-max))
  8724. (message "Link search wrapped back to end of buffer"))
  8725. (setq org-link-search-failed nil)
  8726. (let* ((pos (point))
  8727. (ct (org-context))
  8728. (a (assoc :link ct)))
  8729. (if a (goto-char (nth 1 a)))
  8730. (if (re-search-backward org-any-link-re nil t)
  8731. (progn
  8732. (goto-char (match-beginning 0))
  8733. (if (outline-invisible-p) (org-show-context)))
  8734. (goto-char pos)
  8735. (setq org-link-search-failed t)
  8736. (error "No further link found"))))
  8737. (defun org-translate-link (s)
  8738. "Translate a link string if a translation function has been defined."
  8739. (if (and org-link-translation-function
  8740. (fboundp org-link-translation-function)
  8741. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  8742. (progn
  8743. (setq s (funcall org-link-translation-function
  8744. (match-string 1 s) (match-string 2 s)))
  8745. (concat (car s) ":" (cdr s)))
  8746. s))
  8747. (defun org-translate-link-from-planner (type path)
  8748. "Translate a link from Emacs Planner syntax so that Org can follow it.
  8749. This is still an experimental function, your mileage may vary."
  8750. (cond
  8751. ((member type '("http" "https" "news" "ftp"))
  8752. ;; standard Internet links are the same.
  8753. nil)
  8754. ((and (equal type "irc") (string-match "^//" path))
  8755. ;; Planner has two / at the beginning of an irc link, we have 1.
  8756. ;; We should have zero, actually....
  8757. (setq path (substring path 1)))
  8758. ((and (equal type "lisp") (string-match "^/" path))
  8759. ;; Planner has a slash, we do not.
  8760. (setq type "elisp" path (substring path 1)))
  8761. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  8762. ;; A typical message link. Planner has the id after the final slash,
  8763. ;; we separate it with a hash mark
  8764. (setq path (concat (match-string 1 path) "#"
  8765. (org-remove-angle-brackets (match-string 2 path)))))
  8766. )
  8767. (cons type path))
  8768. (defun org-find-file-at-mouse (ev)
  8769. "Open file link or URL at mouse."
  8770. (interactive "e")
  8771. (mouse-set-point ev)
  8772. (org-open-at-point 'in-emacs))
  8773. (defun org-open-at-mouse (ev)
  8774. "Open file link or URL at mouse.
  8775. See the docstring of `org-open-file' for details."
  8776. (interactive "e")
  8777. (mouse-set-point ev)
  8778. (if (eq major-mode 'org-agenda-mode)
  8779. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  8780. (org-open-at-point))
  8781. (defvar org-window-config-before-follow-link nil
  8782. "The window configuration before following a link.
  8783. This is saved in case the need arises to restore it.")
  8784. (defvar org-open-link-marker (make-marker)
  8785. "Marker pointing to the location where `org-open-at-point; was called.")
  8786. ;;;###autoload
  8787. (defun org-open-at-point-global ()
  8788. "Follow a link like Org-mode does.
  8789. This command can be called in any mode to follow a link that has
  8790. Org-mode syntax."
  8791. (interactive)
  8792. (org-run-like-in-org-mode 'org-open-at-point))
  8793. ;;;###autoload
  8794. (defun org-open-link-from-string (s &optional arg reference-buffer)
  8795. "Open a link in the string S, as if it was in Org-mode."
  8796. (interactive "sLink: \nP")
  8797. (let ((reference-buffer (or reference-buffer (current-buffer))))
  8798. (with-temp-buffer
  8799. (let ((org-inhibit-startup (not reference-buffer)))
  8800. (org-mode)
  8801. (insert s)
  8802. (goto-char (point-min))
  8803. (when reference-buffer
  8804. (setq org-link-abbrev-alist-local
  8805. (with-current-buffer reference-buffer
  8806. org-link-abbrev-alist-local)))
  8807. (org-open-at-point arg reference-buffer)))))
  8808. (defvar org-open-at-point-functions nil
  8809. "Hook that is run when following a link at point.
  8810. Functions in this hook must return t if they identify and follow
  8811. a link at point. If they don't find anything interesting at point,
  8812. they must return nil.")
  8813. (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
  8814. (defun org-open-at-point (&optional arg reference-buffer)
  8815. "Open link at or after point.
  8816. If there is no link at point, this function will search forward up to
  8817. the end of the current line.
  8818. Normally, files will be opened by an appropriate application. If the
  8819. optional prefix argument ARG is non-nil, Emacs will visit the file.
  8820. With a double prefix argument, try to open outside of Emacs, in the
  8821. application the system uses for this file type."
  8822. (interactive "P")
  8823. ;; if in a code block, then open the block's results
  8824. (unless (call-interactively #'org-babel-open-src-block-result)
  8825. (org-load-modules-maybe)
  8826. (move-marker org-open-link-marker (point))
  8827. (setq org-window-config-before-follow-link (current-window-configuration))
  8828. (org-remove-occur-highlights nil nil t)
  8829. (cond
  8830. ((and (org-at-heading-p)
  8831. (not (org-at-timestamp-p t))
  8832. (not (org-in-regexp
  8833. (concat org-plain-link-re "\\|"
  8834. org-bracket-link-regexp "\\|"
  8835. org-angle-link-re "\\|"
  8836. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8837. (not (get-text-property (point) 'org-linked-text)))
  8838. (or (org-offer-links-in-entry arg)
  8839. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8840. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  8841. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  8842. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8843. (not (org-in-regexp org-bracket-link-regexp)))
  8844. (org-footnote-action))
  8845. (t
  8846. (let (type path link line search (pos (point)))
  8847. (catch 'match
  8848. (save-excursion
  8849. (skip-chars-forward "^]\n\r")
  8850. (when (org-in-regexp org-bracket-link-regexp 1)
  8851. (setq link (org-extract-attributes
  8852. (org-link-unescape (org-match-string-no-properties 1))))
  8853. (while (string-match " *\n *" link)
  8854. (setq link (replace-match " " t t link)))
  8855. (setq link (org-link-expand-abbrev link))
  8856. (cond
  8857. ((or (file-name-absolute-p link)
  8858. (string-match "^\\.\\.?/" link))
  8859. (setq type "file" path link))
  8860. ((string-match org-link-re-with-space3 link)
  8861. (setq type (match-string 1 link) path (match-string 2 link)))
  8862. ((string-match "^help:+\\(.+\\)" link)
  8863. (setq type "help" path (match-string 1 link)))
  8864. (t (setq type "thisfile" path link)))
  8865. (throw 'match t)))
  8866. (when (get-text-property (point) 'org-linked-text)
  8867. (setq type "thisfile"
  8868. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8869. (1+ (point)) (point))
  8870. path (buffer-substring
  8871. (or (previous-single-property-change pos 'org-linked-text)
  8872. (point-min))
  8873. (or (next-single-property-change pos 'org-linked-text)
  8874. (point-max))))
  8875. (throw 'match t))
  8876. (save-excursion
  8877. (when (or (org-in-regexp org-angle-link-re)
  8878. (and (goto-char (car (org-in-regexp org-plain-link-re)))
  8879. (save-match-data (not (looking-back "\\[\\[")))))
  8880. (setq type (match-string 1)
  8881. path (org-link-unescape (match-string 2)))
  8882. (throw 'match t)))
  8883. (save-excursion
  8884. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  8885. (setq type "tags"
  8886. path (match-string 1))
  8887. (while (string-match ":" path)
  8888. (setq path (replace-match "+" t t path)))
  8889. (throw 'match t)))
  8890. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8891. (setq type "tree-match"
  8892. path (match-string 1))
  8893. (throw 'match t)))
  8894. (unless path
  8895. (error "No link found"))
  8896. ;; switch back to reference buffer
  8897. ;; needed when if called in a temporary buffer through
  8898. ;; org-open-link-from-string
  8899. (with-current-buffer (or reference-buffer (current-buffer))
  8900. ;; Remove any trailing spaces in path
  8901. (if (string-match " +\\'" path)
  8902. (setq path (replace-match "" t t path)))
  8903. (if (and org-link-translation-function
  8904. (fboundp org-link-translation-function))
  8905. ;; Check if we need to translate the link
  8906. (let ((tmp (funcall org-link-translation-function type path)))
  8907. (setq type (car tmp) path (cdr tmp))))
  8908. (cond
  8909. ((assoc type org-link-protocols)
  8910. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8911. ((equal type "help")
  8912. (let ((f-or-v (intern path)))
  8913. (cond ((fboundp f-or-v)
  8914. (describe-function f-or-v))
  8915. ((boundp f-or-v)
  8916. (describe-variable f-or-v))
  8917. (t (error "Not a known function or variable")))))
  8918. ((equal type "mailto")
  8919. (let ((cmd (car org-link-mailto-program))
  8920. (args (cdr org-link-mailto-program)) args1
  8921. (address path) (subject "") a)
  8922. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8923. (setq address (match-string 1 path)
  8924. subject (org-link-escape (match-string 2 path))))
  8925. (while args
  8926. (cond
  8927. ((not (stringp (car args))) (push (pop args) args1))
  8928. (t (setq a (pop args))
  8929. (if (string-match "%a" a)
  8930. (setq a (replace-match address t t a)))
  8931. (if (string-match "%s" a)
  8932. (setq a (replace-match subject t t a)))
  8933. (push a args1))))
  8934. (apply cmd (nreverse args1))))
  8935. ((member type '("http" "https" "ftp" "news"))
  8936. (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
  8937. (org-link-escape
  8938. path org-link-escape-chars-browser)
  8939. path))))
  8940. ((string= type "doi")
  8941. (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
  8942. (org-link-escape
  8943. path org-link-escape-chars-browser)
  8944. path))))
  8945. ((member type '("message"))
  8946. (browse-url (concat type ":" path)))
  8947. ((string= type "tags")
  8948. (org-tags-view arg path))
  8949. ((string= type "tree-match")
  8950. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8951. ((string= type "file")
  8952. (if (string-match "::\\([0-9]+\\)\\'" path)
  8953. (setq line (string-to-number (match-string 1 path))
  8954. path (substring path 0 (match-beginning 0)))
  8955. (if (string-match "::\\(.+\\)\\'" path)
  8956. (setq search (match-string 1 path)
  8957. path (substring path 0 (match-beginning 0)))))
  8958. (if (string-match "[*?{]" (file-name-nondirectory path))
  8959. (dired path)
  8960. (org-open-file path arg line search)))
  8961. ((string= type "shell")
  8962. (let ((buf (generate-new-buffer "*Org Shell Output"))
  8963. (cmd path))
  8964. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  8965. (string-match org-confirm-shell-link-not-regexp cmd))
  8966. (not org-confirm-shell-link-function)
  8967. (funcall org-confirm-shell-link-function
  8968. (format "Execute \"%s\" in shell? "
  8969. (org-add-props cmd nil
  8970. 'face 'org-warning))))
  8971. (progn
  8972. (message "Executing %s" cmd)
  8973. (shell-command cmd buf)
  8974. (if (featurep 'midnight)
  8975. (setq clean-buffer-list-kill-buffer-names
  8976. (cons buf clean-buffer-list-kill-buffer-names))))
  8977. (error "Abort"))))
  8978. ((string= type "elisp")
  8979. (let ((cmd path))
  8980. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  8981. (string-match org-confirm-elisp-link-not-regexp cmd))
  8982. (not org-confirm-elisp-link-function)
  8983. (funcall org-confirm-elisp-link-function
  8984. (format "Execute \"%s\" as elisp? "
  8985. (org-add-props cmd nil
  8986. 'face 'org-warning))))
  8987. (message "%s => %s" cmd
  8988. (if (equal (string-to-char cmd) ?\()
  8989. (eval (read cmd))
  8990. (call-interactively (read cmd))))
  8991. (error "Abort"))))
  8992. ((and (string= type "thisfile")
  8993. (run-hook-with-args-until-success
  8994. 'org-open-link-functions path)))
  8995. ((string= type "thisfile")
  8996. (if arg
  8997. (switch-to-buffer-other-window
  8998. (org-get-buffer-for-internal-link (current-buffer)))
  8999. (org-mark-ring-push))
  9000. (let ((cmd `(org-link-search
  9001. ,path
  9002. ,(cond ((equal arg '(4)) ''occur)
  9003. ((equal arg '(16)) ''org-occur))
  9004. ,pos)))
  9005. (condition-case nil (let ((org-link-search-inhibit-query t))
  9006. (eval cmd))
  9007. (error (progn (widen) (eval cmd))))))
  9008. (t (browse-url-at-point)))))))
  9009. (move-marker org-open-link-marker nil)
  9010. (run-hook-with-args 'org-follow-link-hook)))
  9011. (defun org-offer-links-in-entry (&optional nth zero)
  9012. "Offer links in the current entry and follow the selected link.
  9013. If there is only one link, follow it immediately as well.
  9014. If NTH is an integer, immediately pick the NTH link found.
  9015. If ZERO is a string, check also this string for a link, and if
  9016. there is one, offer it as link number zero."
  9017. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  9018. "\\(" org-angle-link-re "\\)\\|"
  9019. "\\(" org-plain-link-re "\\)"))
  9020. (cnt ?0)
  9021. (in-emacs (if (integerp nth) nil nth))
  9022. have-zero end links link c)
  9023. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  9024. (push (match-string 0 zero) links)
  9025. (setq cnt (1- cnt) have-zero t))
  9026. (save-excursion
  9027. (org-back-to-heading t)
  9028. (setq end (save-excursion (outline-next-heading) (point)))
  9029. (while (re-search-forward re end t)
  9030. (push (match-string 0) links))
  9031. (setq links (org-uniquify (reverse links))))
  9032. (cond
  9033. ((null links)
  9034. (message "No links"))
  9035. ((equal (length links) 1)
  9036. (setq link (list (car links))))
  9037. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  9038. (setq link (list (nth (if have-zero nth (1- nth)) links))))
  9039. (t ; we have to select a link
  9040. (save-excursion
  9041. (save-window-excursion
  9042. (delete-other-windows)
  9043. (with-output-to-temp-buffer "*Select Link*"
  9044. (mapc (lambda (l)
  9045. (if (not (string-match org-bracket-link-regexp l))
  9046. (princ (format "[%c] %s\n" (incf cnt)
  9047. (org-remove-angle-brackets l)))
  9048. (if (match-end 3)
  9049. (princ (format "[%c] %s (%s)\n" (incf cnt)
  9050. (match-string 3 l) (match-string 1 l)))
  9051. (princ (format "[%c] %s\n" (incf cnt)
  9052. (match-string 1 l))))))
  9053. links))
  9054. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  9055. (message "Select link to open, RET to open all:")
  9056. (setq c (read-char-exclusive))
  9057. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  9058. (when (equal c ?q) (error "Abort"))
  9059. (if (equal c ?\C-m)
  9060. (setq link links)
  9061. (setq nth (- c ?0))
  9062. (if have-zero (setq nth (1+ nth)))
  9063. (unless (and (integerp nth) (>= (length links) nth))
  9064. (error "Invalid link selection"))
  9065. (setq link (list (nth (1- nth) links))))))
  9066. (if link
  9067. (let ((buf (current-buffer)))
  9068. (dolist (l link)
  9069. (org-open-link-from-string l in-emacs buf))
  9070. t)
  9071. nil)))
  9072. ;; Add special file links that specify the way of opening
  9073. (org-add-link-type "file+sys" 'org-open-file-with-system)
  9074. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  9075. (defun org-open-file-with-system (path)
  9076. "Open file at PATH using the system way of opening it."
  9077. (org-open-file path 'system))
  9078. (defun org-open-file-with-emacs (path)
  9079. "Open file at PATH in Emacs."
  9080. (org-open-file path 'emacs))
  9081. (defun org-remove-file-link-modifiers ()
  9082. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  9083. (goto-char (point-min))
  9084. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  9085. (org-if-unprotected
  9086. (replace-match "file:" t t))))
  9087. (eval-after-load "org-exp"
  9088. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  9089. 'org-remove-file-link-modifiers))
  9090. ;;;; Time estimates
  9091. (defun org-get-effort (&optional pom)
  9092. "Get the effort estimate for the current entry."
  9093. (org-entry-get pom org-effort-property))
  9094. ;;; File search
  9095. (defvar org-create-file-search-functions nil
  9096. "List of functions to construct the right search string for a file link.
  9097. These functions are called in turn with point at the location to
  9098. which the link should point.
  9099. A function in the hook should first test if it would like to
  9100. handle this file type, for example by checking the `major-mode'
  9101. or the file extension. If it decides not to handle this file, it
  9102. should just return nil to give other functions a chance. If it
  9103. does handle the file, it must return the search string to be used
  9104. when following the link. The search string will be part of the
  9105. file link, given after a double colon, and `org-open-at-point'
  9106. will automatically search for it. If special measures must be
  9107. taken to make the search successful, another function should be
  9108. added to the companion hook `org-execute-file-search-functions',
  9109. which see.
  9110. A function in this hook may also use `setq' to set the variable
  9111. `description' to provide a suggestion for the descriptive text to
  9112. be used for this link when it gets inserted into an Org-mode
  9113. buffer with \\[org-insert-link].")
  9114. (defvar org-execute-file-search-functions nil
  9115. "List of functions to execute a file search triggered by a link.
  9116. Functions added to this hook must accept a single argument, the
  9117. search string that was part of the file link, the part after the
  9118. double colon. The function must first check if it would like to
  9119. handle this search, for example by checking the `major-mode' or
  9120. the file extension. If it decides not to handle this search, it
  9121. should just return nil to give other functions a chance. If it
  9122. does handle the search, it must return a non-nil value to keep
  9123. other functions from trying.
  9124. Each function can access the current prefix argument through the
  9125. variable `current-prefix-argument'. Note that a single prefix is
  9126. used to force opening a link in Emacs, so it may be good to only
  9127. use a numeric or double prefix to guide the search function.
  9128. In case this is needed, a function in this hook can also restore
  9129. the window configuration before `org-open-at-point' was called using:
  9130. (set-window-configuration org-window-config-before-follow-link)")
  9131. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  9132. (defun org-link-search (s &optional type avoid-pos stealth)
  9133. "Search for a link search option.
  9134. If S is surrounded by forward slashes, it is interpreted as a
  9135. regular expression. In org-mode files, this will create an `org-occur'
  9136. sparse tree. In ordinary files, `occur' will be used to list matches.
  9137. If the current buffer is in `dired-mode', grep will be used to search
  9138. in all files. If AVOID-POS is given, ignore matches near that position.
  9139. When optional argument STEALTH is non-nil, do not modify
  9140. visibility around point, thus ignoring
  9141. `org-show-hierarchy-above', `org-show-following-heading' and
  9142. `org-show-siblings' variables."
  9143. (let ((case-fold-search t)
  9144. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  9145. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  9146. (append '(("") (" ") ("\t") ("\n"))
  9147. org-emphasis-alist)
  9148. "\\|") "\\)"))
  9149. (pos (point))
  9150. (pre nil) (post nil)
  9151. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  9152. (cond
  9153. ;; First check if there are any special search functions
  9154. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9155. ;; Now try the builtin stuff
  9156. ((and (equal (string-to-char s0) ?#)
  9157. (> (length s0) 1)
  9158. (save-excursion
  9159. (goto-char (point-min))
  9160. (and
  9161. (re-search-forward
  9162. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  9163. (setq type 'dedicated
  9164. pos (match-beginning 0))))
  9165. ;; There is an exact target for this
  9166. (goto-char pos)
  9167. (org-back-to-heading t)))
  9168. ((save-excursion
  9169. (goto-char (point-min))
  9170. (and
  9171. (re-search-forward
  9172. (concat "<<" (regexp-quote s0) ">>") nil t)
  9173. (setq type 'dedicated
  9174. pos (match-beginning 0))))
  9175. ;; There is an exact target for this
  9176. (goto-char pos))
  9177. ((save-excursion
  9178. (goto-char (point-min))
  9179. (and
  9180. (re-search-forward
  9181. (format "^[ \t]*#\\+TARGET: %s" (regexp-quote s0)) nil t)
  9182. (setq type 'dedicated pos (match-beginning 0))))
  9183. ;; Found an invisible target.
  9184. (goto-char pos))
  9185. ((save-excursion
  9186. (goto-char (point-min))
  9187. (and
  9188. (re-search-forward
  9189. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9190. (setq type 'dedicated pos (match-beginning 0))))
  9191. ;; Found an element with a matching #+name affiliated keyword.
  9192. (goto-char pos))
  9193. ((and (string-match "^(\\(.*\\))$" s0)
  9194. (save-excursion
  9195. (goto-char (point-min))
  9196. (and
  9197. (re-search-forward
  9198. (concat "[^[]" (regexp-quote
  9199. (format org-coderef-label-format
  9200. (match-string 1 s0))))
  9201. nil t)
  9202. (setq type 'dedicated
  9203. pos (1+ (match-beginning 0))))))
  9204. ;; There is a coderef target for this
  9205. (goto-char pos))
  9206. ((string-match "^/\\(.*\\)/$" s)
  9207. ;; A regular expression
  9208. (cond
  9209. ((derived-mode-p 'org-mode)
  9210. (org-occur (match-string 1 s)))
  9211. ;;((eq major-mode 'dired-mode)
  9212. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  9213. (t (org-do-occur (match-string 1 s)))))
  9214. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9215. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9216. (goto-char (point-min))
  9217. (cond
  9218. ((let (case-fold-search)
  9219. (re-search-forward (format org-complex-heading-regexp-format
  9220. (regexp-quote s))
  9221. nil t))
  9222. ;; OK, found a match
  9223. (setq type 'dedicated)
  9224. (goto-char (match-beginning 0)))
  9225. ((and (not org-link-search-inhibit-query)
  9226. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9227. (y-or-n-p "No match - create this as a new heading? "))
  9228. (goto-char (point-max))
  9229. (or (bolp) (newline))
  9230. (insert "* " s "\n")
  9231. (beginning-of-line 0))
  9232. (t
  9233. (goto-char pos)
  9234. (error "No match"))))
  9235. (t
  9236. ;; A normal search string
  9237. (when (equal (string-to-char s) ?*)
  9238. ;; Anchor on headlines, post may include tags.
  9239. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9240. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9241. s (substring s 1)))
  9242. (remove-text-properties
  9243. 0 (length s)
  9244. '(face nil mouse-face nil keymap nil fontified nil) s)
  9245. ;; Make a series of regular expressions to find a match
  9246. (setq words (org-split-string s "[ \n\r\t]+")
  9247. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9248. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9249. "\\)" markers)
  9250. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  9251. re2a (concat "[ \t\r\n]" re2a_)
  9252. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9253. re4 (concat "[^a-zA-Z_]" re4_)
  9254. re1 (concat pre re2 post)
  9255. re3 (concat pre (if pre re4_ re4) post)
  9256. re5 (concat pre ".*" re4)
  9257. re2 (concat pre re2)
  9258. re2a (concat pre (if pre re2a_ re2a))
  9259. re4 (concat pre (if pre re4_ re4))
  9260. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9261. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9262. re5 "\\)"
  9263. ))
  9264. (cond
  9265. ((eq type 'org-occur) (org-occur reall))
  9266. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9267. (t (goto-char (point-min))
  9268. (setq type 'fuzzy)
  9269. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  9270. (org-search-not-self 1 re1 nil t)
  9271. (org-search-not-self 1 re2 nil t)
  9272. (org-search-not-self 1 re2a nil t)
  9273. (org-search-not-self 1 re3 nil t)
  9274. (org-search-not-self 1 re4 nil t)
  9275. (org-search-not-self 1 re5 nil t)
  9276. )
  9277. (goto-char (match-beginning 1))
  9278. (goto-char pos)
  9279. (error "No match"))))))
  9280. (and (derived-mode-p 'org-mode)
  9281. (not stealth)
  9282. (org-show-context 'link-search))
  9283. type))
  9284. (defun org-search-not-self (group &rest args)
  9285. "Execute `re-search-forward', but only accept matches that do not
  9286. enclose the position of `org-open-link-marker'."
  9287. (let ((m org-open-link-marker))
  9288. (catch 'exit
  9289. (while (apply 're-search-forward args)
  9290. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9291. (goto-char (match-end group))
  9292. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9293. (> (match-beginning 0) (marker-position m))
  9294. (< (match-end 0) (marker-position m)))
  9295. (save-match-data
  9296. (or (not (org-in-regexp
  9297. org-bracket-link-analytic-regexp 1))
  9298. (not (match-end 4)) ; no description
  9299. (and (<= (match-beginning 4) (point))
  9300. (>= (match-end 4) (point))))))
  9301. (throw 'exit (point))))))))
  9302. (defun org-get-buffer-for-internal-link (buffer)
  9303. "Return a buffer to be used for displaying the link target of internal links."
  9304. (cond
  9305. ((not org-display-internal-link-with-indirect-buffer)
  9306. buffer)
  9307. ((string-match "(Clone)$" (buffer-name buffer))
  9308. (message "Buffer is already a clone, not making another one")
  9309. ;; we also do not modify visibility in this case
  9310. buffer)
  9311. (t ; make a new indirect buffer for displaying the link
  9312. (let* ((bn (buffer-name buffer))
  9313. (ibn (concat bn "(Clone)"))
  9314. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9315. (with-current-buffer ib (org-overview))
  9316. ib))))
  9317. (defun org-do-occur (regexp &optional cleanup)
  9318. "Call the Emacs command `occur'.
  9319. If CLEANUP is non-nil, remove the printout of the regular expression
  9320. in the *Occur* buffer. This is useful if the regex is long and not useful
  9321. to read."
  9322. (occur regexp)
  9323. (when cleanup
  9324. (let ((cwin (selected-window)) win beg end)
  9325. (when (setq win (get-buffer-window "*Occur*"))
  9326. (select-window win))
  9327. (goto-char (point-min))
  9328. (when (re-search-forward "match[a-z]+" nil t)
  9329. (setq beg (match-end 0))
  9330. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9331. (setq end (1- (match-beginning 0)))))
  9332. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9333. (goto-char (point-min))
  9334. (select-window cwin))))
  9335. ;;; The mark ring for links jumps
  9336. (defvar org-mark-ring nil
  9337. "Mark ring for positions before jumps in Org-mode.")
  9338. (defvar org-mark-ring-last-goto nil
  9339. "Last position in the mark ring used to go back.")
  9340. ;; Fill and close the ring
  9341. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9342. (loop for i from 1 to org-mark-ring-length do
  9343. (push (make-marker) org-mark-ring))
  9344. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9345. org-mark-ring)
  9346. (defun org-mark-ring-push (&optional pos buffer)
  9347. "Put the current position or POS into the mark ring and rotate it."
  9348. (interactive)
  9349. (setq pos (or pos (point)))
  9350. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9351. (move-marker (car org-mark-ring)
  9352. (or pos (point))
  9353. (or buffer (current-buffer)))
  9354. (message "%s"
  9355. (substitute-command-keys
  9356. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9357. (defun org-mark-ring-goto (&optional n)
  9358. "Jump to the previous position in the mark ring.
  9359. With prefix arg N, jump back that many stored positions. When
  9360. called several times in succession, walk through the entire ring.
  9361. Org-mode commands jumping to a different position in the current file,
  9362. or to another Org-mode file, automatically push the old position
  9363. onto the ring."
  9364. (interactive "p")
  9365. (let (p m)
  9366. (if (eq last-command this-command)
  9367. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9368. (setq p org-mark-ring))
  9369. (setq org-mark-ring-last-goto p)
  9370. (setq m (car p))
  9371. (org-pop-to-buffer-same-window (marker-buffer m))
  9372. (goto-char m)
  9373. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9374. (defun org-remove-angle-brackets (s)
  9375. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9376. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9377. s)
  9378. (defun org-add-angle-brackets (s)
  9379. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9380. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9381. s)
  9382. (defun org-remove-double-quotes (s)
  9383. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9384. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9385. s)
  9386. ;;; Following specific links
  9387. (defun org-follow-timestamp-link ()
  9388. (cond
  9389. ((org-at-date-range-p t)
  9390. (let ((org-agenda-start-on-weekday)
  9391. (t1 (match-string 1))
  9392. (t2 (match-string 2)))
  9393. (setq t1 (time-to-days (org-time-string-to-time t1))
  9394. t2 (time-to-days (org-time-string-to-time t2)))
  9395. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  9396. ((org-at-timestamp-p t)
  9397. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9398. (substring (match-string 1) 0 10)))
  9399. 1))
  9400. (t (error "This should not happen"))))
  9401. ;;; Following file links
  9402. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9403. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9404. (declare-function mailcap-mime-info
  9405. "mailcap" (string &optional request no-decode))
  9406. (defvar org-wait nil)
  9407. (defun org-open-file (path &optional in-emacs line search)
  9408. "Open the file at PATH.
  9409. First, this expands any special file name abbreviations. Then the
  9410. configuration variable `org-file-apps' is checked if it contains an
  9411. entry for this file type, and if yes, the corresponding command is launched.
  9412. If no application is found, Emacs simply visits the file.
  9413. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9414. With a double \\[universal-argument] \\[universal-argument] \
  9415. prefix arg, Org tries to avoid opening in Emacs
  9416. and to use an external application to visit the file.
  9417. Optional LINE specifies a line to go to, optional SEARCH a string
  9418. to search for. If LINE or SEARCH is given, the file will be
  9419. opened in Emacs, unless an entry from org-file-apps that makes
  9420. use of groups in a regexp matches.
  9421. If you want to change the way frames are used when following a
  9422. link, please customize `org-link-frame-setup'.
  9423. If the file does not exist, an error is thrown."
  9424. (let* ((file (if (equal path "")
  9425. buffer-file-name
  9426. (substitute-in-file-name (expand-file-name path))))
  9427. (file-apps (append org-file-apps (org-default-apps)))
  9428. (apps (org-remove-if
  9429. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9430. (apps-dlink (org-remove-if-not
  9431. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9432. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9433. (dirp (if remp nil (file-directory-p file)))
  9434. (file (if (and dirp org-open-directory-means-index-dot-org)
  9435. (concat (file-name-as-directory file) "index.org")
  9436. file))
  9437. (a-m-a-p (assq 'auto-mode apps))
  9438. (dfile (downcase file))
  9439. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9440. (link (cond ((and (eq line nil)
  9441. (eq search nil))
  9442. file)
  9443. (line
  9444. (concat file "::" (number-to-string line)))
  9445. (search
  9446. (concat file "::" search))))
  9447. (dlink (downcase link))
  9448. (old-buffer (current-buffer))
  9449. (old-pos (point))
  9450. (old-mode major-mode)
  9451. ext cmd link-match-data)
  9452. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9453. (setq ext (match-string 1 dfile))
  9454. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9455. (setq ext (match-string 1 dfile))))
  9456. (cond
  9457. ((member in-emacs '((16) system))
  9458. (setq cmd (cdr (assoc 'system apps))))
  9459. (in-emacs (setq cmd 'emacs))
  9460. (t
  9461. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9462. (and dirp (cdr (assoc 'directory apps)))
  9463. ; first, try matching against apps-dlink
  9464. ; if we get a match here, store the match data for later
  9465. (let ((match (assoc-default dlink apps-dlink
  9466. 'string-match)))
  9467. (if match
  9468. (progn (setq link-match-data (match-data))
  9469. match)
  9470. (progn (setq in-emacs (or in-emacs line search))
  9471. nil))) ; if we have no match in apps-dlink,
  9472. ; always open the file in emacs if line or search
  9473. ; is given (for backwards compatibility)
  9474. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9475. 'string-match)
  9476. (cdr (assoc ext apps))
  9477. (cdr (assoc t apps))))))
  9478. (when (eq cmd 'system)
  9479. (setq cmd (cdr (assoc 'system apps))))
  9480. (when (eq cmd 'default)
  9481. (setq cmd (cdr (assoc t apps))))
  9482. (when (eq cmd 'mailcap)
  9483. (require 'mailcap)
  9484. (mailcap-parse-mailcaps)
  9485. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9486. (command (mailcap-mime-info mime-type)))
  9487. (if (stringp command)
  9488. (setq cmd command)
  9489. (setq cmd 'emacs))))
  9490. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  9491. (not (file-exists-p file))
  9492. (not org-open-non-existing-files))
  9493. (error "No such file: %s" file))
  9494. (cond
  9495. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  9496. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  9497. (while (string-match "['\"]%s['\"]" cmd)
  9498. (setq cmd (replace-match "%s" t t cmd)))
  9499. (while (string-match "%s" cmd)
  9500. (setq cmd (replace-match
  9501. (save-match-data
  9502. (shell-quote-argument
  9503. (convert-standard-filename file)))
  9504. t t cmd)))
  9505. ;; Replace "%1", "%2" etc. in command with group matches from regex
  9506. (save-match-data
  9507. (let ((match-index 1)
  9508. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  9509. (set-match-data link-match-data)
  9510. (while (<= match-index number-of-groups)
  9511. (let ((regex (concat "%" (number-to-string match-index)))
  9512. (replace-with (match-string match-index dlink)))
  9513. (while (string-match regex cmd)
  9514. (setq cmd (replace-match replace-with t t cmd))))
  9515. (setq match-index (+ match-index 1)))))
  9516. (save-window-excursion
  9517. (message "Running %s...done" cmd)
  9518. (start-process-shell-command cmd nil cmd)
  9519. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  9520. ((or (stringp cmd)
  9521. (eq cmd 'emacs))
  9522. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  9523. (widen)
  9524. (if line (org-goto-line line)
  9525. (if search (org-link-search search))))
  9526. ((consp cmd)
  9527. (let ((file (convert-standard-filename file)))
  9528. (save-match-data
  9529. (set-match-data link-match-data)
  9530. (eval cmd))))
  9531. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  9532. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  9533. (or (not (equal old-buffer (current-buffer)))
  9534. (not (equal old-pos (point))))
  9535. (org-mark-ring-push old-pos old-buffer))))
  9536. (defun org-file-apps-entry-match-against-dlink-p (entry)
  9537. "This function returns non-nil if `entry' uses a regular
  9538. expression which should be matched against the whole link by
  9539. org-open-file.
  9540. It assumes that is the case when the entry uses a regular
  9541. expression which has at least one grouping construct and the
  9542. action is either a lisp form or a command string containing
  9543. '%1', i.e. using at least one subexpression match as a
  9544. parameter."
  9545. (let ((selector (car entry))
  9546. (action (cdr entry)))
  9547. (if (stringp selector)
  9548. (and (> (regexp-opt-depth selector) 0)
  9549. (or (and (stringp action)
  9550. (string-match "%[0-9]" action))
  9551. (consp action)))
  9552. nil)))
  9553. (defun org-default-apps ()
  9554. "Return the default applications for this operating system."
  9555. (cond
  9556. ((eq system-type 'darwin)
  9557. org-file-apps-defaults-macosx)
  9558. ((eq system-type 'windows-nt)
  9559. org-file-apps-defaults-windowsnt)
  9560. (t org-file-apps-defaults-gnu)))
  9561. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  9562. "Convert extensions to regular expressions in the cars of LIST.
  9563. Also, weed out any non-string entries, because the return value is used
  9564. only for regexp matching.
  9565. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  9566. point to the symbol `emacs', indicating that the file should
  9567. be opened in Emacs."
  9568. (append
  9569. (delq nil
  9570. (mapcar (lambda (x)
  9571. (if (not (stringp (car x)))
  9572. nil
  9573. (if (string-match "\\W" (car x))
  9574. x
  9575. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  9576. list))
  9577. (if add-auto-mode
  9578. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  9579. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  9580. (defun org-file-remote-p (file)
  9581. "Test whether FILE specifies a location on a remote system.
  9582. Return non-nil if the location is indeed remote.
  9583. For example, the filename \"/user@host:/foo\" specifies a location
  9584. on the system \"/user@host:\"."
  9585. (cond ((fboundp 'file-remote-p)
  9586. (file-remote-p file))
  9587. ((fboundp 'tramp-handle-file-remote-p)
  9588. (tramp-handle-file-remote-p file))
  9589. ((and (boundp 'ange-ftp-name-format)
  9590. (string-match (car ange-ftp-name-format) file))
  9591. t)))
  9592. ;;;; Refiling
  9593. (defun org-get-org-file ()
  9594. "Read a filename, with default directory `org-directory'."
  9595. (let ((default (or org-default-notes-file remember-data-file)))
  9596. (read-file-name (format "File name [%s]: " default)
  9597. (file-name-as-directory org-directory)
  9598. default)))
  9599. (defun org-notes-order-reversed-p ()
  9600. "Check if the current file should receive notes in reversed order."
  9601. (cond
  9602. ((not org-reverse-note-order) nil)
  9603. ((eq t org-reverse-note-order) t)
  9604. ((not (listp org-reverse-note-order)) nil)
  9605. (t (catch 'exit
  9606. (let ((all org-reverse-note-order)
  9607. entry)
  9608. (while (setq entry (pop all))
  9609. (if (string-match (car entry) buffer-file-name)
  9610. (throw 'exit (cdr entry))))
  9611. nil)))))
  9612. (defvar org-refile-target-table nil
  9613. "The list of refile targets, created by `org-refile'.")
  9614. (defvar org-agenda-new-buffers nil
  9615. "Buffers created to visit agenda files.")
  9616. (defvar org-refile-cache nil
  9617. "Cache for refile targets.")
  9618. (defvar org-refile-markers nil
  9619. "All the markers used for caching refile locations.")
  9620. (defun org-refile-marker (pos)
  9621. "Get a new refile marker, but only if caching is in use."
  9622. (if (not org-refile-use-cache)
  9623. pos
  9624. (let ((m (make-marker)))
  9625. (move-marker m pos)
  9626. (push m org-refile-markers)
  9627. m)))
  9628. (defun org-refile-cache-clear ()
  9629. "Clear the refile cache and disable all the markers."
  9630. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  9631. (setq org-refile-markers nil)
  9632. (setq org-refile-cache nil)
  9633. (message "Refile cache has been cleared"))
  9634. (defun org-refile-cache-check-set (set)
  9635. "Check if all the markers in the cache still have live buffers."
  9636. (let (marker)
  9637. (catch 'exit
  9638. (while (and set (setq marker (nth 3 (pop set))))
  9639. ;; if org-refile-use-outline-path is 'file, marker may be nil
  9640. (when (and marker (null (marker-buffer marker)))
  9641. (message "not found") (sit-for 3)
  9642. (throw 'exit nil)))
  9643. t)))
  9644. (defun org-refile-cache-put (set &rest identifiers)
  9645. "Push the refile targets SET into the cache, under IDENTIFIERS."
  9646. (let* ((key (sha1 (prin1-to-string identifiers)))
  9647. (entry (assoc key org-refile-cache)))
  9648. (if entry
  9649. (setcdr entry set)
  9650. (push (cons key set) org-refile-cache))))
  9651. (defun org-refile-cache-get (&rest identifiers)
  9652. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  9653. (cond
  9654. ((not org-refile-cache) nil)
  9655. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  9656. (t
  9657. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  9658. org-refile-cache))))
  9659. (and set (org-refile-cache-check-set set) set)))))
  9660. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  9661. "Produce a table with refile targets."
  9662. (let ((case-fold-search nil)
  9663. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  9664. (entries (or org-refile-targets '((nil . (:level . 1)))))
  9665. targets tgs txt re files f desc descre fast-path-p level pos0)
  9666. (message "Getting targets...")
  9667. (with-current-buffer (or default-buffer (current-buffer))
  9668. (while (setq entry (pop entries))
  9669. (setq files (car entry) desc (cdr entry))
  9670. (setq fast-path-p nil)
  9671. (cond
  9672. ((null files) (setq files (list (current-buffer))))
  9673. ((eq files 'org-agenda-files)
  9674. (setq files (org-agenda-files 'unrestricted)))
  9675. ((and (symbolp files) (fboundp files))
  9676. (setq files (funcall files)))
  9677. ((and (symbolp files) (boundp files))
  9678. (setq files (symbol-value files))))
  9679. (if (stringp files) (setq files (list files)))
  9680. (cond
  9681. ((eq (car desc) :tag)
  9682. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  9683. ((eq (car desc) :todo)
  9684. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  9685. ((eq (car desc) :regexp)
  9686. (setq descre (cdr desc)))
  9687. ((eq (car desc) :level)
  9688. (setq descre (concat "^\\*\\{" (number-to-string
  9689. (if org-odd-levels-only
  9690. (1- (* 2 (cdr desc)))
  9691. (cdr desc)))
  9692. "\\}[ \t]")))
  9693. ((eq (car desc) :maxlevel)
  9694. (setq fast-path-p t)
  9695. (setq descre (concat "^\\*\\{1," (number-to-string
  9696. (if org-odd-levels-only
  9697. (1- (* 2 (cdr desc)))
  9698. (cdr desc)))
  9699. "\\}[ \t]")))
  9700. (t (error "Bad refiling target description %s" desc)))
  9701. (while (setq f (pop files))
  9702. (with-current-buffer
  9703. (if (bufferp f) f (org-get-agenda-file-buffer f))
  9704. (or
  9705. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  9706. (progn
  9707. (if (bufferp f) (setq f (buffer-file-name
  9708. (buffer-base-buffer f))))
  9709. (setq f (and f (expand-file-name f)))
  9710. (if (eq org-refile-use-outline-path 'file)
  9711. (push (list (file-name-nondirectory f) f nil nil) tgs))
  9712. (save-excursion
  9713. (save-restriction
  9714. (widen)
  9715. (goto-char (point-min))
  9716. (while (re-search-forward descre nil t)
  9717. (goto-char (setq pos0 (point-at-bol)))
  9718. (catch 'next
  9719. (when org-refile-target-verify-function
  9720. (save-match-data
  9721. (or (funcall org-refile-target-verify-function)
  9722. (throw 'next t))))
  9723. (when (and (looking-at org-complex-heading-regexp)
  9724. (not (member (match-string 4) excluded-entries))
  9725. (match-string 4))
  9726. (setq level (org-reduced-level
  9727. (- (match-end 1) (match-beginning 1)))
  9728. txt (org-link-display-format (match-string 4))
  9729. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  9730. re (format org-complex-heading-regexp-format
  9731. (regexp-quote (match-string 4))))
  9732. (when org-refile-use-outline-path
  9733. (setq txt (mapconcat
  9734. 'org-protect-slash
  9735. (append
  9736. (if (eq org-refile-use-outline-path
  9737. 'file)
  9738. (list (file-name-nondirectory
  9739. (buffer-file-name
  9740. (buffer-base-buffer))))
  9741. (if (eq org-refile-use-outline-path
  9742. 'full-file-path)
  9743. (list (buffer-file-name
  9744. (buffer-base-buffer)))))
  9745. (org-get-outline-path fast-path-p
  9746. level txt)
  9747. (list txt))
  9748. "/")))
  9749. (push (list txt f re (org-refile-marker (point)))
  9750. tgs)))
  9751. (when (= (point) pos0)
  9752. ;; verification function has not moved point
  9753. (goto-char (point-at-eol))))))))
  9754. (when org-refile-use-cache
  9755. (org-refile-cache-put tgs (buffer-file-name) descre))
  9756. (setq targets (append tgs targets))
  9757. ))))
  9758. (message "Getting targets...done")
  9759. (nreverse targets)))
  9760. (defun org-protect-slash (s)
  9761. (while (string-match "/" s)
  9762. (setq s (replace-match "\\" t t s)))
  9763. s)
  9764. (defvar org-olpa (make-vector 20 nil))
  9765. (defun org-get-outline-path (&optional fastp level heading)
  9766. "Return the outline path to the current entry, as a list.
  9767. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  9768. routine which makes outline path derivations for an entire file,
  9769. avoiding backtracing. Refile target collection makes use of that."
  9770. (if fastp
  9771. (progn
  9772. (if (> level 19)
  9773. (error "Outline path failure, more than 19 levels"))
  9774. (loop for i from level upto 19 do
  9775. (aset org-olpa i nil))
  9776. (prog1
  9777. (delq nil (append org-olpa nil))
  9778. (aset org-olpa level heading)))
  9779. (let (rtn case-fold-search)
  9780. (save-excursion
  9781. (save-restriction
  9782. (widen)
  9783. (while (org-up-heading-safe)
  9784. (when (looking-at org-complex-heading-regexp)
  9785. (push (org-match-string-no-properties 4) rtn)))
  9786. rtn)))))
  9787. (defun org-format-outline-path (path &optional width prefix)
  9788. "Format the outline path PATH for display.
  9789. Width is the maximum number of characters that is available.
  9790. Prefix is a prefix to be included in the returned string,
  9791. such as the file name."
  9792. (setq width (or width 79))
  9793. (if prefix (setq width (- width (length prefix))))
  9794. (if (not path)
  9795. (or prefix "")
  9796. (let* ((nsteps (length path))
  9797. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  9798. (maxwidth (if (<= total-width width)
  9799. 10000 ;; everything fits
  9800. ;; we need to shorten the level headings
  9801. (/ (- width nsteps) nsteps)))
  9802. (org-odd-levels-only nil)
  9803. (n 0)
  9804. (total (1+ (length prefix))))
  9805. (setq maxwidth (max maxwidth 10))
  9806. (concat prefix
  9807. (mapconcat
  9808. (lambda (h)
  9809. (setq n (1+ n))
  9810. (if (and (= n nsteps) (< maxwidth 10000))
  9811. (setq maxwidth (- total-width total)))
  9812. (if (< (length h) maxwidth)
  9813. (progn (setq total (+ total (length h) 1)) h)
  9814. (setq h (substring h 0 (- maxwidth 2))
  9815. total (+ total maxwidth 1))
  9816. (if (string-match "[ \t]+\\'" h)
  9817. (setq h (substring h 0 (match-beginning 0))))
  9818. (setq h (concat h "..")))
  9819. (org-add-props h nil 'face
  9820. (nth (% (1- n) org-n-level-faces)
  9821. org-level-faces))
  9822. h)
  9823. path "/")))))
  9824. (defun org-display-outline-path (&optional file current)
  9825. "Display the current outline path in the echo area."
  9826. (interactive "P")
  9827. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  9828. (case-fold-search nil)
  9829. (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
  9830. (if current (setq path (append path
  9831. (save-excursion
  9832. (org-back-to-heading t)
  9833. (if (looking-at org-complex-heading-regexp)
  9834. (list (match-string 4)))))))
  9835. (message "%s"
  9836. (org-format-outline-path
  9837. path
  9838. (1- (frame-width))
  9839. (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
  9840. (defvar org-refile-history nil
  9841. "History for refiling operations.")
  9842. (defvar org-after-refile-insert-hook nil
  9843. "Hook run after `org-refile' has inserted its stuff at the new location.
  9844. Note that this is still *before* the stuff will be removed from
  9845. the *old* location.")
  9846. (defvar org-capture-last-stored-marker)
  9847. (defun org-refile (&optional goto default-buffer rfloc)
  9848. "Move the entry or entries at point to another heading.
  9849. The list of target headings is compiled using the information in
  9850. `org-refile-targets', which see.
  9851. At the target location, the entry is filed as a subitem of the target
  9852. heading. Depending on `org-reverse-note-order', the new subitem will
  9853. either be the first or the last subitem.
  9854. If there is an active region, all entries in that region will be moved.
  9855. However, the region must fulfill the requirement that the first heading
  9856. is the first one sets the top-level of the moved text - at most siblings
  9857. below it are allowed.
  9858. With prefix arg GOTO, the command will only visit the target location
  9859. and not actually move anything.
  9860. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  9861. go to the location where the last refiling operation has put the subtree.
  9862. With a prefix argument of `2', refile to the running clock.
  9863. RFLOC can be a refile location obtained in a different way.
  9864. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  9865. If you are using target caching (see `org-refile-use-cache'),
  9866. you have to clear the target cache in order to find new targets.
  9867. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  9868. prefix argument (`C-u C-u C-u C-c C-w')."
  9869. (interactive "P")
  9870. (if (member goto '(0 (64)))
  9871. (org-refile-cache-clear)
  9872. (let* ((cbuf (current-buffer))
  9873. (regionp (org-region-active-p))
  9874. (region-start (and regionp (region-beginning)))
  9875. (region-end (and regionp (region-end)))
  9876. (region-length (and regionp (- region-end region-start)))
  9877. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9878. pos it nbuf file re level reversed)
  9879. (setq last-command nil)
  9880. (when regionp
  9881. (goto-char region-start)
  9882. (or (bolp) (goto-char (point-at-bol)))
  9883. (setq region-start (point))
  9884. (unless (or (org-kill-is-subtree-p
  9885. (buffer-substring region-start region-end))
  9886. (prog1 org-refile-active-region-within-subtree
  9887. (org-toggle-heading)))
  9888. (error "The region is not a (sequence of) subtree(s)")))
  9889. (if (equal goto '(16))
  9890. (org-refile-goto-last-stored)
  9891. (when (or
  9892. (and (equal goto 2)
  9893. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9894. (prog1
  9895. (setq it (list (or org-clock-heading "running clock")
  9896. (buffer-file-name
  9897. (marker-buffer org-clock-hd-marker))
  9898. ""
  9899. (marker-position org-clock-hd-marker)))
  9900. (setq goto nil)))
  9901. (setq it (or rfloc
  9902. (let (heading-text)
  9903. (save-excursion
  9904. (unless goto
  9905. (org-back-to-heading t)
  9906. (setq heading-text
  9907. (nth 4 (org-heading-components))))
  9908. (org-refile-get-location
  9909. (cond (goto "Goto")
  9910. (regionp "Refile region to")
  9911. (t (concat "Refile subtree \""
  9912. heading-text "\" to")))
  9913. default-buffer
  9914. (and (not (equal '(4) goto))
  9915. org-refile-allow-creating-parent-nodes)
  9916. goto))))))
  9917. (setq file (nth 1 it)
  9918. re (nth 2 it)
  9919. pos (nth 3 it))
  9920. (if (and (not goto)
  9921. pos
  9922. (equal (buffer-file-name) file)
  9923. (if regionp
  9924. (and (>= pos region-start)
  9925. (<= pos region-end))
  9926. (and (>= pos (point))
  9927. (< pos (save-excursion
  9928. (org-end-of-subtree t t))))))
  9929. (error "Cannot refile to position inside the tree or region"))
  9930. (setq nbuf (or (find-buffer-visiting file)
  9931. (find-file-noselect file)))
  9932. (if goto
  9933. (progn
  9934. (org-pop-to-buffer-same-window nbuf)
  9935. (goto-char pos)
  9936. (org-show-context 'org-goto))
  9937. (if regionp
  9938. (progn
  9939. (org-kill-new (buffer-substring region-start region-end))
  9940. (org-save-markers-in-region region-start region-end))
  9941. (org-copy-subtree 1 nil t))
  9942. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9943. (find-file-noselect file)))
  9944. (setq reversed (org-notes-order-reversed-p))
  9945. (save-excursion
  9946. (save-restriction
  9947. (widen)
  9948. (if pos
  9949. (progn
  9950. (goto-char pos)
  9951. (looking-at org-outline-regexp)
  9952. (setq level (org-get-valid-level (funcall outline-level) 1))
  9953. (goto-char
  9954. (if reversed
  9955. (or (outline-next-heading) (point-max))
  9956. (or (save-excursion (org-get-next-sibling))
  9957. (org-end-of-subtree t t)
  9958. (point-max)))))
  9959. (setq level 1)
  9960. (if (not reversed)
  9961. (goto-char (point-max))
  9962. (goto-char (point-min))
  9963. (or (outline-next-heading) (goto-char (point-max)))))
  9964. (if (not (bolp)) (newline))
  9965. (org-paste-subtree level)
  9966. (when org-log-refile
  9967. (org-add-log-setup 'refile nil nil 'findpos
  9968. org-log-refile)
  9969. (unless (eq org-log-refile 'note)
  9970. (save-excursion (org-add-log-note))))
  9971. (and org-auto-align-tags
  9972. (let ((org-loop-over-headlines-in-active-region nil))
  9973. (org-set-tags nil t)))
  9974. (bookmark-set "org-refile-last-stored")
  9975. ;; If we are refiling for capture, make sure that the
  9976. ;; last-capture pointers point here
  9977. (when (org-bound-and-true-p org-refile-for-capture)
  9978. (bookmark-set "org-capture-last-stored-marker")
  9979. (move-marker org-capture-last-stored-marker (point)))
  9980. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9981. (run-hooks 'org-after-refile-insert-hook))))
  9982. (if regionp
  9983. (delete-region (point) (+ (point) region-length))
  9984. (org-cut-subtree))
  9985. (when (featurep 'org-inlinetask)
  9986. (org-inlinetask-remove-END-maybe))
  9987. (setq org-markers-to-move nil)
  9988. (message "Refiled to \"%s\" in file %s" (car it) file)))))))
  9989. (defun org-refile-goto-last-stored ()
  9990. "Go to the location where the last refile was stored."
  9991. (interactive)
  9992. (bookmark-jump "org-refile-last-stored")
  9993. (message "This is the location of the last refile"))
  9994. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  9995. no-exclude)
  9996. "Prompt the user for a refile location, using PROMPT.
  9997. PROMPT should not be suffixed with a colon and a space, because
  9998. this function appends the default value from
  9999. `org-refile-history' automatically, if that is not empty.
  10000. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  10001. this is used for the GOTO interface."
  10002. (let ((org-refile-targets org-refile-targets)
  10003. (org-refile-use-outline-path org-refile-use-outline-path)
  10004. excluded-entries)
  10005. (when (and (derived-mode-p 'org-mode)
  10006. (not org-refile-use-cache)
  10007. (not no-exclude))
  10008. (org-map-tree
  10009. (lambda()
  10010. (setq excluded-entries
  10011. (append excluded-entries (list (org-get-heading t t)))))))
  10012. (setq org-refile-target-table
  10013. (org-refile-get-targets default-buffer excluded-entries)))
  10014. (unless org-refile-target-table
  10015. (error "No refile targets"))
  10016. (let* ((prompt (concat prompt
  10017. (and (car org-refile-history)
  10018. (concat " (default " (car org-refile-history) ")"))
  10019. ": "))
  10020. (cbuf (current-buffer))
  10021. (partial-completion-mode nil)
  10022. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  10023. (cfunc (if (and org-refile-use-outline-path
  10024. org-outline-path-complete-in-steps)
  10025. 'org-olpath-completing-read
  10026. 'org-icompleting-read))
  10027. (extra (if org-refile-use-outline-path "/" ""))
  10028. (filename (and cfn (expand-file-name cfn)))
  10029. (tbl (mapcar
  10030. (lambda (x)
  10031. (if (and (not (member org-refile-use-outline-path
  10032. '(file full-file-path)))
  10033. (not (equal filename (nth 1 x))))
  10034. (cons (concat (car x) extra " ("
  10035. (file-name-nondirectory (nth 1 x)) ")")
  10036. (cdr x))
  10037. (cons (concat (car x) extra) (cdr x))))
  10038. org-refile-target-table))
  10039. (completion-ignore-case t)
  10040. pa answ parent-target child parent old-hist)
  10041. (setq old-hist org-refile-history)
  10042. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  10043. nil 'org-refile-history (car org-refile-history)))
  10044. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  10045. (org-refile-check-position pa)
  10046. (if pa
  10047. (progn
  10048. (when (or (not org-refile-history)
  10049. (not (eq old-hist org-refile-history))
  10050. (not (equal (car pa) (car org-refile-history))))
  10051. (setq org-refile-history
  10052. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  10053. org-refile-history
  10054. (cdr org-refile-history))))
  10055. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  10056. (pop org-refile-history)))
  10057. pa)
  10058. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  10059. (progn
  10060. (setq parent (match-string 1 answ)
  10061. child (match-string 2 answ))
  10062. (setq parent-target (or (assoc parent tbl)
  10063. (assoc (concat parent "/") tbl)))
  10064. (when (and parent-target
  10065. (or (eq new-nodes t)
  10066. (and (eq new-nodes 'confirm)
  10067. (y-or-n-p (format "Create new node \"%s\"? "
  10068. child)))))
  10069. (org-refile-new-child parent-target child)))
  10070. (error "Invalid target location")))))
  10071. (declare-function org-string-nw-p "org-macs.el" (s))
  10072. (defun org-refile-check-position (refile-pointer)
  10073. "Check if the refile pointer matches the readline to which it points."
  10074. (let* ((file (nth 1 refile-pointer))
  10075. (re (nth 2 refile-pointer))
  10076. (pos (nth 3 refile-pointer))
  10077. buffer)
  10078. (when (org-string-nw-p re)
  10079. (setq buffer (if (markerp pos)
  10080. (marker-buffer pos)
  10081. (or (find-buffer-visiting file)
  10082. (find-file-noselect file))))
  10083. (with-current-buffer buffer
  10084. (save-excursion
  10085. (save-restriction
  10086. (widen)
  10087. (goto-char pos)
  10088. (beginning-of-line 1)
  10089. (unless (org-looking-at-p re)
  10090. (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  10091. (defun org-refile-new-child (parent-target child)
  10092. "Use refile target PARENT-TARGET to add new CHILD below it."
  10093. (unless parent-target
  10094. (error "Cannot find parent for new node"))
  10095. (let ((file (nth 1 parent-target))
  10096. (pos (nth 3 parent-target))
  10097. level)
  10098. (with-current-buffer (or (find-buffer-visiting file)
  10099. (find-file-noselect file))
  10100. (save-excursion
  10101. (save-restriction
  10102. (widen)
  10103. (if pos
  10104. (goto-char pos)
  10105. (goto-char (point-max))
  10106. (if (not (bolp)) (newline)))
  10107. (when (looking-at org-outline-regexp)
  10108. (setq level (funcall outline-level))
  10109. (org-end-of-subtree t t))
  10110. (org-back-over-empty-lines)
  10111. (insert "\n" (make-string
  10112. (if pos (org-get-valid-level level 1) 1) ?*)
  10113. " " child "\n")
  10114. (beginning-of-line 0)
  10115. (list (concat (car parent-target) "/" child) file "" (point)))))))
  10116. (defun org-olpath-completing-read (prompt collection &rest args)
  10117. "Read an outline path like a file name."
  10118. (let ((thetable collection)
  10119. (org-completion-use-ido nil) ; does not work with ido.
  10120. (org-completion-use-iswitchb nil)) ; or iswitchb
  10121. (apply
  10122. 'org-icompleting-read prompt
  10123. (lambda (string predicate &optional flag)
  10124. (let (rtn r f (l (length string)))
  10125. (cond
  10126. ((eq flag nil)
  10127. ;; try completion
  10128. (try-completion string thetable))
  10129. ((eq flag t)
  10130. ;; all-completions
  10131. (setq rtn (all-completions string thetable predicate))
  10132. (mapcar
  10133. (lambda (x)
  10134. (setq r (substring x l))
  10135. (if (string-match " ([^)]*)$" x)
  10136. (setq f (match-string 0 x))
  10137. (setq f ""))
  10138. (if (string-match "/" r)
  10139. (concat string (substring r 0 (match-end 0)) f)
  10140. x))
  10141. rtn))
  10142. ((eq flag 'lambda)
  10143. ;; exact match?
  10144. (assoc string thetable)))))
  10145. args)))
  10146. ;;;; Dynamic blocks
  10147. (defun org-find-dblock (name)
  10148. "Find the first dynamic block with name NAME in the buffer.
  10149. If not found, stay at current position and return nil."
  10150. (let ((case-fold-search t) pos)
  10151. (save-excursion
  10152. (goto-char (point-min))
  10153. (setq pos (and (re-search-forward
  10154. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10155. (match-beginning 0))))
  10156. (if pos (goto-char pos))
  10157. pos))
  10158. (defconst org-dblock-start-re
  10159. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  10160. "Matches the start line of a dynamic block, with parameters.")
  10161. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  10162. "Matches the end of a dynamic block.")
  10163. (defun org-create-dblock (plist)
  10164. "Create a dynamic block section, with parameters taken from PLIST.
  10165. PLIST must contain a :name entry which is used as name of the block."
  10166. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10167. (end-of-line 1)
  10168. (newline))
  10169. (let ((col (current-column))
  10170. (name (plist-get plist :name)))
  10171. (insert "#+BEGIN: " name)
  10172. (while plist
  10173. (if (eq (car plist) :name)
  10174. (setq plist (cddr plist))
  10175. (insert " " (prin1-to-string (pop plist)))))
  10176. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10177. (beginning-of-line -2)))
  10178. (defun org-prepare-dblock ()
  10179. "Prepare dynamic block for refresh.
  10180. This empties the block, puts the cursor at the insert position and returns
  10181. the property list including an extra property :name with the block name."
  10182. (unless (looking-at org-dblock-start-re)
  10183. (error "Not at a dynamic block"))
  10184. (let* ((begdel (1+ (match-end 0)))
  10185. (name (org-no-properties (match-string 1)))
  10186. (params (append (list :name name)
  10187. (read (concat "(" (match-string 3) ")")))))
  10188. (save-excursion
  10189. (beginning-of-line 1)
  10190. (skip-chars-forward " \t")
  10191. (setq params (plist-put params :indentation-column (current-column))))
  10192. (unless (re-search-forward org-dblock-end-re nil t)
  10193. (error "Dynamic block not terminated"))
  10194. (setq params
  10195. (append params
  10196. (list :content (buffer-substring
  10197. begdel (match-beginning 0)))))
  10198. (delete-region begdel (match-beginning 0))
  10199. (goto-char begdel)
  10200. (open-line 1)
  10201. params))
  10202. (defun org-map-dblocks (&optional command)
  10203. "Apply COMMAND to all dynamic blocks in the current buffer.
  10204. If COMMAND is not given, use `org-update-dblock'."
  10205. (let ((cmd (or command 'org-update-dblock)))
  10206. (save-excursion
  10207. (goto-char (point-min))
  10208. (while (re-search-forward org-dblock-start-re nil t)
  10209. (goto-char (match-beginning 0))
  10210. (save-excursion
  10211. (condition-case nil
  10212. (funcall cmd)
  10213. (error (message "Error during update of dynamic block"))))
  10214. (unless (re-search-forward org-dblock-end-re nil t)
  10215. (error "Dynamic block not terminated"))))))
  10216. (defun org-dblock-update (&optional arg)
  10217. "User command for updating dynamic blocks.
  10218. Update the dynamic block at point. With prefix ARG, update all dynamic
  10219. blocks in the buffer."
  10220. (interactive "P")
  10221. (if arg
  10222. (org-update-all-dblocks)
  10223. (or (looking-at org-dblock-start-re)
  10224. (org-beginning-of-dblock))
  10225. (org-update-dblock)))
  10226. (defun org-update-dblock ()
  10227. "Update the dynamic block at point.
  10228. This means to empty the block, parse for parameters and then call
  10229. the correct writing function."
  10230. (interactive)
  10231. (save-window-excursion
  10232. (let* ((pos (point))
  10233. (line (org-current-line))
  10234. (params (org-prepare-dblock))
  10235. (name (plist-get params :name))
  10236. (indent (plist-get params :indentation-column))
  10237. (cmd (intern (concat "org-dblock-write:" name))))
  10238. (message "Updating dynamic block `%s' at line %d..." name line)
  10239. (funcall cmd params)
  10240. (message "Updating dynamic block `%s' at line %d...done" name line)
  10241. (goto-char pos)
  10242. (when (and indent (> indent 0))
  10243. (setq indent (make-string indent ?\ ))
  10244. (save-excursion
  10245. (org-beginning-of-dblock)
  10246. (forward-line 1)
  10247. (while (not (looking-at org-dblock-end-re))
  10248. (insert indent)
  10249. (beginning-of-line 2))
  10250. (when (looking-at org-dblock-end-re)
  10251. (and (looking-at "[ \t]+")
  10252. (replace-match ""))
  10253. (insert indent)))))))
  10254. (defun org-beginning-of-dblock ()
  10255. "Find the beginning of the dynamic block at point.
  10256. Error if there is no such block at point."
  10257. (let ((pos (point))
  10258. beg)
  10259. (end-of-line 1)
  10260. (if (and (re-search-backward org-dblock-start-re nil t)
  10261. (setq beg (match-beginning 0))
  10262. (re-search-forward org-dblock-end-re nil t)
  10263. (> (match-end 0) pos))
  10264. (goto-char beg)
  10265. (goto-char pos)
  10266. (error "Not in a dynamic block"))))
  10267. ;;;###autoload
  10268. (defun org-update-all-dblocks ()
  10269. "Update all dynamic blocks in the buffer.
  10270. This function can be used in a hook."
  10271. (interactive)
  10272. (when (derived-mode-p 'org-mode)
  10273. (org-map-dblocks 'org-update-dblock)))
  10274. ;;;; Completion
  10275. (defconst org-additional-option-like-keywords
  10276. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
  10277. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
  10278. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  10279. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
  10280. "BEGIN:" "END:"
  10281. "ORGTBL" "TBLFM:" "TBLNAME:"
  10282. "BEGIN_EXAMPLE" "END_EXAMPLE"
  10283. "BEGIN_VERBATIM" "END_VERBATIM"
  10284. "BEGIN_QUOTE" "END_QUOTE"
  10285. "BEGIN_VERSE" "END_VERSE"
  10286. "BEGIN_CENTER" "END_CENTER"
  10287. "BEGIN_SRC" "END_SRC"
  10288. "BEGIN_RESULT" "END_RESULT"
  10289. "BEGIN_lstlisting" "END_lstlisting"
  10290. "NAME:" "RESULTS:"
  10291. "HEADER:" "HEADERS:"
  10292. "COLUMNS:" "PROPERTY:"
  10293. "CAPTION:" "LABEL:"
  10294. "SETUPFILE:"
  10295. "INCLUDE:"
  10296. "BIND:"
  10297. "MACRO:"))
  10298. (defconst org-options-keywords
  10299. '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
  10300. "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
  10301. "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
  10302. "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
  10303. "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
  10304. "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:"
  10305. "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
  10306. (defconst org-additional-option-like-keywords-for-flyspell
  10307. (delete-dups
  10308. (split-string
  10309. (mapconcat (lambda(k)
  10310. (replace-regexp-in-string
  10311. "_\\|:" " "
  10312. (concat k " " (downcase k) " " (upcase k))))
  10313. (append org-options-keywords org-additional-option-like-keywords)
  10314. " ")
  10315. " +" t)))
  10316. (defcustom org-structure-template-alist
  10317. '(
  10318. ("s" "#+BEGIN_SRC ?\n\n#+END_SRC"
  10319. "<src lang=\"?\">\n\n</src>")
  10320. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE"
  10321. "<example>\n?\n</example>")
  10322. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE"
  10323. "<quote>\n?\n</quote>")
  10324. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE"
  10325. "<verse>\n?\n</verse>")
  10326. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER"
  10327. "<center>\n?\n</center>")
  10328. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10329. "<literal style=\"latex\">\n?\n</literal>")
  10330. ("L" "#+LaTeX: "
  10331. "<literal style=\"latex\">?</literal>")
  10332. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10333. "<literal style=\"html\">\n?\n</literal>")
  10334. ("H" "#+HTML: "
  10335. "<literal style=\"html\">?</literal>")
  10336. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
  10337. ("A" "#+ASCII: ")
  10338. ("i" "#+INDEX: ?"
  10339. "#+INDEX: ?")
  10340. ("I" "#+INCLUDE: %file ?"
  10341. "<include file=%file markup=\"?\">")
  10342. )
  10343. "Structure completion elements.
  10344. This is a list of abbreviation keys and values. The value gets inserted
  10345. if you type `<' followed by the key and then press the completion key,
  10346. usually `M-TAB'. %file will be replaced by a file name after prompting
  10347. for the file using completion. The cursor will be placed at the position
  10348. of the `?` in the template.
  10349. There are two templates for each key, the first uses the original Org syntax,
  10350. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10351. the default when the /org-mtags.el/ module has been loaded. See also the
  10352. variable `org-mtags-prefer-muse-templates'."
  10353. :group 'org-completion
  10354. :type '(repeat
  10355. (string :tag "Key")
  10356. (string :tag "Template")
  10357. (string :tag "Muse Template")))
  10358. (defun org-try-structure-completion ()
  10359. "Try to complete a structure template before point.
  10360. This looks for strings like \"<e\" on an otherwise empty line and
  10361. expands them."
  10362. (let ((l (buffer-substring (point-at-bol) (point)))
  10363. a)
  10364. (when (and (looking-at "[ \t]*$")
  10365. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10366. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10367. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10368. (match-beginning 1)) a)
  10369. t)))
  10370. (defun org-complete-expand-structure-template (start cell)
  10371. "Expand a structure template."
  10372. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10373. (rpl (nth (if musep 2 1) cell))
  10374. (ind ""))
  10375. (delete-region start (point))
  10376. (when (string-match "\\`#\\+" rpl)
  10377. (cond
  10378. ((bolp))
  10379. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10380. (setq ind (buffer-substring (point-at-bol) (point))))
  10381. (t (newline))))
  10382. (setq start (point))
  10383. (if (string-match "%file" rpl)
  10384. (setq rpl (replace-match
  10385. (concat
  10386. "\""
  10387. (save-match-data
  10388. (abbreviate-file-name (read-file-name "Include file: ")))
  10389. "\"")
  10390. t t rpl)))
  10391. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10392. (concat "\n" ind)))
  10393. (insert rpl)
  10394. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10395. ;;;; TODO, DEADLINE, Comments
  10396. (defun org-toggle-comment ()
  10397. "Change the COMMENT state of an entry."
  10398. (interactive)
  10399. (save-excursion
  10400. (org-back-to-heading)
  10401. (let (case-fold-search)
  10402. (cond
  10403. ((looking-at (format org-heading-keyword-regexp-format
  10404. org-comment-string))
  10405. (goto-char (match-end 1))
  10406. (looking-at (concat " +" org-comment-string))
  10407. (replace-match "" t t)
  10408. (when (eolp) (insert " ")))
  10409. ((looking-at org-outline-regexp)
  10410. (goto-char (match-end 0))
  10411. (insert org-comment-string " "))))))
  10412. (defvar org-last-todo-state-is-todo nil
  10413. "This is non-nil when the last TODO state change led to a TODO state.
  10414. If the last change removed the TODO tag or switched to DONE, then
  10415. this is nil.")
  10416. (defvar org-setting-tags nil) ; dynamically skipped
  10417. (defvar org-todo-setup-filter-hook nil
  10418. "Hook for functions that pre-filter todo specs.
  10419. Each function takes a todo spec and returns either nil or the spec
  10420. transformed into canonical form." )
  10421. (defvar org-todo-get-default-hook nil
  10422. "Hook for functions that get a default item for todo.
  10423. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10424. nil or a string to be used for the todo mark." )
  10425. (defvar org-agenda-headline-snapshot-before-repeat)
  10426. (defun org-current-effective-time ()
  10427. "Return current time adjusted for `org-extend-today-until' variable."
  10428. (let* ((ct (org-current-time))
  10429. (dct (decode-time ct))
  10430. (ct1
  10431. (if (and org-use-effective-time
  10432. (< (nth 2 dct) org-extend-today-until))
  10433. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
  10434. ct)))
  10435. ct1))
  10436. (defun org-todo-yesterday (&optional arg)
  10437. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10438. (interactive "P")
  10439. (if (eq major-mode 'org-agenda-mode)
  10440. (apply 'org-agenda-todo-yesterday arg)
  10441. (let* ((hour (third (decode-time
  10442. (org-current-time))))
  10443. (org-extend-today-until (1+ hour)))
  10444. (org-todo arg))))
  10445. (defun org-todo (&optional arg)
  10446. "Change the TODO state of an item.
  10447. The state of an item is given by a keyword at the start of the heading,
  10448. like
  10449. *** TODO Write paper
  10450. *** DONE Call mom
  10451. The different keywords are specified in the variable `org-todo-keywords'.
  10452. By default the available states are \"TODO\" and \"DONE\".
  10453. So for this example: when the item starts with TODO, it is changed to DONE.
  10454. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10455. DONE are present, add TODO at the beginning of the heading.
  10456. With \\[universal-argument] prefix arg, use completion to determine the new \
  10457. state.
  10458. With numeric prefix arg, switch to that state.
  10459. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10460. keywords (nextset).
  10461. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10462. With a numeric prefix arg of 0, inhibit note taking for the change.
  10463. For calling through lisp, arg is also interpreted in the following way:
  10464. 'none -> empty state
  10465. \"\"(empty string) -> switch to empty state
  10466. 'done -> switch to DONE
  10467. 'nextset -> switch to the next set of keywords
  10468. 'previousset -> switch to the previous set of keywords
  10469. \"WAITING\" -> switch to the specified keyword, but only if it
  10470. really is a member of `org-todo-keywords'."
  10471. (interactive "P")
  10472. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10473. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10474. 'region-start-level 'region))
  10475. org-loop-over-headlines-in-active-region)
  10476. (org-map-entries
  10477. `(org-todo ,arg)
  10478. org-loop-over-headlines-in-active-region
  10479. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  10480. (if (equal arg '(16)) (setq arg 'nextset))
  10481. (let ((org-blocker-hook org-blocker-hook)
  10482. (case-fold-search nil))
  10483. (when (equal arg '(64))
  10484. (setq arg nil org-blocker-hook nil))
  10485. (when (and org-blocker-hook
  10486. (or org-inhibit-blocking
  10487. (org-entry-get nil "NOBLOCKING")))
  10488. (setq org-blocker-hook nil))
  10489. (save-excursion
  10490. (catch 'exit
  10491. (org-back-to-heading t)
  10492. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  10493. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  10494. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  10495. (let* ((match-data (match-data))
  10496. (startpos (point-at-bol))
  10497. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  10498. (org-log-done org-log-done)
  10499. (org-log-repeat org-log-repeat)
  10500. (org-todo-log-states org-todo-log-states)
  10501. (org-inhibit-logging
  10502. (if (equal arg 0)
  10503. (progn (setq arg nil) 'note) org-inhibit-logging))
  10504. (this (match-string 1))
  10505. (hl-pos (match-beginning 0))
  10506. (head (org-get-todo-sequence-head this))
  10507. (ass (assoc head org-todo-kwd-alist))
  10508. (interpret (nth 1 ass))
  10509. (done-word (nth 3 ass))
  10510. (final-done-word (nth 4 ass))
  10511. (org-last-state (or this ""))
  10512. (completion-ignore-case t)
  10513. (member (member this org-todo-keywords-1))
  10514. (tail (cdr member))
  10515. (org-state (cond
  10516. ((and org-todo-key-trigger
  10517. (or (and (equal arg '(4))
  10518. (eq org-use-fast-todo-selection 'prefix))
  10519. (and (not arg) org-use-fast-todo-selection
  10520. (not (eq org-use-fast-todo-selection
  10521. 'prefix)))))
  10522. ;; Use fast selection
  10523. (org-fast-todo-selection))
  10524. ((and (equal arg '(4))
  10525. (or (not org-use-fast-todo-selection)
  10526. (not org-todo-key-trigger)))
  10527. ;; Read a state with completion
  10528. (org-icompleting-read
  10529. "State: " (mapcar (lambda(x) (list x))
  10530. org-todo-keywords-1)
  10531. nil t))
  10532. ((eq arg 'right)
  10533. (if this
  10534. (if tail (car tail) nil)
  10535. (car org-todo-keywords-1)))
  10536. ((eq arg 'left)
  10537. (if (equal member org-todo-keywords-1)
  10538. nil
  10539. (if this
  10540. (nth (- (length org-todo-keywords-1)
  10541. (length tail) 2)
  10542. org-todo-keywords-1)
  10543. (org-last org-todo-keywords-1))))
  10544. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  10545. (setq arg nil))) ; hack to fall back to cycling
  10546. (arg
  10547. ;; user or caller requests a specific state
  10548. (cond
  10549. ((equal arg "") nil)
  10550. ((eq arg 'none) nil)
  10551. ((eq arg 'done) (or done-word (car org-done-keywords)))
  10552. ((eq arg 'nextset)
  10553. (or (car (cdr (member head org-todo-heads)))
  10554. (car org-todo-heads)))
  10555. ((eq arg 'previousset)
  10556. (let ((org-todo-heads (reverse org-todo-heads)))
  10557. (or (car (cdr (member head org-todo-heads)))
  10558. (car org-todo-heads))))
  10559. ((car (member arg org-todo-keywords-1)))
  10560. ((stringp arg)
  10561. (error "State `%s' not valid in this file" arg))
  10562. ((nth (1- (prefix-numeric-value arg))
  10563. org-todo-keywords-1))))
  10564. ((null member) (or head (car org-todo-keywords-1)))
  10565. ((equal this final-done-word) nil) ;; -> make empty
  10566. ((null tail) nil) ;; -> first entry
  10567. ((memq interpret '(type priority))
  10568. (if (eq this-command last-command)
  10569. (car tail)
  10570. (if (> (length tail) 0)
  10571. (or done-word (car org-done-keywords))
  10572. nil)))
  10573. (t
  10574. (car tail))))
  10575. (org-state (or
  10576. (run-hook-with-args-until-success
  10577. 'org-todo-get-default-hook org-state org-last-state)
  10578. org-state))
  10579. (next (if org-state (concat " " org-state " ") " "))
  10580. (change-plist (list :type 'todo-state-change :from this :to org-state
  10581. :position startpos))
  10582. dolog now-done-p)
  10583. (when org-blocker-hook
  10584. (setq org-last-todo-state-is-todo
  10585. (not (member this org-done-keywords)))
  10586. (unless (save-excursion
  10587. (save-match-data
  10588. (org-with-wide-buffer
  10589. (run-hook-with-args-until-failure
  10590. 'org-blocker-hook change-plist))))
  10591. (if (org-called-interactively-p 'interactive)
  10592. (error "TODO state change from %s to %s blocked" this org-state)
  10593. ;; fail silently
  10594. (message "TODO state change from %s to %s blocked" this org-state)
  10595. (throw 'exit nil))))
  10596. (store-match-data match-data)
  10597. (replace-match next t t)
  10598. (unless (pos-visible-in-window-p hl-pos)
  10599. (message "TODO state changed to %s" (org-trim next)))
  10600. (unless head
  10601. (setq head (org-get-todo-sequence-head org-state)
  10602. ass (assoc head org-todo-kwd-alist)
  10603. interpret (nth 1 ass)
  10604. done-word (nth 3 ass)
  10605. final-done-word (nth 4 ass)))
  10606. (when (memq arg '(nextset previousset))
  10607. (message "Keyword-Set %d/%d: %s"
  10608. (- (length org-todo-sets) -1
  10609. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  10610. (length org-todo-sets)
  10611. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  10612. (setq org-last-todo-state-is-todo
  10613. (not (member org-state org-done-keywords)))
  10614. (setq now-done-p (and (member org-state org-done-keywords)
  10615. (not (member this org-done-keywords))))
  10616. (and logging (org-local-logging logging))
  10617. (when (and (or org-todo-log-states org-log-done)
  10618. (not (eq org-inhibit-logging t))
  10619. (not (memq arg '(nextset previousset))))
  10620. ;; we need to look at recording a time and note
  10621. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  10622. (nth 2 (assoc this org-todo-log-states))))
  10623. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  10624. (setq dolog 'time))
  10625. (when (and org-state
  10626. (member org-state org-not-done-keywords)
  10627. (not (member this org-not-done-keywords)))
  10628. ;; This is now a todo state and was not one before
  10629. ;; If there was a CLOSED time stamp, get rid of it.
  10630. (org-add-planning-info nil nil 'closed))
  10631. (when (and now-done-p org-log-done)
  10632. ;; It is now done, and it was not done before
  10633. (org-add-planning-info 'closed (org-current-effective-time))
  10634. (if (and (not dolog) (eq 'note org-log-done))
  10635. (org-add-log-setup 'done org-state this 'findpos 'note)))
  10636. (when (and org-state dolog)
  10637. ;; This is a non-nil state, and we need to log it
  10638. (org-add-log-setup 'state org-state this 'findpos dolog)))
  10639. ;; Fixup tag positioning
  10640. (org-todo-trigger-tag-changes org-state)
  10641. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  10642. (when org-provide-todo-statistics
  10643. (org-update-parent-todo-statistics))
  10644. (run-hooks 'org-after-todo-state-change-hook)
  10645. (if (and arg (not (member org-state org-done-keywords)))
  10646. (setq head (org-get-todo-sequence-head org-state)))
  10647. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  10648. ;; Do we need to trigger a repeat?
  10649. (when now-done-p
  10650. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  10651. ;; This is for the agenda, take a snapshot of the headline.
  10652. (save-match-data
  10653. (setq org-agenda-headline-snapshot-before-repeat
  10654. (org-get-heading))))
  10655. (org-auto-repeat-maybe org-state))
  10656. ;; Fixup cursor location if close to the keyword
  10657. (if (and (outline-on-heading-p)
  10658. (not (bolp))
  10659. (save-excursion (beginning-of-line 1)
  10660. (looking-at org-todo-line-regexp))
  10661. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  10662. (progn
  10663. (goto-char (or (match-end 2) (match-end 1)))
  10664. (and (looking-at " ") (just-one-space))))
  10665. (when org-trigger-hook
  10666. (save-excursion
  10667. (run-hook-with-args 'org-trigger-hook change-plist)))))))))
  10668. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  10669. "Block turning an entry into a TODO, using the hierarchy.
  10670. This checks whether the current task should be blocked from state
  10671. changes. Such blocking occurs when:
  10672. 1. The task has children which are not all in a completed state.
  10673. 2. A task has a parent with the property :ORDERED:, and there
  10674. are siblings prior to the current task with incomplete
  10675. status.
  10676. 3. The parent of the task is blocked because it has siblings that should
  10677. be done first, or is child of a block grandparent TODO entry."
  10678. (if (not org-enforce-todo-dependencies)
  10679. t ; if locally turned off don't block
  10680. (catch 'dont-block
  10681. ;; If this is not a todo state change, or if this entry is already DONE,
  10682. ;; do not block
  10683. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10684. (member (plist-get change-plist :from)
  10685. (cons 'done org-done-keywords))
  10686. (member (plist-get change-plist :to)
  10687. (cons 'todo org-not-done-keywords))
  10688. (not (plist-get change-plist :to)))
  10689. (throw 'dont-block t))
  10690. ;; If this task has children, and any are undone, it's blocked
  10691. (save-excursion
  10692. (org-back-to-heading t)
  10693. (let ((this-level (funcall outline-level)))
  10694. (outline-next-heading)
  10695. (let ((child-level (funcall outline-level)))
  10696. (while (and (not (eobp))
  10697. (> child-level this-level))
  10698. ;; this todo has children, check whether they are all
  10699. ;; completed
  10700. (if (and (not (org-entry-is-done-p))
  10701. (org-entry-is-todo-p))
  10702. (throw 'dont-block nil))
  10703. (outline-next-heading)
  10704. (setq child-level (funcall outline-level))))))
  10705. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  10706. ;; any previous siblings are undone, it's blocked
  10707. (save-excursion
  10708. (org-back-to-heading t)
  10709. (let* ((pos (point))
  10710. (parent-pos (and (org-up-heading-safe) (point))))
  10711. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10712. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10713. (forward-line 1)
  10714. (re-search-forward org-not-done-heading-regexp pos t))
  10715. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  10716. ;; Search further up the hierarchy, to see if an ancestor is blocked
  10717. (while t
  10718. (goto-char parent-pos)
  10719. (if (not (looking-at org-not-done-heading-regexp))
  10720. (throw 'dont-block t)) ; do not block, parent is not a TODO
  10721. (setq pos (point))
  10722. (setq parent-pos (and (org-up-heading-safe) (point)))
  10723. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10724. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10725. (forward-line 1)
  10726. (re-search-forward org-not-done-heading-regexp pos t))
  10727. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  10728. (defcustom org-track-ordered-property-with-tag nil
  10729. "Should the ORDERED property also be shown as a tag?
  10730. The ORDERED property decides if an entry should require subtasks to be
  10731. completed in sequence. Since a property is not very visible, setting
  10732. this option means that toggling the ORDERED property with the command
  10733. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  10734. not relevant for the behavior, but it makes things more visible.
  10735. Note that toggling the tag with tags commands will not change the property
  10736. and therefore not influence behavior!
  10737. This can be t, meaning the tag ORDERED should be used, It can also be a
  10738. string to select a different tag for this task."
  10739. :group 'org-todo
  10740. :type '(choice
  10741. (const :tag "No tracking" nil)
  10742. (const :tag "Track with ORDERED tag" t)
  10743. (string :tag "Use other tag")))
  10744. (defun org-toggle-ordered-property ()
  10745. "Toggle the ORDERED property of the current entry.
  10746. For better visibility, you can track the value of this property with a tag.
  10747. See variable `org-track-ordered-property-with-tag'."
  10748. (interactive)
  10749. (let* ((t1 org-track-ordered-property-with-tag)
  10750. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  10751. (save-excursion
  10752. (org-back-to-heading)
  10753. (if (org-entry-get nil "ORDERED")
  10754. (progn
  10755. (org-delete-property "ORDERED")
  10756. (and tag (org-toggle-tag tag 'off))
  10757. (message "Subtasks can be completed in arbitrary order"))
  10758. (org-entry-put nil "ORDERED" "t")
  10759. (and tag (org-toggle-tag tag 'on))
  10760. (message "Subtasks must be completed in sequence")))))
  10761. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  10762. (defun org-block-todo-from-checkboxes (change-plist)
  10763. "Block turning an entry into a TODO, using checkboxes.
  10764. This checks whether the current task should be blocked from state
  10765. changes because there are unchecked boxes in this entry."
  10766. (if (not org-enforce-todo-checkbox-dependencies)
  10767. t ; if locally turned off don't block
  10768. (catch 'dont-block
  10769. ;; If this is not a todo state change, or if this entry is already DONE,
  10770. ;; do not block
  10771. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10772. (member (plist-get change-plist :from)
  10773. (cons 'done org-done-keywords))
  10774. (member (plist-get change-plist :to)
  10775. (cons 'todo org-not-done-keywords))
  10776. (not (plist-get change-plist :to)))
  10777. (throw 'dont-block t))
  10778. ;; If this task has checkboxes that are not checked, it's blocked
  10779. (save-excursion
  10780. (org-back-to-heading t)
  10781. (let ((beg (point)) end)
  10782. (outline-next-heading)
  10783. (setq end (point))
  10784. (goto-char beg)
  10785. (if (org-list-search-forward
  10786. (concat (org-item-beginning-re)
  10787. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  10788. "\\[[- ]\\]")
  10789. end t)
  10790. (progn
  10791. (if (boundp 'org-blocked-by-checkboxes)
  10792. (setq org-blocked-by-checkboxes t))
  10793. (throw 'dont-block nil)))))
  10794. t))) ; do not block
  10795. (defun org-entry-blocked-p ()
  10796. "Is the current entry blocked?"
  10797. (if (org-entry-get nil "NOBLOCKING")
  10798. nil ;; Never block this entry
  10799. (not
  10800. (run-hook-with-args-until-failure
  10801. 'org-blocker-hook
  10802. (list :type 'todo-state-change
  10803. :position (point)
  10804. :from 'todo
  10805. :to 'done)))))
  10806. (defun org-update-statistics-cookies (all)
  10807. "Update the statistics cookie, either from TODO or from checkboxes.
  10808. This should be called with the cursor in a line with a statistics cookie."
  10809. (interactive "P")
  10810. (if all
  10811. (progn
  10812. (org-update-checkbox-count 'all)
  10813. (org-map-entries 'org-update-parent-todo-statistics))
  10814. (if (not (org-at-heading-p))
  10815. (org-update-checkbox-count)
  10816. (let ((pos (move-marker (make-marker) (point)))
  10817. end l1 l2)
  10818. (ignore-errors (org-back-to-heading t))
  10819. (if (not (org-at-heading-p))
  10820. (org-update-checkbox-count)
  10821. (setq l1 (org-outline-level))
  10822. (setq end (save-excursion
  10823. (outline-next-heading)
  10824. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  10825. (point)))
  10826. (if (and (save-excursion
  10827. (re-search-forward
  10828. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  10829. (not (save-excursion (re-search-forward
  10830. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  10831. (org-update-checkbox-count)
  10832. (if (and l2 (> l2 l1))
  10833. (progn
  10834. (goto-char end)
  10835. (org-update-parent-todo-statistics))
  10836. (goto-char pos)
  10837. (beginning-of-line 1)
  10838. (while (re-search-forward
  10839. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  10840. (point-at-eol) t)
  10841. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  10842. (goto-char pos)
  10843. (move-marker pos nil)))))
  10844. (defvar org-entry-property-inherited-from) ;; defined below
  10845. (defun org-update-parent-todo-statistics ()
  10846. "Update any statistics cookie in the parent of the current headline.
  10847. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  10848. the entire subtree and this will travel up the hierarchy and update
  10849. statistics everywhere."
  10850. (let* ((prop (save-excursion (org-up-heading-safe)
  10851. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  10852. (recursive (or (not org-hierarchical-todo-statistics)
  10853. (and prop (string-match "\\<recursive\\>" prop))))
  10854. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  10855. 0))
  10856. (first t)
  10857. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10858. level ltoggle l1 new ndel
  10859. (cnt-all 0) (cnt-done 0) is-percent kwd
  10860. checkbox-beg ov ovs ove cookie-present)
  10861. (catch 'exit
  10862. (save-excursion
  10863. (beginning-of-line 1)
  10864. (setq ltoggle (funcall outline-level))
  10865. ;; Three situations are to consider:
  10866. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  10867. ;; to the top-level ancestor on the headline;
  10868. ;; 2. If parent has "recursive" property, repeat up to the
  10869. ;; headline setting that property, taking inheritance into
  10870. ;; account;
  10871. ;; 3. Else, move up to direct parent and proceed only once.
  10872. (while (and (setq level (org-up-heading-safe))
  10873. (or recursive first)
  10874. (>= (point) lim))
  10875. (setq first nil cookie-present nil)
  10876. (unless (and level
  10877. (not (string-match
  10878. "\\<checkbox\\>"
  10879. (downcase (or (org-entry-get nil "COOKIE_DATA")
  10880. "")))))
  10881. (throw 'exit nil))
  10882. (while (re-search-forward box-re (point-at-eol) t)
  10883. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10884. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  10885. (save-match-data
  10886. (unless (outline-next-heading) (throw 'exit nil))
  10887. (while (and (looking-at org-complex-heading-regexp)
  10888. (> (setq l1 (length (match-string 1))) level))
  10889. (setq kwd (and (or recursive (= l1 ltoggle))
  10890. (match-string 2)))
  10891. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10892. (and (listp org-provide-todo-statistics)
  10893. (or (member kwd org-provide-todo-statistics)
  10894. (member kwd org-done-keywords))))
  10895. (setq cnt-all (1+ cnt-all))
  10896. (if (eq org-provide-todo-statistics t)
  10897. (and kwd (setq cnt-all (1+ cnt-all)))))
  10898. (and (member kwd org-done-keywords)
  10899. (setq cnt-done (1+ cnt-done)))
  10900. (outline-next-heading)))
  10901. (setq new
  10902. (if is-percent
  10903. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10904. (format "[%d/%d]" cnt-done cnt-all))
  10905. ndel (- (match-end 0) checkbox-beg))
  10906. ;; handle overlays when updating cookie from column view
  10907. (when (setq ov (car (overlays-at checkbox-beg)))
  10908. (setq ovs (overlay-start ov) ove (overlay-end ov))
  10909. (delete-overlay ov))
  10910. (goto-char checkbox-beg)
  10911. (insert new)
  10912. (delete-region (point) (+ (point) ndel))
  10913. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  10914. (when ov (move-overlay ov ovs ove)))
  10915. (when cookie-present
  10916. (run-hook-with-args 'org-after-todo-statistics-hook
  10917. cnt-done (- cnt-all cnt-done))))))
  10918. (run-hooks 'org-todo-statistics-hook)))
  10919. (defvar org-after-todo-statistics-hook nil
  10920. "Hook that is called after a TODO statistics cookie has been updated.
  10921. Each function is called with two arguments: the number of not-done entries
  10922. and the number of done entries.
  10923. For example, the following function, when added to this hook, will switch
  10924. an entry to DONE when all children are done, and back to TODO when new
  10925. entries are set to a TODO status. Note that this hook is only called
  10926. when there is a statistics cookie in the headline!
  10927. (defun org-summary-todo (n-done n-not-done)
  10928. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10929. (let (org-log-done org-log-states) ; turn off logging
  10930. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10931. ")
  10932. (defvar org-todo-statistics-hook nil
  10933. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10934. This hook runs even if there is no statistics cookie present, in which case
  10935. `org-after-todo-statistics-hook' would not run.")
  10936. (defun org-todo-trigger-tag-changes (state)
  10937. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10938. (let ((l org-todo-state-tags-triggers)
  10939. changes)
  10940. (when (or (not state) (equal state ""))
  10941. (setq changes (append changes (cdr (assoc "" l)))))
  10942. (when (and (stringp state) (> (length state) 0))
  10943. (setq changes (append changes (cdr (assoc state l)))))
  10944. (when (member state org-not-done-keywords)
  10945. (setq changes (append changes (cdr (assoc 'todo l)))))
  10946. (when (member state org-done-keywords)
  10947. (setq changes (append changes (cdr (assoc 'done l)))))
  10948. (dolist (c changes)
  10949. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10950. (defun org-local-logging (value)
  10951. "Get logging settings from a property VALUE."
  10952. (let* (words w a)
  10953. ;; directly set the variables, they are already local.
  10954. (setq org-log-done nil
  10955. org-log-repeat nil
  10956. org-todo-log-states nil)
  10957. (setq words (org-split-string value))
  10958. (while (setq w (pop words))
  10959. (cond
  10960. ((setq a (assoc w org-startup-options))
  10961. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10962. (set (nth 1 a) (nth 2 a))))
  10963. ((setq a (org-extract-log-state-settings w))
  10964. (and (member (car a) org-todo-keywords-1)
  10965. (push a org-todo-log-states)))))))
  10966. (defun org-get-todo-sequence-head (kwd)
  10967. "Return the head of the TODO sequence to which KWD belongs.
  10968. If KWD is not set, check if there is a text property remembering the
  10969. right sequence."
  10970. (let (p)
  10971. (cond
  10972. ((not kwd)
  10973. (or (get-text-property (point-at-bol) 'org-todo-head)
  10974. (progn
  10975. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  10976. nil (point-at-eol)))
  10977. (get-text-property p 'org-todo-head))))
  10978. ((not (member kwd org-todo-keywords-1))
  10979. (car org-todo-keywords-1))
  10980. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  10981. (defun org-fast-todo-selection ()
  10982. "Fast TODO keyword selection with single keys.
  10983. Returns the new TODO keyword, or nil if no state change should occur."
  10984. (let* ((fulltable org-todo-key-alist)
  10985. (done-keywords org-done-keywords) ;; needed for the faces.
  10986. (maxlen (apply 'max (mapcar
  10987. (lambda (x)
  10988. (if (stringp (car x)) (string-width (car x)) 0))
  10989. fulltable)))
  10990. (expert nil)
  10991. (fwidth (+ maxlen 3 1 3))
  10992. (ncol (/ (- (window-width) 4) fwidth))
  10993. tg cnt e c tbl
  10994. groups ingroup)
  10995. (save-excursion
  10996. (save-window-excursion
  10997. (if expert
  10998. (set-buffer (get-buffer-create " *Org todo*"))
  10999. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  11000. (erase-buffer)
  11001. (org-set-local 'org-done-keywords done-keywords)
  11002. (setq tbl fulltable cnt 0)
  11003. (while (setq e (pop tbl))
  11004. (cond
  11005. ((equal e '(:startgroup))
  11006. (push '() groups) (setq ingroup t)
  11007. (when (not (= cnt 0))
  11008. (setq cnt 0)
  11009. (insert "\n"))
  11010. (insert "{ "))
  11011. ((equal e '(:endgroup))
  11012. (setq ingroup nil cnt 0)
  11013. (insert "}\n"))
  11014. ((equal e '(:newline))
  11015. (when (not (= cnt 0))
  11016. (setq cnt 0)
  11017. (insert "\n")
  11018. (setq e (car tbl))
  11019. (while (equal (car tbl) '(:newline))
  11020. (insert "\n")
  11021. (setq tbl (cdr tbl)))))
  11022. (t
  11023. (setq tg (car e) c (cdr e))
  11024. (if ingroup (push tg (car groups)))
  11025. (setq tg (org-add-props tg nil 'face
  11026. (org-get-todo-face tg)))
  11027. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11028. (insert "[" c "] " tg (make-string
  11029. (- fwidth 4 (length tg)) ?\ ))
  11030. (when (= (setq cnt (1+ cnt)) ncol)
  11031. (insert "\n")
  11032. (if ingroup (insert " "))
  11033. (setq cnt 0)))))
  11034. (insert "\n")
  11035. (goto-char (point-min))
  11036. (if (not expert) (org-fit-window-to-buffer))
  11037. (message "[a-z..]:Set [SPC]:clear")
  11038. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11039. (cond
  11040. ((or (= c ?\C-g)
  11041. (and (= c ?q) (not (rassoc c fulltable))))
  11042. (setq quit-flag t))
  11043. ((= c ?\ ) nil)
  11044. ((setq e (rassoc c fulltable) tg (car e))
  11045. tg)
  11046. (t (setq quit-flag t)))))))
  11047. (defun org-entry-is-todo-p ()
  11048. (member (org-get-todo-state) org-not-done-keywords))
  11049. (defun org-entry-is-done-p ()
  11050. (member (org-get-todo-state) org-done-keywords))
  11051. (defun org-get-todo-state ()
  11052. (save-excursion
  11053. (org-back-to-heading t)
  11054. (and (looking-at org-todo-line-regexp)
  11055. (match-end 2)
  11056. (match-string 2))))
  11057. (defun org-at-date-range-p (&optional inactive-ok)
  11058. "Is the cursor inside a date range?"
  11059. (interactive)
  11060. (save-excursion
  11061. (catch 'exit
  11062. (let ((pos (point)))
  11063. (skip-chars-backward "^[<\r\n")
  11064. (skip-chars-backward "<[")
  11065. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11066. (>= (match-end 0) pos)
  11067. (throw 'exit t))
  11068. (skip-chars-backward "^<[\r\n")
  11069. (skip-chars-backward "<[")
  11070. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11071. (>= (match-end 0) pos)
  11072. (throw 'exit t)))
  11073. nil)))
  11074. (defun org-get-repeat (&optional tagline)
  11075. "Check if there is a deadline/schedule with repeater in this entry."
  11076. (save-match-data
  11077. (save-excursion
  11078. (org-back-to-heading t)
  11079. (and (re-search-forward (if tagline
  11080. (concat tagline "\\s-*" org-repeat-re)
  11081. org-repeat-re)
  11082. (org-entry-end-position) t)
  11083. (match-string-no-properties 1)))))
  11084. (defvar org-last-changed-timestamp)
  11085. (defvar org-last-inserted-timestamp)
  11086. (defvar org-log-post-message)
  11087. (defvar org-log-note-purpose)
  11088. (defvar org-log-note-how)
  11089. (defvar org-log-note-extra)
  11090. (defun org-auto-repeat-maybe (done-word)
  11091. "Check if the current headline contains a repeated deadline/schedule.
  11092. If yes, set TODO state back to what it was and change the base date
  11093. of repeating deadline/scheduled time stamps to new date.
  11094. This function is run automatically after each state change to a DONE state."
  11095. ;; last-state is dynamically scoped into this function
  11096. (let* ((repeat (org-get-repeat))
  11097. (aa (assoc org-last-state org-todo-kwd-alist))
  11098. (interpret (nth 1 aa))
  11099. (head (nth 2 aa))
  11100. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11101. (msg "Entry repeats: ")
  11102. (org-log-done nil)
  11103. (org-todo-log-states nil)
  11104. re type n what ts time to-state)
  11105. (when repeat
  11106. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  11107. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  11108. org-todo-repeat-to-state))
  11109. (unless (and to-state (member to-state org-todo-keywords-1))
  11110. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11111. (org-todo to-state)
  11112. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11113. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11114. (org-time-stamp-format t t))))
  11115. (when org-log-repeat
  11116. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11117. (memq 'org-add-log-note post-command-hook))
  11118. ;; OK, we are already setup for some record
  11119. (if (eq org-log-repeat 'note)
  11120. ;; make sure we take a note, not only a time stamp
  11121. (setq org-log-note-how 'note))
  11122. ;; Set up for taking a record
  11123. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  11124. org-last-state
  11125. 'findpos org-log-repeat)))
  11126. (org-back-to-heading t)
  11127. (org-add-planning-info nil nil 'closed)
  11128. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11129. org-deadline-time-regexp "\\)\\|\\("
  11130. org-ts-regexp "\\)"))
  11131. (while (re-search-forward
  11132. re (save-excursion (outline-next-heading) (point)) t)
  11133. (setq type (if (match-end 1) org-scheduled-string
  11134. (if (match-end 3) org-deadline-string "Plain:"))
  11135. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  11136. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  11137. (setq n (string-to-number (match-string 2 ts))
  11138. what (match-string 3 ts))
  11139. (if (equal what "w") (setq n (* n 7) what "d"))
  11140. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  11141. (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  11142. ;; Preparation, see if we need to modify the start date for the change
  11143. (when (match-end 1)
  11144. (setq time (save-match-data (org-time-string-to-time ts)))
  11145. (cond
  11146. ((equal (match-string 1 ts) ".")
  11147. ;; Shift starting date to today
  11148. (org-timestamp-change
  11149. (- (org-today) (time-to-days time))
  11150. 'day))
  11151. ((equal (match-string 1 ts) "+")
  11152. (let ((nshiftmax 10) (nshift 0))
  11153. (while (or (= nshift 0)
  11154. (<= (time-to-days time)
  11155. (time-to-days (current-time))))
  11156. (when (= (incf nshift) nshiftmax)
  11157. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  11158. (error "Abort")))
  11159. (org-timestamp-change n (cdr (assoc what whata)))
  11160. (org-at-timestamp-p t)
  11161. (setq ts (match-string 1))
  11162. (setq time (save-match-data (org-time-string-to-time ts)))))
  11163. (org-timestamp-change (- n) (cdr (assoc what whata)))
  11164. ;; rematch, so that we have everything in place for the real shift
  11165. (org-at-timestamp-p t)
  11166. (setq ts (match-string 1))
  11167. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  11168. (org-timestamp-change n (cdr (assoc what whata)))
  11169. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  11170. (setq org-log-post-message msg)
  11171. (message "%s" msg))))
  11172. (defun org-show-todo-tree (arg)
  11173. "Make a compact tree which shows all headlines marked with TODO.
  11174. The tree will show the lines where the regexp matches, and all higher
  11175. headlines above the match.
  11176. With a \\[universal-argument] prefix, prompt for a regexp to match.
  11177. With a numeric prefix N, construct a sparse tree for the Nth element
  11178. of `org-todo-keywords-1'."
  11179. (interactive "P")
  11180. (let ((case-fold-search nil)
  11181. (kwd-re
  11182. (cond ((null arg) org-not-done-regexp)
  11183. ((equal arg '(4))
  11184. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  11185. (mapcar 'list org-todo-keywords-1))))
  11186. (concat "\\("
  11187. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  11188. "\\)\\>")))
  11189. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  11190. (regexp-quote (nth (1- (prefix-numeric-value arg))
  11191. org-todo-keywords-1)))
  11192. (t (error "Invalid prefix argument: %s" arg)))))
  11193. (message "%d TODO entries found"
  11194. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  11195. (defun org-deadline (&optional remove time)
  11196. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  11197. With argument REMOVE, remove any deadline from the item.
  11198. With argument TIME, set the deadline at the corresponding date. TIME
  11199. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11200. (interactive "P")
  11201. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11202. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11203. 'region-start-level 'region))
  11204. org-loop-over-headlines-in-active-region)
  11205. (org-map-entries
  11206. `(org-deadline ',remove ,time)
  11207. org-loop-over-headlines-in-active-region
  11208. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11209. (let* ((old-date (org-entry-get nil "DEADLINE"))
  11210. (repeater (and old-date
  11211. (string-match
  11212. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11213. old-date)
  11214. (match-string 1 old-date))))
  11215. (if remove
  11216. (progn
  11217. (when (and old-date org-log-redeadline)
  11218. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11219. org-log-redeadline))
  11220. (org-remove-timestamp-with-keyword org-deadline-string)
  11221. (message "Item no longer has a deadline."))
  11222. (org-add-planning-info 'deadline time 'closed)
  11223. (when (and old-date org-log-redeadline
  11224. (not (equal old-date
  11225. (substring org-last-inserted-timestamp 1 -1))))
  11226. (org-add-log-setup 'redeadline nil old-date 'findpos
  11227. org-log-redeadline))
  11228. (when repeater
  11229. (save-excursion
  11230. (org-back-to-heading t)
  11231. (when (re-search-forward (concat org-deadline-string " "
  11232. org-last-inserted-timestamp)
  11233. (save-excursion
  11234. (outline-next-heading) (point)) t)
  11235. (goto-char (1- (match-end 0)))
  11236. (insert " " repeater)
  11237. (setq org-last-inserted-timestamp
  11238. (concat (substring org-last-inserted-timestamp 0 -1)
  11239. " " repeater
  11240. (substring org-last-inserted-timestamp -1))))))
  11241. (message "Deadline on %s" org-last-inserted-timestamp)))))
  11242. (defun org-schedule (&optional remove time)
  11243. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11244. With argument REMOVE, remove any scheduling date from the item.
  11245. With argument TIME, scheduled at the corresponding date. TIME can
  11246. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11247. (interactive "P")
  11248. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11249. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11250. 'region-start-level 'region))
  11251. org-loop-over-headlines-in-active-region)
  11252. (org-map-entries
  11253. `(org-schedule ',remove ,time)
  11254. org-loop-over-headlines-in-active-region
  11255. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11256. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11257. (repeater (and old-date
  11258. (string-match
  11259. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11260. old-date)
  11261. (match-string 1 old-date))))
  11262. (if remove
  11263. (progn
  11264. (when (and old-date org-log-reschedule)
  11265. (org-add-log-setup 'delschedule nil old-date 'findpos
  11266. org-log-reschedule))
  11267. (org-remove-timestamp-with-keyword org-scheduled-string)
  11268. (message "Item is no longer scheduled."))
  11269. (org-add-planning-info 'scheduled time 'closed)
  11270. (when (and old-date org-log-reschedule
  11271. (not (equal old-date
  11272. (substring org-last-inserted-timestamp 1 -1))))
  11273. (org-add-log-setup 'reschedule nil old-date 'findpos
  11274. org-log-reschedule))
  11275. (when repeater
  11276. (save-excursion
  11277. (org-back-to-heading t)
  11278. (when (re-search-forward (concat org-scheduled-string " "
  11279. org-last-inserted-timestamp)
  11280. (save-excursion
  11281. (outline-next-heading) (point)) t)
  11282. (goto-char (1- (match-end 0)))
  11283. (insert " " repeater)
  11284. (setq org-last-inserted-timestamp
  11285. (concat (substring org-last-inserted-timestamp 0 -1)
  11286. " " repeater
  11287. (substring org-last-inserted-timestamp -1))))))
  11288. (message "Scheduled to %s" org-last-inserted-timestamp)))))
  11289. (defun org-get-scheduled-time (pom &optional inherit)
  11290. "Get the scheduled time as a time tuple, of a format suitable
  11291. for calling org-schedule with, or if there is no scheduling,
  11292. returns nil."
  11293. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11294. (when time
  11295. (apply 'encode-time (org-parse-time-string time)))))
  11296. (defun org-get-deadline-time (pom &optional inherit)
  11297. "Get the deadline as a time tuple, of a format suitable for
  11298. calling org-deadline with, or if there is no scheduling, returns
  11299. nil."
  11300. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11301. (when time
  11302. (apply 'encode-time (org-parse-time-string time)))))
  11303. (defun org-remove-timestamp-with-keyword (keyword)
  11304. "Remove all time stamps with KEYWORD in the current entry."
  11305. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11306. beg)
  11307. (save-excursion
  11308. (org-back-to-heading t)
  11309. (setq beg (point))
  11310. (outline-next-heading)
  11311. (while (re-search-backward re beg t)
  11312. (replace-match "")
  11313. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11314. (equal (char-before) ?\ ))
  11315. (backward-delete-char 1)
  11316. (if (string-match "^[ \t]*$" (buffer-substring
  11317. (point-at-bol) (point-at-eol)))
  11318. (delete-region (point-at-bol)
  11319. (min (point-max) (1+ (point-at-eol))))))))))
  11320. (defun org-add-planning-info (what &optional time &rest remove)
  11321. "Insert new timestamp with keyword in the line directly after the headline.
  11322. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11323. If non is given, the user is prompted for a date.
  11324. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11325. be removed."
  11326. (interactive)
  11327. (let (org-time-was-given org-end-time-was-given ts
  11328. end default-time default-input)
  11329. (catch 'exit
  11330. (when (and (memq what '(scheduled deadline))
  11331. (or (not time)
  11332. (and (stringp time)
  11333. (string-match "^[-+]+[0-9]" time))))
  11334. ;; Try to get a default date/time from existing timestamp
  11335. (save-excursion
  11336. (org-back-to-heading t)
  11337. (setq end (save-excursion (outline-next-heading) (point)))
  11338. (when (re-search-forward (if (eq what 'scheduled)
  11339. org-scheduled-time-regexp
  11340. org-deadline-time-regexp)
  11341. end t)
  11342. (setq ts (match-string 1)
  11343. default-time
  11344. (apply 'encode-time (org-parse-time-string ts))
  11345. default-input (and ts (org-get-compact-tod ts))))))
  11346. (when what
  11347. (setq time
  11348. (if (stringp time)
  11349. ;; This is a string (relative or absolute), set proper date
  11350. (apply 'encode-time
  11351. (org-read-date-analyze
  11352. time default-time (decode-time default-time)))
  11353. ;; If necessary, get the time from the user
  11354. (or time (org-read-date nil 'to-time nil nil
  11355. default-time default-input)))))
  11356. (when (and org-insert-labeled-timestamps-at-point
  11357. (member what '(scheduled deadline)))
  11358. (insert
  11359. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11360. (org-insert-time-stamp time org-time-was-given
  11361. nil nil nil (list org-end-time-was-given))
  11362. (setq what nil))
  11363. (save-excursion
  11364. (save-restriction
  11365. (let (col list elt ts buffer-invisibility-spec)
  11366. (org-back-to-heading t)
  11367. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11368. (goto-char (match-end 1))
  11369. (setq col (current-column))
  11370. (goto-char (match-end 0))
  11371. (if (eobp) (insert "\n") (forward-char 1))
  11372. (when (and (not what)
  11373. (not (looking-at
  11374. (concat "[ \t]*"
  11375. org-keyword-time-not-clock-regexp))))
  11376. ;; Nothing to add, nothing to remove...... :-)
  11377. (throw 'exit nil))
  11378. (if (and (not (looking-at org-outline-regexp))
  11379. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11380. "[^\r\n]*"))
  11381. (not (equal (match-string 1) org-clock-string)))
  11382. (narrow-to-region (match-beginning 0) (match-end 0))
  11383. (insert-before-markers "\n")
  11384. (backward-char 1)
  11385. (narrow-to-region (point) (point))
  11386. (and org-adapt-indentation (org-indent-to-column col)))
  11387. ;; Check if we have to remove something.
  11388. (setq list (cons what remove))
  11389. (while list
  11390. (setq elt (pop list))
  11391. (when (or (and (eq elt 'scheduled)
  11392. (re-search-forward org-scheduled-time-regexp nil t))
  11393. (and (eq elt 'deadline)
  11394. (re-search-forward org-deadline-time-regexp nil t))
  11395. (and (eq elt 'closed)
  11396. (re-search-forward org-closed-time-regexp nil t)))
  11397. (replace-match "")
  11398. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11399. (and (looking-at "[ \t]+") (replace-match ""))
  11400. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11401. (when what
  11402. (insert
  11403. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11404. (cond ((eq what 'scheduled) org-scheduled-string)
  11405. ((eq what 'deadline) org-deadline-string)
  11406. ((eq what 'closed) org-closed-string))
  11407. " ")
  11408. (setq ts (org-insert-time-stamp
  11409. time
  11410. (or org-time-was-given
  11411. (and (eq what 'closed) org-log-done-with-time))
  11412. (eq what 'closed)
  11413. nil nil (list org-end-time-was-given)))
  11414. (insert
  11415. (if (not (or (bolp) (eq (char-before) ?\ )
  11416. (memq (char-after) '(32 10))
  11417. (eobp))) " " ""))
  11418. (end-of-line 1))
  11419. (goto-char (point-min))
  11420. (widen)
  11421. (if (and (looking-at "[ \t]*\n")
  11422. (equal (char-before) ?\n))
  11423. (delete-region (1- (point)) (point-at-eol)))
  11424. ts))))))
  11425. (defvar org-log-note-marker (make-marker))
  11426. (defvar org-log-note-purpose nil)
  11427. (defvar org-log-note-state nil)
  11428. (defvar org-log-note-previous-state nil)
  11429. (defvar org-log-note-how nil)
  11430. (defvar org-log-note-extra nil)
  11431. (defvar org-log-note-window-configuration nil)
  11432. (defvar org-log-note-return-to (make-marker))
  11433. (defvar org-log-note-effective-time nil
  11434. "Remembered current time so that dynamically scoped
  11435. `org-extend-today-until' affects tha timestamps in state change
  11436. log")
  11437. (defvar org-log-post-message nil
  11438. "Message to be displayed after a log note has been stored.
  11439. The auto-repeater uses this.")
  11440. (defun org-add-note ()
  11441. "Add a note to the current entry.
  11442. This is done in the same way as adding a state change note."
  11443. (interactive)
  11444. (org-add-log-setup 'note nil nil 'findpos nil))
  11445. (defvar org-property-end-re)
  11446. (defun org-add-log-setup (&optional purpose state prev-state
  11447. findpos how extra)
  11448. "Set up the post command hook to take a note.
  11449. If this is about to TODO state change, the new state is expected in STATE.
  11450. When FINDPOS is non-nil, find the correct position for the note in
  11451. the current entry. If not, assume that it can be inserted at point.
  11452. HOW is an indicator what kind of note should be created.
  11453. EXTRA is additional text that will be inserted into the notes buffer."
  11454. (let* ((org-log-into-drawer (org-log-into-drawer))
  11455. (drawer (cond ((stringp org-log-into-drawer)
  11456. org-log-into-drawer)
  11457. (org-log-into-drawer "LOGBOOK"))))
  11458. (save-restriction
  11459. (save-excursion
  11460. (when findpos
  11461. (org-back-to-heading t)
  11462. (narrow-to-region (point) (save-excursion
  11463. (outline-next-heading) (point)))
  11464. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  11465. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  11466. "[^\r\n]*\\)?"))
  11467. (goto-char (match-end 0))
  11468. (cond
  11469. (drawer
  11470. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  11471. nil t)
  11472. (progn
  11473. (goto-char (match-end 0))
  11474. (or org-log-states-order-reversed
  11475. (and (re-search-forward org-property-end-re nil t)
  11476. (goto-char (1- (match-beginning 0))))))
  11477. (insert "\n:" drawer ":\n:END:")
  11478. (beginning-of-line 0)
  11479. (org-indent-line)
  11480. (beginning-of-line 2)
  11481. (org-indent-line)
  11482. (end-of-line 0)))
  11483. ((and org-log-state-notes-insert-after-drawers
  11484. (save-excursion
  11485. (forward-line) (looking-at org-drawer-regexp)))
  11486. (forward-line)
  11487. (while (looking-at org-drawer-regexp)
  11488. (goto-char (match-end 0))
  11489. (re-search-forward org-property-end-re (point-max) t)
  11490. (forward-line))
  11491. (forward-line -1)))
  11492. (unless org-log-states-order-reversed
  11493. (and (= (char-after) ?\n) (forward-char 1))
  11494. (org-skip-over-state-notes)
  11495. (skip-chars-backward " \t\n\r")))
  11496. (move-marker org-log-note-marker (point))
  11497. (setq org-log-note-purpose purpose
  11498. org-log-note-state state
  11499. org-log-note-previous-state prev-state
  11500. org-log-note-how how
  11501. org-log-note-extra extra
  11502. org-log-note-effective-time (org-current-effective-time))
  11503. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  11504. (defun org-skip-over-state-notes ()
  11505. "Skip past the list of State notes in an entry."
  11506. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  11507. (when (ignore-errors (goto-char (org-in-item-p)))
  11508. (let* ((struct (org-list-struct))
  11509. (prevs (org-list-prevs-alist struct)))
  11510. (while (looking-at "[ \t]*- State")
  11511. (goto-char (or (org-list-get-next-item (point) struct prevs)
  11512. (org-list-get-item-end (point) struct)))))))
  11513. (defun org-add-log-note (&optional purpose)
  11514. "Pop up a window for taking a note, and add this note later at point."
  11515. (remove-hook 'post-command-hook 'org-add-log-note)
  11516. (setq org-log-note-window-configuration (current-window-configuration))
  11517. (delete-other-windows)
  11518. (move-marker org-log-note-return-to (point))
  11519. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  11520. (goto-char org-log-note-marker)
  11521. (org-switch-to-buffer-other-window "*Org Note*")
  11522. (erase-buffer)
  11523. (if (memq org-log-note-how '(time state))
  11524. (let (current-prefix-arg) (org-store-log-note))
  11525. (let ((org-inhibit-startup t)) (org-mode))
  11526. (insert (format "# Insert note for %s.
  11527. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  11528. (cond
  11529. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  11530. ((eq org-log-note-purpose 'done) "closed todo item")
  11531. ((eq org-log-note-purpose 'state)
  11532. (format "state change from \"%s\" to \"%s\""
  11533. (or org-log-note-previous-state "")
  11534. (or org-log-note-state "")))
  11535. ((eq org-log-note-purpose 'reschedule)
  11536. "rescheduling")
  11537. ((eq org-log-note-purpose 'delschedule)
  11538. "no longer scheduled")
  11539. ((eq org-log-note-purpose 'redeadline)
  11540. "changing deadline")
  11541. ((eq org-log-note-purpose 'deldeadline)
  11542. "removing deadline")
  11543. ((eq org-log-note-purpose 'refile)
  11544. "refiling")
  11545. ((eq org-log-note-purpose 'note)
  11546. "this entry")
  11547. (t (error "This should not happen")))))
  11548. (if org-log-note-extra (insert org-log-note-extra))
  11549. (org-set-local 'org-finish-function 'org-store-log-note)
  11550. (run-hooks 'org-log-buffer-setup-hook)))
  11551. (defvar org-note-abort nil) ; dynamically scoped
  11552. (defun org-store-log-note ()
  11553. "Finish taking a log note, and insert it to where it belongs."
  11554. (let ((txt (buffer-string))
  11555. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  11556. lines ind bul)
  11557. (kill-buffer (current-buffer))
  11558. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  11559. (setq txt (replace-match "" t t txt)))
  11560. (if (string-match "\\s-+\\'" txt)
  11561. (setq txt (replace-match "" t t txt)))
  11562. (setq lines (org-split-string txt "\n"))
  11563. (when (and note (string-match "\\S-" note))
  11564. (setq note
  11565. (org-replace-escapes
  11566. note
  11567. (list (cons "%u" (user-login-name))
  11568. (cons "%U" user-full-name)
  11569. (cons "%t" (format-time-string
  11570. (org-time-stamp-format 'long 'inactive)
  11571. org-log-note-effective-time))
  11572. (cons "%T" (format-time-string
  11573. (org-time-stamp-format 'long nil)
  11574. org-log-note-effective-time))
  11575. (cons "%d" (format-time-string
  11576. (org-time-stamp-format nil 'inactive)
  11577. org-log-note-effective-time))
  11578. (cons "%D" (format-time-string
  11579. (org-time-stamp-format nil nil)
  11580. org-log-note-effective-time))
  11581. (cons "%s" (if org-log-note-state
  11582. (concat "\"" org-log-note-state "\"")
  11583. ""))
  11584. (cons "%S" (if org-log-note-previous-state
  11585. (concat "\"" org-log-note-previous-state "\"")
  11586. "\"\"")))))
  11587. (if lines (setq note (concat note " \\\\")))
  11588. (push note lines))
  11589. (when (or current-prefix-arg org-note-abort)
  11590. (when org-log-into-drawer
  11591. (org-remove-empty-drawer-at
  11592. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  11593. org-log-note-marker))
  11594. (setq lines nil))
  11595. (when lines
  11596. (with-current-buffer (marker-buffer org-log-note-marker)
  11597. (save-excursion
  11598. (goto-char org-log-note-marker)
  11599. (move-marker org-log-note-marker nil)
  11600. (end-of-line 1)
  11601. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  11602. (setq ind (save-excursion
  11603. (if (ignore-errors (goto-char (org-in-item-p)))
  11604. (let ((struct (org-list-struct)))
  11605. (org-list-get-ind
  11606. (org-list-get-top-point struct) struct))
  11607. (skip-chars-backward " \r\t\n")
  11608. (cond
  11609. ((and (org-at-heading-p)
  11610. org-adapt-indentation)
  11611. (1+ (org-current-level)))
  11612. ((org-at-heading-p) 0)
  11613. (t (org-get-indentation))))))
  11614. (setq bul (org-list-bullet-string "-"))
  11615. (org-indent-line-to ind)
  11616. (insert bul (pop lines))
  11617. (let ((ind-body (+ (length bul) ind)))
  11618. (while lines
  11619. (insert "\n")
  11620. (org-indent-line-to ind-body)
  11621. (insert (pop lines))))
  11622. (message "Note stored")
  11623. (org-back-to-heading t)
  11624. (org-cycle-hide-drawers 'children)))))
  11625. (set-window-configuration org-log-note-window-configuration)
  11626. (with-current-buffer (marker-buffer org-log-note-return-to)
  11627. (goto-char org-log-note-return-to))
  11628. (move-marker org-log-note-return-to nil)
  11629. (and org-log-post-message (message "%s" org-log-post-message)))
  11630. (defun org-remove-empty-drawer-at (drawer pos)
  11631. "Remove an empty drawer DRAWER at position POS.
  11632. POS may also be a marker."
  11633. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  11634. (save-excursion
  11635. (save-restriction
  11636. (widen)
  11637. (goto-char pos)
  11638. (if (org-in-regexp
  11639. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  11640. (replace-match ""))))))
  11641. (defvar org-ts-type nil)
  11642. (defun org-sparse-tree (&optional arg type)
  11643. "Create a sparse tree, prompt for the details.
  11644. This command can create sparse trees. You first need to select the type
  11645. of match used to create the tree:
  11646. t Show all TODO entries.
  11647. T Show entries with a specific TODO keyword.
  11648. m Show entries selected by a tags/property match.
  11649. p Enter a property name and its value (both with completion on existing
  11650. names/values) and show entries with that property.
  11651. r Show entries matching a regular expression (`/' can be used as well).
  11652. b Show deadlines and scheduled items before a date.
  11653. a Show deadlines and scheduled items after a date.
  11654. d Show deadlines due within `org-deadline-warning-days'.
  11655. D Show deadlines and scheduled items between a date range."
  11656. (interactive "P")
  11657. (let (ans kwd value ts-type)
  11658. (setq type (or type org-sparse-tree-default-date-type))
  11659. (setq org-ts-type type)
  11660. (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"
  11661. (cond ((eq type 'all) "all timestamps")
  11662. ((eq type 'scheduled) "only scheduled")
  11663. ((eq type 'deadline) "only deadline")
  11664. ((eq type 'active) "only active timestamps")
  11665. ((eq type 'inactive) "only inactive timestamps")
  11666. ((eq type 'scheduled-or-deadline) "scheduled/deadline")
  11667. (t "scheduled/deadline")))
  11668. (setq ans (read-char-exclusive))
  11669. (cond
  11670. ((equal ans ?c)
  11671. (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
  11672. ((equal ans ?d)
  11673. (call-interactively 'org-check-deadlines))
  11674. ((equal ans ?b)
  11675. (call-interactively 'org-check-before-date))
  11676. ((equal ans ?a)
  11677. (call-interactively 'org-check-after-date))
  11678. ((equal ans ?D)
  11679. (call-interactively 'org-check-dates-range))
  11680. ((equal ans ?t)
  11681. (org-show-todo-tree nil))
  11682. ((equal ans ?T)
  11683. (org-show-todo-tree '(4)))
  11684. ((member ans '(?T ?m))
  11685. (call-interactively 'org-match-sparse-tree))
  11686. ((member ans '(?p ?P))
  11687. (setq kwd (org-icompleting-read "Property: "
  11688. (mapcar 'list (org-buffer-property-keys))))
  11689. (setq value (org-icompleting-read "Value: "
  11690. (mapcar 'list (org-property-values kwd))))
  11691. (unless (string-match "\\`{.*}\\'" value)
  11692. (setq value (concat "\"" value "\"")))
  11693. (org-match-sparse-tree arg (concat kwd "=" value)))
  11694. ((member ans '(?r ?R ?/))
  11695. (call-interactively 'org-occur))
  11696. (t (error "No such sparse tree command \"%c\"" ans)))))
  11697. (defvar org-occur-highlights nil
  11698. "List of overlays used for occur matches.")
  11699. (make-variable-buffer-local 'org-occur-highlights)
  11700. (defvar org-occur-parameters nil
  11701. "Parameters of the active org-occur calls.
  11702. This is a list, each call to org-occur pushes as cons cell,
  11703. containing the regular expression and the callback, onto the list.
  11704. The list can contain several entries if `org-occur' has been called
  11705. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  11706. will only contain one set of parameters. When the highlights are
  11707. removed (for example with `C-c C-c', or with the next edit (depending
  11708. on `org-remove-highlights-with-change'), this variable is emptied
  11709. as well.")
  11710. (make-variable-buffer-local 'org-occur-parameters)
  11711. (defun org-occur (regexp &optional keep-previous callback)
  11712. "Make a compact tree which shows all matches of REGEXP.
  11713. The tree will show the lines where the regexp matches, and all higher
  11714. headlines above the match. It will also show the heading after the match,
  11715. to make sure editing the matching entry is easy.
  11716. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  11717. call to `org-occur' will be kept, to allow stacking of calls to this
  11718. command.
  11719. If CALLBACK is non-nil, it is a function which is called to confirm
  11720. that the match should indeed be shown."
  11721. (interactive "sRegexp: \nP")
  11722. (when (equal regexp "")
  11723. (error "Regexp cannot be empty"))
  11724. (unless keep-previous
  11725. (org-remove-occur-highlights nil nil t))
  11726. (push (cons regexp callback) org-occur-parameters)
  11727. (let ((cnt 0))
  11728. (save-excursion
  11729. (goto-char (point-min))
  11730. (if (or (not keep-previous) ; do not want to keep
  11731. (not org-occur-highlights)) ; no previous matches
  11732. ;; hide everything
  11733. (org-overview))
  11734. (while (re-search-forward regexp nil t)
  11735. (when (or (not callback)
  11736. (save-match-data (funcall callback)))
  11737. (setq cnt (1+ cnt))
  11738. (when org-highlight-sparse-tree-matches
  11739. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  11740. (org-show-context 'occur-tree))))
  11741. (when org-remove-highlights-with-change
  11742. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  11743. nil 'local))
  11744. (unless org-sparse-tree-open-archived-trees
  11745. (org-hide-archived-subtrees (point-min) (point-max)))
  11746. (run-hooks 'org-occur-hook)
  11747. (if (org-called-interactively-p 'interactive)
  11748. (message "%d match(es) for regexp %s" cnt regexp))
  11749. cnt))
  11750. (defun org-occur-next-match (&optional n reset)
  11751. "Function for `next-error-function' to find sparse tree matches.
  11752. N is the number of matches to move, when negative move backwards.
  11753. RESET is entirely ignored - this function always goes back to the
  11754. starting point when no match is found."
  11755. (let* ((limit (if (< n 0) (point-min) (point-max)))
  11756. (search-func (if (< n 0)
  11757. 'previous-single-char-property-change
  11758. 'next-single-char-property-change))
  11759. (n (abs n))
  11760. (pos (point))
  11761. p1)
  11762. (catch 'exit
  11763. (while (setq p1 (funcall search-func (point) 'org-type))
  11764. (when (equal p1 limit)
  11765. (goto-char pos)
  11766. (error "No more matches"))
  11767. (when (equal (get-char-property p1 'org-type) 'org-occur)
  11768. (setq n (1- n))
  11769. (when (= n 0)
  11770. (goto-char p1)
  11771. (throw 'exit (point))))
  11772. (goto-char p1))
  11773. (goto-char p1)
  11774. (error "No more matches"))))
  11775. (defun org-show-context (&optional key)
  11776. "Make sure point and context are visible.
  11777. How much context is shown depends upon the variables
  11778. `org-show-hierarchy-above', `org-show-following-heading',
  11779. `org-show-entry-below' and `org-show-siblings'."
  11780. (let ((heading-p (org-at-heading-p t))
  11781. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  11782. (following-p (org-get-alist-option org-show-following-heading key))
  11783. (entry-p (org-get-alist-option org-show-entry-below key))
  11784. (siblings-p (org-get-alist-option org-show-siblings key)))
  11785. (catch 'exit
  11786. ;; Show heading or entry text
  11787. (if (and heading-p (not entry-p))
  11788. (org-flag-heading nil) ; only show the heading
  11789. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  11790. (org-show-hidden-entry))) ; show entire entry
  11791. (when following-p
  11792. ;; Show next sibling, or heading below text
  11793. (save-excursion
  11794. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  11795. (org-flag-heading nil))))
  11796. (when siblings-p (org-show-siblings))
  11797. (when hierarchy-p
  11798. ;; show all higher headings, possibly with siblings
  11799. (save-excursion
  11800. (while (and (condition-case nil
  11801. (progn (org-up-heading-all 1) t)
  11802. (error nil))
  11803. (not (bobp)))
  11804. (org-flag-heading nil)
  11805. (when siblings-p (org-show-siblings))))))))
  11806. (defvar org-reveal-start-hook nil
  11807. "Hook run before revealing a location.")
  11808. (defun org-reveal (&optional siblings)
  11809. "Show current entry, hierarchy above it, and the following headline.
  11810. This can be used to show a consistent set of context around locations
  11811. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  11812. not t for the search context.
  11813. With optional argument SIBLINGS, on each level of the hierarchy all
  11814. siblings are shown. This repairs the tree structure to what it would
  11815. look like when opened with hierarchical calls to `org-cycle'.
  11816. With double optional argument \\[universal-argument] \\[universal-argument], \
  11817. go to the parent and show the
  11818. entire tree."
  11819. (interactive "P")
  11820. (run-hooks 'org-reveal-start-hook)
  11821. (let ((org-show-hierarchy-above t)
  11822. (org-show-following-heading t)
  11823. (org-show-siblings (if siblings t org-show-siblings)))
  11824. (org-show-context nil))
  11825. (when (equal siblings '(16))
  11826. (save-excursion
  11827. (when (org-up-heading-safe)
  11828. (org-show-subtree)
  11829. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  11830. (defun org-highlight-new-match (beg end)
  11831. "Highlight from BEG to END and mark the highlight is an occur headline."
  11832. (let ((ov (make-overlay beg end)))
  11833. (overlay-put ov 'face 'secondary-selection)
  11834. (overlay-put ov 'org-type 'org-occur)
  11835. (push ov org-occur-highlights)))
  11836. (defun org-remove-occur-highlights (&optional beg end noremove)
  11837. "Remove the occur highlights from the buffer.
  11838. BEG and END are ignored. If NOREMOVE is nil, remove this function
  11839. from the `before-change-functions' in the current buffer."
  11840. (interactive)
  11841. (unless org-inhibit-highlight-removal
  11842. (mapc 'delete-overlay org-occur-highlights)
  11843. (setq org-occur-highlights nil)
  11844. (setq org-occur-parameters nil)
  11845. (unless noremove
  11846. (remove-hook 'before-change-functions
  11847. 'org-remove-occur-highlights 'local))))
  11848. ;;;; Priorities
  11849. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  11850. "Regular expression matching the priority indicator.")
  11851. (defvar org-remove-priority-next-time nil)
  11852. (defun org-priority-up ()
  11853. "Increase the priority of the current item."
  11854. (interactive)
  11855. (org-priority 'up))
  11856. (defun org-priority-down ()
  11857. "Decrease the priority of the current item."
  11858. (interactive)
  11859. (org-priority 'down))
  11860. (defun org-priority (&optional action)
  11861. "Change the priority of an item.
  11862. ACTION can be `set', `up', `down', or a character."
  11863. (interactive)
  11864. (unless org-enable-priority-commands
  11865. (error "Priority commands are disabled"))
  11866. (setq action (or action 'set))
  11867. (let (current new news have remove)
  11868. (save-excursion
  11869. (org-back-to-heading t)
  11870. (if (looking-at org-priority-regexp)
  11871. (setq current (string-to-char (match-string 2))
  11872. have t))
  11873. (cond
  11874. ((eq action 'remove)
  11875. (setq remove t new ?\ ))
  11876. ((or (eq action 'set)
  11877. (if (featurep 'xemacs) (characterp action) (integerp action)))
  11878. (if (not (eq action 'set))
  11879. (setq new action)
  11880. (message "Priority %c-%c, SPC to remove: "
  11881. org-highest-priority org-lowest-priority)
  11882. (save-match-data
  11883. (setq new (read-char-exclusive))))
  11884. (if (and (= (upcase org-highest-priority) org-highest-priority)
  11885. (= (upcase org-lowest-priority) org-lowest-priority))
  11886. (setq new (upcase new)))
  11887. (cond ((equal new ?\ ) (setq remove t))
  11888. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  11889. (error "Priority must be between `%c' and `%c'"
  11890. org-highest-priority org-lowest-priority))))
  11891. ((eq action 'up)
  11892. (setq new (if have
  11893. (1- current) ; normal cycling
  11894. ;; last priority was empty
  11895. (if (eq last-command this-command)
  11896. org-lowest-priority ; wrap around empty to lowest
  11897. ;; default
  11898. (if org-priority-start-cycle-with-default
  11899. org-default-priority
  11900. (1- org-default-priority))))))
  11901. ((eq action 'down)
  11902. (setq new (if have
  11903. (1+ current) ; normal cycling
  11904. ;; last priority was empty
  11905. (if (eq last-command this-command)
  11906. org-highest-priority ; wrap around empty to highest
  11907. ;; default
  11908. (if org-priority-start-cycle-with-default
  11909. org-default-priority
  11910. (1+ org-default-priority))))))
  11911. (t (error "Invalid action")))
  11912. (if (or (< (upcase new) org-highest-priority)
  11913. (> (upcase new) org-lowest-priority))
  11914. (if (and (memq action '(up down))
  11915. (not have) (not (eq last-command this-command)))
  11916. ;; `new' is from default priority
  11917. (error
  11918. "The default can not be set, see `org-default-priority' why")
  11919. ;; normal cycling: `new' is beyond highest/lowest priority
  11920. ;; and is wrapped around to the empty priority
  11921. (setq remove t)))
  11922. (setq news (format "%c" new))
  11923. (if have
  11924. (if remove
  11925. (replace-match "" t t nil 1)
  11926. (replace-match news t t nil 2))
  11927. (if remove
  11928. (error "No priority cookie found in line")
  11929. (let ((case-fold-search nil))
  11930. (looking-at org-todo-line-regexp))
  11931. (if (match-end 2)
  11932. (progn
  11933. (goto-char (match-end 2))
  11934. (insert " [#" news "]"))
  11935. (goto-char (match-beginning 3))
  11936. (insert "[#" news "] "))))
  11937. (org-preserve-lc (org-set-tags nil 'align)))
  11938. (if remove
  11939. (message "Priority removed")
  11940. (message "Priority of current item set to %s" news))))
  11941. (defun org-get-priority (s)
  11942. "Find priority cookie and return priority."
  11943. (if (functionp org-get-priority-function)
  11944. (funcall org-get-priority-function)
  11945. (save-match-data
  11946. (if (not (string-match org-priority-regexp s))
  11947. (* 1000 (- org-lowest-priority org-default-priority))
  11948. (* 1000 (- org-lowest-priority
  11949. (string-to-char (match-string 2 s))))))))
  11950. ;;;; Tags
  11951. (defvar org-agenda-archives-mode)
  11952. (defvar org-map-continue-from nil
  11953. "Position from where mapping should continue.
  11954. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  11955. (defvar org-scanner-tags nil
  11956. "The current tag list while the tags scanner is running.")
  11957. (defvar org-trust-scanner-tags nil
  11958. "Should `org-get-tags-at' use the tags for the scanner.
  11959. This is for internal dynamical scoping only.
  11960. When this is non-nil, the function `org-get-tags-at' will return the value
  11961. of `org-scanner-tags' instead of building the list by itself. This
  11962. can lead to large speed-ups when the tags scanner is used in a file with
  11963. many entries, and when the list of tags is retrieved, for example to
  11964. obtain a list of properties. Building the tags list for each entry in such
  11965. a file becomes an N^2 operation - but with this variable set, it scales
  11966. as N.")
  11967. (defun org-scan-tags (action matcher todo-only &optional start-level)
  11968. "Scan headline tags with inheritance and produce output ACTION.
  11969. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  11970. or `agenda' to produce an entry list for an agenda view. It can also be
  11971. a Lisp form or a function that should be called at each matched headline, in
  11972. this case the return value is a list of all return values from these calls.
  11973. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  11974. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  11975. only lines with a not-done TODO keyword are included in the output.
  11976. This should be the same variable that was scoped into
  11977. and set by `org-make-tags-matcher' when it constructed MATCHER.
  11978. START-LEVEL can be a string with asterisks, reducing the scope to
  11979. headlines matching this string."
  11980. (require 'org-agenda)
  11981. (let* ((re (concat "^"
  11982. (if start-level
  11983. ;; Get the correct level to match
  11984. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  11985. org-outline-regexp)
  11986. " *\\(\\<\\("
  11987. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  11988. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  11989. (props (list 'face 'default
  11990. 'done-face 'org-agenda-done
  11991. 'undone-face 'default
  11992. 'mouse-face 'highlight
  11993. 'org-not-done-regexp org-not-done-regexp
  11994. 'org-todo-regexp org-todo-regexp
  11995. 'org-complex-heading-regexp org-complex-heading-regexp
  11996. 'help-echo
  11997. (format "mouse-2 or RET jump to org file %s"
  11998. (abbreviate-file-name
  11999. (or (buffer-file-name (buffer-base-buffer))
  12000. (buffer-name (buffer-base-buffer)))))))
  12001. (case-fold-search nil)
  12002. (org-map-continue-from nil)
  12003. lspos tags tags-list
  12004. (tags-alist (list (cons 0 org-file-tags)))
  12005. (llast 0) rtn rtn1 level category i txt
  12006. todo marker entry priority)
  12007. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  12008. (setq action (list 'lambda nil action)))
  12009. (save-excursion
  12010. (goto-char (point-min))
  12011. (when (eq action 'sparse-tree)
  12012. (org-overview)
  12013. (org-remove-occur-highlights))
  12014. (while (re-search-forward re nil t)
  12015. (setq org-map-continue-from nil)
  12016. (catch :skip
  12017. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  12018. tags (if (match-end 4) (org-match-string-no-properties 4)))
  12019. (goto-char (setq lspos (match-beginning 0)))
  12020. (setq level (org-reduced-level (funcall outline-level))
  12021. category (org-get-category))
  12022. (setq i llast llast level)
  12023. ;; remove tag lists from same and sublevels
  12024. (while (>= i level)
  12025. (when (setq entry (assoc i tags-alist))
  12026. (setq tags-alist (delete entry tags-alist)))
  12027. (setq i (1- i)))
  12028. ;; add the next tags
  12029. (when tags
  12030. (setq tags (org-split-string tags ":")
  12031. tags-alist
  12032. (cons (cons level tags) tags-alist)))
  12033. ;; compile tags for current headline
  12034. (setq tags-list
  12035. (if org-use-tag-inheritance
  12036. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  12037. tags)
  12038. org-scanner-tags tags-list)
  12039. (when org-use-tag-inheritance
  12040. (setcdr (car tags-alist)
  12041. (mapcar (lambda (x)
  12042. (setq x (copy-sequence x))
  12043. (org-add-prop-inherited x))
  12044. (cdar tags-alist))))
  12045. (when (and tags org-use-tag-inheritance
  12046. (or (not (eq t org-use-tag-inheritance))
  12047. org-tags-exclude-from-inheritance))
  12048. ;; selective inheritance, remove uninherited ones
  12049. (setcdr (car tags-alist)
  12050. (org-remove-uninherited-tags (cdar tags-alist))))
  12051. (when (and
  12052. ;; eval matcher only when the todo condition is OK
  12053. (and (or (not todo-only) (member todo org-not-done-keywords))
  12054. (let ((case-fold-search t) (org-trust-scanner-tags t))
  12055. (eval matcher)))
  12056. ;; Call the skipper, but return t if it does not skip,
  12057. ;; so that the `and' form continues evaluating
  12058. (progn
  12059. (unless (eq action 'sparse-tree) (org-agenda-skip))
  12060. t)
  12061. ;; Check if timestamps are deselecting this entry
  12062. (or (not todo-only)
  12063. (and (member todo org-not-done-keywords)
  12064. (or (not org-agenda-tags-todo-honor-ignore-options)
  12065. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  12066. ;; Extra check for the archive tag
  12067. ;; FIXME: Does the skipper already do this????
  12068. (or
  12069. (not (member org-archive-tag tags-list))
  12070. ;; we have an archive tag, should we use this anyway?
  12071. (or (not org-agenda-skip-archived-trees)
  12072. (and (eq action 'agenda) org-agenda-archives-mode))))
  12073. ;; select this headline
  12074. (cond
  12075. ((eq action 'sparse-tree)
  12076. (and org-highlight-sparse-tree-matches
  12077. (org-get-heading) (match-end 0)
  12078. (org-highlight-new-match
  12079. (match-beginning 1) (match-end 1)))
  12080. (org-show-context 'tags-tree))
  12081. ((eq action 'agenda)
  12082. (setq txt (org-agenda-format-item
  12083. ""
  12084. (concat
  12085. (if (eq org-tags-match-list-sublevels 'indented)
  12086. (make-string (1- level) ?.) "")
  12087. (org-get-heading))
  12088. category
  12089. tags-list)
  12090. priority (org-get-priority txt))
  12091. (goto-char lspos)
  12092. (setq marker (org-agenda-new-marker))
  12093. (org-add-props txt props
  12094. 'org-marker marker 'org-hd-marker marker 'org-category category
  12095. 'todo-state todo
  12096. 'priority priority 'type "tagsmatch")
  12097. (push txt rtn))
  12098. ((functionp action)
  12099. (setq org-map-continue-from nil)
  12100. (save-excursion
  12101. (setq rtn1 (funcall action))
  12102. (push rtn1 rtn)))
  12103. (t (error "Invalid action")))
  12104. ;; if we are to skip sublevels, jump to end of subtree
  12105. (unless org-tags-match-list-sublevels
  12106. (org-end-of-subtree t)
  12107. (backward-char 1))))
  12108. ;; Get the correct position from where to continue
  12109. (if org-map-continue-from
  12110. (goto-char org-map-continue-from)
  12111. (and (= (point) lspos) (end-of-line 1)))))
  12112. (when (and (eq action 'sparse-tree)
  12113. (not org-sparse-tree-open-archived-trees))
  12114. (org-hide-archived-subtrees (point-min) (point-max)))
  12115. (nreverse rtn)))
  12116. (defun org-remove-uninherited-tags (tags)
  12117. "Remove all tags that are not inherited from the list TAGS."
  12118. (cond
  12119. ((eq org-use-tag-inheritance t)
  12120. (if org-tags-exclude-from-inheritance
  12121. (org-delete-all org-tags-exclude-from-inheritance tags)
  12122. tags))
  12123. ((not org-use-tag-inheritance) nil)
  12124. ((stringp org-use-tag-inheritance)
  12125. (delq nil (mapcar
  12126. (lambda (x)
  12127. (if (and (string-match org-use-tag-inheritance x)
  12128. (not (member x org-tags-exclude-from-inheritance)))
  12129. x nil))
  12130. tags)))
  12131. ((listp org-use-tag-inheritance)
  12132. (delq nil (mapcar
  12133. (lambda (x)
  12134. (if (member x org-use-tag-inheritance) x nil))
  12135. tags)))))
  12136. (defun org-match-sparse-tree (&optional todo-only match)
  12137. "Create a sparse tree according to tags string MATCH.
  12138. MATCH can contain positive and negative selection of tags, like
  12139. \"+WORK+URGENT-WITHBOSS\".
  12140. If optional argument TODO-ONLY is non-nil, only select lines that are
  12141. also TODO lines."
  12142. (interactive "P")
  12143. (org-agenda-prepare-buffers (list (current-buffer)))
  12144. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  12145. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  12146. (defvar org-cached-props nil)
  12147. (defun org-cached-entry-get (pom property)
  12148. (if (or (eq t org-use-property-inheritance)
  12149. (and (stringp org-use-property-inheritance)
  12150. (string-match org-use-property-inheritance property))
  12151. (and (listp org-use-property-inheritance)
  12152. (member property org-use-property-inheritance)))
  12153. ;; Caching is not possible, check it directly
  12154. (org-entry-get pom property 'inherit)
  12155. ;; Get all properties, so that we can do complicated checks easily
  12156. (cdr (assoc property (or org-cached-props
  12157. (setq org-cached-props
  12158. (org-entry-properties pom)))))))
  12159. (defun org-global-tags-completion-table (&optional files)
  12160. "Return the list of all tags in all agenda buffer/files.
  12161. Optional FILES argument is a list of files which can be used
  12162. instead of the agenda files."
  12163. (save-excursion
  12164. (org-uniquify
  12165. (delq nil
  12166. (apply 'append
  12167. (mapcar
  12168. (lambda (file)
  12169. (set-buffer (find-file-noselect file))
  12170. (append (org-get-buffer-tags)
  12171. (mapcar (lambda (x) (if (stringp (car-safe x))
  12172. (list (car-safe x)) nil))
  12173. org-tag-alist)))
  12174. (if (and files (car files))
  12175. files
  12176. (org-agenda-files))))))))
  12177. (defun org-make-tags-matcher (match)
  12178. "Create the TAGS/TODO matcher form for the selection string MATCH.
  12179. The variable `todo-only' is scoped dynamically into this function.
  12180. It will be set to t if the matcher restricts matching to TODO entries,
  12181. otherwise will not be touched.
  12182. Returns a cons of the selection string MATCH and the constructed
  12183. lisp form implementing the matcher. The matcher is to be evaluated
  12184. at an Org entry, with point on the headline, and returns t if the
  12185. entry matches the selection string MATCH. The returned lisp form
  12186. references two variables with information about the entry, which
  12187. must be bound around the form's evaluation: todo, the TODO keyword
  12188. at the entry (or nil of none); and tags-list, the list of all tags
  12189. at the entry including inherited ones. Additionally, the category
  12190. of the entry (if any) must be specified as the text property
  12191. 'org-category on the headline.
  12192. See also `org-scan-tags'.
  12193. "
  12194. (declare (special todo-only))
  12195. (unless (boundp 'todo-only)
  12196. (error "org-make-tags-matcher expects todo-only to be scoped in"))
  12197. (unless match
  12198. ;; Get a new match request, with completion
  12199. (let ((org-last-tags-completion-table
  12200. (org-global-tags-completion-table)))
  12201. (setq match (org-completing-read-no-i
  12202. "Match: " 'org-tags-completion-function nil nil nil
  12203. 'org-tags-history))))
  12204. ;; Parse the string and create a lisp form
  12205. (let ((match0 match)
  12206. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  12207. minus tag mm
  12208. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  12209. orterms term orlist re-p str-p level-p level-op time-p
  12210. prop-p pn pv po gv rest)
  12211. (if (string-match "/+" match)
  12212. ;; match contains also a todo-matching request
  12213. (progn
  12214. (setq tagsmatch (substring match 0 (match-beginning 0))
  12215. todomatch (substring match (match-end 0)))
  12216. (if (string-match "^!" todomatch)
  12217. (setq todo-only t todomatch (substring todomatch 1)))
  12218. (if (string-match "^\\s-*$" todomatch)
  12219. (setq todomatch nil)))
  12220. ;; only matching tags
  12221. (setq tagsmatch match todomatch nil))
  12222. ;; Make the tags matcher
  12223. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12224. (setq tagsmatcher t)
  12225. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12226. (while (setq term (pop orterms))
  12227. (while (and (equal (substring term -1) "\\") orterms)
  12228. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12229. (while (string-match re term)
  12230. (setq rest (substring term (match-end 0))
  12231. minus (and (match-end 1)
  12232. (equal (match-string 1 term) "-"))
  12233. tag (save-match-data (replace-regexp-in-string
  12234. "\\\\-" "-"
  12235. (match-string 2 term)))
  12236. re-p (equal (string-to-char tag) ?{)
  12237. level-p (match-end 4)
  12238. prop-p (match-end 5)
  12239. mm (cond
  12240. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12241. (level-p
  12242. (setq level-op (org-op-to-function (match-string 3 term)))
  12243. `(,level-op level ,(string-to-number
  12244. (match-string 4 term))))
  12245. (prop-p
  12246. (setq pn (match-string 5 term)
  12247. po (match-string 6 term)
  12248. pv (match-string 7 term)
  12249. re-p (equal (string-to-char pv) ?{)
  12250. str-p (equal (string-to-char pv) ?\")
  12251. time-p (save-match-data
  12252. (string-match "^\"[[<].*[]>]\"$" pv))
  12253. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12254. (if time-p (setq pv (org-matcher-time pv)))
  12255. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12256. (cond
  12257. ((equal pn "CATEGORY")
  12258. (setq gv '(get-text-property (point) 'org-category)))
  12259. ((equal pn "TODO")
  12260. (setq gv 'todo))
  12261. (t
  12262. (setq gv `(org-cached-entry-get nil ,pn))))
  12263. (if re-p
  12264. (if (eq po 'org<>)
  12265. `(not (string-match ,pv (or ,gv "")))
  12266. `(string-match ,pv (or ,gv "")))
  12267. (if str-p
  12268. `(,po (or ,gv "") ,pv)
  12269. `(,po (string-to-number (or ,gv ""))
  12270. ,(string-to-number pv) ))))
  12271. (t `(member ,tag tags-list)))
  12272. mm (if minus (list 'not mm) mm)
  12273. term rest)
  12274. (push mm tagsmatcher))
  12275. (push (if (> (length tagsmatcher) 1)
  12276. (cons 'and tagsmatcher)
  12277. (car tagsmatcher))
  12278. orlist)
  12279. (setq tagsmatcher nil))
  12280. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12281. (setq tagsmatcher
  12282. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12283. ;; Make the todo matcher
  12284. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12285. (setq todomatcher t)
  12286. (setq orterms (org-split-string todomatch "|") orlist nil)
  12287. (while (setq term (pop orterms))
  12288. (while (string-match re term)
  12289. (setq minus (and (match-end 1)
  12290. (equal (match-string 1 term) "-"))
  12291. kwd (match-string 2 term)
  12292. re-p (equal (string-to-char kwd) ?{)
  12293. term (substring term (match-end 0))
  12294. mm (if re-p
  12295. `(string-match ,(substring kwd 1 -1) todo)
  12296. (list 'equal 'todo kwd))
  12297. mm (if minus (list 'not mm) mm))
  12298. (push mm todomatcher))
  12299. (push (if (> (length todomatcher) 1)
  12300. (cons 'and todomatcher)
  12301. (car todomatcher))
  12302. orlist)
  12303. (setq todomatcher nil))
  12304. (setq todomatcher (if (> (length orlist) 1)
  12305. (cons 'or orlist) (car orlist))))
  12306. ;; Return the string and lisp forms of the matcher
  12307. (setq matcher (if todomatcher
  12308. (list 'and tagsmatcher todomatcher)
  12309. tagsmatcher))
  12310. (when todo-only
  12311. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12312. matcher)))
  12313. (cons match0 matcher)))
  12314. (defun org-op-to-function (op &optional stringp)
  12315. "Turn an operator into the appropriate function."
  12316. (setq op
  12317. (cond
  12318. ((equal op "<" ) '(< string< org-time<))
  12319. ((equal op ">" ) '(> org-string> org-time>))
  12320. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12321. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12322. ((member op '("=" "==")) '(= string= org-time=))
  12323. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12324. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12325. (defun org<> (a b) (not (= a b)))
  12326. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12327. (defun org-string>= (a b) (not (string< a b)))
  12328. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12329. (defun org-string<> (a b) (not (string= a b)))
  12330. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  12331. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  12332. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  12333. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  12334. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  12335. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  12336. (defun org-2ft (s)
  12337. "Convert S to a floating point time.
  12338. If S is already a number, just return it. If it is a string, parse
  12339. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  12340. (cond
  12341. ((numberp s) s)
  12342. ((stringp s)
  12343. (condition-case nil
  12344. (float-time (apply 'encode-time (org-parse-time-string s)))
  12345. (error 0.)))
  12346. (t 0.)))
  12347. (defun org-time-today ()
  12348. "Time in seconds today at 0:00.
  12349. Returns the float number of seconds since the beginning of the
  12350. epoch to the beginning of today (00:00)."
  12351. (float-time (apply 'encode-time
  12352. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  12353. (defun org-matcher-time (s)
  12354. "Interpret a time comparison value."
  12355. (save-match-data
  12356. (cond
  12357. ((string= s "<now>") (float-time))
  12358. ((string= s "<today>") (org-time-today))
  12359. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  12360. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  12361. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  12362. (+ (org-time-today)
  12363. (* (string-to-number (match-string 1 s))
  12364. (cdr (assoc (match-string 2 s)
  12365. '(("d" . 86400.0) ("w" . 604800.0)
  12366. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  12367. (t (org-2ft s)))))
  12368. (defun org-match-any-p (re list)
  12369. "Does re match any element of list?"
  12370. (setq list (mapcar (lambda (x) (string-match re x)) list))
  12371. (delq nil list))
  12372. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  12373. (defvar org-tags-overlay (make-overlay 1 1))
  12374. (org-detach-overlay org-tags-overlay)
  12375. (defun org-get-local-tags-at (&optional pos)
  12376. "Get a list of tags defined in the current headline."
  12377. (org-get-tags-at pos 'local))
  12378. (defun org-get-local-tags ()
  12379. "Get a list of tags defined in the current headline."
  12380. (org-get-tags-at nil 'local))
  12381. (defun org-get-tags-at (&optional pos local)
  12382. "Get a list of all headline tags applicable at POS.
  12383. POS defaults to point. If tags are inherited, the list contains
  12384. the targets in the same sequence as the headlines appear, i.e.
  12385. the tags of the current headline come last.
  12386. When LOCAL is non-nil, only return tags from the current headline,
  12387. ignore inherited ones."
  12388. (interactive)
  12389. (if (and org-trust-scanner-tags
  12390. (or (not pos) (equal pos (point)))
  12391. (not local))
  12392. org-scanner-tags
  12393. (let (tags ltags lastpos parent)
  12394. (save-excursion
  12395. (save-restriction
  12396. (widen)
  12397. (goto-char (or pos (point)))
  12398. (save-match-data
  12399. (catch 'done
  12400. (condition-case nil
  12401. (progn
  12402. (org-back-to-heading t)
  12403. (while (not (equal lastpos (point)))
  12404. (setq lastpos (point))
  12405. (when (looking-at
  12406. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  12407. (setq ltags (org-split-string
  12408. (org-match-string-no-properties 1) ":"))
  12409. (when parent
  12410. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  12411. (setq tags (append
  12412. (if parent
  12413. (org-remove-uninherited-tags ltags)
  12414. ltags)
  12415. tags)))
  12416. (or org-use-tag-inheritance (throw 'done t))
  12417. (if local (throw 'done t))
  12418. (or (org-up-heading-safe) (error nil))
  12419. (setq parent t)))
  12420. (error nil)))))
  12421. (if local
  12422. tags
  12423. (append (org-remove-uninherited-tags org-file-tags) tags))))))
  12424. (defun org-add-prop-inherited (s)
  12425. (add-text-properties 0 (length s) '(inherited t) s)
  12426. s)
  12427. (defun org-toggle-tag (tag &optional onoff)
  12428. "Toggle the tag TAG for the current line.
  12429. If ONOFF is `on' or `off', don't toggle but set to this state."
  12430. (let (res current)
  12431. (save-excursion
  12432. (org-back-to-heading t)
  12433. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  12434. (point-at-eol) t)
  12435. (progn
  12436. (setq current (match-string 1))
  12437. (replace-match ""))
  12438. (setq current ""))
  12439. (setq current (nreverse (org-split-string current ":")))
  12440. (cond
  12441. ((eq onoff 'on)
  12442. (setq res t)
  12443. (or (member tag current) (push tag current)))
  12444. ((eq onoff 'off)
  12445. (or (not (member tag current)) (setq current (delete tag current))))
  12446. (t (if (member tag current)
  12447. (setq current (delete tag current))
  12448. (setq res t)
  12449. (push tag current))))
  12450. (end-of-line 1)
  12451. (if current
  12452. (progn
  12453. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  12454. (org-set-tags nil t))
  12455. (delete-horizontal-space))
  12456. (run-hooks 'org-after-tags-change-hook))
  12457. res))
  12458. (defun org-align-tags-here (to-col)
  12459. ;; Assumes that this is a headline
  12460. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  12461. (beginning-of-line 1)
  12462. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12463. (< pos (match-beginning 2)))
  12464. (progn
  12465. (setq tags-l (- (match-end 2) (match-beginning 2)))
  12466. (goto-char (match-beginning 1))
  12467. (insert " ")
  12468. (delete-region (point) (1+ (match-beginning 2)))
  12469. (setq ncol (max (current-column)
  12470. (1+ col)
  12471. (if (> to-col 0)
  12472. to-col
  12473. (- (abs to-col) tags-l))))
  12474. (setq p (point))
  12475. (insert (make-string (- ncol (current-column)) ?\ ))
  12476. (setq ncol (current-column))
  12477. (when indent-tabs-mode (tabify p (point-at-eol)))
  12478. (org-move-to-column (min ncol col) t))
  12479. (goto-char pos))))
  12480. (defun org-set-tags-command (&optional arg just-align)
  12481. "Call the set-tags command for the current entry."
  12482. (interactive "P")
  12483. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  12484. (org-set-tags arg just-align)
  12485. (save-excursion
  12486. (org-back-to-heading t)
  12487. (org-set-tags arg just-align))))
  12488. (defun org-set-tags-to (data)
  12489. "Set the tags of the current entry to DATA, replacing the current tags.
  12490. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  12491. If DATA is nil or the empty string, any tags will be removed."
  12492. (interactive "sTags: ")
  12493. (setq data
  12494. (cond
  12495. ((eq data nil) "")
  12496. ((equal data "") "")
  12497. ((stringp data)
  12498. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  12499. ":"))
  12500. ((listp data)
  12501. (concat ":" (mapconcat 'identity data ":") ":"))))
  12502. (when data
  12503. (save-excursion
  12504. (org-back-to-heading t)
  12505. (when (looking-at org-complex-heading-regexp)
  12506. (if (match-end 5)
  12507. (progn
  12508. (goto-char (match-beginning 5))
  12509. (insert data)
  12510. (delete-region (point) (point-at-eol))
  12511. (org-set-tags nil 'align))
  12512. (goto-char (point-at-eol))
  12513. (insert " " data)
  12514. (org-set-tags nil 'align)))
  12515. (beginning-of-line 1)
  12516. (if (looking-at ".*?\\([ \t]+\\)$")
  12517. (delete-region (match-beginning 1) (match-end 1))))))
  12518. (defun org-align-all-tags ()
  12519. "Align the tags i all headings."
  12520. (interactive)
  12521. (save-excursion
  12522. (or (ignore-errors (org-back-to-heading t))
  12523. (outline-next-heading))
  12524. (if (org-at-heading-p)
  12525. (org-set-tags t)
  12526. (message "No headings"))))
  12527. (defvar org-indent-indentation-per-level)
  12528. (defun org-set-tags (&optional arg just-align)
  12529. "Set the tags for the current headline.
  12530. With prefix ARG, realign all tags in headings in the current buffer."
  12531. (interactive "P")
  12532. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12533. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12534. 'region-start-level 'region))
  12535. org-loop-over-headlines-in-active-region)
  12536. (org-map-entries
  12537. ;; We don't use ARG and JUST-ALIGN here these args are not
  12538. ;; useful when looping over headlines
  12539. `(org-set-tags)
  12540. org-loop-over-headlines-in-active-region
  12541. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12542. (let* ((re org-outline-regexp-bol)
  12543. (current (unless arg (org-get-tags-string)))
  12544. (col (current-column))
  12545. (org-setting-tags t)
  12546. table current-tags inherited-tags ; computed below when needed
  12547. tags p0 c0 c1 rpl di tc level)
  12548. (if arg
  12549. (save-excursion
  12550. (goto-char (point-min))
  12551. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  12552. (while (re-search-forward re nil t)
  12553. (org-set-tags nil t)
  12554. (end-of-line 1)))
  12555. (message "All tags realigned to column %d" org-tags-column))
  12556. (if just-align
  12557. (setq tags current)
  12558. ;; Get a new set of tags from the user
  12559. (save-excursion
  12560. (setq table (append org-tag-persistent-alist
  12561. (or org-tag-alist (org-get-buffer-tags))
  12562. (and
  12563. org-complete-tags-always-offer-all-agenda-tags
  12564. (org-global-tags-completion-table
  12565. (org-agenda-files))))
  12566. org-last-tags-completion-table table
  12567. current-tags (org-split-string current ":")
  12568. inherited-tags (nreverse
  12569. (nthcdr (length current-tags)
  12570. (nreverse (org-get-tags-at))))
  12571. tags
  12572. (if (or (eq t org-use-fast-tag-selection)
  12573. (and org-use-fast-tag-selection
  12574. (delq nil (mapcar 'cdr table))))
  12575. (org-fast-tag-selection
  12576. current-tags inherited-tags table
  12577. (if org-fast-tag-selection-include-todo
  12578. org-todo-key-alist))
  12579. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  12580. (org-trim
  12581. (org-icompleting-read "Tags: "
  12582. 'org-tags-completion-function
  12583. nil nil current 'org-tags-history))))))
  12584. (while (string-match "[-+&]+" tags)
  12585. ;; No boolean logic, just a list
  12586. (setq tags (replace-match ":" t t tags))))
  12587. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  12588. (if org-tags-sort-function
  12589. (setq tags (mapconcat 'identity
  12590. (sort (org-split-string
  12591. tags (org-re "[^[:alnum:]_@#%]+"))
  12592. org-tags-sort-function) ":")))
  12593. (if (string-match "\\`[\t ]*\\'" tags)
  12594. (setq tags "")
  12595. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  12596. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  12597. ;; Insert new tags at the correct column
  12598. (beginning-of-line 1)
  12599. (setq level (or (and (looking-at org-outline-regexp)
  12600. (- (match-end 0) (point) 1))
  12601. 1))
  12602. (cond
  12603. ((and (equal current "") (equal tags "")))
  12604. ((re-search-forward
  12605. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  12606. (point-at-eol) t)
  12607. (if (equal tags "")
  12608. (setq rpl "")
  12609. (goto-char (match-beginning 0))
  12610. (setq c0 (current-column)
  12611. ;; compute offset for the case of org-indent-mode active
  12612. di (if org-indent-mode
  12613. (* (1- org-indent-indentation-per-level) (1- level))
  12614. 0)
  12615. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  12616. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  12617. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  12618. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  12619. (replace-match rpl t t)
  12620. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  12621. tags)
  12622. (t (error "Tags alignment failed")))
  12623. (org-move-to-column col)
  12624. (unless just-align
  12625. (run-hooks 'org-after-tags-change-hook))))))
  12626. (defun org-change-tag-in-region (beg end tag off)
  12627. "Add or remove TAG for each entry in the region.
  12628. This works in the agenda, and also in an org-mode buffer."
  12629. (interactive
  12630. (list (region-beginning) (region-end)
  12631. (let ((org-last-tags-completion-table
  12632. (if (derived-mode-p 'org-mode)
  12633. (org-get-buffer-tags)
  12634. (org-global-tags-completion-table))))
  12635. (org-icompleting-read
  12636. "Tag: " 'org-tags-completion-function nil nil nil
  12637. 'org-tags-history))
  12638. (progn
  12639. (message "[s]et or [r]emove? ")
  12640. (equal (read-char-exclusive) ?r))))
  12641. (if (fboundp 'deactivate-mark) (deactivate-mark))
  12642. (let ((agendap (equal major-mode 'org-agenda-mode))
  12643. l1 l2 m buf pos newhead (cnt 0))
  12644. (goto-char end)
  12645. (setq l2 (1- (org-current-line)))
  12646. (goto-char beg)
  12647. (setq l1 (org-current-line))
  12648. (loop for l from l1 to l2 do
  12649. (org-goto-line l)
  12650. (setq m (get-text-property (point) 'org-hd-marker))
  12651. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  12652. (and agendap m))
  12653. (setq buf (if agendap (marker-buffer m) (current-buffer))
  12654. pos (if agendap m (point)))
  12655. (with-current-buffer buf
  12656. (save-excursion
  12657. (save-restriction
  12658. (goto-char pos)
  12659. (setq cnt (1+ cnt))
  12660. (org-toggle-tag tag (if off 'off 'on))
  12661. (setq newhead (org-get-heading)))))
  12662. (and agendap (org-agenda-change-all-lines newhead m))))
  12663. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  12664. (defun org-tags-completion-function (string predicate &optional flag)
  12665. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  12666. (confirm (lambda (x) (stringp (car x)))))
  12667. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  12668. (setq s1 (match-string 1 string)
  12669. s2 (match-string 2 string))
  12670. (setq s1 "" s2 string))
  12671. (cond
  12672. ((eq flag nil)
  12673. ;; try completion
  12674. (setq rtn (try-completion s2 ctable confirm))
  12675. (if (stringp rtn)
  12676. (setq rtn
  12677. (concat s1 s2 (substring rtn (length s2))
  12678. (if (and org-add-colon-after-tag-completion
  12679. (assoc rtn ctable))
  12680. ":" ""))))
  12681. rtn)
  12682. ((eq flag t)
  12683. ;; all-completions
  12684. (all-completions s2 ctable confirm)
  12685. )
  12686. ((eq flag 'lambda)
  12687. ;; exact match?
  12688. (assoc s2 ctable)))
  12689. ))
  12690. (defun org-fast-tag-insert (kwd tags face &optional end)
  12691. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  12692. (insert (format "%-12s" (concat kwd ":"))
  12693. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  12694. (or end "")))
  12695. (defun org-fast-tag-show-exit (flag)
  12696. (save-excursion
  12697. (org-goto-line 3)
  12698. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  12699. (replace-match ""))
  12700. (when flag
  12701. (end-of-line 1)
  12702. (org-move-to-column (- (window-width) 19) t)
  12703. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  12704. (defun org-set-current-tags-overlay (current prefix)
  12705. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  12706. (if (featurep 'xemacs)
  12707. (org-overlay-display org-tags-overlay (concat prefix s)
  12708. 'secondary-selection)
  12709. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  12710. (org-overlay-display org-tags-overlay (concat prefix s)))))
  12711. (defvar org-last-tag-selection-key nil)
  12712. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  12713. "Fast tag selection with single keys.
  12714. CURRENT is the current list of tags in the headline, INHERITED is the
  12715. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  12716. possibly with grouping information. TODO-TABLE is a similar table with
  12717. TODO keywords, should these have keys assigned to them.
  12718. If the keys are nil, a-z are automatically assigned.
  12719. Returns the new tags string, or nil to not change the current settings."
  12720. (let* ((fulltable (append table todo-table))
  12721. (maxlen (apply 'max (mapcar
  12722. (lambda (x)
  12723. (if (stringp (car x)) (string-width (car x)) 0))
  12724. fulltable)))
  12725. (buf (current-buffer))
  12726. (expert (eq org-fast-tag-selection-single-key 'expert))
  12727. (buffer-tags nil)
  12728. (fwidth (+ maxlen 3 1 3))
  12729. (ncol (/ (- (window-width) 4) fwidth))
  12730. (i-face 'org-done)
  12731. (c-face 'org-todo)
  12732. tg cnt e c char c1 c2 ntable tbl rtn
  12733. ov-start ov-end ov-prefix
  12734. (exit-after-next org-fast-tag-selection-single-key)
  12735. (done-keywords org-done-keywords)
  12736. groups ingroup)
  12737. (save-excursion
  12738. (beginning-of-line 1)
  12739. (if (looking-at
  12740. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12741. (setq ov-start (match-beginning 1)
  12742. ov-end (match-end 1)
  12743. ov-prefix "")
  12744. (setq ov-start (1- (point-at-eol))
  12745. ov-end (1+ ov-start))
  12746. (skip-chars-forward "^\n\r")
  12747. (setq ov-prefix
  12748. (concat
  12749. (buffer-substring (1- (point)) (point))
  12750. (if (> (current-column) org-tags-column)
  12751. " "
  12752. (make-string (- org-tags-column (current-column)) ?\ ))))))
  12753. (move-overlay org-tags-overlay ov-start ov-end)
  12754. (save-window-excursion
  12755. (if expert
  12756. (set-buffer (get-buffer-create " *Org tags*"))
  12757. (delete-other-windows)
  12758. (split-window-vertically)
  12759. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  12760. (erase-buffer)
  12761. (org-set-local 'org-done-keywords done-keywords)
  12762. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  12763. (org-fast-tag-insert "Current" current c-face "\n\n")
  12764. (org-fast-tag-show-exit exit-after-next)
  12765. (org-set-current-tags-overlay current ov-prefix)
  12766. (setq tbl fulltable char ?a cnt 0)
  12767. (while (setq e (pop tbl))
  12768. (cond
  12769. ((equal (car e) :startgroup)
  12770. (push '() groups) (setq ingroup t)
  12771. (when (not (= cnt 0))
  12772. (setq cnt 0)
  12773. (insert "\n"))
  12774. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  12775. ((equal (car e) :endgroup)
  12776. (setq ingroup nil cnt 0)
  12777. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  12778. ((equal e '(:newline))
  12779. (when (not (= cnt 0))
  12780. (setq cnt 0)
  12781. (insert "\n")
  12782. (setq e (car tbl))
  12783. (while (equal (car tbl) '(:newline))
  12784. (insert "\n")
  12785. (setq tbl (cdr tbl)))))
  12786. (t
  12787. (setq tg (copy-sequence (car e)) c2 nil)
  12788. (if (cdr e)
  12789. (setq c (cdr e))
  12790. ;; automatically assign a character.
  12791. (setq c1 (string-to-char
  12792. (downcase (substring
  12793. tg (if (= (string-to-char tg) ?@) 1 0)))))
  12794. (if (or (rassoc c1 ntable) (rassoc c1 table))
  12795. (while (or (rassoc char ntable) (rassoc char table))
  12796. (setq char (1+ char)))
  12797. (setq c2 c1))
  12798. (setq c (or c2 char)))
  12799. (if ingroup (push tg (car groups)))
  12800. (setq tg (org-add-props tg nil 'face
  12801. (cond
  12802. ((not (assoc tg table))
  12803. (org-get-todo-face tg))
  12804. ((member tg current) c-face)
  12805. ((member tg inherited) i-face))))
  12806. (if (and (= cnt 0) (not ingroup)) (insert " "))
  12807. (insert "[" c "] " tg (make-string
  12808. (- fwidth 4 (length tg)) ?\ ))
  12809. (push (cons tg c) ntable)
  12810. (when (= (setq cnt (1+ cnt)) ncol)
  12811. (insert "\n")
  12812. (if ingroup (insert " "))
  12813. (setq cnt 0)))))
  12814. (setq ntable (nreverse ntable))
  12815. (insert "\n")
  12816. (goto-char (point-min))
  12817. (if (not expert) (org-fit-window-to-buffer))
  12818. (setq rtn
  12819. (catch 'exit
  12820. (while t
  12821. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  12822. (if (not groups) "no " "")
  12823. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  12824. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  12825. (setq org-last-tag-selection-key c)
  12826. (cond
  12827. ((= c ?\r) (throw 'exit t))
  12828. ((= c ?!)
  12829. (setq groups (not groups))
  12830. (goto-char (point-min))
  12831. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  12832. ((= c ?\C-c)
  12833. (if (not expert)
  12834. (org-fast-tag-show-exit
  12835. (setq exit-after-next (not exit-after-next)))
  12836. (setq expert nil)
  12837. (delete-other-windows)
  12838. (set-window-buffer (split-window-vertically) " *Org tags*")
  12839. (org-switch-to-buffer-other-window " *Org tags*")
  12840. (org-fit-window-to-buffer)))
  12841. ((or (= c ?\C-g)
  12842. (and (= c ?q) (not (rassoc c ntable))))
  12843. (org-detach-overlay org-tags-overlay)
  12844. (setq quit-flag t))
  12845. ((= c ?\ )
  12846. (setq current nil)
  12847. (if exit-after-next (setq exit-after-next 'now)))
  12848. ((= c ?\t)
  12849. (condition-case nil
  12850. (setq tg (org-icompleting-read
  12851. "Tag: "
  12852. (or buffer-tags
  12853. (with-current-buffer buf
  12854. (org-get-buffer-tags)))))
  12855. (quit (setq tg "")))
  12856. (when (string-match "\\S-" tg)
  12857. (add-to-list 'buffer-tags (list tg))
  12858. (if (member tg current)
  12859. (setq current (delete tg current))
  12860. (push tg current)))
  12861. (if exit-after-next (setq exit-after-next 'now)))
  12862. ((setq e (rassoc c todo-table) tg (car e))
  12863. (with-current-buffer buf
  12864. (save-excursion (org-todo tg)))
  12865. (if exit-after-next (setq exit-after-next 'now)))
  12866. ((setq e (rassoc c ntable) tg (car e))
  12867. (if (member tg current)
  12868. (setq current (delete tg current))
  12869. (loop for g in groups do
  12870. (if (member tg g)
  12871. (mapc (lambda (x)
  12872. (setq current (delete x current)))
  12873. g)))
  12874. (push tg current))
  12875. (if exit-after-next (setq exit-after-next 'now))))
  12876. ;; Create a sorted list
  12877. (setq current
  12878. (sort current
  12879. (lambda (a b)
  12880. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  12881. (if (eq exit-after-next 'now) (throw 'exit t))
  12882. (goto-char (point-min))
  12883. (beginning-of-line 2)
  12884. (delete-region (point) (point-at-eol))
  12885. (org-fast-tag-insert "Current" current c-face)
  12886. (org-set-current-tags-overlay current ov-prefix)
  12887. (while (re-search-forward
  12888. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  12889. (setq tg (match-string 1))
  12890. (add-text-properties
  12891. (match-beginning 1) (match-end 1)
  12892. (list 'face
  12893. (cond
  12894. ((member tg current) c-face)
  12895. ((member tg inherited) i-face)
  12896. (t (get-text-property (match-beginning 1) 'face))))))
  12897. (goto-char (point-min)))))
  12898. (org-detach-overlay org-tags-overlay)
  12899. (if rtn
  12900. (mapconcat 'identity current ":")
  12901. nil))))
  12902. (defun org-get-tags-string ()
  12903. "Get the TAGS string in the current headline."
  12904. (unless (org-at-heading-p t)
  12905. (error "Not on a heading"))
  12906. (save-excursion
  12907. (beginning-of-line 1)
  12908. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12909. (org-match-string-no-properties 1)
  12910. "")))
  12911. (defun org-get-tags ()
  12912. "Get the list of tags specified in the current headline."
  12913. (org-split-string (org-get-tags-string) ":"))
  12914. (defun org-get-buffer-tags ()
  12915. "Get a table of all tags used in the buffer, for completion."
  12916. (let (tags)
  12917. (save-excursion
  12918. (goto-char (point-min))
  12919. (while (re-search-forward
  12920. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  12921. (when (equal (char-after (point-at-bol 0)) ?*)
  12922. (mapc (lambda (x) (add-to-list 'tags x))
  12923. (org-split-string (org-match-string-no-properties 1) ":")))))
  12924. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  12925. (mapcar 'list tags)))
  12926. ;;;; The mapping API
  12927. ;;;###autoload
  12928. (defun org-map-entries (func &optional match scope &rest skip)
  12929. "Call FUNC at each headline selected by MATCH in SCOPE.
  12930. FUNC is a function or a lisp form. The function will be called without
  12931. arguments, with the cursor positioned at the beginning of the headline.
  12932. The return values of all calls to the function will be collected and
  12933. returned as a list.
  12934. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  12935. does not need to preserve point. After evaluation, the cursor will be
  12936. moved to the end of the line (presumably of the headline of the
  12937. processed entry) and search continues from there. Under some
  12938. circumstances, this may not produce the wanted results. For example,
  12939. if you have removed (e.g. archived) the current (sub)tree it could
  12940. mean that the next entry will be skipped entirely. In such cases, you
  12941. can specify the position from where search should continue by making
  12942. FUNC set the variable `org-map-continue-from' to the desired buffer
  12943. position.
  12944. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  12945. Only headlines that are matched by this query will be considered during
  12946. the iteration. When MATCH is nil or t, all headlines will be
  12947. visited by the iteration.
  12948. SCOPE determines the scope of this command. It can be any of:
  12949. nil The current buffer, respecting the restriction if any
  12950. tree The subtree started with the entry at point
  12951. region The entries within the active region, if any
  12952. region-start-level
  12953. The entries within the active region, but only those at
  12954. the same level than the first one.
  12955. file The current buffer, without restriction
  12956. file-with-archives
  12957. The current buffer, and any archives associated with it
  12958. agenda All agenda files
  12959. agenda-with-archives
  12960. All agenda files with any archive files associated with them
  12961. \(file1 file2 ...)
  12962. If this is a list, all files in the list will be scanned
  12963. The remaining args are treated as settings for the skipping facilities of
  12964. the scanner. The following items can be given here:
  12965. archive skip trees with the archive tag.
  12966. comment skip trees with the COMMENT keyword
  12967. function or Emacs Lisp form:
  12968. will be used as value for `org-agenda-skip-function', so whenever
  12969. the function returns t, FUNC will not be called for that
  12970. entry and search will continue from the point where the
  12971. function leaves it.
  12972. If your function needs to retrieve the tags including inherited tags
  12973. at the *current* entry, you can use the value of the variable
  12974. `org-scanner-tags' which will be much faster than getting the value
  12975. with `org-get-tags-at'. If your function gets properties with
  12976. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  12977. to t around the call to `org-entry-properties' to get the same speedup.
  12978. Note that if your function moves around to retrieve tags and properties at
  12979. a *different* entry, you cannot use these techniques."
  12980. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  12981. (not (org-region-active-p)))
  12982. (let* ((org-agenda-archives-mode nil) ; just to make sure
  12983. (org-agenda-skip-archived-trees (memq 'archive skip))
  12984. (org-agenda-skip-comment-trees (memq 'comment skip))
  12985. (org-agenda-skip-function
  12986. (car (org-delete-all '(comment archive) skip)))
  12987. (org-tags-match-list-sublevels t)
  12988. (start-level (eq scope 'region-start-level))
  12989. matcher file res
  12990. org-todo-keywords-for-agenda
  12991. org-done-keywords-for-agenda
  12992. org-todo-keyword-alist-for-agenda
  12993. org-drawers-for-agenda
  12994. org-tag-alist-for-agenda
  12995. todo-only)
  12996. (cond
  12997. ((eq match t) (setq matcher t))
  12998. ((eq match nil) (setq matcher t))
  12999. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  13000. (save-excursion
  13001. (save-restriction
  13002. (cond ((eq scope 'tree)
  13003. (org-back-to-heading t)
  13004. (org-narrow-to-subtree)
  13005. (setq scope nil))
  13006. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  13007. (org-region-active-p))
  13008. ;; If needed, set start-level to a string like "2"
  13009. (when start-level
  13010. (save-excursion
  13011. (goto-char (region-beginning))
  13012. (unless (org-at-heading-p) (outline-next-heading))
  13013. (setq start-level (org-current-level))))
  13014. (narrow-to-region (region-beginning)
  13015. (save-excursion
  13016. (goto-char (region-end))
  13017. (unless (and (bolp) (org-at-heading-p))
  13018. (outline-next-heading))
  13019. (point)))
  13020. (setq scope nil)))
  13021. (if (not scope)
  13022. (progn
  13023. (org-agenda-prepare-buffers
  13024. (list (buffer-file-name (current-buffer))))
  13025. (setq res (org-scan-tags func matcher todo-only start-level)))
  13026. ;; Get the right scope
  13027. (cond
  13028. ((and scope (listp scope) (symbolp (car scope)))
  13029. (setq scope (eval scope)))
  13030. ((eq scope 'agenda)
  13031. (setq scope (org-agenda-files t)))
  13032. ((eq scope 'agenda-with-archives)
  13033. (setq scope (org-agenda-files t))
  13034. (setq scope (org-add-archive-files scope)))
  13035. ((eq scope 'file)
  13036. (setq scope (list (buffer-file-name))))
  13037. ((eq scope 'file-with-archives)
  13038. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  13039. (org-agenda-prepare-buffers scope)
  13040. (while (setq file (pop scope))
  13041. (with-current-buffer (org-find-base-buffer-visiting file)
  13042. (save-excursion
  13043. (save-restriction
  13044. (widen)
  13045. (goto-char (point-min))
  13046. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  13047. res)))
  13048. ;;;; Properties
  13049. ;;; Setting and retrieving properties
  13050. (defconst org-special-properties
  13051. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  13052. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
  13053. "The special properties valid in Org-mode.
  13054. These are properties that are not defined in the property drawer,
  13055. but in some other way.")
  13056. (defconst org-default-properties
  13057. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  13058. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  13059. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  13060. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  13061. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  13062. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  13063. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  13064. "Some properties that are used by Org-mode for various purposes.
  13065. Being in this list makes sure that they are offered for completion.")
  13066. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  13067. "Regular expression matching the first line of a property drawer.")
  13068. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  13069. "Regular expression matching the last line of a property drawer.")
  13070. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  13071. "Regular expression matching the first line of a property drawer.")
  13072. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  13073. "Regular expression matching the first line of a property drawer.")
  13074. (defconst org-property-drawer-re
  13075. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  13076. org-property-end-re "\\)\n?")
  13077. "Matches an entire property drawer.")
  13078. (defconst org-clock-drawer-re
  13079. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  13080. org-property-end-re "\\)\n?")
  13081. "Matches an entire clock drawer.")
  13082. (defsubst org-re-property (property)
  13083. "Return a regexp matching a PROPERTY line.
  13084. Match group 1 will be set to the value."
  13085. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
  13086. (defsubst org-re-property-keyword (property)
  13087. "Return a regexp matching a PROPERTY line, possibly with no
  13088. value for the property."
  13089. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)?"))
  13090. (defun org-property-action ()
  13091. "Do an action on properties."
  13092. (interactive)
  13093. (let (c)
  13094. (org-at-property-p)
  13095. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  13096. (setq c (read-char-exclusive))
  13097. (cond
  13098. ((equal c ?s)
  13099. (call-interactively 'org-set-property))
  13100. ((equal c ?d)
  13101. (call-interactively 'org-delete-property))
  13102. ((equal c ?D)
  13103. (call-interactively 'org-delete-property-globally))
  13104. ((equal c ?c)
  13105. (call-interactively 'org-compute-property-at-point))
  13106. (t (error "No such property action %c" c)))))
  13107. (defun org-inc-effort ()
  13108. "Increment the value of the effort property in the current entry."
  13109. (interactive)
  13110. (org-set-effort nil t))
  13111. (defun org-set-effort (&optional value increment)
  13112. "Set the effort property of the current entry.
  13113. With numerical prefix arg, use the nth allowed value, 0 stands for the
  13114. 10th allowed value.
  13115. When INCREMENT is non-nil, set the property to the next allowed value."
  13116. (interactive "P")
  13117. (if (equal value 0) (setq value 10))
  13118. (let* ((completion-ignore-case t)
  13119. (prop org-effort-property)
  13120. (cur (org-entry-get nil prop))
  13121. (allowed (org-property-get-allowed-values nil prop 'table))
  13122. (existing (mapcar 'list (org-property-values prop)))
  13123. rpl
  13124. (val (cond
  13125. ((stringp value) value)
  13126. ((and allowed (integerp value))
  13127. (or (car (nth (1- value) allowed))
  13128. (car (org-last allowed))))
  13129. ((and allowed increment)
  13130. (or (caadr (member (list cur) allowed))
  13131. (error "Allowed effort values are not set")))
  13132. (allowed
  13133. (message "Select 1-9,0, [RET%s]: %s"
  13134. (if cur (concat "=" cur) "")
  13135. (mapconcat 'car allowed " "))
  13136. (setq rpl (read-char-exclusive))
  13137. (if (equal rpl ?\r)
  13138. cur
  13139. (setq rpl (- rpl ?0))
  13140. (if (equal rpl 0) (setq rpl 10))
  13141. (if (and (> rpl 0) (<= rpl (length allowed)))
  13142. (car (nth (1- rpl) allowed))
  13143. (org-completing-read "Effort: " allowed nil))))
  13144. (t
  13145. (let (org-completion-use-ido org-completion-use-iswitchb)
  13146. (org-completing-read
  13147. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  13148. (concat "[" cur "]") "")
  13149. ": ")
  13150. existing nil nil "" nil cur))))))
  13151. (unless (equal (org-entry-get nil prop) val)
  13152. (org-entry-put nil prop val))
  13153. (message "%s is now %s" prop val)))
  13154. (defun org-at-property-p ()
  13155. "Is cursor inside a property drawer?"
  13156. (save-excursion
  13157. (beginning-of-line 1)
  13158. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  13159. (save-match-data ;; Used by calling procedures
  13160. (let ((p (point))
  13161. (range (unless (org-before-first-heading-p)
  13162. (org-get-property-block))))
  13163. (and range (<= (car range) p) (< p (cdr range))))))))
  13164. (defun org-get-property-block (&optional beg end force)
  13165. "Return the (beg . end) range of the body of the property drawer.
  13166. BEG and END are the beginning and end of the current subtree, or of
  13167. the part before the first headline. If they are not given, they will
  13168. be found. If the drawer does not exist and FORCE is non-nil, create
  13169. the drawer."
  13170. (catch 'exit
  13171. (save-excursion
  13172. (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
  13173. (progn (org-back-to-heading t) (point))))
  13174. (end (or end (and (not (outline-next-heading)) (point-max))
  13175. (point))))
  13176. (goto-char beg)
  13177. (if (re-search-forward org-property-start-re end t)
  13178. (setq beg (1+ (match-end 0)))
  13179. (if force
  13180. (save-excursion
  13181. (org-insert-property-drawer)
  13182. (setq end (progn (outline-next-heading) (point))))
  13183. (throw 'exit nil))
  13184. (goto-char beg)
  13185. (if (re-search-forward org-property-start-re end t)
  13186. (setq beg (1+ (match-end 0)))))
  13187. (if (re-search-forward org-property-end-re end t)
  13188. (setq end (match-beginning 0))
  13189. (or force (throw 'exit nil))
  13190. (goto-char beg)
  13191. (setq end beg)
  13192. (org-indent-line)
  13193. (insert ":END:\n"))
  13194. (cons beg end)))))
  13195. (defun org-entry-properties (&optional pom which specific)
  13196. "Get all properties of the entry at point-or-marker POM.
  13197. This includes the TODO keyword, the tags, time strings for deadline,
  13198. scheduled, and clocking, and any additional properties defined in the
  13199. entry. The return value is an alist, keys may occur multiple times
  13200. if the property key was used several times.
  13201. POM may also be nil, in which case the current entry is used.
  13202. If WHICH is nil or `all', get all properties. If WHICH is
  13203. `special' or `standard', only get that subclass. If WHICH
  13204. is a string only get exactly this property. SPECIFIC can be a string, the
  13205. specific property we are interested in. Specifying it can speed
  13206. things up because then unnecessary parsing is avoided."
  13207. (setq which (or which 'all))
  13208. (org-with-point-at pom
  13209. (let ((clockstr (substring org-clock-string 0 -1))
  13210. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  13211. (case-fold-search nil)
  13212. beg end range props sum-props key key1 value string clocksum clocksumt)
  13213. (save-excursion
  13214. (when (condition-case nil
  13215. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  13216. (error nil))
  13217. (setq beg (point))
  13218. (setq sum-props (get-text-property (point) 'org-summaries))
  13219. (setq clocksum (get-text-property (point) :org-clock-minutes)
  13220. clocksumt (get-text-property (point) :org-clock-minutes-today))
  13221. (outline-next-heading)
  13222. (setq end (point))
  13223. (when (memq which '(all special))
  13224. ;; Get the special properties, like TODO and tags
  13225. (goto-char beg)
  13226. (when (and (or (not specific) (string= specific "TODO"))
  13227. (looking-at org-todo-line-regexp) (match-end 2))
  13228. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  13229. (when (and (or (not specific) (string= specific "PRIORITY"))
  13230. (looking-at org-priority-regexp))
  13231. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  13232. (when (or (not specific) (string= specific "FILE"))
  13233. (push (cons "FILE" buffer-file-name) props))
  13234. (when (and (or (not specific) (string= specific "TAGS"))
  13235. (setq value (org-get-tags-string))
  13236. (string-match "\\S-" value))
  13237. (push (cons "TAGS" value) props))
  13238. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13239. (setq value (org-get-tags-at)))
  13240. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13241. ":"))
  13242. props))
  13243. (when (or (not specific) (string= specific "BLOCKED"))
  13244. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13245. (when (or (not specific)
  13246. (member specific
  13247. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13248. "TIMESTAMP" "TIMESTAMP_IA")))
  13249. (catch 'match
  13250. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13251. (setq key (if (match-end 1)
  13252. (substring (org-match-string-no-properties 1)
  13253. 0 -1))
  13254. string (if (equal key clockstr)
  13255. (org-trim
  13256. (buffer-substring-no-properties
  13257. (match-beginning 3) (goto-char
  13258. (point-at-eol))))
  13259. (substring (org-match-string-no-properties 3)
  13260. 1 -1)))
  13261. ;; Get the correct property name from the key. This is
  13262. ;; necessary if the user has configured time keywords.
  13263. (setq key1 (concat key ":"))
  13264. (cond
  13265. ((not key)
  13266. (setq key
  13267. (if (= (char-after (match-beginning 3)) ?\[)
  13268. "TIMESTAMP_IA" "TIMESTAMP")))
  13269. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13270. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13271. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13272. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13273. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13274. (progn
  13275. (push (cons key string) props)
  13276. ;; no need to search further if match is found
  13277. (throw 'match t))
  13278. (when (or (equal key "CLOCK") (not (assoc key props)))
  13279. (push (cons key string) props)))))))
  13280. (when (memq which '(all standard))
  13281. ;; Get the standard properties, like :PROP: ...
  13282. (setq range (org-get-property-block beg end))
  13283. (when range
  13284. (goto-char (car range))
  13285. (while (re-search-forward
  13286. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  13287. (cdr range) t)
  13288. (setq key (org-match-string-no-properties 1)
  13289. value (org-trim (or (org-match-string-no-properties 2) "")))
  13290. (unless (member key excluded)
  13291. (push (cons key (or value "")) props)))))
  13292. (if clocksum
  13293. (push (cons "CLOCKSUM"
  13294. (org-columns-number-to-string (/ (float clocksum) 60.)
  13295. 'add_times))
  13296. props))
  13297. (if clocksumt
  13298. (push (cons "CLOCKSUM_T"
  13299. (org-columns-number-to-string (/ (float clocksumt) 60.)
  13300. 'add_times))
  13301. props))
  13302. (unless (assoc "CATEGORY" props)
  13303. (push (cons "CATEGORY" (org-get-category)) props))
  13304. (append sum-props (nreverse props)))))))
  13305. (defun org-entry-get (pom property &optional inherit literal-nil)
  13306. "Get value of PROPERTY for entry or content at point-or-marker POM.
  13307. If INHERIT is non-nil and the entry does not have the property,
  13308. then also check higher levels of the hierarchy.
  13309. If INHERIT is the symbol `selective', use inheritance only if the setting
  13310. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13311. If the property is present but empty, the return value is the empty string.
  13312. If the property is not present at all, nil is returned.
  13313. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13314. do not interpret it as the list atom nil. This is used for inheritance
  13315. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13316. (org-with-point-at pom
  13317. (if (and inherit (if (eq inherit 'selective)
  13318. (org-property-inherit-p property)
  13319. t))
  13320. (org-entry-get-with-inheritance property literal-nil)
  13321. (if (member property org-special-properties)
  13322. ;; We need a special property. Use `org-entry-properties' to
  13323. ;; retrieve it, but specify the wanted property
  13324. (cdr (assoc property (org-entry-properties nil 'special property)))
  13325. (let* ((range (org-get-property-block))
  13326. (props (list (or (assoc property org-file-properties)
  13327. (assoc property org-global-properties)
  13328. (assoc property org-global-properties-fixed))))
  13329. (ap (lambda (key)
  13330. (when (re-search-forward
  13331. (org-re-property key) (cdr range) t)
  13332. (setq props
  13333. (org-update-property-plist
  13334. key
  13335. (if (match-end 1)
  13336. (org-match-string-no-properties 1) "")
  13337. props)))))
  13338. val)
  13339. (when (and range (goto-char (car range)))
  13340. (funcall ap property)
  13341. (goto-char (car range))
  13342. (while (funcall ap (concat property "+")))
  13343. (setq val (cdr (assoc property props)))
  13344. (when val (if literal-nil val (org-not-nil val)))))))))
  13345. (defun org-property-or-variable-value (var &optional inherit)
  13346. "Check if there is a property fixing the value of VAR.
  13347. If yes, return this value. If not, return the current value of the variable."
  13348. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  13349. (if (and prop (stringp prop) (string-match "\\S-" prop))
  13350. (read prop)
  13351. (symbol-value var))))
  13352. (defun org-entry-delete (pom property)
  13353. "Delete the property PROPERTY from entry at point-or-marker POM."
  13354. (org-with-point-at pom
  13355. (if (member property org-special-properties)
  13356. nil ; cannot delete these properties.
  13357. (let ((range (org-get-property-block)))
  13358. (if (and range
  13359. (goto-char (car range))
  13360. (re-search-forward
  13361. (org-re-property property)
  13362. (cdr range) t))
  13363. (progn
  13364. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  13365. t)
  13366. nil)))))
  13367. ;; Multi-values properties are properties that contain multiple values
  13368. ;; These values are assumed to be single words, separated by whitespace.
  13369. (defun org-entry-add-to-multivalued-property (pom property value)
  13370. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  13371. (let* ((old (org-entry-get pom property))
  13372. (values (and old (org-split-string old "[ \t]"))))
  13373. (setq value (org-entry-protect-space value))
  13374. (unless (member value values)
  13375. (setq values (cons value values))
  13376. (org-entry-put pom property
  13377. (mapconcat 'identity values " ")))))
  13378. (defun org-entry-remove-from-multivalued-property (pom property value)
  13379. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  13380. (let* ((old (org-entry-get pom property))
  13381. (values (and old (org-split-string old "[ \t]"))))
  13382. (setq value (org-entry-protect-space value))
  13383. (when (member value values)
  13384. (setq values (delete value values))
  13385. (org-entry-put pom property
  13386. (mapconcat 'identity values " ")))))
  13387. (defun org-entry-member-in-multivalued-property (pom property value)
  13388. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  13389. (let* ((old (org-entry-get pom property))
  13390. (values (and old (org-split-string old "[ \t]"))))
  13391. (setq value (org-entry-protect-space value))
  13392. (member value values)))
  13393. (defun org-entry-get-multivalued-property (pom property)
  13394. "Return a list of values in a multivalued property."
  13395. (let* ((value (org-entry-get pom property))
  13396. (values (and value (org-split-string value "[ \t]"))))
  13397. (mapcar 'org-entry-restore-space values)))
  13398. (defun org-entry-put-multivalued-property (pom property &rest values)
  13399. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  13400. VALUES should be a list of strings. Spaces will be protected."
  13401. (org-entry-put pom property
  13402. (mapconcat 'org-entry-protect-space values " "))
  13403. (let* ((value (org-entry-get pom property))
  13404. (values (and value (org-split-string value "[ \t]"))))
  13405. (mapcar 'org-entry-restore-space values)))
  13406. (defun org-entry-protect-space (s)
  13407. "Protect spaces and newline in string S."
  13408. (while (string-match " " s)
  13409. (setq s (replace-match "%20" t t s)))
  13410. (while (string-match "\n" s)
  13411. (setq s (replace-match "%0A" t t s)))
  13412. s)
  13413. (defun org-entry-restore-space (s)
  13414. "Restore spaces and newline in string S."
  13415. (while (string-match "%20" s)
  13416. (setq s (replace-match " " t t s)))
  13417. (while (string-match "%0A" s)
  13418. (setq s (replace-match "\n" t t s)))
  13419. s)
  13420. (defvar org-entry-property-inherited-from (make-marker)
  13421. "Marker pointing to the entry from where a property was inherited.
  13422. Each call to `org-entry-get-with-inheritance' will set this marker to the
  13423. location of the entry where the inheritance search matched. If there was
  13424. no match, the marker will point nowhere.
  13425. Note that also `org-entry-get' calls this function, if the INHERIT flag
  13426. is set.")
  13427. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  13428. "Get PROPERTY of entry or content at point, search higher levels if needed.
  13429. The search will stop at the first ancestor which has the property defined.
  13430. If the value found is \"nil\", return nil to show that the property
  13431. should be considered as undefined (this is the meaning of nil here).
  13432. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  13433. (move-marker org-entry-property-inherited-from nil)
  13434. (let (tmp)
  13435. (save-excursion
  13436. (save-restriction
  13437. (widen)
  13438. (catch 'ex
  13439. (while t
  13440. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  13441. (or (ignore-errors (org-back-to-heading t))
  13442. (goto-char (point-min)))
  13443. (move-marker org-entry-property-inherited-from (point))
  13444. (throw 'ex tmp))
  13445. (or (ignore-errors (org-up-heading-safe))
  13446. (throw 'ex nil))))))
  13447. (setq tmp (or tmp
  13448. (cdr (assoc property org-file-properties))
  13449. (cdr (assoc property org-global-properties))
  13450. (cdr (assoc property org-global-properties-fixed))))
  13451. (if literal-nil tmp (org-not-nil tmp))))
  13452. (defvar org-property-changed-functions nil
  13453. "Hook called when the value of a property has changed.
  13454. Each hook function should accept two arguments, the name of the property
  13455. and the new value.")
  13456. (defun org-entry-put (pom property value)
  13457. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  13458. (org-with-point-at pom
  13459. (org-back-to-heading t)
  13460. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  13461. range)
  13462. (cond
  13463. ((equal property "TODO")
  13464. (when (and (stringp value) (string-match "\\S-" value)
  13465. (not (member value org-todo-keywords-1)))
  13466. (error "\"%s\" is not a valid TODO state" value))
  13467. (if (or (not value)
  13468. (not (string-match "\\S-" value)))
  13469. (setq value 'none))
  13470. (org-todo value)
  13471. (org-set-tags nil 'align))
  13472. ((equal property "PRIORITY")
  13473. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  13474. (string-to-char value) ?\ ))
  13475. (org-set-tags nil 'align))
  13476. ((equal property "CLOCKSUM")
  13477. (if (not (re-search-forward
  13478. (concat org-clock-string "\\]--\\(\\[[^]]+\\]\\)") nil t))
  13479. (error "Cannot find a clock log")
  13480. (goto-char (- (match-end 1) 2))
  13481. (cond
  13482. ((eq value 'earlier) (org-timestamp-down))
  13483. ((eq value 'later) (org-timestamp-up)))
  13484. (org-clock-sum-current-item)))
  13485. ((equal property "SCHEDULED")
  13486. (if (re-search-forward org-scheduled-time-regexp end t)
  13487. (cond
  13488. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13489. ((eq value 'later) (org-timestamp-change 1 'day))
  13490. (t (call-interactively 'org-schedule)))
  13491. (call-interactively 'org-schedule)))
  13492. ((equal property "DEADLINE")
  13493. (if (re-search-forward org-deadline-time-regexp end t)
  13494. (cond
  13495. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13496. ((eq value 'later) (org-timestamp-change 1 'day))
  13497. (t (call-interactively 'org-deadline)))
  13498. (call-interactively 'org-deadline)))
  13499. ((member property org-special-properties)
  13500. (error "The %s property can not yet be set with `org-entry-put'"
  13501. property))
  13502. (t ; a non-special property
  13503. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  13504. (setq range (org-get-property-block beg end 'force))
  13505. (goto-char (car range))
  13506. (if (re-search-forward
  13507. (org-re-property-keyword property) (cdr range) t)
  13508. (progn
  13509. (delete-region (match-beginning 0) (match-end 0))
  13510. (goto-char (match-beginning 0)))
  13511. (goto-char (cdr range))
  13512. (insert "\n")
  13513. (backward-char 1)
  13514. (org-indent-line))
  13515. (insert ":" property ":")
  13516. (and value (insert " " value))
  13517. (org-indent-line)))))
  13518. (run-hook-with-args 'org-property-changed-functions property value)))
  13519. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  13520. "Get all property keys in the current buffer.
  13521. With INCLUDE-SPECIALS, also list the special properties that reflect things
  13522. like tags and TODO state.
  13523. With INCLUDE-DEFAULTS, also include properties that has special meaning
  13524. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  13525. and others.
  13526. With INCLUDE-COLUMNS, also include property names given in COLUMN
  13527. formats in the current buffer."
  13528. (let (rtn range cfmt s p)
  13529. (save-excursion
  13530. (save-restriction
  13531. (widen)
  13532. (goto-char (point-min))
  13533. (while (re-search-forward org-property-start-re nil t)
  13534. (setq range (org-get-property-block))
  13535. (goto-char (car range))
  13536. (while (re-search-forward
  13537. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  13538. (cdr range) t)
  13539. (add-to-list 'rtn (org-match-string-no-properties 1)))
  13540. (outline-next-heading))))
  13541. (when include-specials
  13542. (setq rtn (append org-special-properties rtn)))
  13543. (when include-defaults
  13544. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  13545. (add-to-list 'rtn org-effort-property))
  13546. (when include-columns
  13547. (save-excursion
  13548. (save-restriction
  13549. (widen)
  13550. (goto-char (point-min))
  13551. (while (re-search-forward
  13552. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  13553. nil t)
  13554. (setq cfmt (match-string 2) s 0)
  13555. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  13556. cfmt s)
  13557. (setq s (match-end 0)
  13558. p (match-string 1 cfmt))
  13559. (unless (or (equal p "ITEM")
  13560. (member p org-special-properties))
  13561. (add-to-list 'rtn (match-string 1 cfmt))))))))
  13562. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  13563. (defun org-property-values (key)
  13564. "Return a list of all values of property KEY in the current buffer."
  13565. (save-excursion
  13566. (save-restriction
  13567. (widen)
  13568. (goto-char (point-min))
  13569. (let ((re (org-re-property key))
  13570. values)
  13571. (while (re-search-forward re nil t)
  13572. (add-to-list 'values (org-trim (match-string 1))))
  13573. (delete "" values)))))
  13574. (defun org-insert-property-drawer ()
  13575. "Insert a property drawer into the current entry."
  13576. (org-back-to-heading t)
  13577. (looking-at org-outline-regexp)
  13578. (let ((indent (if org-adapt-indentation
  13579. (- (match-end 0) (match-beginning 0))
  13580. 0))
  13581. (beg (point))
  13582. (re (concat "^[ \t]*" org-keyword-time-regexp))
  13583. end hiddenp)
  13584. (outline-next-heading)
  13585. (setq end (point))
  13586. (goto-char beg)
  13587. (while (re-search-forward re end t))
  13588. (setq hiddenp (outline-invisible-p))
  13589. (end-of-line 1)
  13590. (and (equal (char-after) ?\n) (forward-char 1))
  13591. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  13592. (if (member (match-string 1) '("CLOCK:" ":END:"))
  13593. ;; just skip this line
  13594. (beginning-of-line 2)
  13595. ;; Drawer start, find the end
  13596. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  13597. (beginning-of-line 1)))
  13598. (org-skip-over-state-notes)
  13599. (skip-chars-backward " \t\n\r")
  13600. (if (eq (char-before) ?*) (forward-char 1))
  13601. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  13602. (beginning-of-line 0)
  13603. (org-indent-to-column indent)
  13604. (beginning-of-line 2)
  13605. (org-indent-to-column indent)
  13606. (beginning-of-line 0)
  13607. (if hiddenp
  13608. (save-excursion
  13609. (org-back-to-heading t)
  13610. (hide-entry))
  13611. (org-flag-drawer t))))
  13612. (defun org-insert-drawer (&optional arg drawer)
  13613. "Insert a drawer at point.
  13614. Optional argument DRAWER, when non-nil, is a string representing
  13615. drawer's name. Otherwise, the user is prompted for a name.
  13616. If a region is active, insert the drawer around that region
  13617. instead.
  13618. Point is left between drawer's boundaries."
  13619. (interactive "P")
  13620. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  13621. "LOGBOOK"))
  13622. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  13623. ;; internally by Org. They are meant to be inserted
  13624. ;; automatically.
  13625. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  13626. ;; Remove system drawers from list. Note: For some reason,
  13627. ;; `org-completing-read' ignores the predicate while
  13628. ;; `completing-read' handles it fine.
  13629. (drawer (if arg "PROPERTIES"
  13630. (or drawer
  13631. (completing-read
  13632. "Drawer: " org-drawers
  13633. (lambda (d) (not (member d system-drawers))))))))
  13634. (cond
  13635. ;; With C-u, fall back on `org-insert-property-drawer'
  13636. (arg (org-insert-property-drawer))
  13637. ;; With an active region, insert a drawer at point.
  13638. ((not (org-region-active-p))
  13639. (progn
  13640. (unless (bolp) (insert "\n"))
  13641. (insert (format ":%s:\n\n:END:\n" drawer))
  13642. (forward-line -2)))
  13643. ;; Otherwise, insert the drawer at point
  13644. (t
  13645. (let ((rbeg (region-beginning))
  13646. (rend (copy-marker (region-end))))
  13647. (unwind-protect
  13648. (progn
  13649. (goto-char rbeg)
  13650. (beginning-of-line)
  13651. (when (save-excursion
  13652. (re-search-forward org-outline-regexp-bol rend t))
  13653. (error "Drawers cannot contain headlines"))
  13654. ;; Position point at the beginning of the first
  13655. ;; non-blank line in region. Insert drawer's opening
  13656. ;; there, then indent it.
  13657. (org-skip-whitespace)
  13658. (beginning-of-line)
  13659. (insert ":" drawer ":\n")
  13660. (forward-line -1)
  13661. (indent-for-tab-command)
  13662. ;; Move point to the beginning of the first blank line
  13663. ;; after the last non-blank line in region. Insert
  13664. ;; drawer's closing, then indent it.
  13665. (goto-char rend)
  13666. (skip-chars-backward " \r\t\n")
  13667. (insert "\n:END:")
  13668. (indent-for-tab-command)
  13669. (unless (eolp) (insert "\n")))
  13670. ;; Clear marker, whatever the outcome of insertion is.
  13671. (set-marker rend nil)))))))
  13672. (defvar org-property-set-functions-alist nil
  13673. "Property set function alist.
  13674. Each entry should have the following format:
  13675. (PROPERTY . READ-FUNCTION)
  13676. The read function will be called with the same argument as
  13677. `org-completing-read'.")
  13678. (defun org-set-property-function (property)
  13679. "Get the function that should be used to set PROPERTY.
  13680. This is computed according to `org-property-set-functions-alist'."
  13681. (or (cdr (assoc property org-property-set-functions-alist))
  13682. 'org-completing-read))
  13683. (defun org-read-property-value (property)
  13684. "Read PROPERTY value from user."
  13685. (let* ((completion-ignore-case t)
  13686. (allowed (org-property-get-allowed-values nil property 'table))
  13687. (cur (org-entry-get nil property))
  13688. (prompt (concat property " value"
  13689. (if (and cur (string-match "\\S-" cur))
  13690. (concat " [" cur "]") "") ": "))
  13691. (set-function (org-set-property-function property))
  13692. (val (if allowed
  13693. (funcall set-function prompt allowed nil
  13694. (not (get-text-property 0 'org-unrestricted
  13695. (caar allowed))))
  13696. (let (org-completion-use-ido org-completion-use-iswitchb)
  13697. (funcall set-function prompt
  13698. (mapcar 'list (org-property-values property))
  13699. nil nil "" nil cur)))))
  13700. (if (equal val "")
  13701. cur
  13702. val)))
  13703. (defvar org-last-set-property nil)
  13704. (defun org-read-property-name ()
  13705. "Read a property name."
  13706. (let* ((completion-ignore-case t)
  13707. (keys (org-buffer-property-keys nil t t))
  13708. (default-prop (or (save-excursion
  13709. (save-match-data
  13710. (beginning-of-line)
  13711. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  13712. (null (string= (match-string 1) "END"))
  13713. (match-string 1))))
  13714. org-last-set-property))
  13715. (property (org-icompleting-read
  13716. (concat "Property"
  13717. (if default-prop (concat " [" default-prop "]") "")
  13718. ": ")
  13719. (mapcar 'list keys)
  13720. nil nil nil nil
  13721. default-prop
  13722. )))
  13723. (if (member property keys)
  13724. property
  13725. (or (cdr (assoc (downcase property)
  13726. (mapcar (lambda (x) (cons (downcase x) x))
  13727. keys)))
  13728. property))))
  13729. (defun org-set-property (property value)
  13730. "In the current entry, set PROPERTY to VALUE.
  13731. When called interactively, this will prompt for a property name, offering
  13732. completion on existing and default properties. And then it will prompt
  13733. for a value, offering completion either on allowed values (via an inherited
  13734. xxx_ALL property) or on existing values in other instances of this property
  13735. in the current file."
  13736. (interactive (list nil nil))
  13737. (let* ((property (or property (org-read-property-name)))
  13738. (value (or value (org-read-property-value property)))
  13739. (fn (cdr (assoc property org-properties-postprocess-alist))))
  13740. (setq org-last-set-property property)
  13741. ;; Possibly postprocess the inserted value:
  13742. (when fn (setq value (funcall fn value)))
  13743. (unless (equal (org-entry-get nil property) value)
  13744. (org-entry-put nil property value))))
  13745. (defun org-delete-property (property)
  13746. "In the current entry, delete PROPERTY."
  13747. (interactive
  13748. (let* ((completion-ignore-case t)
  13749. (prop (org-icompleting-read "Property: "
  13750. (org-entry-properties nil 'standard))))
  13751. (list prop)))
  13752. (message "Property %s %s" property
  13753. (if (org-entry-delete nil property)
  13754. "deleted"
  13755. "was not present in the entry")))
  13756. (defun org-delete-property-globally (property)
  13757. "Remove PROPERTY globally, from all entries."
  13758. (interactive
  13759. (let* ((completion-ignore-case t)
  13760. (prop (org-icompleting-read
  13761. "Globally remove property: "
  13762. (mapcar 'list (org-buffer-property-keys)))))
  13763. (list prop)))
  13764. (save-excursion
  13765. (save-restriction
  13766. (widen)
  13767. (goto-char (point-min))
  13768. (let ((cnt 0))
  13769. (while (re-search-forward
  13770. (org-re-property property)
  13771. nil t)
  13772. (setq cnt (1+ cnt))
  13773. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  13774. (message "Property \"%s\" removed from %d entries" property cnt)))))
  13775. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  13776. (defun org-compute-property-at-point ()
  13777. "Compute the property at point.
  13778. This looks for an enclosing column format, extracts the operator and
  13779. then applies it to the property in the column format's scope."
  13780. (interactive)
  13781. (unless (org-at-property-p)
  13782. (error "Not at a property"))
  13783. (let ((prop (org-match-string-no-properties 2)))
  13784. (org-columns-get-format-and-top-level)
  13785. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  13786. (error "No operator defined for property %s" prop))
  13787. (org-columns-compute prop)))
  13788. (defvar org-property-allowed-value-functions nil
  13789. "Hook for functions supplying allowed values for a specific property.
  13790. The functions must take a single argument, the name of the property, and
  13791. return a flat list of allowed values. If \":ETC\" is one of
  13792. the values, this means that these values are intended as defaults for
  13793. completion, but that other values should be allowed too.
  13794. The functions must return nil if they are not responsible for this
  13795. property.")
  13796. (defun org-property-get-allowed-values (pom property &optional table)
  13797. "Get allowed values for the property PROPERTY.
  13798. When TABLE is non-nil, return an alist that can directly be used for
  13799. completion."
  13800. (let (vals)
  13801. (cond
  13802. ((equal property "TODO")
  13803. (setq vals (org-with-point-at pom
  13804. (append org-todo-keywords-1 '("")))))
  13805. ((equal property "PRIORITY")
  13806. (let ((n org-lowest-priority))
  13807. (while (>= n org-highest-priority)
  13808. (push (char-to-string n) vals)
  13809. (setq n (1- n)))))
  13810. ((member property org-special-properties))
  13811. ((setq vals (run-hook-with-args-until-success
  13812. 'org-property-allowed-value-functions property)))
  13813. (t
  13814. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  13815. (when (and vals (string-match "\\S-" vals))
  13816. (setq vals (car (read-from-string (concat "(" vals ")"))))
  13817. (setq vals (mapcar (lambda (x)
  13818. (cond ((stringp x) x)
  13819. ((numberp x) (number-to-string x))
  13820. ((symbolp x) (symbol-name x))
  13821. (t "???")))
  13822. vals)))))
  13823. (when (member ":ETC" vals)
  13824. (setq vals (remove ":ETC" vals))
  13825. (org-add-props (car vals) '(org-unrestricted t)))
  13826. (if table (mapcar 'list vals) vals)))
  13827. (defun org-property-previous-allowed-value (&optional previous)
  13828. "Switch to the next allowed value for this property."
  13829. (interactive)
  13830. (org-property-next-allowed-value t))
  13831. (defun org-property-next-allowed-value (&optional previous)
  13832. "Switch to the next allowed value for this property."
  13833. (interactive)
  13834. (unless (org-at-property-p)
  13835. (error "Not at a property"))
  13836. (let* ((key (match-string 2))
  13837. (value (match-string 3))
  13838. (allowed (or (org-property-get-allowed-values (point) key)
  13839. (and (member value '("[ ]" "[-]" "[X]"))
  13840. '("[ ]" "[X]"))))
  13841. nval)
  13842. (unless allowed
  13843. (error "Allowed values for this property have not been defined"))
  13844. (if previous (setq allowed (reverse allowed)))
  13845. (if (member value allowed)
  13846. (setq nval (car (cdr (member value allowed)))))
  13847. (setq nval (or nval (car allowed)))
  13848. (if (equal nval value)
  13849. (error "Only one allowed value for this property"))
  13850. (org-at-property-p)
  13851. (replace-match (concat " :" key ": " nval) t t)
  13852. (org-indent-line)
  13853. (beginning-of-line 1)
  13854. (skip-chars-forward " \t")
  13855. (run-hook-with-args 'org-property-changed-functions key nval)))
  13856. (defun org-find-olp (path &optional this-buffer)
  13857. "Return a marker pointing to the entry at outline path OLP.
  13858. If anything goes wrong, throw an error.
  13859. You can wrap this call to catch the error like this:
  13860. (condition-case msg
  13861. (org-mobile-locate-entry (match-string 4))
  13862. (error (nth 1 msg)))
  13863. The return value will then be either a string with the error message,
  13864. or a marker if everything is OK.
  13865. If THIS-BUFFER is set, the outline path does not contain a file,
  13866. only headings."
  13867. (let* ((file (if this-buffer buffer-file-name (pop path)))
  13868. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  13869. (level 1)
  13870. (lmin 1)
  13871. (lmax 1)
  13872. limit re end found pos heading cnt flevel)
  13873. (unless buffer (error "File not found :%s" file))
  13874. (with-current-buffer buffer
  13875. (save-excursion
  13876. (save-restriction
  13877. (widen)
  13878. (setq limit (point-max))
  13879. (goto-char (point-min))
  13880. (while (setq heading (pop path))
  13881. (setq re (format org-complex-heading-regexp-format
  13882. (regexp-quote heading)))
  13883. (setq cnt 0 pos (point))
  13884. (while (re-search-forward re end t)
  13885. (setq level (- (match-end 1) (match-beginning 1)))
  13886. (if (and (>= level lmin) (<= level lmax))
  13887. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  13888. (when (= cnt 0) (error "Heading not found on level %d: %s"
  13889. lmax heading))
  13890. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  13891. lmax heading))
  13892. (goto-char found)
  13893. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  13894. (setq end (save-excursion (org-end-of-subtree t t))))
  13895. (when (org-at-heading-p)
  13896. (move-marker (make-marker) (point))))))))
  13897. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  13898. "Find node HEADING in BUFFER.
  13899. Return a marker to the heading if it was found, or nil if not.
  13900. If POS-ONLY is set, return just the position instead of a marker.
  13901. The heading text must match exact, but it may have a TODO keyword,
  13902. a priority cookie and tags in the standard locations."
  13903. (with-current-buffer (or buffer (current-buffer))
  13904. (save-excursion
  13905. (save-restriction
  13906. (widen)
  13907. (goto-char (point-min))
  13908. (let (case-fold-search)
  13909. (if (re-search-forward
  13910. (format org-complex-heading-regexp-format
  13911. (regexp-quote heading)) nil t)
  13912. (if pos-only
  13913. (match-beginning 0)
  13914. (move-marker (make-marker) (match-beginning 0)))))))))
  13915. (defun org-find-exact-heading-in-directory (heading &optional dir)
  13916. "Find Org node headline HEADING in all .org files in directory DIR.
  13917. When the target headline is found, return a marker to this location."
  13918. (let ((files (directory-files (or dir default-directory)
  13919. nil "\\`[^.#].*\\.org\\'"))
  13920. file visiting m buffer)
  13921. (catch 'found
  13922. (while (setq file (pop files))
  13923. (message "trying %s" file)
  13924. (setq visiting (org-find-base-buffer-visiting file))
  13925. (setq buffer (or visiting (find-file-noselect file)))
  13926. (setq m (org-find-exact-headline-in-buffer
  13927. heading buffer))
  13928. (when (and (not m) (not visiting)) (kill-buffer buffer))
  13929. (and m (throw 'found m))))))
  13930. (defun org-find-entry-with-id (ident)
  13931. "Locate the entry that contains the ID property with exact value IDENT.
  13932. IDENT can be a string, a symbol or a number, this function will search for
  13933. the string representation of it.
  13934. Return the position where this entry starts, or nil if there is no such entry."
  13935. (interactive "sID: ")
  13936. (let ((id (cond
  13937. ((stringp ident) ident)
  13938. ((symbol-name ident) (symbol-name ident))
  13939. ((numberp ident) (number-to-string ident))
  13940. (t (error "IDENT %s must be a string, symbol or number" ident))))
  13941. (case-fold-search nil))
  13942. (save-excursion
  13943. (save-restriction
  13944. (widen)
  13945. (goto-char (point-min))
  13946. (when (re-search-forward
  13947. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  13948. nil t)
  13949. (org-back-to-heading t)
  13950. (point))))))
  13951. ;;;; Timestamps
  13952. (defvar org-last-changed-timestamp nil)
  13953. (defvar org-last-inserted-timestamp nil
  13954. "The last time stamp inserted with `org-insert-time-stamp'.")
  13955. (defvar org-time-was-given) ; dynamically scoped parameter
  13956. (defvar org-end-time-was-given) ; dynamically scoped parameter
  13957. (defvar org-ts-what) ; dynamically scoped parameter
  13958. (defun org-time-stamp (arg &optional inactive)
  13959. "Prompt for a date/time and insert a time stamp.
  13960. If the user specifies a time like HH:MM or if this command is
  13961. called with at least one prefix argument, the time stamp contains
  13962. the date and the time. Otherwise, only the date is be included.
  13963. All parts of a date not specified by the user is filled in from
  13964. the current date/time. So if you just press return without
  13965. typing anything, the time stamp will represent the current
  13966. date/time.
  13967. If there is already a timestamp at the cursor, it will be
  13968. modified.
  13969. With two universal prefix arguments, insert an active timestamp
  13970. with the current time without prompting the user."
  13971. (interactive "P")
  13972. (let* ((ts nil)
  13973. (default-time
  13974. ;; Default time is either today, or, when entering a range,
  13975. ;; the range start.
  13976. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  13977. (save-excursion
  13978. (re-search-backward
  13979. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  13980. (- (point) 20) t)))
  13981. (apply 'encode-time (org-parse-time-string (match-string 1)))
  13982. (current-time)))
  13983. (default-input (and ts (org-get-compact-tod ts)))
  13984. (repeater (save-excursion
  13985. (save-match-data
  13986. (beginning-of-line)
  13987. (when (re-search-forward
  13988. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  13989. (save-excursion (progn (end-of-line) (point))) t)
  13990. (match-string 0)))))
  13991. org-time-was-given org-end-time-was-given time)
  13992. (cond
  13993. ((and (org-at-timestamp-p t)
  13994. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  13995. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  13996. (insert "--")
  13997. (setq time (let ((this-command this-command))
  13998. (org-read-date arg 'totime nil nil
  13999. default-time default-input inactive)))
  14000. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  14001. ((org-at-timestamp-p t)
  14002. (setq time (let ((this-command this-command))
  14003. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14004. (when (org-at-timestamp-p t) ; just to get the match data
  14005. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  14006. (replace-match "")
  14007. (setq org-last-changed-timestamp
  14008. (org-insert-time-stamp
  14009. time (or org-time-was-given arg)
  14010. inactive nil nil (list org-end-time-was-given)))
  14011. (when repeater (goto-char (1- (point))) (insert " " repeater)
  14012. (setq org-last-changed-timestamp
  14013. (concat (substring org-last-inserted-timestamp 0 -1)
  14014. " " repeater ">"))))
  14015. (message "Timestamp updated"))
  14016. ((equal arg '(16))
  14017. (org-insert-time-stamp (current-time) t))
  14018. (t
  14019. (setq time (let ((this-command this-command))
  14020. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14021. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  14022. nil nil (list org-end-time-was-given))))))
  14023. ;; FIXME: can we use this for something else, like computing time differences?
  14024. (defun org-get-compact-tod (s)
  14025. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  14026. (let* ((t1 (match-string 1 s))
  14027. (h1 (string-to-number (match-string 2 s)))
  14028. (m1 (string-to-number (match-string 3 s)))
  14029. (t2 (and (match-end 4) (match-string 5 s)))
  14030. (h2 (and t2 (string-to-number (match-string 6 s))))
  14031. (m2 (and t2 (string-to-number (match-string 7 s))))
  14032. dh dm)
  14033. (if (not t2)
  14034. t1
  14035. (setq dh (- h2 h1) dm (- m2 m1))
  14036. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  14037. (concat t1 "+" (number-to-string dh)
  14038. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  14039. (defun org-time-stamp-inactive (&optional arg)
  14040. "Insert an inactive time stamp.
  14041. An inactive time stamp is enclosed in square brackets instead of angle
  14042. brackets. It is inactive in the sense that it does not trigger agenda entries,
  14043. does not link to the calendar and cannot be changed with the S-cursor keys.
  14044. So these are more for recording a certain time/date."
  14045. (interactive "P")
  14046. (org-time-stamp arg 'inactive))
  14047. (defvar org-date-ovl (make-overlay 1 1))
  14048. (overlay-put org-date-ovl 'face 'org-date-selected)
  14049. (org-detach-overlay org-date-ovl)
  14050. (defvar org-ans1) ; dynamically scoped parameter
  14051. (defvar org-ans2) ; dynamically scoped parameter
  14052. (defvar org-plain-time-of-day-regexp) ; defined below
  14053. (defvar org-overriding-default-time nil) ; dynamically scoped
  14054. (defvar org-read-date-overlay nil)
  14055. (defvar org-dcst nil) ; dynamically scoped
  14056. (defvar org-read-date-history nil)
  14057. (defvar org-read-date-final-answer nil)
  14058. (defvar org-read-date-analyze-futurep nil)
  14059. (defvar org-read-date-analyze-forced-year nil)
  14060. (defvar org-read-date-inactive)
  14061. (defun org-read-date (&optional org-with-time to-time from-string prompt
  14062. default-time default-input inactive)
  14063. "Read a date, possibly a time, and make things smooth for the user.
  14064. The prompt will suggest to enter an ISO date, but you can also enter anything
  14065. which will at least partially be understood by `parse-time-string'.
  14066. Unrecognized parts of the date will default to the current day, month, year,
  14067. hour and minute. If this command is called to replace a timestamp at point,
  14068. or to enter the second timestamp of a range, the default time is taken
  14069. from the existing stamp. Furthermore, the command prefers the future,
  14070. so if you are giving a date where the year is not given, and the day-month
  14071. combination is already past in the current year, it will assume you
  14072. mean next year. For details, see the manual. A few examples:
  14073. 3-2-5 --> 2003-02-05
  14074. feb 15 --> currentyear-02-15
  14075. 2/15 --> currentyear-02-15
  14076. sep 12 9 --> 2009-09-12
  14077. 12:45 --> today 12:45
  14078. 22 sept 0:34 --> currentyear-09-22 0:34
  14079. 12 --> currentyear-currentmonth-12
  14080. Fri --> nearest Friday (today or later)
  14081. etc.
  14082. Furthermore you can specify a relative date by giving, as the *first* thing
  14083. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  14084. change in days weeks, months, years.
  14085. With a single plus or minus, the date is relative to today. With a double
  14086. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  14087. +4d --> four days from today
  14088. +4 --> same as above
  14089. +2w --> two weeks from today
  14090. ++5 --> five days from default date
  14091. The function understands only English month and weekday abbreviations.
  14092. While prompting, a calendar is popped up - you can also select the
  14093. date with the mouse (button 1). The calendar shows a period of three
  14094. months. To scroll it to other months, use the keys `>' and `<'.
  14095. If you don't like the calendar, turn it off with
  14096. \(setq org-read-date-popup-calendar nil)
  14097. With optional argument TO-TIME, the date will immediately be converted
  14098. to an internal time.
  14099. With an optional argument ORG-WITH-TIME, the prompt will suggest to
  14100. also insert a time. Note that when ORG-WITH-TIME is not set, you can
  14101. still enter a time, and this function will inform the calling routine
  14102. about this change. The calling routine may then choose to change the
  14103. format used to insert the time stamp into the buffer to include the time.
  14104. With optional argument FROM-STRING, read from this string instead from
  14105. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  14106. the time/date that is used for everything that is not specified by the
  14107. user."
  14108. (require 'parse-time)
  14109. (let* ((org-time-stamp-rounding-minutes
  14110. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  14111. (org-dcst org-display-custom-times)
  14112. (ct (org-current-time))
  14113. (org-def (or org-overriding-default-time default-time ct))
  14114. (org-defdecode (decode-time org-def))
  14115. (dummy (progn
  14116. (when (< (nth 2 org-defdecode) org-extend-today-until)
  14117. (setcar (nthcdr 2 org-defdecode) -1)
  14118. (setcar (nthcdr 1 org-defdecode) 59)
  14119. (setq org-def (apply 'encode-time org-defdecode)
  14120. org-defdecode (decode-time org-def)))))
  14121. (calendar-frame-setup nil)
  14122. (calendar-setup nil)
  14123. (calendar-move-hook nil)
  14124. (calendar-view-diary-initially-flag nil)
  14125. (calendar-view-holidays-initially-flag nil)
  14126. (timestr (format-time-string
  14127. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  14128. (prompt (concat (if prompt (concat prompt " ") "")
  14129. (format "Date+time [%s]: " timestr)))
  14130. ans (org-ans0 "") org-ans1 org-ans2 final)
  14131. (cond
  14132. (from-string (setq ans from-string))
  14133. (org-read-date-popup-calendar
  14134. (save-excursion
  14135. (save-window-excursion
  14136. (calendar)
  14137. (org-eval-in-calendar '(setq cursor-type nil) t)
  14138. (unwind-protect
  14139. (progn
  14140. (calendar-forward-day (- (time-to-days org-def)
  14141. (calendar-absolute-from-gregorian
  14142. (calendar-current-date))))
  14143. (org-eval-in-calendar nil t)
  14144. (let* ((old-map (current-local-map))
  14145. (map (copy-keymap calendar-mode-map))
  14146. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  14147. (org-defkey map (kbd "RET") 'org-calendar-select)
  14148. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  14149. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  14150. (org-defkey minibuffer-local-map [(meta shift left)]
  14151. (lambda () (interactive)
  14152. (org-eval-in-calendar '(calendar-backward-month 1))))
  14153. (org-defkey minibuffer-local-map [(meta shift right)]
  14154. (lambda () (interactive)
  14155. (org-eval-in-calendar '(calendar-forward-month 1))))
  14156. (org-defkey minibuffer-local-map [(meta shift up)]
  14157. (lambda () (interactive)
  14158. (org-eval-in-calendar '(calendar-backward-year 1))))
  14159. (org-defkey minibuffer-local-map [(meta shift down)]
  14160. (lambda () (interactive)
  14161. (org-eval-in-calendar '(calendar-forward-year 1))))
  14162. (org-defkey minibuffer-local-map [?\e (shift left)]
  14163. (lambda () (interactive)
  14164. (org-eval-in-calendar '(calendar-backward-month 1))))
  14165. (org-defkey minibuffer-local-map [?\e (shift right)]
  14166. (lambda () (interactive)
  14167. (org-eval-in-calendar '(calendar-forward-month 1))))
  14168. (org-defkey minibuffer-local-map [?\e (shift up)]
  14169. (lambda () (interactive)
  14170. (org-eval-in-calendar '(calendar-backward-year 1))))
  14171. (org-defkey minibuffer-local-map [?\e (shift down)]
  14172. (lambda () (interactive)
  14173. (org-eval-in-calendar '(calendar-forward-year 1))))
  14174. (org-defkey minibuffer-local-map [(shift up)]
  14175. (lambda () (interactive)
  14176. (org-eval-in-calendar '(calendar-backward-week 1))))
  14177. (org-defkey minibuffer-local-map [(shift down)]
  14178. (lambda () (interactive)
  14179. (org-eval-in-calendar '(calendar-forward-week 1))))
  14180. (org-defkey minibuffer-local-map [(shift left)]
  14181. (lambda () (interactive)
  14182. (org-eval-in-calendar '(calendar-backward-day 1))))
  14183. (org-defkey minibuffer-local-map [(shift right)]
  14184. (lambda () (interactive)
  14185. (org-eval-in-calendar '(calendar-forward-day 1))))
  14186. (org-defkey minibuffer-local-map ">"
  14187. (lambda () (interactive)
  14188. (org-eval-in-calendar '(scroll-calendar-left 1))))
  14189. (org-defkey minibuffer-local-map "<"
  14190. (lambda () (interactive)
  14191. (org-eval-in-calendar '(scroll-calendar-right 1))))
  14192. (org-defkey minibuffer-local-map "\C-v"
  14193. (lambda () (interactive)
  14194. (org-eval-in-calendar
  14195. '(calendar-scroll-left-three-months 1))))
  14196. (org-defkey minibuffer-local-map "\M-v"
  14197. (lambda () (interactive)
  14198. (org-eval-in-calendar
  14199. '(calendar-scroll-right-three-months 1))))
  14200. (run-hooks 'org-read-date-minibuffer-setup-hook)
  14201. (unwind-protect
  14202. (progn
  14203. (use-local-map map)
  14204. (setq org-read-date-inactive inactive)
  14205. (add-hook 'post-command-hook 'org-read-date-display)
  14206. (setq org-ans0 (read-string prompt default-input
  14207. 'org-read-date-history nil))
  14208. ;; org-ans0: from prompt
  14209. ;; org-ans1: from mouse click
  14210. ;; org-ans2: from calendar motion
  14211. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  14212. (remove-hook 'post-command-hook 'org-read-date-display)
  14213. (use-local-map old-map)
  14214. (when org-read-date-overlay
  14215. (delete-overlay org-read-date-overlay)
  14216. (setq org-read-date-overlay nil)))))
  14217. (bury-buffer "*Calendar*")))))
  14218. (t ; Naked prompt only
  14219. (unwind-protect
  14220. (setq ans (read-string prompt default-input
  14221. 'org-read-date-history timestr))
  14222. (when org-read-date-overlay
  14223. (delete-overlay org-read-date-overlay)
  14224. (setq org-read-date-overlay nil)))))
  14225. (setq final (org-read-date-analyze ans org-def org-defdecode))
  14226. (when org-read-date-analyze-forced-year
  14227. (message "Year was forced into %s"
  14228. (if org-read-date-force-compatible-dates
  14229. "compatible range (1970-2037)"
  14230. "range representable on this machine"))
  14231. (ding))
  14232. ;; One round trip to get rid of 34th of August and stuff like that....
  14233. (setq final (decode-time (apply 'encode-time final)))
  14234. (setq org-read-date-final-answer ans)
  14235. (if to-time
  14236. (apply 'encode-time final)
  14237. (if (and (boundp 'org-time-was-given) org-time-was-given)
  14238. (format "%04d-%02d-%02d %02d:%02d"
  14239. (nth 5 final) (nth 4 final) (nth 3 final)
  14240. (nth 2 final) (nth 1 final))
  14241. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  14242. (defvar org-def)
  14243. (defvar org-defdecode)
  14244. (defvar org-with-time)
  14245. (defun org-read-date-display ()
  14246. "Display the current date prompt interpretation in the minibuffer."
  14247. (when org-read-date-display-live
  14248. (when org-read-date-overlay
  14249. (delete-overlay org-read-date-overlay))
  14250. (when (minibufferp (current-buffer))
  14251. (save-excursion
  14252. (end-of-line 1)
  14253. (while (not (equal (buffer-substring
  14254. (max (point-min) (- (point) 4)) (point))
  14255. " "))
  14256. (insert " ")))
  14257. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14258. " " (or org-ans1 org-ans2)))
  14259. (org-end-time-was-given nil)
  14260. (f (org-read-date-analyze ans org-def org-defdecode))
  14261. (fmts (if org-dcst
  14262. org-time-stamp-custom-formats
  14263. org-time-stamp-formats))
  14264. (fmt (if (or org-with-time
  14265. (and (boundp 'org-time-was-given) org-time-was-given))
  14266. (cdr fmts)
  14267. (car fmts)))
  14268. (txt (format-time-string fmt (apply 'encode-time f)))
  14269. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  14270. (txt (concat "=> " txt)))
  14271. (when (and org-end-time-was-given
  14272. (string-match org-plain-time-of-day-regexp txt))
  14273. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  14274. org-end-time-was-given
  14275. (substring txt (match-end 0)))))
  14276. (when org-read-date-analyze-futurep
  14277. (setq txt (concat txt " (=>F)")))
  14278. (setq org-read-date-overlay
  14279. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  14280. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  14281. (defun org-read-date-analyze (ans org-def org-defdecode)
  14282. "Analyze the combined answer of the date prompt."
  14283. ;; FIXME: cleanup and comment
  14284. (let ((nowdecode (decode-time (current-time)))
  14285. delta deltan deltaw deltadef year month day
  14286. hour minute second wday pm h2 m2 tl wday1
  14287. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  14288. (setq org-read-date-analyze-futurep nil
  14289. org-read-date-analyze-forced-year nil)
  14290. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  14291. (setq ans "+0"))
  14292. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  14293. (unless (save-match-data (string-match org-plain-time-of-day-regexp ans))
  14294. (setq ans (replace-match "" t t ans)
  14295. deltan (car delta)
  14296. deltaw (nth 1 delta)
  14297. deltadef (nth 2 delta))))
  14298. ;; Check if there is an iso week date in there
  14299. ;; If yes, store the info and postpone interpreting it until the rest
  14300. ;; of the parsing is done
  14301. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  14302. (setq iso-year (if (match-end 1)
  14303. (org-small-year-to-year
  14304. (string-to-number (match-string 1 ans))))
  14305. iso-weekday (if (match-end 3)
  14306. (string-to-number (match-string 3 ans)))
  14307. iso-week (string-to-number (match-string 2 ans)))
  14308. (setq ans (replace-match "" t t ans)))
  14309. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  14310. (when (string-match
  14311. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  14312. (setq year (if (match-end 2)
  14313. (string-to-number (match-string 2 ans))
  14314. (progn (setq kill-year t)
  14315. (string-to-number (format-time-string "%Y"))))
  14316. month (string-to-number (match-string 3 ans))
  14317. day (string-to-number (match-string 4 ans)))
  14318. (if (< year 100) (setq year (+ 2000 year)))
  14319. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14320. t nil ans)))
  14321. ;; Help matching dotted european dates
  14322. (when (string-match
  14323. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
  14324. (setq year (if (match-end 3)
  14325. (string-to-number (match-string 3 ans))
  14326. (progn (setq kill-year t)
  14327. (string-to-number (format-time-string "%Y"))))
  14328. day (string-to-number (match-string 1 ans))
  14329. month (string-to-number (match-string 2 ans))
  14330. ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14331. t nil ans)))
  14332. ;; Help matching american dates, like 5/30 or 5/30/7
  14333. (when (string-match
  14334. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  14335. (setq year (if (match-end 4)
  14336. (string-to-number (match-string 4 ans))
  14337. (progn (setq kill-year t)
  14338. (string-to-number (format-time-string "%Y"))))
  14339. month (string-to-number (match-string 1 ans))
  14340. day (string-to-number (match-string 2 ans)))
  14341. (if (< year 100) (setq year (+ 2000 year)))
  14342. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14343. t nil ans)))
  14344. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  14345. ;; If there is a time with am/pm, and *no* time without it, we convert
  14346. ;; so that matching will be successful.
  14347. (loop for i from 1 to 2 do ; twice, for end time as well
  14348. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  14349. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  14350. (setq hour (string-to-number (match-string 1 ans))
  14351. minute (if (match-end 3)
  14352. (string-to-number (match-string 3 ans))
  14353. 0)
  14354. pm (equal ?p
  14355. (string-to-char (downcase (match-string 4 ans)))))
  14356. (if (and (= hour 12) (not pm))
  14357. (setq hour 0)
  14358. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  14359. (setq ans (replace-match (format "%02d:%02d" hour minute)
  14360. t t ans))))
  14361. ;; Check if a time range is given as a duration
  14362. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  14363. (setq hour (string-to-number (match-string 1 ans))
  14364. h2 (+ hour (string-to-number (match-string 3 ans)))
  14365. minute (string-to-number (match-string 2 ans))
  14366. m2 (+ minute (if (match-end 5) (string-to-number
  14367. (match-string 5 ans))0)))
  14368. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  14369. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  14370. t t ans)))
  14371. ;; Check if there is a time range
  14372. (when (boundp 'org-end-time-was-given)
  14373. (setq org-time-was-given nil)
  14374. (when (and (string-match org-plain-time-of-day-regexp ans)
  14375. (match-end 8))
  14376. (setq org-end-time-was-given (match-string 8 ans))
  14377. (setq ans (concat (substring ans 0 (match-beginning 7))
  14378. (substring ans (match-end 7))))))
  14379. (setq tl (parse-time-string ans)
  14380. day (or (nth 3 tl) (nth 3 org-defdecode))
  14381. month (or (nth 4 tl)
  14382. (if (and org-read-date-prefer-future
  14383. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  14384. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  14385. (nth 4 org-defdecode)))
  14386. year (or (and (not kill-year) (nth 5 tl))
  14387. (if (and org-read-date-prefer-future
  14388. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  14389. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  14390. (nth 5 org-defdecode)))
  14391. hour (or (nth 2 tl) (nth 2 org-defdecode))
  14392. minute (or (nth 1 tl) (nth 1 org-defdecode))
  14393. second (or (nth 0 tl) 0)
  14394. wday (nth 6 tl))
  14395. (when (and (eq org-read-date-prefer-future 'time)
  14396. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  14397. (equal day (nth 3 nowdecode))
  14398. (equal month (nth 4 nowdecode))
  14399. (equal year (nth 5 nowdecode))
  14400. (nth 2 tl)
  14401. (or (< (nth 2 tl) (nth 2 nowdecode))
  14402. (and (= (nth 2 tl) (nth 2 nowdecode))
  14403. (nth 1 tl)
  14404. (< (nth 1 tl) (nth 1 nowdecode)))))
  14405. (setq day (1+ day)
  14406. futurep t))
  14407. ;; Special date definitions below
  14408. (cond
  14409. (iso-week
  14410. ;; There was an iso week
  14411. (require 'cal-iso)
  14412. (setq futurep nil)
  14413. (setq year (or iso-year year)
  14414. day (or iso-weekday wday 1)
  14415. wday nil ; to make sure that the trigger below does not match
  14416. iso-date (calendar-gregorian-from-absolute
  14417. (calendar-absolute-from-iso
  14418. (list iso-week day year))))
  14419. ; FIXME: Should we also push ISO weeks into the future?
  14420. ; (when (and org-read-date-prefer-future
  14421. ; (not iso-year)
  14422. ; (< (calendar-absolute-from-gregorian iso-date)
  14423. ; (time-to-days (current-time))))
  14424. ; (setq year (1+ year)
  14425. ; iso-date (calendar-gregorian-from-absolute
  14426. ; (calendar-absolute-from-iso
  14427. ; (list iso-week day year)))))
  14428. (setq month (car iso-date)
  14429. year (nth 2 iso-date)
  14430. day (nth 1 iso-date)))
  14431. (deltan
  14432. (setq futurep nil)
  14433. (unless deltadef
  14434. (let ((now (decode-time (current-time))))
  14435. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  14436. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  14437. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  14438. ((equal deltaw "m") (setq month (+ month deltan)))
  14439. ((equal deltaw "y") (setq year (+ year deltan)))))
  14440. ((and wday (not (nth 3 tl)))
  14441. ;; Weekday was given, but no day, so pick that day in the week
  14442. ;; on or after the derived date.
  14443. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  14444. (unless (equal wday wday1)
  14445. (setq day (+ day (% (- wday wday1 -7) 7))))))
  14446. (if (and (boundp 'org-time-was-given)
  14447. (nth 2 tl))
  14448. (setq org-time-was-given t))
  14449. (if (< year 100) (setq year (+ 2000 year)))
  14450. ;; Check of the date is representable
  14451. (if org-read-date-force-compatible-dates
  14452. (progn
  14453. (if (< year 1970)
  14454. (setq year 1970 org-read-date-analyze-forced-year t))
  14455. (if (> year 2037)
  14456. (setq year 2037 org-read-date-analyze-forced-year t)))
  14457. (condition-case nil
  14458. (ignore (encode-time second minute hour day month year))
  14459. (error
  14460. (setq year (nth 5 org-defdecode))
  14461. (setq org-read-date-analyze-forced-year t))))
  14462. (setq org-read-date-analyze-futurep futurep)
  14463. (list second minute hour day month year)))
  14464. (defvar parse-time-weekdays)
  14465. (defun org-read-date-get-relative (s today default)
  14466. "Check string S for special relative date string.
  14467. TODAY and DEFAULT are internal times, for today and for a default.
  14468. Return shift list (N what def-flag)
  14469. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  14470. N is the number of WHATs to shift.
  14471. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  14472. the DEFAULT date rather than TODAY."
  14473. (require 'parse-time)
  14474. (when (and
  14475. (string-match
  14476. (concat
  14477. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  14478. "\\([0-9]+\\)?"
  14479. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  14480. "\\([ \t]\\|$\\)") s)
  14481. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  14482. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  14483. (string-to-char (substring (match-string 1 s) -1))
  14484. ?+))
  14485. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  14486. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  14487. (what (if (match-end 3) (match-string 3 s) "d"))
  14488. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  14489. (date (if rel default today))
  14490. (wday (nth 6 (decode-time date)))
  14491. delta)
  14492. (if wday1
  14493. (progn
  14494. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  14495. (if (= dir ?-) (setq delta (- delta 7)))
  14496. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  14497. (list delta "d" rel))
  14498. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  14499. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  14500. "Turn a user-specified date into the internal representation.
  14501. The internal representation needed by the calendar is (month day year).
  14502. This is a wrapper to handle the brain-dead convention in calendar that
  14503. user function argument order change dependent on argument order."
  14504. (if (boundp 'calendar-date-style)
  14505. (cond
  14506. ((eq calendar-date-style 'american)
  14507. (list arg1 arg2 arg3))
  14508. ((eq calendar-date-style 'european)
  14509. (list arg2 arg1 arg3))
  14510. ((eq calendar-date-style 'iso)
  14511. (list arg2 arg3 arg1)))
  14512. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  14513. (if (org-bound-and-true-p european-calendar-style)
  14514. (list arg2 arg1 arg3)
  14515. (list arg1 arg2 arg3)))))
  14516. (defun org-eval-in-calendar (form &optional keepdate)
  14517. "Eval FORM in the calendar window and return to current window.
  14518. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  14519. otherwise stick to the current value of `org-ans2'."
  14520. (let ((sf (selected-frame))
  14521. (sw (selected-window)))
  14522. (select-window (get-buffer-window "*Calendar*" t))
  14523. (eval form)
  14524. (when (and (not keepdate) (calendar-cursor-to-date))
  14525. (let* ((date (calendar-cursor-to-date))
  14526. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14527. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  14528. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  14529. (select-window sw)
  14530. (org-select-frame-set-input-focus sf)))
  14531. (defun org-calendar-select ()
  14532. "Return to `org-read-date' with the date currently selected.
  14533. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14534. (interactive)
  14535. (when (calendar-cursor-to-date)
  14536. (let* ((date (calendar-cursor-to-date))
  14537. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14538. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14539. (if (active-minibuffer-window) (exit-minibuffer))))
  14540. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  14541. "Insert a date stamp for the date given by the internal TIME.
  14542. WITH-HM means use the stamp format that includes the time of the day.
  14543. INACTIVE means use square brackets instead of angular ones, so that the
  14544. stamp will not contribute to the agenda.
  14545. PRE and POST are optional strings to be inserted before and after the
  14546. stamp.
  14547. The command returns the inserted time stamp."
  14548. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  14549. stamp)
  14550. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  14551. (insert-before-markers (or pre ""))
  14552. (when (listp extra)
  14553. (setq extra (car extra))
  14554. (if (and (stringp extra)
  14555. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  14556. (setq extra (format "-%02d:%02d"
  14557. (string-to-number (match-string 1 extra))
  14558. (string-to-number (match-string 2 extra))))
  14559. (setq extra nil)))
  14560. (when extra
  14561. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  14562. (insert-before-markers (setq stamp (format-time-string fmt time)))
  14563. (insert-before-markers (or post ""))
  14564. (setq org-last-inserted-timestamp stamp)))
  14565. (defun org-toggle-time-stamp-overlays ()
  14566. "Toggle the use of custom time stamp formats."
  14567. (interactive)
  14568. (setq org-display-custom-times (not org-display-custom-times))
  14569. (unless org-display-custom-times
  14570. (let ((p (point-min)) (bmp (buffer-modified-p)))
  14571. (while (setq p (next-single-property-change p 'display))
  14572. (if (and (get-text-property p 'display)
  14573. (eq (get-text-property p 'face) 'org-date))
  14574. (remove-text-properties
  14575. p (setq p (next-single-property-change p 'display))
  14576. '(display t))))
  14577. (set-buffer-modified-p bmp)))
  14578. (if (featurep 'xemacs)
  14579. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  14580. (org-restart-font-lock)
  14581. (setq org-table-may-need-update t)
  14582. (if org-display-custom-times
  14583. (message "Time stamps are overlaid with custom format")
  14584. (message "Time stamp overlays removed")))
  14585. (defun org-display-custom-time (beg end)
  14586. "Overlay modified time stamp format over timestamp between BEG and END."
  14587. (let* ((ts (buffer-substring beg end))
  14588. t1 w1 with-hm tf time str w2 (off 0))
  14589. (save-match-data
  14590. (setq t1 (org-parse-time-string ts t))
  14591. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  14592. (setq off (- (match-end 0) (match-beginning 0)))))
  14593. (setq end (- end off))
  14594. (setq w1 (- end beg)
  14595. with-hm (and (nth 1 t1) (nth 2 t1))
  14596. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  14597. time (org-fix-decoded-time t1)
  14598. str (org-add-props
  14599. (format-time-string
  14600. (substring tf 1 -1) (apply 'encode-time time))
  14601. nil 'mouse-face 'highlight)
  14602. w2 (length str))
  14603. (if (not (= w2 w1))
  14604. (add-text-properties (1+ beg) (+ 2 beg)
  14605. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  14606. (if (featurep 'xemacs)
  14607. (progn
  14608. (put-text-property beg end 'invisible t)
  14609. (put-text-property beg end 'end-glyph (make-glyph str)))
  14610. (put-text-property beg end 'display str))))
  14611. (defun org-translate-time (string)
  14612. "Translate all timestamps in STRING to custom format.
  14613. But do this only if the variable `org-display-custom-times' is set."
  14614. (when org-display-custom-times
  14615. (save-match-data
  14616. (let* ((start 0)
  14617. (re org-ts-regexp-both)
  14618. t1 with-hm inactive tf time str beg end)
  14619. (while (setq start (string-match re string start))
  14620. (setq beg (match-beginning 0)
  14621. end (match-end 0)
  14622. t1 (save-match-data
  14623. (org-parse-time-string (substring string beg end) t))
  14624. with-hm (and (nth 1 t1) (nth 2 t1))
  14625. inactive (equal (substring string beg (1+ beg)) "[")
  14626. tf (funcall (if with-hm 'cdr 'car)
  14627. org-time-stamp-custom-formats)
  14628. time (org-fix-decoded-time t1)
  14629. str (format-time-string
  14630. (concat
  14631. (if inactive "[" "<") (substring tf 1 -1)
  14632. (if inactive "]" ">"))
  14633. (apply 'encode-time time))
  14634. string (replace-match str t t string)
  14635. start (+ start (length str)))))))
  14636. string)
  14637. (defun org-fix-decoded-time (time)
  14638. "Set 0 instead of nil for the first 6 elements of time.
  14639. Don't touch the rest."
  14640. (let ((n 0))
  14641. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  14642. (defun org-days-to-time (timestamp-string)
  14643. "Difference between TIMESTAMP-STRING and now in days."
  14644. (- (time-to-days (org-time-string-to-time timestamp-string))
  14645. (time-to-days (current-time))))
  14646. (defun org-deadline-close (timestamp-string &optional ndays)
  14647. "Is the time in TIMESTAMP-STRING close to the current date?"
  14648. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  14649. (and (< (org-days-to-time timestamp-string) ndays)
  14650. (not (org-entry-is-done-p))))
  14651. (defun org-get-wdays (ts)
  14652. "Get the deadline lead time appropriate for timestring TS."
  14653. (cond
  14654. ((<= org-deadline-warning-days 0)
  14655. ;; 0 or negative, enforce this value no matter what
  14656. (- org-deadline-warning-days))
  14657. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  14658. ;; lead time is specified.
  14659. (floor (* (string-to-number (match-string 1 ts))
  14660. (cdr (assoc (match-string 2 ts)
  14661. '(("d" . 1) ("w" . 7)
  14662. ("m" . 30.4) ("y" . 365.25)))))))
  14663. ;; go for the default.
  14664. (t org-deadline-warning-days)))
  14665. (defun org-calendar-select-mouse (ev)
  14666. "Return to `org-read-date' with the date currently selected.
  14667. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14668. (interactive "e")
  14669. (mouse-set-point ev)
  14670. (when (calendar-cursor-to-date)
  14671. (let* ((date (calendar-cursor-to-date))
  14672. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14673. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14674. (if (active-minibuffer-window) (exit-minibuffer))))
  14675. (defun org-check-deadlines (ndays)
  14676. "Check if there are any deadlines due or past due.
  14677. A deadline is considered due if it happens within `org-deadline-warning-days'
  14678. days from today's date. If the deadline appears in an entry marked DONE,
  14679. it is not shown. The prefix arg NDAYS can be used to test that many
  14680. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  14681. (interactive "P")
  14682. (let* ((org-warn-days
  14683. (cond
  14684. ((equal ndays '(4)) 100000)
  14685. (ndays (prefix-numeric-value ndays))
  14686. (t (abs org-deadline-warning-days))))
  14687. (case-fold-search nil)
  14688. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14689. (callback
  14690. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  14691. (message "%d deadlines past-due or due within %d days"
  14692. (org-occur regexp nil callback)
  14693. org-warn-days)))
  14694. (defsubst org-re-timestamp (type)
  14695. "Return a regexp for timestamp TYPE.
  14696. Allowed values for TYPE are:
  14697. all: all timestamps
  14698. active: only active timestamps (<...>)
  14699. inactive: only inactive timestamps ([...])
  14700. scheduled: only scheduled timestamps
  14701. deadline: only deadline timestamps
  14702. When TYPE is nil, fall back on returning a regexp that matches
  14703. both scheduled and deadline timestamps."
  14704. (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
  14705. ((eq type 'active) org-ts-regexp)
  14706. ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
  14707. ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
  14708. ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14709. ((eq type 'scheduled-or-deadline)
  14710. (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
  14711. (defun org-check-before-date (date)
  14712. "Check if there are deadlines or scheduled entries before DATE."
  14713. (interactive (list (org-read-date)))
  14714. (let ((case-fold-search nil)
  14715. (regexp (org-re-timestamp org-ts-type))
  14716. (callback
  14717. (lambda () (time-less-p
  14718. (org-time-string-to-time (match-string 1))
  14719. (org-time-string-to-time date)))))
  14720. (message "%d entries before %s"
  14721. (org-occur regexp nil callback) date)))
  14722. (defun org-check-after-date (date)
  14723. "Check if there are deadlines or scheduled entries after DATE."
  14724. (interactive (list (org-read-date)))
  14725. (let ((case-fold-search nil)
  14726. (regexp (org-re-timestamp org-ts-type))
  14727. (callback
  14728. (lambda () (not
  14729. (time-less-p
  14730. (org-time-string-to-time (match-string 1))
  14731. (org-time-string-to-time date))))))
  14732. (message "%d entries after %s"
  14733. (org-occur regexp nil callback) date)))
  14734. (defun org-check-dates-range (start-date end-date)
  14735. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  14736. (interactive (list (org-read-date nil nil nil "Range starts")
  14737. (org-read-date nil nil nil "Range end")))
  14738. (let ((case-fold-search nil)
  14739. (regexp (org-re-timestamp org-ts-type))
  14740. (callback
  14741. (lambda ()
  14742. (let ((match (match-string 1)))
  14743. (and
  14744. (not (time-less-p
  14745. (org-time-string-to-time match)
  14746. (org-time-string-to-time start-date)))
  14747. (time-less-p
  14748. (org-time-string-to-time match)
  14749. (org-time-string-to-time end-date)))))))
  14750. (message "%d entries between %s and %s"
  14751. (org-occur regexp nil callback) start-date end-date)))
  14752. (defun org-evaluate-time-range (&optional to-buffer)
  14753. "Evaluate a time range by computing the difference between start and end.
  14754. Normally the result is just printed in the echo area, but with prefix arg
  14755. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  14756. If the time range is actually in a table, the result is inserted into the
  14757. next column.
  14758. For time difference computation, a year is assumed to be exactly 365
  14759. days in order to avoid rounding problems."
  14760. (interactive "P")
  14761. (or
  14762. (org-clock-update-time-maybe)
  14763. (save-excursion
  14764. (unless (org-at-date-range-p t)
  14765. (goto-char (point-at-bol))
  14766. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  14767. (if (not (org-at-date-range-p t))
  14768. (error "Not at a time-stamp range, and none found in current line")))
  14769. (let* ((ts1 (match-string 1))
  14770. (ts2 (match-string 2))
  14771. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  14772. (match-end (match-end 0))
  14773. (time1 (org-time-string-to-time ts1))
  14774. (time2 (org-time-string-to-time ts2))
  14775. (t1 (org-float-time time1))
  14776. (t2 (org-float-time time2))
  14777. (diff (abs (- t2 t1)))
  14778. (negative (< (- t2 t1) 0))
  14779. ;; (ys (floor (* 365 24 60 60)))
  14780. (ds (* 24 60 60))
  14781. (hs (* 60 60))
  14782. (fy "%dy %dd %02d:%02d")
  14783. (fy1 "%dy %dd")
  14784. (fd "%dd %02d:%02d")
  14785. (fd1 "%dd")
  14786. (fh "%02d:%02d")
  14787. y d h m align)
  14788. (if havetime
  14789. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14790. y 0
  14791. d (floor (/ diff ds)) diff (mod diff ds)
  14792. h (floor (/ diff hs)) diff (mod diff hs)
  14793. m (floor (/ diff 60)))
  14794. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14795. y 0
  14796. d (floor (+ (/ diff ds) 0.5))
  14797. h 0 m 0))
  14798. (if (not to-buffer)
  14799. (message "%s" (org-make-tdiff-string y d h m))
  14800. (if (org-at-table-p)
  14801. (progn
  14802. (goto-char match-end)
  14803. (setq align t)
  14804. (and (looking-at " *|") (goto-char (match-end 0))))
  14805. (goto-char match-end))
  14806. (if (looking-at
  14807. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  14808. (replace-match ""))
  14809. (if negative (insert " -"))
  14810. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  14811. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  14812. (insert " " (format fh h m))))
  14813. (if align (org-table-align))
  14814. (message "Time difference inserted")))))
  14815. (defun org-make-tdiff-string (y d h m)
  14816. (let ((fmt "")
  14817. (l nil))
  14818. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  14819. l (push y l)))
  14820. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  14821. l (push d l)))
  14822. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  14823. l (push h l)))
  14824. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  14825. l (push m l)))
  14826. (apply 'format fmt (nreverse l))))
  14827. (defun org-time-string-to-time (s &optional buffer pos)
  14828. (condition-case errdata
  14829. (apply 'encode-time (org-parse-time-string s))
  14830. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14831. s (if (not (and buffer pos))
  14832. ""
  14833. (format " at %d in buffer `%s'" pos buffer))
  14834. (cdr errdata)))))
  14835. (defun org-time-string-to-seconds (s)
  14836. (org-float-time (org-time-string-to-time s)))
  14837. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  14838. "Convert a time stamp to an absolute day number.
  14839. If there is a specifier for a cyclic time stamp, get the closest date to
  14840. DAYNR.
  14841. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  14842. The variable date is bound by the calendar when this is called."
  14843. (cond
  14844. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  14845. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  14846. daynr
  14847. (+ daynr 1000)))
  14848. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  14849. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  14850. (time-to-days (current-time))) (match-string 0 s)
  14851. prefer show-all))
  14852. (t (time-to-days
  14853. (condition-case errdata
  14854. (apply 'encode-time (org-parse-time-string s))
  14855. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14856. s (if (not (and buffer pos))
  14857. ""
  14858. (format " at %d in buffer `%s'" pos buffer))
  14859. (cdr errdata))))))))
  14860. (defun org-days-to-iso-week (days)
  14861. "Return the iso week number."
  14862. (require 'cal-iso)
  14863. (car (calendar-iso-from-absolute days)))
  14864. (defun org-small-year-to-year (year)
  14865. "Convert 2-digit years into 4-digit years.
  14866. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  14867. The year 2000 cannot be abbreviated. Any year larger than 99
  14868. is returned unchanged."
  14869. (if (< year 38)
  14870. (setq year (+ 2000 year))
  14871. (if (< year 100)
  14872. (setq year (+ 1900 year))))
  14873. year)
  14874. (defun org-time-from-absolute (d)
  14875. "Return the time corresponding to date D.
  14876. D may be an absolute day number, or a calendar-type list (month day year)."
  14877. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  14878. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  14879. (defun org-calendar-holiday ()
  14880. "List of holidays, for Diary display in Org-mode."
  14881. (require 'holidays)
  14882. (let ((hl (funcall
  14883. (if (fboundp 'calendar-check-holidays)
  14884. 'calendar-check-holidays 'check-calendar-holidays) date)))
  14885. (if hl (mapconcat 'identity hl "; "))))
  14886. (defun org-diary-sexp-entry (sexp entry date)
  14887. "Process a SEXP diary ENTRY for DATE."
  14888. (require 'diary-lib)
  14889. (let ((result (if calendar-debug-sexp
  14890. (let ((stack-trace-on-error t))
  14891. (eval (car (read-from-string sexp))))
  14892. (condition-case nil
  14893. (eval (car (read-from-string sexp)))
  14894. (error
  14895. (beep)
  14896. (message "Bad sexp at line %d in %s: %s"
  14897. (org-current-line)
  14898. (buffer-file-name) sexp)
  14899. (sleep-for 2))))))
  14900. (cond ((stringp result) (split-string result "; "))
  14901. ((and (consp result)
  14902. (not (consp (cdr result)))
  14903. (stringp (cdr result))) (cdr result))
  14904. ((and (consp result)
  14905. (stringp (car result))) result)
  14906. (result entry))))
  14907. (defun org-diary-to-ical-string (frombuf)
  14908. "Get iCalendar entries from diary entries in buffer FROMBUF.
  14909. This uses the icalendar.el library."
  14910. (let* ((tmpdir (if (featurep 'xemacs)
  14911. (temp-directory)
  14912. temporary-file-directory))
  14913. (tmpfile (make-temp-name
  14914. (expand-file-name "orgics" tmpdir)))
  14915. buf rtn b e)
  14916. (with-current-buffer frombuf
  14917. (icalendar-export-region (point-min) (point-max) tmpfile)
  14918. (setq buf (find-buffer-visiting tmpfile))
  14919. (set-buffer buf)
  14920. (goto-char (point-min))
  14921. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  14922. (setq b (match-beginning 0)))
  14923. (goto-char (point-max))
  14924. (if (re-search-backward "^END:VEVENT" nil t)
  14925. (setq e (match-end 0)))
  14926. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  14927. (kill-buffer buf)
  14928. (delete-file tmpfile)
  14929. rtn))
  14930. (defun org-closest-date (start current change prefer show-all)
  14931. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  14932. When PREFER is `past', return a date that is either CURRENT or past.
  14933. When PREFER is `future', return a date that is either CURRENT or future.
  14934. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  14935. ;; Make the proper lists from the dates
  14936. (catch 'exit
  14937. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  14938. dn dw sday cday n1 n2 n0
  14939. d m y y1 y2 date1 date2 nmonths nm ny m2)
  14940. (setq start (org-date-to-gregorian start)
  14941. current (org-date-to-gregorian
  14942. (if show-all
  14943. current
  14944. (time-to-days (current-time))))
  14945. sday (calendar-absolute-from-gregorian start)
  14946. cday (calendar-absolute-from-gregorian current))
  14947. (if (<= cday sday) (throw 'exit sday))
  14948. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  14949. (setq dn (string-to-number (match-string 1 change))
  14950. dw (cdr (assoc (match-string 2 change) a1)))
  14951. (error "Invalid change specifier: %s" change))
  14952. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  14953. (cond
  14954. ((eq dw 'day)
  14955. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  14956. n2 (+ n1 dn)))
  14957. ((eq dw 'year)
  14958. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  14959. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  14960. (setq date1 (list m d y1)
  14961. n1 (calendar-absolute-from-gregorian date1)
  14962. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  14963. n2 (calendar-absolute-from-gregorian date2)))
  14964. ((eq dw 'month)
  14965. ;; approx number of month between the two dates
  14966. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  14967. ;; How often does dn fit in there?
  14968. (setq d (nth 1 start) m (car start) y (nth 2 start)
  14969. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  14970. m (+ m nm)
  14971. ny (floor (/ m 12))
  14972. y (+ y ny)
  14973. m (- m (* ny 12)))
  14974. (while (> m 12) (setq m (- m 12) y (1+ y)))
  14975. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  14976. (setq m2 (+ m dn) y2 y)
  14977. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14978. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  14979. (while (<= n2 cday)
  14980. (setq n1 n2 m m2 y y2)
  14981. (setq m2 (+ m dn) y2 y)
  14982. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14983. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  14984. ;; Make sure n1 is the earlier date
  14985. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  14986. (if show-all
  14987. (cond
  14988. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14989. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14990. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  14991. (cond
  14992. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14993. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14994. (t (if (= cday n1) n1 n2)))))))
  14995. (defun org-date-to-gregorian (date)
  14996. "Turn any specification of DATE into a Gregorian date for the calendar."
  14997. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  14998. ((and (listp date) (= (length date) 3)) date)
  14999. ((stringp date)
  15000. (setq date (org-parse-time-string date))
  15001. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  15002. ((listp date)
  15003. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  15004. (defun org-parse-time-string (s &optional nodefault)
  15005. "Parse the standard Org-mode time string.
  15006. This should be a lot faster than the normal `parse-time-string'.
  15007. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  15008. hour and minute fields will be nil if not given."
  15009. (if (string-match org-ts-regexp0 s)
  15010. (list 0
  15011. (if (or (match-beginning 8) (not nodefault))
  15012. (string-to-number (or (match-string 8 s) "0")))
  15013. (if (or (match-beginning 7) (not nodefault))
  15014. (string-to-number (or (match-string 7 s) "0")))
  15015. (string-to-number (match-string 4 s))
  15016. (string-to-number (match-string 3 s))
  15017. (string-to-number (match-string 2 s))
  15018. nil nil nil)
  15019. (error "Not a standard Org-mode time string: %s" s)))
  15020. (defun org-timestamp-up (&optional arg)
  15021. "Increase the date item at the cursor by one.
  15022. If the cursor is on the year, change the year. If it is on the month,
  15023. the day or the time, change that.
  15024. With prefix ARG, change by that many units."
  15025. (interactive "p")
  15026. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  15027. (defun org-timestamp-down (&optional arg)
  15028. "Decrease the date item at the cursor by one.
  15029. If the cursor is on the year, change the year. If it is on the month,
  15030. the day or the time, change that.
  15031. With prefix ARG, change by that many units."
  15032. (interactive "p")
  15033. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  15034. (defun org-timestamp-up-day (&optional arg)
  15035. "Increase the date in the time stamp by one day.
  15036. With prefix ARG, change that many days."
  15037. (interactive "p")
  15038. (if (and (not (org-at-timestamp-p t))
  15039. (org-at-heading-p))
  15040. (org-todo 'up)
  15041. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  15042. (defun org-timestamp-down-day (&optional arg)
  15043. "Decrease the date in the time stamp by one day.
  15044. With prefix ARG, change that many days."
  15045. (interactive "p")
  15046. (if (and (not (org-at-timestamp-p t))
  15047. (org-at-heading-p))
  15048. (org-todo 'down)
  15049. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  15050. (defun org-at-timestamp-p (&optional inactive-ok)
  15051. "Determine if the cursor is in or at a timestamp."
  15052. (interactive)
  15053. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  15054. (pos (point))
  15055. (ans (or (looking-at tsr)
  15056. (save-excursion
  15057. (skip-chars-backward "^[<\n\r\t")
  15058. (if (> (point) (point-min)) (backward-char 1))
  15059. (and (looking-at tsr)
  15060. (> (- (match-end 0) pos) -1))))))
  15061. (and ans
  15062. (boundp 'org-ts-what)
  15063. (setq org-ts-what
  15064. (cond
  15065. ((= pos (match-beginning 0)) 'bracket)
  15066. ;; Point is considered to be "on the bracket" whether
  15067. ;; it's really on it or right after it.
  15068. ((= pos (1- (match-end 0))) 'bracket)
  15069. ((= pos (match-end 0)) 'after)
  15070. ((org-pos-in-match-range pos 2) 'year)
  15071. ((org-pos-in-match-range pos 3) 'month)
  15072. ((org-pos-in-match-range pos 7) 'hour)
  15073. ((org-pos-in-match-range pos 8) 'minute)
  15074. ((or (org-pos-in-match-range pos 4)
  15075. (org-pos-in-match-range pos 5)) 'day)
  15076. ((and (> pos (or (match-end 8) (match-end 5)))
  15077. (< pos (match-end 0)))
  15078. (- pos (or (match-end 8) (match-end 5))))
  15079. (t 'day))))
  15080. ans))
  15081. (defun org-toggle-timestamp-type ()
  15082. "Toggle the type (<active> or [inactive]) of a time stamp."
  15083. (interactive)
  15084. (when (org-at-timestamp-p t)
  15085. (let ((beg (match-beginning 0)) (end (match-end 0))
  15086. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  15087. (save-excursion
  15088. (goto-char beg)
  15089. (while (re-search-forward "[][<>]" end t)
  15090. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  15091. t t)))
  15092. (message "Timestamp is now %sactive"
  15093. (if (equal (char-after beg) ?<) "" "in")))))
  15094. (defvar org-clock-history) ; defined in org-clock.el
  15095. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  15096. (defun org-timestamp-change (n &optional what updown)
  15097. "Change the date in the time stamp at point.
  15098. The date will be changed by N times WHAT. WHAT can be `day', `month',
  15099. `year', `minute', `second'. If WHAT is not given, the cursor position
  15100. in the timestamp determines what will be changed."
  15101. (let ((origin (point)) origin-cat
  15102. with-hm inactive
  15103. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  15104. org-ts-what
  15105. extra rem
  15106. ts time time0 fixnext clrgx)
  15107. (if (not (org-at-timestamp-p t))
  15108. (error "Not at a timestamp"))
  15109. (if (and (not what) (eq org-ts-what 'bracket))
  15110. (org-toggle-timestamp-type)
  15111. ;; Point isn't on brackets. Remember the part of the time-stamp
  15112. ;; the point was in. Indeed, size of time-stamps may change,
  15113. ;; but point must be kept in the same category nonetheless.
  15114. (setq origin-cat org-ts-what)
  15115. (if (and (not what) (not (eq org-ts-what 'day))
  15116. org-display-custom-times
  15117. (get-text-property (point) 'display)
  15118. (not (get-text-property (1- (point)) 'display)))
  15119. (setq org-ts-what 'day))
  15120. (setq org-ts-what (or what org-ts-what)
  15121. inactive (= (char-after (match-beginning 0)) ?\[)
  15122. ts (match-string 0))
  15123. (replace-match "")
  15124. (if (string-match
  15125. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  15126. ts)
  15127. (setq extra (match-string 1 ts)))
  15128. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  15129. (setq with-hm t))
  15130. (setq time0 (org-parse-time-string ts))
  15131. (when (and updown
  15132. (eq org-ts-what 'minute)
  15133. (not current-prefix-arg))
  15134. ;; This looks like s-up and s-down. Change by one rounding step.
  15135. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  15136. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  15137. (setcar (cdr time0) (+ (nth 1 time0)
  15138. (if (> n 0) (- rem) (- dm rem))))))
  15139. (setq time
  15140. (encode-time (or (car time0) 0)
  15141. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  15142. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  15143. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  15144. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  15145. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  15146. (nthcdr 6 time0)))
  15147. (when (and (member org-ts-what '(hour minute))
  15148. extra
  15149. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  15150. (setq extra (org-modify-ts-extra
  15151. extra
  15152. (if (eq org-ts-what 'hour) 2 5)
  15153. n dm)))
  15154. (when (integerp org-ts-what)
  15155. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  15156. (if (eq what 'calendar)
  15157. (let ((cal-date (org-get-date-from-calendar)))
  15158. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  15159. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  15160. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  15161. (setcar time0 (or (car time0) 0))
  15162. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  15163. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  15164. (setq time (apply 'encode-time time0))))
  15165. ;; Insert the new time-stamp, and ensure point stays in the same
  15166. ;; category as before (i.e. not after the last position in that
  15167. ;; category).
  15168. (let ((pos (point)))
  15169. ;; Stay before inserted string. `save-excursion' is of no use.
  15170. (setq org-last-changed-timestamp
  15171. (org-insert-time-stamp time with-hm inactive nil nil extra))
  15172. (goto-char pos))
  15173. (save-match-data
  15174. (looking-at org-ts-regexp3)
  15175. (goto-char (cond
  15176. ;; `day' category ends before `hour' if any, or at
  15177. ;; the end of the day name.
  15178. ((eq origin-cat 'day)
  15179. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  15180. ((eq origin-cat 'hour) (min (match-end 7) origin))
  15181. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  15182. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  15183. ;; `year' and `month' have both fixed size: point
  15184. ;; couldn't have moved into another part.
  15185. (t origin))))
  15186. ;; Update clock if on a CLOCK line.
  15187. (org-clock-update-time-maybe)
  15188. ;; Maybe adjust the closest clock in `org-clock-history'
  15189. (when org-clock-adjust-closest
  15190. (if (not (and (org-at-clock-log-p)
  15191. (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
  15192. org-clock-history))))))
  15193. (message "No clock to adjust")
  15194. (cond ((save-excursion ; fix previous clock?
  15195. (re-search-backward org-ts-regexp0 nil t)
  15196. (org-looking-back (concat org-clock-string " \\[")))
  15197. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  15198. ((save-excursion ; fix next clock?
  15199. (re-search-backward org-ts-regexp0 nil t)
  15200. (looking-at (concat org-ts-regexp0 "\\] =>")))
  15201. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  15202. (save-window-excursion
  15203. ;; Find closest clock to point, adjust the previous/next one in history
  15204. (let* ((p (save-excursion (org-back-to-heading t)))
  15205. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  15206. (clfixnth
  15207. (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
  15208. (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
  15209. (if (not clfixpos)
  15210. (message "No clock to adjust")
  15211. (save-excursion
  15212. (org-goto-marker-or-bmk clfixpos)
  15213. (org-show-subtree)
  15214. (when (re-search-forward clrgx nil t)
  15215. (goto-char (match-beginning 1))
  15216. (let (org-clock-adjust-closest)
  15217. (org-timestamp-change n org-ts-what updown))
  15218. (message "Clock adjusted in %s for heading: %s"
  15219. (file-name-nondirectory (buffer-file-name))
  15220. (org-get-heading t t)))))))))
  15221. ;; Try to recenter the calendar window, if any.
  15222. (if (and org-calendar-follow-timestamp-change
  15223. (get-buffer-window "*Calendar*" t)
  15224. (memq org-ts-what '(day month year)))
  15225. (org-recenter-calendar (time-to-days time))))))
  15226. (defun org-modify-ts-extra (s pos n dm)
  15227. "Change the different parts of the lead-time and repeat fields in timestamp."
  15228. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  15229. ng h m new rem)
  15230. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  15231. (cond
  15232. ((or (org-pos-in-match-range pos 2)
  15233. (org-pos-in-match-range pos 3))
  15234. (setq m (string-to-number (match-string 3 s))
  15235. h (string-to-number (match-string 2 s)))
  15236. (if (org-pos-in-match-range pos 2)
  15237. (setq h (+ h n))
  15238. (setq n (* dm (org-no-warnings (signum n))))
  15239. (when (not (= 0 (setq rem (% m dm))))
  15240. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  15241. (setq m (+ m n)))
  15242. (if (< m 0) (setq m (+ m 60) h (1- h)))
  15243. (if (> m 59) (setq m (- m 60) h (1+ h)))
  15244. (setq h (min 24 (max 0 h)))
  15245. (setq ng 1 new (format "-%02d:%02d" h m)))
  15246. ((org-pos-in-match-range pos 6)
  15247. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  15248. ((org-pos-in-match-range pos 5)
  15249. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  15250. ((org-pos-in-match-range pos 9)
  15251. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  15252. ((org-pos-in-match-range pos 8)
  15253. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  15254. (when ng
  15255. (setq s (concat
  15256. (substring s 0 (match-beginning ng))
  15257. new
  15258. (substring s (match-end ng))))))
  15259. s))
  15260. (defun org-recenter-calendar (date)
  15261. "If the calendar is visible, recenter it to DATE."
  15262. (let ((cwin (get-buffer-window "*Calendar*" t)))
  15263. (when cwin
  15264. (let ((calendar-move-hook nil))
  15265. (with-selected-window cwin
  15266. (calendar-goto-date (if (listp date) date
  15267. (calendar-gregorian-from-absolute date))))))))
  15268. (defun org-goto-calendar (&optional arg)
  15269. "Go to the Emacs calendar at the current date.
  15270. If there is a time stamp in the current line, go to that date.
  15271. A prefix ARG can be used to force the current date."
  15272. (interactive "P")
  15273. (let ((tsr org-ts-regexp) diff
  15274. (calendar-move-hook nil)
  15275. (calendar-view-holidays-initially-flag nil)
  15276. (calendar-view-diary-initially-flag nil))
  15277. (if (or (org-at-timestamp-p)
  15278. (save-excursion
  15279. (beginning-of-line 1)
  15280. (looking-at (concat ".*" tsr))))
  15281. (let ((d1 (time-to-days (current-time)))
  15282. (d2 (time-to-days
  15283. (org-time-string-to-time (match-string 1)))))
  15284. (setq diff (- d2 d1))))
  15285. (calendar)
  15286. (calendar-goto-today)
  15287. (if (and diff (not arg)) (calendar-forward-day diff))))
  15288. (defun org-get-date-from-calendar ()
  15289. "Return a list (month day year) of date at point in calendar."
  15290. (with-current-buffer "*Calendar*"
  15291. (save-match-data
  15292. (calendar-cursor-to-date))))
  15293. (defun org-date-from-calendar ()
  15294. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  15295. If there is already a time stamp at the cursor position, update it."
  15296. (interactive)
  15297. (if (org-at-timestamp-p t)
  15298. (org-timestamp-change 0 'calendar)
  15299. (let ((cal-date (org-get-date-from-calendar)))
  15300. (org-insert-time-stamp
  15301. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  15302. (defun org-minutes-to-hh:mm-string (m)
  15303. "Compute H:MM from a number of minutes."
  15304. (let ((h (/ m 60)))
  15305. (setq m (- m (* 60 h)))
  15306. (format org-time-clocksum-format h m)))
  15307. (defun org-hh:mm-string-to-minutes (s)
  15308. "Convert a string H:MM to a number of minutes.
  15309. If the string is just a number, interpret it as minutes.
  15310. In fact, the first hh:mm or number in the string will be taken,
  15311. there can be extra stuff in the string.
  15312. If no number is found, the return value is 0."
  15313. (cond
  15314. ((integerp s) s)
  15315. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  15316. (+ (* (string-to-number (match-string 1 s)) 60)
  15317. (string-to-number (match-string 2 s))))
  15318. ((string-match "\\([0-9]+\\)" s)
  15319. (string-to-number (match-string 1 s)))
  15320. (t 0)))
  15321. (defcustom org-effort-durations
  15322. `(("h" . 60)
  15323. ("d" . ,(* 60 8))
  15324. ("w" . ,(* 60 8 5))
  15325. ("m" . ,(* 60 8 5 4))
  15326. ("y" . ,(* 60 8 5 40)))
  15327. "Conversion factor to minutes for an effort modifier.
  15328. Each entry has the form (MODIFIER . MINUTES).
  15329. In an effort string, a number followed by MODIFIER is multiplied
  15330. by the specified number of MINUTES to obtain an effort in
  15331. minutes.
  15332. For example, if the value of this variable is ((\"hours\" . 60)), then an
  15333. effort string \"2hours\" is equivalent to 120 minutes."
  15334. :group 'org-agenda
  15335. :version "24.1"
  15336. :type '(alist :key-type (string :tag "Modifier")
  15337. :value-type (number :tag "Minutes")))
  15338. (defcustom org-image-actual-width t
  15339. "Should we use the actual width of images when inlining them?
  15340. When set to `t', always use the image width.
  15341. When set to a number, use imagemagick (when available) to set
  15342. the image's width to this value.
  15343. When set to a number in a list, try to get the width from the
  15344. #+ATTR.* keyword if it matches a width specification like
  15345. width=\"[0-9]+\", and fall back on that number if none is found.
  15346. When set to nil, try to get the width from an #+ATTR.* keyword
  15347. and fall back on the original width if none is found.
  15348. This requires Emacs >= 24.1, build with imagemagick support."
  15349. :group 'org-appearance
  15350. :version "24.3"
  15351. :type '(choice
  15352. (const :tag "Use the image width" t)
  15353. (integer :tag "Use a number of pixels")
  15354. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  15355. (const :tag "Use #+ATTR* or don't resize" nil)))
  15356. (defun org-duration-string-to-minutes (s &optional output-to-string)
  15357. "Convert a duration string S to minutes.
  15358. A bare number is interpreted as minutes, modifiers can be set by
  15359. customizing `org-effort-durations' (which see).
  15360. Entries containing a colon are interpreted as H:MM by
  15361. `org-hh:mm-string-to-minutes'."
  15362. (let ((result 0)
  15363. (re (concat "\\([0-9.]+\\) *\\("
  15364. (regexp-opt (mapcar 'car org-effort-durations))
  15365. "\\)")))
  15366. (while (string-match re s)
  15367. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  15368. (string-to-number (match-string 1 s))))
  15369. (setq s (replace-match "" nil t s)))
  15370. (setq result (floor result))
  15371. (incf result (org-hh:mm-string-to-minutes s))
  15372. (if output-to-string (number-to-string result) result)))
  15373. ;;;; Files
  15374. (defun org-save-all-org-buffers ()
  15375. "Save all Org-mode buffers without user confirmation."
  15376. (interactive)
  15377. (message "Saving all Org-mode buffers...")
  15378. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  15379. (when (featurep 'org-id) (org-id-locations-save))
  15380. (message "Saving all Org-mode buffers... done"))
  15381. (defun org-revert-all-org-buffers ()
  15382. "Revert all Org-mode buffers.
  15383. Prompt for confirmation when there are unsaved changes.
  15384. Be sure you know what you are doing before letting this function
  15385. overwrite your changes.
  15386. This function is useful in a setup where one tracks org files
  15387. with a version control system, to revert on one machine after pulling
  15388. changes from another. I believe the procedure must be like this:
  15389. 1. M-x org-save-all-org-buffers
  15390. 2. Pull changes from the other machine, resolve conflicts
  15391. 3. M-x org-revert-all-org-buffers"
  15392. (interactive)
  15393. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  15394. (error "Abort"))
  15395. (save-excursion
  15396. (save-window-excursion
  15397. (mapc
  15398. (lambda (b)
  15399. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  15400. (with-current-buffer b buffer-file-name))
  15401. (org-pop-to-buffer-same-window b)
  15402. (revert-buffer t 'no-confirm)))
  15403. (buffer-list))
  15404. (when (and (featurep 'org-id) org-id-track-globally)
  15405. (org-id-locations-load)))))
  15406. ;;;; Agenda files
  15407. ;;;###autoload
  15408. (defun org-switchb (&optional arg)
  15409. "Switch between Org buffers.
  15410. With one prefix argument, restrict available buffers to files.
  15411. With two prefix arguments, restrict available buffers to agenda files.
  15412. Defaults to `iswitchb' for buffer name completion.
  15413. Set `org-completion-use-ido' to make it use ido instead."
  15414. (interactive "P")
  15415. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  15416. ((equal arg '(16)) (org-buffer-list 'agenda))
  15417. (t (org-buffer-list))))
  15418. (org-completion-use-iswitchb org-completion-use-iswitchb)
  15419. (org-completion-use-ido org-completion-use-ido))
  15420. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  15421. (setq org-completion-use-iswitchb t))
  15422. (org-pop-to-buffer-same-window
  15423. (org-icompleting-read "Org buffer: "
  15424. (mapcar 'list (mapcar 'buffer-name blist))
  15425. nil t))))
  15426. ;;; Define some older names previously used for this functionality
  15427. ;;;###autoload
  15428. (defalias 'org-ido-switchb 'org-switchb)
  15429. ;;;###autoload
  15430. (defalias 'org-iswitchb 'org-switchb)
  15431. (defun org-buffer-list (&optional predicate exclude-tmp)
  15432. "Return a list of Org buffers.
  15433. PREDICATE can be `export', `files' or `agenda'.
  15434. export restrict the list to Export buffers.
  15435. files restrict the list to buffers visiting Org files.
  15436. agenda restrict the list to buffers visiting agenda files.
  15437. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  15438. (let* ((bfn nil)
  15439. (agenda-files (and (eq predicate 'agenda)
  15440. (mapcar 'file-truename (org-agenda-files t))))
  15441. (filter
  15442. (cond
  15443. ((eq predicate 'files)
  15444. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  15445. ((eq predicate 'export)
  15446. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  15447. ((eq predicate 'agenda)
  15448. (lambda (b)
  15449. (with-current-buffer b
  15450. (and (derived-mode-p 'org-mode)
  15451. (setq bfn (buffer-file-name b))
  15452. (member (file-truename bfn) agenda-files)))))
  15453. (t (lambda (b) (with-current-buffer b
  15454. (or (derived-mode-p 'org-mode)
  15455. (string-match "\*Org .*Export"
  15456. (buffer-name b)))))))))
  15457. (delq nil
  15458. (mapcar
  15459. (lambda(b)
  15460. (if (and (funcall filter b)
  15461. (or (not exclude-tmp)
  15462. (not (string-match "tmp" (buffer-name b)))))
  15463. b
  15464. nil))
  15465. (buffer-list)))))
  15466. (defun org-agenda-files (&optional unrestricted archives)
  15467. "Get the list of agenda files.
  15468. Optional UNRESTRICTED means return the full list even if a restriction
  15469. is currently in place.
  15470. When ARCHIVES is t, include all archive files that are really being
  15471. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  15472. `org-agenda-archives-mode' is t."
  15473. (let ((files
  15474. (cond
  15475. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  15476. ((stringp org-agenda-files) (org-read-agenda-file-list))
  15477. ((listp org-agenda-files) org-agenda-files)
  15478. (t (error "Invalid value of `org-agenda-files'")))))
  15479. (setq files (apply 'append
  15480. (mapcar (lambda (f)
  15481. (if (file-directory-p f)
  15482. (directory-files
  15483. f t org-agenda-file-regexp)
  15484. (list f)))
  15485. files)))
  15486. (when org-agenda-skip-unavailable-files
  15487. (setq files (delq nil
  15488. (mapcar (function
  15489. (lambda (file)
  15490. (and (file-readable-p file) file)))
  15491. files))))
  15492. (when (or (eq archives t)
  15493. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  15494. (setq files (org-add-archive-files files)))
  15495. files))
  15496. (defun org-agenda-file-p (&optional file)
  15497. "Return non-nil, if FILE is an agenda file.
  15498. If FILE is omitted, use the file associated with the current
  15499. buffer."
  15500. (member (or file (buffer-file-name))
  15501. (org-agenda-files t)))
  15502. (defun org-edit-agenda-file-list ()
  15503. "Edit the list of agenda files.
  15504. Depending on setup, this either uses customize to edit the variable
  15505. `org-agenda-files', or it visits the file that is holding the list. In the
  15506. latter case, the buffer is set up in a way that saving it automatically kills
  15507. the buffer and restores the previous window configuration."
  15508. (interactive)
  15509. (if (stringp org-agenda-files)
  15510. (let ((cw (current-window-configuration)))
  15511. (find-file org-agenda-files)
  15512. (org-set-local 'org-window-configuration cw)
  15513. (org-add-hook 'after-save-hook
  15514. (lambda ()
  15515. (set-window-configuration
  15516. (prog1 org-window-configuration
  15517. (kill-buffer (current-buffer))))
  15518. (org-install-agenda-files-menu)
  15519. (message "New agenda file list installed"))
  15520. nil 'local)
  15521. (message "%s" (substitute-command-keys
  15522. "Edit list and finish with \\[save-buffer]")))
  15523. (customize-variable 'org-agenda-files)))
  15524. (defun org-store-new-agenda-file-list (list)
  15525. "Set new value for the agenda file list and save it correctly."
  15526. (if (stringp org-agenda-files)
  15527. (let ((fe (org-read-agenda-file-list t)) b u)
  15528. (while (setq b (find-buffer-visiting org-agenda-files))
  15529. (kill-buffer b))
  15530. (with-temp-file org-agenda-files
  15531. (insert
  15532. (mapconcat
  15533. (lambda (f) ;; Keep un-expanded entries.
  15534. (if (setq u (assoc f fe))
  15535. (cdr u)
  15536. f))
  15537. list "\n")
  15538. "\n")))
  15539. (let ((org-mode-hook nil) (org-inhibit-startup t)
  15540. (org-insert-mode-line-in-empty-file nil))
  15541. (setq org-agenda-files list)
  15542. (customize-save-variable 'org-agenda-files org-agenda-files))))
  15543. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  15544. "Read the list of agenda files from a file.
  15545. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  15546. filenames, used by `org-store-new-agenda-file-list' to write back
  15547. un-expanded file names."
  15548. (when (file-directory-p org-agenda-files)
  15549. (error "`org-agenda-files' cannot be a single directory"))
  15550. (when (stringp org-agenda-files)
  15551. (with-temp-buffer
  15552. (insert-file-contents org-agenda-files)
  15553. (mapcar
  15554. (lambda (f)
  15555. (let ((e (expand-file-name (substitute-in-file-name f)
  15556. org-directory)))
  15557. (if pair-with-expansion
  15558. (cons e f)
  15559. e)))
  15560. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  15561. ;;;###autoload
  15562. (defun org-cycle-agenda-files ()
  15563. "Cycle through the files in `org-agenda-files'.
  15564. If the current buffer visits an agenda file, find the next one in the list.
  15565. If the current buffer does not, find the first agenda file."
  15566. (interactive)
  15567. (let* ((fs (org-agenda-files t))
  15568. (files (append fs (list (car fs))))
  15569. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  15570. file)
  15571. (unless files (error "No agenda files"))
  15572. (catch 'exit
  15573. (while (setq file (pop files))
  15574. (if (equal (file-truename file) tcf)
  15575. (when (car files)
  15576. (find-file (car files))
  15577. (throw 'exit t))))
  15578. (find-file (car fs)))
  15579. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  15580. (defun org-agenda-file-to-front (&optional to-end)
  15581. "Move/add the current file to the top of the agenda file list.
  15582. If the file is not present in the list, it is added to the front. If it is
  15583. present, it is moved there. With optional argument TO-END, add/move to the
  15584. end of the list."
  15585. (interactive "P")
  15586. (let ((org-agenda-skip-unavailable-files nil)
  15587. (file-alist (mapcar (lambda (x)
  15588. (cons (file-truename x) x))
  15589. (org-agenda-files t)))
  15590. (ctf (file-truename buffer-file-name))
  15591. x had)
  15592. (setq x (assoc ctf file-alist) had x)
  15593. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  15594. (if to-end
  15595. (setq file-alist (append (delq x file-alist) (list x)))
  15596. (setq file-alist (cons x (delq x file-alist))))
  15597. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  15598. (org-install-agenda-files-menu)
  15599. (message "File %s to %s of agenda file list"
  15600. (if had "moved" "added") (if to-end "end" "front"))))
  15601. (defun org-remove-file (&optional file)
  15602. "Remove current file from the list of files in variable `org-agenda-files'.
  15603. These are the files which are being checked for agenda entries.
  15604. Optional argument FILE means use this file instead of the current."
  15605. (interactive)
  15606. (let* ((org-agenda-skip-unavailable-files nil)
  15607. (file (or file buffer-file-name))
  15608. (true-file (file-truename file))
  15609. (afile (abbreviate-file-name file))
  15610. (files (delq nil (mapcar
  15611. (lambda (x)
  15612. (if (equal true-file
  15613. (file-truename x))
  15614. nil x))
  15615. (org-agenda-files t)))))
  15616. (if (not (= (length files) (length (org-agenda-files t))))
  15617. (progn
  15618. (org-store-new-agenda-file-list files)
  15619. (org-install-agenda-files-menu)
  15620. (message "Removed file: %s" afile))
  15621. (message "File was not in list: %s (not removed)" afile))))
  15622. (defun org-file-menu-entry (file)
  15623. (vector file (list 'find-file file) t))
  15624. (defun org-check-agenda-file (file)
  15625. "Make sure FILE exists. If not, ask user what to do."
  15626. (when (not (file-exists-p file))
  15627. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  15628. (abbreviate-file-name file))
  15629. (let ((r (downcase (read-char-exclusive))))
  15630. (cond
  15631. ((equal r ?r)
  15632. (org-remove-file file)
  15633. (throw 'nextfile t))
  15634. (t (error "Abort"))))))
  15635. (defun org-get-agenda-file-buffer (file)
  15636. "Get a buffer visiting FILE. If the buffer needs to be created, add
  15637. it to the list of buffers which might be released later."
  15638. (let ((buf (org-find-base-buffer-visiting file)))
  15639. (if buf
  15640. buf ; just return it
  15641. ;; Make a new buffer and remember it
  15642. (setq buf (find-file-noselect file))
  15643. (if buf (push buf org-agenda-new-buffers))
  15644. buf)))
  15645. (defun org-release-buffers (blist)
  15646. "Release all buffers in list, asking the user for confirmation when needed.
  15647. When a buffer is unmodified, it is just killed. When modified, it is saved
  15648. \(if the user agrees) and then killed."
  15649. (let (buf file)
  15650. (while (setq buf (pop blist))
  15651. (setq file (buffer-file-name buf))
  15652. (when (and (buffer-modified-p buf)
  15653. file
  15654. (y-or-n-p (format "Save file %s? " file)))
  15655. (with-current-buffer buf (save-buffer)))
  15656. (kill-buffer buf))))
  15657. (defun org-agenda-prepare-buffers (files)
  15658. "Create buffers for all agenda files, protect archived trees and comments."
  15659. (interactive)
  15660. (let ((pa '(:org-archived t))
  15661. (pc '(:org-comment t))
  15662. (pall '(:org-archived t :org-comment t))
  15663. (inhibit-read-only t)
  15664. (rea (concat ":" org-archive-tag ":"))
  15665. bmp file re)
  15666. (save-excursion
  15667. (save-restriction
  15668. (while (setq file (pop files))
  15669. (catch 'nextfile
  15670. (if (bufferp file)
  15671. (set-buffer file)
  15672. (org-check-agenda-file file)
  15673. (set-buffer (org-get-agenda-file-buffer file)))
  15674. (widen)
  15675. (setq bmp (buffer-modified-p))
  15676. (org-refresh-category-properties)
  15677. (setq org-todo-keywords-for-agenda
  15678. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  15679. (setq org-done-keywords-for-agenda
  15680. (append org-done-keywords-for-agenda org-done-keywords))
  15681. (setq org-todo-keyword-alist-for-agenda
  15682. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  15683. (setq org-drawers-for-agenda
  15684. (append org-drawers-for-agenda org-drawers))
  15685. (setq org-tag-alist-for-agenda
  15686. (append org-tag-alist-for-agenda org-tag-alist))
  15687. (save-excursion
  15688. (remove-text-properties (point-min) (point-max) pall)
  15689. (when org-agenda-skip-archived-trees
  15690. (goto-char (point-min))
  15691. (while (re-search-forward rea nil t)
  15692. (if (org-at-heading-p t)
  15693. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  15694. (goto-char (point-min))
  15695. (setq re (format org-heading-keyword-regexp-format
  15696. org-comment-string))
  15697. (while (re-search-forward re nil t)
  15698. (add-text-properties
  15699. (match-beginning 0) (org-end-of-subtree t) pc)))
  15700. (set-buffer-modified-p bmp)))))
  15701. (setq org-todo-keywords-for-agenda
  15702. (org-uniquify org-todo-keywords-for-agenda))
  15703. (setq org-todo-keyword-alist-for-agenda
  15704. (org-uniquify org-todo-keyword-alist-for-agenda)
  15705. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  15706. ;;;; Embedded LaTeX
  15707. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  15708. "Keymap for the minor `org-cdlatex-mode'.")
  15709. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  15710. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  15711. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  15712. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  15713. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  15714. (defvar org-cdlatex-texmathp-advice-is-done nil
  15715. "Flag remembering if we have applied the advice to texmathp already.")
  15716. (define-minor-mode org-cdlatex-mode
  15717. "Toggle the minor `org-cdlatex-mode'.
  15718. This mode supports entering LaTeX environment and math in LaTeX fragments
  15719. in Org-mode.
  15720. \\{org-cdlatex-mode-map}"
  15721. nil " OCDL" nil
  15722. (when org-cdlatex-mode
  15723. (require 'cdlatex)
  15724. (run-hooks 'cdlatex-mode-hook)
  15725. (cdlatex-compute-tables))
  15726. (unless org-cdlatex-texmathp-advice-is-done
  15727. (setq org-cdlatex-texmathp-advice-is-done t)
  15728. (defadvice texmathp (around org-math-always-on activate)
  15729. "Always return t in org-mode buffers.
  15730. This is because we want to insert math symbols without dollars even outside
  15731. the LaTeX math segments. If Orgmode thinks that point is actually inside
  15732. an embedded LaTeX fragment, let texmathp do its job.
  15733. \\[org-cdlatex-mode-map]"
  15734. (interactive)
  15735. (let (p)
  15736. (cond
  15737. ((not (derived-mode-p 'org-mode)) ad-do-it)
  15738. ((eq this-command 'cdlatex-math-symbol)
  15739. (setq ad-return-value t
  15740. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  15741. (t
  15742. (let ((p (org-inside-LaTeX-fragment-p)))
  15743. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  15744. (setq ad-return-value t
  15745. texmathp-why '("Org-mode embedded math" . 0))
  15746. (if p ad-do-it)))))))))
  15747. (defun turn-on-org-cdlatex ()
  15748. "Unconditionally turn on `org-cdlatex-mode'."
  15749. (org-cdlatex-mode 1))
  15750. (defun org-inside-LaTeX-fragment-p ()
  15751. "Test if point is inside a LaTeX fragment.
  15752. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  15753. sequence appearing also before point.
  15754. Even though the matchers for math are configurable, this function assumes
  15755. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  15756. delimiters are skipped when they have been removed by customization.
  15757. The return value is nil, or a cons cell with the delimiter and the
  15758. position of this delimiter.
  15759. This function does a reasonably good job, but can locally be fooled by
  15760. for example currency specifications. For example it will assume being in
  15761. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  15762. fragments that are properly closed, but during editing, we have to live
  15763. with the uncertainty caused by missing closing delimiters. This function
  15764. looks only before point, not after."
  15765. (catch 'exit
  15766. (let ((pos (point))
  15767. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  15768. (lim (progn
  15769. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  15770. (point)))
  15771. dd-on str (start 0) m re)
  15772. (goto-char pos)
  15773. (when dodollar
  15774. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  15775. re (nth 1 (assoc "$" org-latex-regexps)))
  15776. (while (string-match re str start)
  15777. (cond
  15778. ((= (match-end 0) (length str))
  15779. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  15780. ((= (match-end 0) (- (length str) 5))
  15781. (throw 'exit nil))
  15782. (t (setq start (match-end 0))))))
  15783. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  15784. (goto-char pos)
  15785. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  15786. (and (match-beginning 2) (throw 'exit nil))
  15787. ;; count $$
  15788. (while (re-search-backward "\\$\\$" lim t)
  15789. (setq dd-on (not dd-on)))
  15790. (goto-char pos)
  15791. (if dd-on (cons "$$" m))))))
  15792. (defun org-inside-latex-macro-p ()
  15793. "Is point inside a LaTeX macro or its arguments?"
  15794. (save-match-data
  15795. (org-in-regexp
  15796. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  15797. (defun org-try-cdlatex-tab ()
  15798. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  15799. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  15800. - inside a LaTeX fragment, or
  15801. - after the first word in a line, where an abbreviation expansion could
  15802. insert a LaTeX environment."
  15803. (when org-cdlatex-mode
  15804. (cond
  15805. ;; Before any word on the line: No expansion possible.
  15806. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  15807. ;; Just after first word on the line: Expand it. Make sure it
  15808. ;; cannot happen on headlines, though.
  15809. ((save-excursion
  15810. (skip-chars-backward "a-zA-Z0-9*")
  15811. (skip-chars-backward " \t")
  15812. (and (bolp) (not (org-at-heading-p))))
  15813. (cdlatex-tab) t)
  15814. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  15815. (defun org-cdlatex-underscore-caret (&optional arg)
  15816. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  15817. Revert to the normal definition outside of these fragments."
  15818. (interactive "P")
  15819. (if (org-inside-LaTeX-fragment-p)
  15820. (call-interactively 'cdlatex-sub-superscript)
  15821. (let (org-cdlatex-mode)
  15822. (call-interactively (key-binding (vector last-input-event))))))
  15823. (defun org-cdlatex-math-modify (&optional arg)
  15824. "Execute `cdlatex-math-modify' in LaTeX fragments.
  15825. Revert to the normal definition outside of these fragments."
  15826. (interactive "P")
  15827. (if (org-inside-LaTeX-fragment-p)
  15828. (call-interactively 'cdlatex-math-modify)
  15829. (let (org-cdlatex-mode)
  15830. (call-interactively (key-binding (vector last-input-event))))))
  15831. (defvar org-latex-fragment-image-overlays nil
  15832. "List of overlays carrying the images of latex fragments.")
  15833. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  15834. (defun org-remove-latex-fragment-image-overlays ()
  15835. "Remove all overlays with LaTeX fragment images in current buffer."
  15836. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  15837. (setq org-latex-fragment-image-overlays nil))
  15838. (defun org-preview-latex-fragment (&optional subtree)
  15839. "Preview the LaTeX fragment at point, or all locally or globally.
  15840. If the cursor is in a LaTeX fragment, create the image and overlay
  15841. it over the source code. If there is no fragment at point, display
  15842. all fragments in the current text, from one headline to the next. With
  15843. prefix SUBTREE, display all fragments in the current subtree. With a
  15844. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  15845. the cursor is before the first headline,
  15846. display all fragments in the buffer.
  15847. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  15848. (interactive "P")
  15849. (unless buffer-file-name
  15850. (error "Can't preview LaTeX fragment in a non-file buffer"))
  15851. (org-remove-latex-fragment-image-overlays)
  15852. (save-excursion
  15853. (save-restriction
  15854. (let (beg end at msg)
  15855. (cond
  15856. ((or (equal subtree '(16))
  15857. (not (save-excursion
  15858. (re-search-backward org-outline-regexp-bol nil t))))
  15859. (setq beg (point-min) end (point-max)
  15860. msg "Creating images for buffer...%s"))
  15861. ((equal subtree '(4))
  15862. (org-back-to-heading)
  15863. (setq beg (point) end (org-end-of-subtree t)
  15864. msg "Creating images for subtree...%s"))
  15865. (t
  15866. (if (setq at (org-inside-LaTeX-fragment-p))
  15867. (goto-char (max (point-min) (- (cdr at) 2)))
  15868. (org-back-to-heading))
  15869. (setq beg (point) end (progn (outline-next-heading) (point))
  15870. msg (if at "Creating image...%s"
  15871. "Creating images for entry...%s"))))
  15872. (message msg "")
  15873. (narrow-to-region beg end)
  15874. (goto-char beg)
  15875. (org-format-latex
  15876. (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
  15877. (file-name-nondirectory
  15878. buffer-file-name)))
  15879. default-directory 'overlays msg at 'forbuffer
  15880. org-latex-create-formula-image-program)
  15881. (message msg "done. Use `C-c C-c' to remove images.")))))
  15882. (defvar org-latex-regexps
  15883. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  15884. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  15885. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  15886. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15887. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15888. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  15889. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  15890. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  15891. "Regular expressions for matching embedded LaTeX.")
  15892. (defvar org-export-have-math nil) ;; dynamic scoping
  15893. (defun org-format-latex (prefix &optional dir overlays msg at
  15894. forbuffer processing-type)
  15895. "Replace LaTeX fragments with links to an image, and produce images.
  15896. Some of the options can be changed using the variable
  15897. `org-format-latex-options'."
  15898. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  15899. (let* ((prefixnodir (file-name-nondirectory prefix))
  15900. (absprefix (expand-file-name prefix dir))
  15901. (todir (file-name-directory absprefix))
  15902. (opt org-format-latex-options)
  15903. (optnew org-format-latex-options)
  15904. (matchers (plist-get opt :matchers))
  15905. (re-list org-latex-regexps)
  15906. (org-format-latex-header-extra
  15907. (plist-get (org-infile-export-plist) :latex-header-extra))
  15908. (cnt 0) txt hash link beg end re e checkdir
  15909. string
  15910. m n block-type block linkfile movefile ov)
  15911. ;; Check the different regular expressions
  15912. (while (setq e (pop re-list))
  15913. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  15914. block (if block-type "\n\n" ""))
  15915. (when (member m matchers)
  15916. (goto-char (point-min))
  15917. (while (re-search-forward re nil t)
  15918. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  15919. (not (get-text-property (match-beginning n)
  15920. 'org-protected))
  15921. (or (not overlays)
  15922. (not (eq (get-char-property (match-beginning n)
  15923. 'org-overlay-type)
  15924. 'org-latex-overlay))))
  15925. (setq org-export-have-math t)
  15926. (cond
  15927. ((eq processing-type 'verbatim)
  15928. ;; Leave the text verbatim, just protect it
  15929. (add-text-properties (match-beginning n) (match-end n)
  15930. '(org-protected t)))
  15931. ((eq processing-type 'mathjax)
  15932. ;; Prepare for MathJax processing
  15933. (setq string (match-string n))
  15934. (if (member m '("$" "$1"))
  15935. (save-excursion
  15936. (delete-region (match-beginning n) (match-end n))
  15937. (goto-char (match-beginning n))
  15938. (insert (org-add-props (concat "\\(" (substring string 1 -1)
  15939. "\\)")
  15940. '(org-protected t))))
  15941. (add-text-properties (match-beginning n) (match-end n)
  15942. '(org-protected t))))
  15943. ((or (eq processing-type 'dvipng)
  15944. (eq processing-type 'imagemagick))
  15945. ;; Process to an image
  15946. (setq txt (match-string n)
  15947. beg (match-beginning n) end (match-end n)
  15948. cnt (1+ cnt))
  15949. (let ((face (face-at-point))
  15950. (fg (plist-get opt :foreground))
  15951. (bg (plist-get opt :background))
  15952. print-length print-level) ; make sure full list is printed
  15953. (when forbuffer
  15954. ; Get the colors from the face at point
  15955. (goto-char beg)
  15956. (when (eq fg 'auto)
  15957. (setq fg (face-attribute face :foreground nil 'default)))
  15958. (when (eq bg 'auto)
  15959. (setq bg (face-attribute face :background nil 'default)))
  15960. (setq optnew (copy-sequence opt))
  15961. (plist-put optnew :foreground fg)
  15962. (plist-put optnew :background bg))
  15963. (setq hash (sha1 (prin1-to-string
  15964. (list org-format-latex-header
  15965. org-format-latex-header-extra
  15966. org-export-latex-default-packages-alist
  15967. org-export-latex-packages-alist
  15968. org-format-latex-options
  15969. forbuffer txt fg bg)))
  15970. linkfile (format "%s_%s.png" prefix hash)
  15971. movefile (format "%s_%s.png" absprefix hash)))
  15972. (setq link (concat block "[[file:" linkfile "]]" block))
  15973. (if msg (message msg cnt))
  15974. (goto-char beg)
  15975. (unless checkdir ; make sure the directory exists
  15976. (setq checkdir t)
  15977. (or (file-directory-p todir) (make-directory todir t)))
  15978. (org-create-formula-image
  15979. txt movefile optnew forbuffer processing-type)
  15980. (if overlays
  15981. (progn
  15982. (mapc (lambda (o)
  15983. (if (eq (overlay-get o 'org-overlay-type)
  15984. 'org-latex-overlay)
  15985. (delete-overlay o)))
  15986. (overlays-in beg end))
  15987. (setq ov (make-overlay beg end))
  15988. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  15989. (if (featurep 'xemacs)
  15990. (progn
  15991. (overlay-put ov 'invisible t)
  15992. (overlay-put
  15993. ov 'end-glyph
  15994. (make-glyph (vector 'png :file movefile))))
  15995. (overlay-put
  15996. ov 'display
  15997. (list 'image :type 'png :file movefile :ascent 'center)))
  15998. (push ov org-latex-fragment-image-overlays)
  15999. (goto-char end))
  16000. (delete-region beg end)
  16001. (insert (org-add-props link
  16002. (list 'org-latex-src
  16003. (replace-regexp-in-string
  16004. "\"" "" txt)
  16005. 'org-latex-src-embed-type
  16006. (if block-type 'paragraph 'character))))))
  16007. ((eq processing-type 'mathml)
  16008. ;; Process to MathML
  16009. (unless (save-match-data (org-format-latex-mathml-available-p))
  16010. (error "LaTeX to MathML converter not configured"))
  16011. (setq txt (match-string n)
  16012. beg (match-beginning n) end (match-end n)
  16013. cnt (1+ cnt))
  16014. (if msg (message msg cnt))
  16015. (goto-char beg)
  16016. (delete-region beg end)
  16017. (insert (org-format-latex-as-mathml
  16018. txt block-type prefix dir)))
  16019. (t
  16020. (error "Unknown conversion type %s for latex fragments"
  16021. processing-type)))))))))
  16022. (defun org-create-math-formula (latex-frag &optional mathml-file)
  16023. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  16024. Use `org-latex-to-mathml-convert-command'. If the conversion is
  16025. sucessful, return the portion between \"<math...> </math>\"
  16026. elements otherwise return nil. When MATHML-FILE is specified,
  16027. write the results in to that file. When invoked as an
  16028. interactive command, prompt for LATEX-FRAG, with initial value
  16029. set to the current active region and echo the results for user
  16030. inspection."
  16031. (interactive (list (let ((frag (when (org-region-active-p)
  16032. (buffer-substring-no-properties
  16033. (region-beginning) (region-end)))))
  16034. (read-string "LaTeX Fragment: " frag nil frag))))
  16035. (unless latex-frag (error "Invalid latex-frag"))
  16036. (let* ((tmp-in-file (file-relative-name
  16037. (make-temp-name (expand-file-name "ltxmathml-in"))))
  16038. (ignore (write-region latex-frag nil tmp-in-file))
  16039. (tmp-out-file (file-relative-name
  16040. (make-temp-name (expand-file-name "ltxmathml-out"))))
  16041. (cmd (format-spec
  16042. org-latex-to-mathml-convert-command
  16043. `((?j . ,(shell-quote-argument
  16044. (expand-file-name org-latex-to-mathml-jar-file)))
  16045. (?I . ,(shell-quote-argument tmp-in-file))
  16046. (?o . ,(shell-quote-argument tmp-out-file)))))
  16047. mathml shell-command-output)
  16048. (when (org-called-interactively-p 'any)
  16049. (unless (org-format-latex-mathml-available-p)
  16050. (error "LaTeX to MathML converter not configured")))
  16051. (message "Running %s" cmd)
  16052. (setq shell-command-output (shell-command-to-string cmd))
  16053. (setq mathml
  16054. (when (file-readable-p tmp-out-file)
  16055. (with-current-buffer (find-file-noselect tmp-out-file t)
  16056. (goto-char (point-min))
  16057. (when (re-search-forward
  16058. (concat
  16059. (regexp-quote
  16060. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  16061. "\\(.\\|\n\\)*"
  16062. (regexp-quote "</math>")) nil t)
  16063. (prog1 (match-string 0) (kill-buffer))))))
  16064. (cond
  16065. (mathml
  16066. (setq mathml
  16067. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  16068. (when mathml-file
  16069. (write-region mathml nil mathml-file))
  16070. (when (org-called-interactively-p 'any)
  16071. (message mathml)))
  16072. ((message "LaTeX to MathML conversion failed")
  16073. (message shell-command-output)))
  16074. (delete-file tmp-in-file)
  16075. (when (file-exists-p tmp-out-file)
  16076. (delete-file tmp-out-file))
  16077. mathml))
  16078. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  16079. prefix &optional dir)
  16080. "Use `org-create-math-formula' but check local cache first."
  16081. (let* ((absprefix (expand-file-name prefix dir))
  16082. (print-length nil) (print-level nil)
  16083. (formula-id (concat
  16084. "formula-"
  16085. (sha1
  16086. (prin1-to-string
  16087. (list latex-frag
  16088. org-latex-to-mathml-convert-command)))))
  16089. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  16090. (formula-cache-dir (file-name-directory formula-cache)))
  16091. (unless (file-directory-p formula-cache-dir)
  16092. (make-directory formula-cache-dir t))
  16093. (unless (file-exists-p formula-cache)
  16094. (org-create-math-formula latex-frag formula-cache))
  16095. (if (file-exists-p formula-cache)
  16096. ;; Successful conversion. Return the link to MathML file.
  16097. (org-add-props
  16098. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  16099. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  16100. 'org-latex-src-embed-type (if latex-frag-type
  16101. 'paragraph 'character)))
  16102. ;; Failed conversion. Return the LaTeX fragment verbatim
  16103. (add-text-properties
  16104. 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
  16105. latex-frag)))
  16106. (defun org-create-formula-image (string tofile options buffer &optional type)
  16107. "Create an image from LaTeX source using dvipng or convert.
  16108. This function calls either `org-create-formula-image-with-dvipng'
  16109. or `org-create-formula-image-with-imagemagick' depending on the
  16110. value of `org-latex-create-formula-image-program' or on the value
  16111. of the optional TYPE variable.
  16112. Note: ultimately these two function should be combined as they
  16113. share a good deal of logic."
  16114. (org-check-external-command
  16115. "latex" "needed to convert LaTeX fragments to images")
  16116. (funcall
  16117. (case (or type org-latex-create-formula-image-program)
  16118. ('dvipng
  16119. (org-check-external-command
  16120. "dvipng" "needed to convert LaTeX fragments to images")
  16121. #'org-create-formula-image-with-dvipng)
  16122. ('imagemagick
  16123. (org-check-external-command
  16124. "convert" "you need to install imagemagick")
  16125. #'org-create-formula-image-with-imagemagick)
  16126. (t (error
  16127. "invalid value of `org-latex-create-formula-image-program'")))
  16128. string tofile options buffer))
  16129. ;; This function borrows from Ganesh Swami's latex2png.el
  16130. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  16131. "This calls dvipng."
  16132. (require 'org-latex)
  16133. (let* ((tmpdir (if (featurep 'xemacs)
  16134. (temp-directory)
  16135. temporary-file-directory))
  16136. (texfilebase (make-temp-name
  16137. (expand-file-name "orgtex" tmpdir)))
  16138. (texfile (concat texfilebase ".tex"))
  16139. (dvifile (concat texfilebase ".dvi"))
  16140. (pngfile (concat texfilebase ".png"))
  16141. (fnh (if (featurep 'xemacs)
  16142. (font-height (face-font 'default))
  16143. (face-attribute 'default :height nil)))
  16144. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16145. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16146. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16147. "Black"))
  16148. (bg (or (plist-get options (if buffer :background :html-background))
  16149. "Transparent")))
  16150. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
  16151. (setq fg (org-dvipng-color-format fg)))
  16152. (if (eq bg 'default) (setq bg (org-dvipng-color :background))
  16153. (setq bg (org-dvipng-color-format bg)))
  16154. (with-temp-file texfile
  16155. (insert (org-splice-latex-header
  16156. org-format-latex-header
  16157. org-export-latex-default-packages-alist
  16158. org-export-latex-packages-alist t
  16159. org-format-latex-header-extra))
  16160. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  16161. (require 'org-latex)
  16162. (org-export-latex-fix-inputenc))
  16163. (let ((dir default-directory))
  16164. (condition-case nil
  16165. (progn
  16166. (cd tmpdir)
  16167. (call-process "latex" nil nil nil texfile))
  16168. (error nil))
  16169. (cd dir))
  16170. (if (not (file-exists-p dvifile))
  16171. (progn (message "Failed to create dvi file from %s" texfile) nil)
  16172. (condition-case nil
  16173. (if (featurep 'xemacs)
  16174. (call-process "dvipng" nil nil nil
  16175. "-fg" fg "-bg" bg
  16176. "-T" "tight"
  16177. "-o" pngfile
  16178. dvifile)
  16179. (call-process "dvipng" nil nil nil
  16180. "-fg" fg "-bg" bg
  16181. "-D" dpi
  16182. ;;"-x" scale "-y" scale
  16183. "-T" "tight"
  16184. "-o" pngfile
  16185. dvifile))
  16186. (error nil))
  16187. (if (not (file-exists-p pngfile))
  16188. (if org-format-latex-signal-error
  16189. (error "Failed to create png file from %s" texfile)
  16190. (message "Failed to create png file from %s" texfile)
  16191. nil)
  16192. ;; Use the requested file name and clean up
  16193. (copy-file pngfile tofile 'replace)
  16194. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  16195. (if (file-exists-p (concat texfilebase e))
  16196. (delete-file (concat texfilebase e))))
  16197. pngfile))))
  16198. (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
  16199. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  16200. "This calls convert, which is included into imagemagick."
  16201. (require 'org-latex)
  16202. (let* ((tmpdir (if (featurep 'xemacs)
  16203. (temp-directory)
  16204. temporary-file-directory))
  16205. (texfilebase (make-temp-name
  16206. (expand-file-name "orgtex" tmpdir)))
  16207. (texfile (concat texfilebase ".tex"))
  16208. (pdffile (concat texfilebase ".pdf"))
  16209. (pngfile (concat texfilebase ".png"))
  16210. (fnh (if (featurep 'xemacs)
  16211. (font-height (face-font 'default))
  16212. (face-attribute 'default :height nil)))
  16213. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16214. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16215. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16216. "black"))
  16217. (bg (or (plist-get options (if buffer :background :html-background))
  16218. "white")))
  16219. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  16220. (setq fg (org-latex-color-format fg)))
  16221. (if (eq bg 'default) (setq bg (org-latex-color :background))
  16222. (setq bg (org-latex-color-format
  16223. (if (string= bg "Transparent") "white" bg))))
  16224. (with-temp-file texfile
  16225. (insert (org-splice-latex-header
  16226. org-format-latex-header
  16227. org-export-latex-default-packages-alist
  16228. org-export-latex-packages-alist t
  16229. org-format-latex-header-extra))
  16230. (insert "\n\\begin{document}\n"
  16231. "\\definecolor{fg}{rgb}{" fg "}\n"
  16232. "\\definecolor{bg}{rgb}{" bg "}\n"
  16233. "\n\\pagecolor{bg}\n"
  16234. "\n{\\color{fg}\n"
  16235. string
  16236. "\n}\n"
  16237. "\n\\end{document}\n" )
  16238. (require 'org-latex)
  16239. (org-export-latex-fix-inputenc))
  16240. (let ((dir default-directory) cmd cmds latex-frags-cmds)
  16241. (condition-case nil
  16242. (progn
  16243. (cd tmpdir)
  16244. (setq cmds org-latex-to-pdf-process)
  16245. (while cmds
  16246. (setq latex-frags-cmds (pop cmds))
  16247. (if (listp latex-frags-cmds)
  16248. (setq cmds nil)
  16249. (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
  16250. (while latex-frags-cmds
  16251. (setq cmd (pop latex-frags-cmds))
  16252. (while (string-match "%b" cmd)
  16253. (setq cmd (replace-match
  16254. (save-match-data
  16255. (shell-quote-argument texfile))
  16256. t t cmd)))
  16257. (while (string-match "%f" cmd)
  16258. (setq cmd (replace-match
  16259. (save-match-data
  16260. (shell-quote-argument (file-name-nondirectory texfile)))
  16261. t t cmd)))
  16262. (while (string-match "%o" cmd)
  16263. (setq cmd (replace-match
  16264. (save-match-data
  16265. (shell-quote-argument (file-name-directory texfile)))
  16266. t t cmd)))
  16267. (setq cmd (split-string cmd))
  16268. (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
  16269. (error nil))
  16270. (cd dir))
  16271. (if (not (file-exists-p pdffile))
  16272. (progn (message "Failed to create pdf file from %s" texfile) nil)
  16273. (condition-case nil
  16274. (if (featurep 'xemacs)
  16275. (call-process "convert" nil nil nil
  16276. "-density" "96"
  16277. "-trim"
  16278. "-antialias"
  16279. pdffile
  16280. "-quality" "100"
  16281. ;; "-sharpen" "0x1.0"
  16282. pngfile)
  16283. (call-process "convert" nil nil nil
  16284. "-density" dpi
  16285. "-trim"
  16286. "-antialias"
  16287. pdffile
  16288. "-quality" "100"
  16289. ; "-sharpen" "0x1.0"
  16290. pngfile))
  16291. (error nil))
  16292. (if (not (file-exists-p pngfile))
  16293. (if org-format-latex-signal-error
  16294. (error "Failed to create png file from %s" texfile)
  16295. (message "Failed to create png file from %s" texfile)
  16296. nil)
  16297. ;; Use the requested file name and clean up
  16298. (copy-file pngfile tofile 'replace)
  16299. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  16300. (if (file-exists-p (concat texfilebase e))
  16301. (delete-file (concat texfilebase e))))
  16302. pngfile))))
  16303. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  16304. "Fill a LaTeX header template TPL.
  16305. In the template, the following place holders will be recognized:
  16306. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  16307. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  16308. [PACKAGES] \\usepackage statements for PKG
  16309. [NO-PACKAGES] do not include PKG
  16310. [EXTRA] the string EXTRA
  16311. [NO-EXTRA] do not include EXTRA
  16312. For backward compatibility, if both the positive and the negative place
  16313. holder is missing, the positive one (without the \"NO-\") will be
  16314. assumed to be present at the end of the template.
  16315. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  16316. EXTRA is a string.
  16317. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  16318. (let (rpl (end ""))
  16319. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  16320. (setq rpl (if (or (match-end 1) (not def-pkg))
  16321. "" (org-latex-packages-to-string def-pkg snippets-p t))
  16322. tpl (replace-match rpl t t tpl))
  16323. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  16324. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  16325. (setq rpl (if (or (match-end 1) (not pkg))
  16326. "" (org-latex-packages-to-string pkg snippets-p t))
  16327. tpl (replace-match rpl t t tpl))
  16328. (if pkg (setq end
  16329. (concat end "\n"
  16330. (org-latex-packages-to-string pkg snippets-p)))))
  16331. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  16332. (setq rpl (if (or (match-end 1) (not extra))
  16333. "" (concat extra "\n"))
  16334. tpl (replace-match rpl t t tpl))
  16335. (if (and extra (string-match "\\S-" extra))
  16336. (setq end (concat end "\n" extra))))
  16337. (if (string-match "\\S-" end)
  16338. (concat tpl "\n" end)
  16339. tpl)))
  16340. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  16341. "Turn an alist of packages into a string with the \\usepackage macros."
  16342. (setq pkg (mapconcat (lambda(p)
  16343. (cond
  16344. ((stringp p) p)
  16345. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  16346. (format "%% Package %s omitted" (cadr p)))
  16347. ((equal "" (car p))
  16348. (format "\\usepackage{%s}" (cadr p)))
  16349. (t
  16350. (format "\\usepackage[%s]{%s}"
  16351. (car p) (cadr p)))))
  16352. pkg
  16353. "\n"))
  16354. (if newline (concat pkg "\n") pkg))
  16355. (defun org-dvipng-color (attr)
  16356. "Return a RGB color specification for dvipng."
  16357. (apply 'format "rgb %s %s %s"
  16358. (mapcar 'org-normalize-color
  16359. (if (featurep 'xemacs)
  16360. (color-rgb-components
  16361. (face-property 'default
  16362. (cond ((eq attr :foreground) 'foreground)
  16363. ((eq attr :background) 'background))))
  16364. (color-values (face-attribute 'default attr nil))))))
  16365. (defun org-dvipng-color-format (color-name)
  16366. "Convert COLOR-NAME to a RGB color value for dvipng."
  16367. (apply 'format "rgb %s %s %s"
  16368. (mapcar 'org-normalize-color
  16369. (color-values color-name))))
  16370. (defun org-latex-color (attr)
  16371. "Return a RGB color for the LaTeX color package."
  16372. (apply 'format "%s,%s,%s"
  16373. (mapcar 'org-normalize-color
  16374. (if (featurep 'xemacs)
  16375. (color-rgb-components
  16376. (face-property 'default
  16377. (cond ((eq attr :foreground) 'foreground)
  16378. ((eq attr :background) 'background))))
  16379. (color-values (face-attribute 'default attr nil))))))
  16380. (defun org-latex-color-format (color-name)
  16381. "Convert COLOR-NAME to a RGB color value."
  16382. (apply 'format "%s,%s,%s"
  16383. (mapcar 'org-normalize-color
  16384. (color-values color-name))))
  16385. (defun org-normalize-color (value)
  16386. "Return string to be used as color value for an RGB component."
  16387. (format "%g" (/ value 65535.0)))
  16388. ;; Image display
  16389. (defvar org-inline-image-overlays nil)
  16390. (make-variable-buffer-local 'org-inline-image-overlays)
  16391. (defun org-toggle-inline-images (&optional include-linked)
  16392. "Toggle the display of inline images.
  16393. INCLUDE-LINKED is passed to `org-display-inline-images'."
  16394. (interactive "P")
  16395. (if org-inline-image-overlays
  16396. (progn
  16397. (org-remove-inline-images)
  16398. (message "Inline image display turned off"))
  16399. (org-display-inline-images include-linked)
  16400. (if org-inline-image-overlays
  16401. (message "%d images displayed inline"
  16402. (length org-inline-image-overlays))
  16403. (message "No images to display inline"))))
  16404. (defun org-redisplay-inline-images ()
  16405. "Refresh the display of inline images."
  16406. (interactive)
  16407. (if (not org-inline-image-overlays)
  16408. (org-toggle-inline-images)
  16409. (org-toggle-inline-images)
  16410. (org-toggle-inline-images)))
  16411. (defun org-display-inline-images (&optional include-linked refresh beg end)
  16412. "Display inline images.
  16413. Normally only links without a description part are inlined, because this
  16414. is how it will work for export. When INCLUDE-LINKED is set, also links
  16415. with a description part will be inlined. This can be nice for a quick
  16416. look at those images, but it does not reflect what exported files will look
  16417. like.
  16418. When REFRESH is set, refresh existing images between BEG and END.
  16419. This will create new image displays only if necessary.
  16420. BEG and END default to the buffer boundaries."
  16421. (interactive "P")
  16422. (unless refresh
  16423. (org-remove-inline-images)
  16424. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  16425. (save-excursion
  16426. (save-restriction
  16427. (widen)
  16428. (setq beg (or beg (point-min)) end (or end (point-max)))
  16429. (goto-char beg)
  16430. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  16431. (substring (org-image-file-name-regexp) 0 -2)
  16432. "\\)\\]" (if include-linked "" "\\]")))
  16433. old file ov img type attrwidth width)
  16434. (while (re-search-forward re end t)
  16435. (setq old (get-char-property-and-overlay (match-beginning 1)
  16436. 'org-image-overlay)
  16437. file (expand-file-name
  16438. (concat (or (match-string 3) "") (match-string 4))))
  16439. (when (image-type-available-p 'imagemagick)
  16440. (setq attrwidth (if (or (listp org-image-actual-width)
  16441. (null org-image-actual-width))
  16442. (save-excursion
  16443. (save-match-data
  16444. (move-beginning-of-line 0)
  16445. (if (looking-at "#\\+ATTR.*width=\"\\([^\"]+\\)\"")
  16446. (string-to-number (match-string 1))))))
  16447. width (cond ((eq org-image-actual-width t) nil)
  16448. ((null org-image-actual-width) attrwidth)
  16449. ((numberp org-image-actual-width)
  16450. org-image-actual-width)
  16451. ((listp org-image-actual-width)
  16452. (or attrwidth (car org-image-actual-width))))
  16453. type (if width 'imagemagick)))
  16454. (when (file-exists-p file)
  16455. (if (and (car-safe old) refresh)
  16456. (image-refresh (overlay-get (cdr old) 'display))
  16457. (setq img (save-match-data (create-image file type nil :width width)))
  16458. (when img
  16459. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  16460. (overlay-put ov 'display img)
  16461. (overlay-put ov 'face 'default)
  16462. (overlay-put ov 'org-image-overlay t)
  16463. (overlay-put ov 'modification-hooks
  16464. (list 'org-display-inline-modification-hook))
  16465. (push ov org-inline-image-overlays)))))))))
  16466. (defun org-display-inline-modification-hook (ov after beg end &optional len)
  16467. "Remove inline-display overlay if a corresponding region is modified."
  16468. (let ((inhibit-modification-hooks t))
  16469. (when (and ov after)
  16470. (delete ov org-inline-image-overlays)
  16471. (delete-overlay ov))))
  16472. (defun org-remove-inline-images ()
  16473. "Remove inline display of images."
  16474. (interactive)
  16475. (mapc 'delete-overlay org-inline-image-overlays)
  16476. (setq org-inline-image-overlays nil))
  16477. ;;;; Key bindings
  16478. ;; Outline functions from `outline-mode-prefix-map'
  16479. ;; that can be remapped in Org:
  16480. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  16481. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  16482. (define-key org-mode-map [remap outline-forward-same-level]
  16483. 'org-forward-heading-same-level)
  16484. (define-key org-mode-map [remap outline-backward-same-level]
  16485. 'org-backward-heading-same-level)
  16486. (define-key org-mode-map [remap show-branches]
  16487. 'org-kill-note-or-show-branches)
  16488. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  16489. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  16490. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  16491. ;; Outline functions from `outline-mode-prefix-map' that can not
  16492. ;; be remapped in Org:
  16493. ;;
  16494. ;; - the column "key binding" shows whether the Outline function is still
  16495. ;; available in Org mode on the same key that it has been bound to in
  16496. ;; Outline mode:
  16497. ;; - "overridden": key used for a different functionality in Org mode
  16498. ;; - else: key still bound to the same Outline function in Org mode
  16499. ;;
  16500. ;; | Outline function | key binding | Org replacement |
  16501. ;; |------------------------------------+-------------+-----------------------|
  16502. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  16503. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  16504. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  16505. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  16506. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  16507. ;; | `show-entry' | overridden | no replacement |
  16508. ;; | `show-children' | `C-c C-i' | visibility cycling |
  16509. ;; | `show-branches' | `C-c C-k' | still same function |
  16510. ;; | `show-subtree' | overridden | visibility cycling |
  16511. ;; | `show-all' | overridden | no replacement |
  16512. ;; | `hide-subtree' | overridden | visibility cycling |
  16513. ;; | `hide-body' | overridden | no replacement |
  16514. ;; | `hide-entry' | overridden | visibility cycling |
  16515. ;; | `hide-leaves' | overridden | no replacement |
  16516. ;; | `hide-sublevels' | overridden | no replacement |
  16517. ;; | `hide-other' | overridden | no replacement |
  16518. ;; Make `C-c C-x' a prefix key
  16519. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  16520. ;; TAB key with modifiers
  16521. (org-defkey org-mode-map "\C-i" 'org-cycle)
  16522. (org-defkey org-mode-map [(tab)] 'org-cycle)
  16523. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  16524. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  16525. ;; The following line is necessary under Suse GNU/Linux
  16526. (unless (featurep 'xemacs)
  16527. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  16528. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  16529. (define-key org-mode-map [backtab] 'org-shifttab)
  16530. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  16531. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  16532. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  16533. ;; Cursor keys with modifiers
  16534. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  16535. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  16536. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  16537. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  16538. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  16539. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  16540. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  16541. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  16542. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  16543. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  16544. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  16545. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  16546. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  16547. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  16548. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  16549. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  16550. ;; Babel keys
  16551. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  16552. (mapc (lambda (pair)
  16553. (define-key org-babel-map (car pair) (cdr pair)))
  16554. org-babel-key-bindings)
  16555. ;;; Extra keys for tty access.
  16556. ;; We only set them when really needed because otherwise the
  16557. ;; menus don't show the simple keys
  16558. (when (or org-use-extra-keys
  16559. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  16560. (not window-system))
  16561. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  16562. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  16563. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  16564. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  16565. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  16566. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  16567. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  16568. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  16569. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  16570. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  16571. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  16572. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  16573. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  16574. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  16575. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  16576. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  16577. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  16578. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  16579. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  16580. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  16581. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  16582. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  16583. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  16584. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  16585. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  16586. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  16587. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  16588. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  16589. ;; All the other keys
  16590. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  16591. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  16592. (if (boundp 'narrow-map)
  16593. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  16594. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  16595. (if (boundp 'narrow-map)
  16596. (org-defkey narrow-map "b" 'org-narrow-to-block)
  16597. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  16598. (if (boundp 'narrow-map)
  16599. (org-defkey narrow-map "e" 'org-narrow-to-element)
  16600. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  16601. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  16602. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  16603. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  16604. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  16605. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  16606. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  16607. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  16608. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  16609. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  16610. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  16611. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  16612. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  16613. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  16614. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  16615. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  16616. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  16617. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  16618. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  16619. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  16620. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  16621. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  16622. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  16623. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  16624. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  16625. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  16626. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  16627. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  16628. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  16629. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  16630. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  16631. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  16632. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  16633. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  16634. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  16635. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  16636. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  16637. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  16638. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  16639. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  16640. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  16641. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  16642. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  16643. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  16644. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  16645. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  16646. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  16647. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  16648. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  16649. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  16650. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  16651. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  16652. (org-defkey org-mode-map "\C-c^" 'org-sort)
  16653. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  16654. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  16655. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  16656. (org-defkey org-mode-map "\C-m" 'org-return)
  16657. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  16658. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  16659. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  16660. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  16661. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  16662. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  16663. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  16664. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  16665. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  16666. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  16667. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  16668. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  16669. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  16670. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  16671. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  16672. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  16673. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  16674. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  16675. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  16676. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  16677. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  16678. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  16679. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  16680. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  16681. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  16682. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  16683. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  16684. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  16685. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  16686. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  16687. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  16688. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  16689. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  16690. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  16691. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  16692. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  16693. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  16694. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  16695. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  16696. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  16697. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  16698. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  16699. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  16700. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  16701. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  16702. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  16703. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  16704. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  16705. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  16706. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  16707. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  16708. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  16709. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  16710. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  16711. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  16712. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  16713. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  16714. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  16715. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  16716. (when (featurep 'xemacs)
  16717. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  16718. (defconst org-speed-commands-default
  16719. '(
  16720. ("Outline Navigation")
  16721. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  16722. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  16723. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  16724. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  16725. ("u" . (org-speed-move-safe 'outline-up-heading))
  16726. ("j" . org-goto)
  16727. ("g" . (org-refile t))
  16728. ("Outline Visibility")
  16729. ("c" . org-cycle)
  16730. ("C" . org-shifttab)
  16731. (" " . org-display-outline-path)
  16732. (":" . org-columns)
  16733. ("Outline Structure Editing")
  16734. ("U" . org-shiftmetaup)
  16735. ("D" . org-shiftmetadown)
  16736. ("r" . org-metaright)
  16737. ("l" . org-metaleft)
  16738. ("R" . org-shiftmetaright)
  16739. ("L" . org-shiftmetaleft)
  16740. ("i" . (progn (forward-char 1) (call-interactively
  16741. 'org-insert-heading-respect-content)))
  16742. ("^" . org-sort)
  16743. ("w" . org-refile)
  16744. ("a" . org-archive-subtree-default-with-confirmation)
  16745. ("." . org-mark-subtree)
  16746. ("#" . org-toggle-comment)
  16747. ("Clock Commands")
  16748. ("I" . org-clock-in)
  16749. ("O" . org-clock-out)
  16750. ("Meta Data Editing")
  16751. ("t" . org-todo)
  16752. ("0" . (org-priority ?\ ))
  16753. ("1" . (org-priority ?A))
  16754. ("2" . (org-priority ?B))
  16755. ("3" . (org-priority ?C))
  16756. (";" . org-set-tags-command)
  16757. ("e" . org-set-effort)
  16758. ("E" . org-inc-effort)
  16759. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  16760. (org-entry-put (point) "APPT_WARNTIME" m)))
  16761. ("Agenda Views etc")
  16762. ("v" . org-agenda)
  16763. ("/" . org-sparse-tree)
  16764. ("Misc")
  16765. ("o" . org-open-at-point)
  16766. ("?" . org-speed-command-help)
  16767. ("<" . (org-agenda-set-restriction-lock 'subtree))
  16768. (">" . (org-agenda-remove-restriction-lock))
  16769. )
  16770. "The default speed commands.")
  16771. (defun org-print-speed-command (e)
  16772. (if (> (length (car e)) 1)
  16773. (progn
  16774. (princ "\n")
  16775. (princ (car e))
  16776. (princ "\n")
  16777. (princ (make-string (length (car e)) ?-))
  16778. (princ "\n"))
  16779. (princ (car e))
  16780. (princ " ")
  16781. (if (symbolp (cdr e))
  16782. (princ (symbol-name (cdr e)))
  16783. (prin1 (cdr e)))
  16784. (princ "\n")))
  16785. (defun org-speed-command-help ()
  16786. "Show the available speed commands."
  16787. (interactive)
  16788. (if (not org-use-speed-commands)
  16789. (error "Speed commands are not activated, customize `org-use-speed-commands'")
  16790. (with-output-to-temp-buffer "*Help*"
  16791. (princ "User-defined Speed commands\n===========================\n")
  16792. (mapc 'org-print-speed-command org-speed-commands-user)
  16793. (princ "\n")
  16794. (princ "Built-in Speed commands\n=======================\n")
  16795. (mapc 'org-print-speed-command org-speed-commands-default))
  16796. (with-current-buffer "*Help*"
  16797. (setq truncate-lines t))))
  16798. (defun org-speed-move-safe (cmd)
  16799. "Execute CMD, but make sure that the cursor always ends up in a headline.
  16800. If not, return to the original position and throw an error."
  16801. (interactive)
  16802. (let ((pos (point)))
  16803. (call-interactively cmd)
  16804. (unless (and (bolp) (org-at-heading-p))
  16805. (goto-char pos)
  16806. (error "Boundary reached while executing %s" cmd))))
  16807. (defvar org-self-insert-command-undo-counter 0)
  16808. (defvar org-table-auto-blank-field) ; defined in org-table.el
  16809. (defvar org-speed-command nil)
  16810. (defun org-speed-command-default-hook (keys)
  16811. "Hook for activating single-letter speed commands.
  16812. `org-speed-commands-default' specifies a minimal command set.
  16813. Use `org-speed-commands-user' for further customization."
  16814. (when (or (and (bolp) (looking-at org-outline-regexp))
  16815. (and (functionp org-use-speed-commands)
  16816. (funcall org-use-speed-commands)))
  16817. (cdr (assoc keys (append org-speed-commands-user
  16818. org-speed-commands-default)))))
  16819. (defun org-babel-speed-command-hook (keys)
  16820. "Hook for activating single-letter code block commands."
  16821. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  16822. (cdr (assoc keys org-babel-key-bindings))))
  16823. (defcustom org-speed-command-hook
  16824. '(org-speed-command-default-hook org-babel-speed-command-hook)
  16825. "Hook for activating speed commands at strategic locations.
  16826. Hook functions are called in sequence until a valid handler is
  16827. found.
  16828. Each hook takes a single argument, a user-pressed command key
  16829. which is also a `self-insert-command' from the global map.
  16830. Within the hook, examine the cursor position and the command key
  16831. and return nil or a valid handler as appropriate. Handler could
  16832. be one of an interactive command, a function, or a form.
  16833. Set `org-use-speed-commands' to non-nil value to enable this
  16834. hook. The default setting is `org-speed-command-default-hook'."
  16835. :group 'org-structure
  16836. :version "24.1"
  16837. :type 'hook)
  16838. (defun org-self-insert-command (N)
  16839. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  16840. If the cursor is in a table looking at whitespace, the whitespace is
  16841. overwritten, and the table is not marked as requiring realignment."
  16842. (interactive "p")
  16843. (org-check-before-invisible-edit 'insert)
  16844. (cond
  16845. ((and org-use-speed-commands
  16846. (setq org-speed-command
  16847. (run-hook-with-args-until-success
  16848. 'org-speed-command-hook (this-command-keys))))
  16849. (cond
  16850. ((commandp org-speed-command)
  16851. (setq this-command org-speed-command)
  16852. (call-interactively org-speed-command))
  16853. ((functionp org-speed-command)
  16854. (funcall org-speed-command))
  16855. ((and org-speed-command (listp org-speed-command))
  16856. (eval org-speed-command))
  16857. (t (let (org-use-speed-commands)
  16858. (call-interactively 'org-self-insert-command)))))
  16859. ((and
  16860. (org-table-p)
  16861. (progn
  16862. ;; check if we blank the field, and if that triggers align
  16863. (and (featurep 'org-table) org-table-auto-blank-field
  16864. (member last-command
  16865. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  16866. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  16867. ;; got extra space, this field does not determine column width
  16868. (let (org-table-may-need-update) (org-table-blank-field))
  16869. ;; no extra space, this field may determine column width
  16870. (org-table-blank-field)))
  16871. t)
  16872. (eq N 1)
  16873. (looking-at "[^|\n]* |"))
  16874. (let (org-table-may-need-update)
  16875. (goto-char (1- (match-end 0)))
  16876. (backward-delete-char 1)
  16877. (goto-char (match-beginning 0))
  16878. (self-insert-command N)))
  16879. (t
  16880. (setq org-table-may-need-update t)
  16881. (self-insert-command N)
  16882. (org-fix-tags-on-the-fly)
  16883. (if org-self-insert-cluster-for-undo
  16884. (if (not (eq last-command 'org-self-insert-command))
  16885. (setq org-self-insert-command-undo-counter 1)
  16886. (if (>= org-self-insert-command-undo-counter 20)
  16887. (setq org-self-insert-command-undo-counter 1)
  16888. (and (> org-self-insert-command-undo-counter 0)
  16889. buffer-undo-list (listp buffer-undo-list)
  16890. (not (cadr buffer-undo-list)) ; remove nil entry
  16891. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  16892. (setq org-self-insert-command-undo-counter
  16893. (1+ org-self-insert-command-undo-counter))))))))
  16894. (defun org-check-before-invisible-edit (kind)
  16895. "Check is editing if kind KIND would be dangerous with invisible text around.
  16896. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  16897. ;; First, try to get out of here as quickly as possible, to reduce overhead
  16898. (if (and org-catch-invisible-edits
  16899. (or (not (boundp 'visible-mode)) (not visible-mode))
  16900. (or (get-char-property (point) 'invisible)
  16901. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  16902. ;; OK, we need to take a closer look
  16903. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  16904. (invisible-before-point (if (bobp) nil (get-char-property
  16905. (1- (point)) 'invisible)))
  16906. (border-and-ok-direction
  16907. (or
  16908. ;; Check if we are acting predictably before invisible text
  16909. (and invisible-at-point (not invisible-before-point)
  16910. (memq kind '(insert delete-backward)))
  16911. ;; Check if we are acting predictably after invisible text
  16912. ;; This works not well, and I have turned it off. It seems
  16913. ;; better to always show and stop after invisible text.
  16914. ;; (and (not invisible-at-point) invisible-before-point
  16915. ;; (memq kind '(insert delete)))
  16916. )))
  16917. (when (or (memq invisible-at-point '(outline org-hide-block t))
  16918. (memq invisible-before-point '(outline org-hide-block t)))
  16919. (if (eq org-catch-invisible-edits 'error)
  16920. (error "Editing in invisible areas is prohibited - make visible first"))
  16921. (if (and org-custom-properties-overlays
  16922. (y-or-n-p "Display invisible properties in this buffer? "))
  16923. (org-toggle-custom-properties-visibility)
  16924. ;; Make the area visible
  16925. (save-excursion
  16926. (if invisible-before-point
  16927. (goto-char (previous-single-char-property-change
  16928. (point) 'invisible)))
  16929. (org-cycle))
  16930. (cond
  16931. ((eq org-catch-invisible-edits 'show)
  16932. ;; That's it, we do the edit after showing
  16933. (message
  16934. "Unfolding invisible region around point before editing")
  16935. (sit-for 1))
  16936. ((and (eq org-catch-invisible-edits 'smart)
  16937. border-and-ok-direction)
  16938. (message "Unfolding invisible region around point before editing"))
  16939. (t
  16940. ;; Don't do the edit, make the user repeat it in full visibility
  16941. (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  16942. (defun org-fix-tags-on-the-fly ()
  16943. (when (and (equal (char-after (point-at-bol)) ?*)
  16944. (org-at-heading-p))
  16945. (org-align-tags-here org-tags-column)))
  16946. (defun org-delete-backward-char (N)
  16947. "Like `delete-backward-char', insert whitespace at field end in tables.
  16948. When deleting backwards, in tables this function will insert whitespace in
  16949. front of the next \"|\" separator, to keep the table aligned. The table will
  16950. still be marked for re-alignment if the field did fill the entire column,
  16951. because, in this case the deletion might narrow the column."
  16952. (interactive "p")
  16953. (org-check-before-invisible-edit 'delete-backward)
  16954. (if (and (org-table-p)
  16955. (eq N 1)
  16956. (string-match "|" (buffer-substring (point-at-bol) (point)))
  16957. (looking-at ".*?|"))
  16958. (let ((pos (point))
  16959. (noalign (looking-at "[^|\n\r]* |"))
  16960. (c org-table-may-need-update))
  16961. (backward-delete-char N)
  16962. (if (not overwrite-mode)
  16963. (progn
  16964. (skip-chars-forward "^|")
  16965. (insert " ")
  16966. (goto-char (1- pos))))
  16967. ;; noalign: if there were two spaces at the end, this field
  16968. ;; does not determine the width of the column.
  16969. (if noalign (setq org-table-may-need-update c)))
  16970. (backward-delete-char N)
  16971. (org-fix-tags-on-the-fly)))
  16972. (defun org-delete-char (N)
  16973. "Like `delete-char', but insert whitespace at field end in tables.
  16974. When deleting characters, in tables this function will insert whitespace in
  16975. front of the next \"|\" separator, to keep the table aligned. The table will
  16976. still be marked for re-alignment if the field did fill the entire column,
  16977. because, in this case the deletion might narrow the column."
  16978. (interactive "p")
  16979. (org-check-before-invisible-edit 'delete)
  16980. (if (and (org-table-p)
  16981. (not (bolp))
  16982. (not (= (char-after) ?|))
  16983. (eq N 1))
  16984. (if (looking-at ".*?|")
  16985. (let ((pos (point))
  16986. (noalign (looking-at "[^|\n\r]* |"))
  16987. (c org-table-may-need-update))
  16988. (replace-match (concat
  16989. (substring (match-string 0) 1 -1)
  16990. " |"))
  16991. (goto-char pos)
  16992. ;; noalign: if there were two spaces at the end, this field
  16993. ;; does not determine the width of the column.
  16994. (if noalign (setq org-table-may-need-update c)))
  16995. (delete-char N))
  16996. (delete-char N)
  16997. (org-fix-tags-on-the-fly)))
  16998. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  16999. (put 'org-self-insert-command 'delete-selection t)
  17000. (put 'orgtbl-self-insert-command 'delete-selection t)
  17001. (put 'org-delete-char 'delete-selection 'supersede)
  17002. (put 'org-delete-backward-char 'delete-selection 'supersede)
  17003. (put 'org-yank 'delete-selection 'yank)
  17004. ;; Make `flyspell-mode' delay after some commands
  17005. (put 'org-self-insert-command 'flyspell-delayed t)
  17006. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  17007. (put 'org-delete-char 'flyspell-delayed t)
  17008. (put 'org-delete-backward-char 'flyspell-delayed t)
  17009. ;; Make pabbrev-mode expand after org-mode commands
  17010. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  17011. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  17012. ;; How to do this: Measure non-white length of current string
  17013. ;; If equal to column width, we should realign.
  17014. (defun org-remap (map &rest commands)
  17015. "In MAP, remap the functions given in COMMANDS.
  17016. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  17017. (let (new old)
  17018. (while commands
  17019. (setq old (pop commands) new (pop commands))
  17020. (if (fboundp 'command-remapping)
  17021. (org-defkey map (vector 'remap old) new)
  17022. (substitute-key-definition old new map global-map)))))
  17023. (when (eq org-enable-table-editor 'optimized)
  17024. ;; If the user wants maximum table support, we need to hijack
  17025. ;; some standard editing functions
  17026. (org-remap org-mode-map
  17027. 'self-insert-command 'org-self-insert-command
  17028. 'delete-char 'org-delete-char
  17029. 'delete-backward-char 'org-delete-backward-char)
  17030. (org-defkey org-mode-map "|" 'org-force-self-insert))
  17031. (defvar org-ctrl-c-ctrl-c-hook nil
  17032. "Hook for functions attaching themselves to `C-c C-c'.
  17033. This can be used to add additional functionality to the C-c C-c
  17034. key which executes context-dependent commands. This hook is run
  17035. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  17036. run after the last test.
  17037. Each function will be called with no arguments. The function
  17038. must check if the context is appropriate for it to act. If yes,
  17039. it should do its thing and then return a non-nil value. If the
  17040. context is wrong, just do nothing and return nil.")
  17041. (defvar org-ctrl-c-ctrl-c-final-hook nil
  17042. "Hook for functions attaching themselves to `C-c C-c'.
  17043. This can be used to add additional functionality to the C-c C-c
  17044. key which executes context-dependent commands. This hook is run
  17045. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  17046. before the first test.
  17047. Each function will be called with no arguments. The function
  17048. must check if the context is appropriate for it to act. If yes,
  17049. it should do its thing and then return a non-nil value. If the
  17050. context is wrong, just do nothing and return nil.")
  17051. (defvar org-tab-first-hook nil
  17052. "Hook for functions to attach themselves to TAB.
  17053. See `org-ctrl-c-ctrl-c-hook' for more information.
  17054. This hook runs as the first action when TAB is pressed, even before
  17055. `org-cycle' messes around with the `outline-regexp' to cater for
  17056. inline tasks and plain list item folding.
  17057. If any function in this hook returns t, any other actions that
  17058. would have been caused by TAB (such as table field motion or visibility
  17059. cycling) will not occur.")
  17060. (defvar org-tab-after-check-for-table-hook nil
  17061. "Hook for functions to attach themselves to TAB.
  17062. See `org-ctrl-c-ctrl-c-hook' for more information.
  17063. This hook runs after it has been established that the cursor is not in a
  17064. table, but before checking if the cursor is in a headline or if global cycling
  17065. should be done.
  17066. If any function in this hook returns t, not other actions like visibility
  17067. cycling will be done.")
  17068. (defvar org-tab-after-check-for-cycling-hook nil
  17069. "Hook for functions to attach themselves to TAB.
  17070. See `org-ctrl-c-ctrl-c-hook' for more information.
  17071. This hook runs after it has been established that not table field motion and
  17072. not visibility should be done because of current context. This is probably
  17073. the place where a package like yasnippets can hook in.")
  17074. (defvar org-tab-before-tab-emulation-hook nil
  17075. "Hook for functions to attach themselves to TAB.
  17076. See `org-ctrl-c-ctrl-c-hook' for more information.
  17077. This hook runs after every other options for TAB have been exhausted, but
  17078. before indentation and \t insertion takes place.")
  17079. (defvar org-metaleft-hook nil
  17080. "Hook for functions attaching themselves to `M-left'.
  17081. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17082. (defvar org-metaright-hook nil
  17083. "Hook for functions attaching themselves to `M-right'.
  17084. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17085. (defvar org-metaup-hook nil
  17086. "Hook for functions attaching themselves to `M-up'.
  17087. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17088. (defvar org-metadown-hook nil
  17089. "Hook for functions attaching themselves to `M-down'.
  17090. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17091. (defvar org-shiftmetaleft-hook nil
  17092. "Hook for functions attaching themselves to `M-S-left'.
  17093. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17094. (defvar org-shiftmetaright-hook nil
  17095. "Hook for functions attaching themselves to `M-S-right'.
  17096. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17097. (defvar org-shiftmetaup-hook nil
  17098. "Hook for functions attaching themselves to `M-S-up'.
  17099. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17100. (defvar org-shiftmetadown-hook nil
  17101. "Hook for functions attaching themselves to `M-S-down'.
  17102. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17103. (defvar org-metareturn-hook nil
  17104. "Hook for functions attaching themselves to `M-RET'.
  17105. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17106. (defvar org-shiftup-hook nil
  17107. "Hook for functions attaching themselves to `S-up'.
  17108. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17109. (defvar org-shiftup-final-hook nil
  17110. "Hook for functions attaching themselves to `S-up'.
  17111. This one runs after all other options except shift-select have been excluded.
  17112. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17113. (defvar org-shiftdown-hook nil
  17114. "Hook for functions attaching themselves to `S-down'.
  17115. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17116. (defvar org-shiftdown-final-hook nil
  17117. "Hook for functions attaching themselves to `S-down'.
  17118. This one runs after all other options except shift-select have been excluded.
  17119. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17120. (defvar org-shiftleft-hook nil
  17121. "Hook for functions attaching themselves to `S-left'.
  17122. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17123. (defvar org-shiftleft-final-hook nil
  17124. "Hook for functions attaching themselves to `S-left'.
  17125. This one runs after all other options except shift-select have been excluded.
  17126. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17127. (defvar org-shiftright-hook nil
  17128. "Hook for functions attaching themselves to `S-right'.
  17129. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17130. (defvar org-shiftright-final-hook nil
  17131. "Hook for functions attaching themselves to `S-right'.
  17132. This one runs after all other options except shift-select have been excluded.
  17133. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17134. (defun org-modifier-cursor-error ()
  17135. "Throw an error, a modified cursor command was applied in wrong context."
  17136. (error "This command is active in special context like tables, headlines or items"))
  17137. (defun org-shiftselect-error ()
  17138. "Throw an error because Shift-Cursor command was applied in wrong context."
  17139. (if (and (boundp 'shift-select-mode) shift-select-mode)
  17140. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  17141. (error "This command works only in special context like headlines or timestamps")))
  17142. (defun org-call-for-shift-select (cmd)
  17143. (let ((this-command-keys-shift-translated t))
  17144. (call-interactively cmd)))
  17145. (defun org-shifttab (&optional arg)
  17146. "Global visibility cycling or move to previous table field.
  17147. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  17148. on context.
  17149. See the individual commands for more information."
  17150. (interactive "P")
  17151. (cond
  17152. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  17153. ((integerp arg)
  17154. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  17155. (message "Content view to level: %d" arg)
  17156. (org-content (prefix-numeric-value arg2))
  17157. (setq org-cycle-global-status 'overview)))
  17158. (t (call-interactively 'org-global-cycle))))
  17159. (defun org-shiftmetaleft ()
  17160. "Promote subtree or delete table column.
  17161. Calls `org-promote-subtree', `org-outdent-item-tree', or
  17162. `org-table-delete-column', depending on context. See the
  17163. individual commands for more information."
  17164. (interactive)
  17165. (cond
  17166. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  17167. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  17168. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  17169. ((if (not (org-region-active-p)) (org-at-item-p)
  17170. (save-excursion (goto-char (region-beginning))
  17171. (org-at-item-p)))
  17172. (call-interactively 'org-outdent-item-tree))
  17173. (t (org-modifier-cursor-error))))
  17174. (defun org-shiftmetaright ()
  17175. "Demote subtree or insert table column.
  17176. Calls `org-demote-subtree', `org-indent-item-tree', or
  17177. `org-table-insert-column', depending on context. See the
  17178. individual commands for more information."
  17179. (interactive)
  17180. (cond
  17181. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  17182. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  17183. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  17184. ((if (not (org-region-active-p)) (org-at-item-p)
  17185. (save-excursion (goto-char (region-beginning))
  17186. (org-at-item-p)))
  17187. (call-interactively 'org-indent-item-tree))
  17188. (t (org-modifier-cursor-error))))
  17189. (defun org-shiftmetaup (&optional arg)
  17190. "Move subtree up or kill table row.
  17191. Calls `org-move-subtree-up' or `org-table-kill-row' or
  17192. `org-move-item-up' or `org-timestamp-up', depending on context.
  17193. See the individual commands for more information."
  17194. (interactive "P")
  17195. (cond
  17196. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  17197. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  17198. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17199. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17200. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17201. (call-interactively 'org-timestamp-up)))
  17202. (t (org-modifier-cursor-error))))
  17203. (defun org-shiftmetadown (&optional arg)
  17204. "Move subtree down or insert table row.
  17205. Calls `org-move-subtree-down' or `org-table-insert-row' or
  17206. `org-move-item-down' or `org-timestamp-up', depending on context.
  17207. See the individual commands for more information."
  17208. (interactive "P")
  17209. (cond
  17210. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  17211. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  17212. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17213. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17214. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17215. (call-interactively 'org-timestamp-down)))
  17216. (t (org-modifier-cursor-error))))
  17217. (defsubst org-hidden-tree-error ()
  17218. (error
  17219. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  17220. (defun org-metaleft (&optional arg)
  17221. "Promote heading or move table column to left.
  17222. Calls `org-do-promote' or `org-table-move-column', depending on context.
  17223. With no specific context, calls the Emacs default `backward-word'.
  17224. See the individual commands for more information."
  17225. (interactive "P")
  17226. (cond
  17227. ((run-hook-with-args-until-success 'org-metaleft-hook))
  17228. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  17229. ((org-with-limited-levels
  17230. (or (org-at-heading-p)
  17231. (and (org-region-active-p)
  17232. (save-excursion
  17233. (goto-char (region-beginning))
  17234. (org-at-heading-p)))))
  17235. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17236. (call-interactively 'org-do-promote))
  17237. ;; At an inline task.
  17238. ((org-at-heading-p)
  17239. (call-interactively 'org-inlinetask-promote))
  17240. ((or (org-at-item-p)
  17241. (and (org-region-active-p)
  17242. (save-excursion
  17243. (goto-char (region-beginning))
  17244. (org-at-item-p))))
  17245. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17246. (call-interactively 'org-outdent-item))
  17247. (t (call-interactively 'backward-word))))
  17248. (defun org-metaright (&optional arg)
  17249. "Demote a subtree, a list item or move table column to right.
  17250. In front of a drawer or a block keyword, indent it correctly.
  17251. With no specific context, calls the Emacs default `forward-word'.
  17252. See the individual commands for more information."
  17253. (interactive "P")
  17254. (cond
  17255. ((run-hook-with-args-until-success 'org-metaright-hook))
  17256. ((org-at-table-p) (call-interactively 'org-table-move-column))
  17257. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  17258. ((org-at-block-p) (call-interactively 'org-indent-block))
  17259. ((org-with-limited-levels
  17260. (or (org-at-heading-p)
  17261. (and (org-region-active-p)
  17262. (save-excursion
  17263. (goto-char (region-beginning))
  17264. (org-at-heading-p)))))
  17265. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17266. (call-interactively 'org-do-demote))
  17267. ;; At an inline task.
  17268. ((org-at-heading-p)
  17269. (call-interactively 'org-inlinetask-demote))
  17270. ((or (org-at-item-p)
  17271. (and (org-region-active-p)
  17272. (save-excursion
  17273. (goto-char (region-beginning))
  17274. (org-at-item-p))))
  17275. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17276. (call-interactively 'org-indent-item))
  17277. (t (call-interactively 'forward-word))))
  17278. (defun org-check-for-hidden (what)
  17279. "Check if there are hidden headlines/items in the current visual line.
  17280. WHAT can be either `headlines' or `items'. If the current line is
  17281. an outline or item heading and it has a folded subtree below it,
  17282. this function returns t, nil otherwise."
  17283. (let ((re (cond
  17284. ((eq what 'headlines) org-outline-regexp-bol)
  17285. ((eq what 'items) (org-item-beginning-re))
  17286. (t (error "This should not happen"))))
  17287. beg end)
  17288. (save-excursion
  17289. (catch 'exit
  17290. (unless (org-region-active-p)
  17291. (setq beg (point-at-bol))
  17292. (beginning-of-line 2)
  17293. (while (and (not (eobp)) ;; this is like `next-line'
  17294. (get-char-property (1- (point)) 'invisible))
  17295. (beginning-of-line 2))
  17296. (setq end (point))
  17297. (goto-char beg)
  17298. (goto-char (point-at-eol))
  17299. (setq end (max end (point)))
  17300. (while (re-search-forward re end t)
  17301. (if (get-char-property (match-beginning 0) 'invisible)
  17302. (throw 'exit t))))
  17303. nil))))
  17304. (autoload 'org-element-at-point "org-element")
  17305. (declare-function org-element-at-point "org-element" (&optional keep-trail))
  17306. (declare-function org-element-type "org-element" (element))
  17307. (declare-function org-element-contents "org-element" (element))
  17308. (declare-function org-element-property "org-element" (property element))
  17309. (declare-function org-element-paragraph-parser "org-element" (limit))
  17310. (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
  17311. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  17312. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  17313. (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
  17314. (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
  17315. (defun org-metaup (&optional arg)
  17316. "Move subtree up or move table row up.
  17317. Calls `org-move-subtree-up' or `org-table-move-row' or
  17318. `org-move-item-up', depending on context. See the individual commands
  17319. for more information."
  17320. (interactive "P")
  17321. (cond
  17322. ((run-hook-with-args-until-success 'org-metaup-hook))
  17323. ((org-region-active-p)
  17324. (let* ((a (min (region-beginning) (region-end)))
  17325. (b (1- (max (region-beginning) (region-end))))
  17326. (c (save-excursion (goto-char a)
  17327. (move-beginning-of-line 0)))
  17328. (d (save-excursion (goto-char a)
  17329. (move-end-of-line 0) (point))))
  17330. (transpose-regions a b c d)
  17331. (goto-char c)))
  17332. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  17333. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17334. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17335. (t (org-drag-element-backward))))
  17336. (defun org-metadown (&optional arg)
  17337. "Move subtree down or move table row down.
  17338. Calls `org-move-subtree-down' or `org-table-move-row' or
  17339. `org-move-item-down', depending on context. See the individual
  17340. commands for more information."
  17341. (interactive "P")
  17342. (cond
  17343. ((run-hook-with-args-until-success 'org-metadown-hook))
  17344. ((org-region-active-p)
  17345. (let* ((a (min (region-beginning) (region-end)))
  17346. (b (max (region-beginning) (region-end)))
  17347. (c (save-excursion (goto-char b)
  17348. (move-beginning-of-line 1)))
  17349. (d (save-excursion (goto-char b)
  17350. (move-end-of-line 1) (1+ (point)))))
  17351. (transpose-regions a b c d)
  17352. (goto-char d)))
  17353. ((org-at-table-p) (call-interactively 'org-table-move-row))
  17354. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17355. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17356. (t (org-drag-element-forward))))
  17357. (defun org-shiftup (&optional arg)
  17358. "Increase item in timestamp or increase priority of current headline.
  17359. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  17360. depending on context. See the individual commands for more information."
  17361. (interactive "P")
  17362. (cond
  17363. ((run-hook-with-args-until-success 'org-shiftup-hook))
  17364. ((and org-support-shift-select (org-region-active-p))
  17365. (org-call-for-shift-select 'previous-line))
  17366. ((org-at-timestamp-p t)
  17367. (call-interactively (if org-edit-timestamp-down-means-later
  17368. 'org-timestamp-down 'org-timestamp-up)))
  17369. ((and (not (eq org-support-shift-select 'always))
  17370. org-enable-priority-commands
  17371. (org-at-heading-p))
  17372. (call-interactively 'org-priority-up))
  17373. ((and (not org-support-shift-select) (org-at-item-p))
  17374. (call-interactively 'org-previous-item))
  17375. ((org-clocktable-try-shift 'up arg))
  17376. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  17377. (org-support-shift-select
  17378. (org-call-for-shift-select 'previous-line))
  17379. (t (org-shiftselect-error))))
  17380. (defun org-shiftdown (&optional arg)
  17381. "Decrease item in timestamp or decrease priority of current headline.
  17382. Calls `org-timestamp-down' or `org-priority-down', or `org-next-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-shiftdown-hook))
  17387. ((and org-support-shift-select (org-region-active-p))
  17388. (org-call-for-shift-select 'next-line))
  17389. ((org-at-timestamp-p t)
  17390. (call-interactively (if org-edit-timestamp-down-means-later
  17391. 'org-timestamp-up 'org-timestamp-down)))
  17392. ((and (not (eq org-support-shift-select 'always))
  17393. org-enable-priority-commands
  17394. (org-at-heading-p))
  17395. (call-interactively 'org-priority-down))
  17396. ((and (not org-support-shift-select) (org-at-item-p))
  17397. (call-interactively 'org-next-item))
  17398. ((org-clocktable-try-shift 'down arg))
  17399. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  17400. (org-support-shift-select
  17401. (org-call-for-shift-select 'next-line))
  17402. (t (org-shiftselect-error))))
  17403. (defun org-shiftright (&optional arg)
  17404. "Cycle the thing at point or in the current line, depending on context.
  17405. Depending on context, this does one of the following:
  17406. - switch a timestamp at point one day into the future
  17407. - on a headline, switch to the next TODO keyword.
  17408. - on an item, switch entire list to the next bullet type
  17409. - on a property line, switch to the next allowed value
  17410. - on a clocktable definition line, move time block into the future"
  17411. (interactive "P")
  17412. (cond
  17413. ((run-hook-with-args-until-success 'org-shiftright-hook))
  17414. ((and org-support-shift-select (org-region-active-p))
  17415. (org-call-for-shift-select 'forward-char))
  17416. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  17417. ((and (not (eq org-support-shift-select 'always))
  17418. (org-at-heading-p))
  17419. (let ((org-inhibit-logging
  17420. (not org-treat-S-cursor-todo-selection-as-state-change))
  17421. (org-inhibit-blocking
  17422. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17423. (org-call-with-arg 'org-todo 'right)))
  17424. ((or (and org-support-shift-select
  17425. (not (eq org-support-shift-select 'always))
  17426. (org-at-item-bullet-p))
  17427. (and (not org-support-shift-select) (org-at-item-p)))
  17428. (org-call-with-arg 'org-cycle-list-bullet nil))
  17429. ((and (not (eq org-support-shift-select 'always))
  17430. (org-at-property-p))
  17431. (call-interactively 'org-property-next-allowed-value))
  17432. ((org-clocktable-try-shift 'right arg))
  17433. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  17434. (org-support-shift-select
  17435. (org-call-for-shift-select 'forward-char))
  17436. (t (org-shiftselect-error))))
  17437. (defun org-shiftleft (&optional arg)
  17438. "Cycle the thing at point or in the current line, depending on context.
  17439. Depending on context, this does one of the following:
  17440. - switch a timestamp at point one day into the past
  17441. - on a headline, switch to the previous TODO keyword.
  17442. - on an item, switch entire list to the previous bullet type
  17443. - on a property line, switch to the previous allowed value
  17444. - on a clocktable definition line, move time block into the past"
  17445. (interactive "P")
  17446. (cond
  17447. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  17448. ((and org-support-shift-select (org-region-active-p))
  17449. (org-call-for-shift-select 'backward-char))
  17450. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  17451. ((and (not (eq org-support-shift-select 'always))
  17452. (org-at-heading-p))
  17453. (let ((org-inhibit-logging
  17454. (not org-treat-S-cursor-todo-selection-as-state-change))
  17455. (org-inhibit-blocking
  17456. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17457. (org-call-with-arg 'org-todo 'left)))
  17458. ((or (and org-support-shift-select
  17459. (not (eq org-support-shift-select 'always))
  17460. (org-at-item-bullet-p))
  17461. (and (not org-support-shift-select) (org-at-item-p)))
  17462. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  17463. ((and (not (eq org-support-shift-select 'always))
  17464. (org-at-property-p))
  17465. (call-interactively 'org-property-previous-allowed-value))
  17466. ((org-clocktable-try-shift 'left arg))
  17467. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  17468. (org-support-shift-select
  17469. (org-call-for-shift-select 'backward-char))
  17470. (t (org-shiftselect-error))))
  17471. (defun org-shiftcontrolright ()
  17472. "Switch to next TODO set."
  17473. (interactive)
  17474. (cond
  17475. ((and org-support-shift-select (org-region-active-p))
  17476. (org-call-for-shift-select 'forward-word))
  17477. ((and (not (eq org-support-shift-select 'always))
  17478. (org-at-heading-p))
  17479. (org-call-with-arg 'org-todo 'nextset))
  17480. (org-support-shift-select
  17481. (org-call-for-shift-select 'forward-word))
  17482. (t (org-shiftselect-error))))
  17483. (defun org-shiftcontrolleft ()
  17484. "Switch to previous TODO set."
  17485. (interactive)
  17486. (cond
  17487. ((and org-support-shift-select (org-region-active-p))
  17488. (org-call-for-shift-select 'backward-word))
  17489. ((and (not (eq org-support-shift-select 'always))
  17490. (org-at-heading-p))
  17491. (org-call-with-arg 'org-todo 'previousset))
  17492. (org-support-shift-select
  17493. (org-call-for-shift-select 'backward-word))
  17494. (t (org-shiftselect-error))))
  17495. (defun org-shiftcontrolup ()
  17496. "Change timestamps synchronously up in CLOCK log lines."
  17497. (interactive)
  17498. (cond ((and (not org-support-shift-select)
  17499. (org-at-clock-log-p)
  17500. (org-at-timestamp-p t))
  17501. (org-clock-timestamps-up))
  17502. (t (org-shiftselect-error))))
  17503. (defun org-shiftcontroldown ()
  17504. "Change timestamps synchronously down in CLOCK log lines."
  17505. (interactive)
  17506. (cond ((and (not org-support-shift-select)
  17507. (org-at-clock-log-p)
  17508. (org-at-timestamp-p t))
  17509. (org-clock-timestamps-down))
  17510. (t (org-shiftselect-error))))
  17511. (defun org-ctrl-c-ret ()
  17512. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  17513. (interactive)
  17514. (cond
  17515. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  17516. (t (call-interactively 'org-insert-heading))))
  17517. (defun org-find-visible ()
  17518. (let ((s (point)))
  17519. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17520. (get-char-property s 'invisible)))
  17521. s))
  17522. (defun org-find-invisible ()
  17523. (let ((s (point)))
  17524. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17525. (not (get-char-property s 'invisible))))
  17526. s))
  17527. (defun org-copy-visible (beg end)
  17528. "Copy the visible parts of the region."
  17529. (interactive "r")
  17530. (let (snippets s)
  17531. (save-excursion
  17532. (save-restriction
  17533. (narrow-to-region beg end)
  17534. (setq s (goto-char (point-min)))
  17535. (while (not (= (point) (point-max)))
  17536. (goto-char (org-find-invisible))
  17537. (push (buffer-substring s (point)) snippets)
  17538. (setq s (goto-char (org-find-visible))))))
  17539. (kill-new (apply 'concat (nreverse snippets)))))
  17540. (defun org-copy-special ()
  17541. "Copy region in table or copy current subtree.
  17542. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  17543. See the individual commands for more information."
  17544. (interactive)
  17545. (call-interactively
  17546. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  17547. (defun org-cut-special ()
  17548. "Cut region in table or cut current subtree.
  17549. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  17550. See the individual commands for more information."
  17551. (interactive)
  17552. (call-interactively
  17553. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  17554. (defun org-paste-special (arg)
  17555. "Paste rectangular region into table, or past subtree relative to level.
  17556. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  17557. See the individual commands for more information."
  17558. (interactive "P")
  17559. (if (org-at-table-p)
  17560. (org-table-paste-rectangle)
  17561. (org-paste-subtree arg)))
  17562. (defun org-edit-special (&optional arg)
  17563. "Call a special editor for the stuff at point.
  17564. When at a table, call the formula editor with `org-table-edit-formulas'.
  17565. When at the first line of an src example, call `org-edit-src-code'.
  17566. When in an #+include line, visit the include file. Otherwise call
  17567. `ffap' to visit the file at point."
  17568. (interactive)
  17569. ;; possibly prep session before editing source
  17570. (when arg
  17571. (let* ((info (org-babel-get-src-block-info))
  17572. (lang (nth 0 info))
  17573. (params (nth 2 info))
  17574. (session (cdr (assoc :session params))))
  17575. (when (and info session) ;; we are in a source-code block with a session
  17576. (funcall
  17577. (intern (concat "org-babel-prep-session:" lang)) session params))))
  17578. (cond ;; proceed with `org-edit-special'
  17579. ((save-excursion
  17580. (beginning-of-line 1)
  17581. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  17582. (find-file (org-trim (match-string 1))))
  17583. ((org-edit-src-code))
  17584. ((org-edit-fixed-width-region))
  17585. ((org-at-table.el-p)
  17586. (org-edit-src-code))
  17587. ((or (org-at-table-p)
  17588. (save-excursion
  17589. (beginning-of-line 1)
  17590. (let ((case-fold-search )) (looking-at "[ \t]*#\\+tblfm:"))))
  17591. (call-interactively 'org-table-edit-formulas))
  17592. (t (call-interactively 'ffap))))
  17593. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  17594. (defun org-ctrl-c-ctrl-c (&optional arg)
  17595. "Set tags in headline, or update according to changed information at point.
  17596. This command does many different things, depending on context:
  17597. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  17598. this is what we do.
  17599. - If the cursor is on a statistics cookie, update it.
  17600. - If the cursor is in a headline, prompt for tags and insert them
  17601. into the current line, aligned to `org-tags-column'. When called
  17602. with prefix arg, realign all tags in the current buffer.
  17603. - If the cursor is in one of the special #+KEYWORD lines, this
  17604. triggers scanning the buffer for these lines and updating the
  17605. information.
  17606. - If the cursor is inside a table, realign the table. This command
  17607. works even if the automatic table editor has been turned off.
  17608. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  17609. the entire table.
  17610. - If the cursor is at a footnote reference or definition, jump to
  17611. the corresponding definition or references, respectively.
  17612. - If the cursor is a the beginning of a dynamic block, update it.
  17613. - If the current buffer is a capture buffer, close note and file it.
  17614. - If the cursor is on a <<<target>>>, update radio targets and
  17615. corresponding links in this buffer.
  17616. - If the cursor is on a numbered item in a plain list, renumber the
  17617. ordered list.
  17618. - If the cursor is on a checkbox, toggle it.
  17619. - If the cursor is on a code block, evaluate it. The variable
  17620. `org-confirm-babel-evaluate' can be used to control prompting
  17621. before code block evaluation, by default every code block
  17622. evaluation requires confirmation. Code block evaluation can be
  17623. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  17624. (interactive "P")
  17625. (let ((org-enable-table-editor t))
  17626. (cond
  17627. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  17628. org-occur-highlights
  17629. org-latex-fragment-image-overlays)
  17630. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  17631. (org-remove-occur-highlights)
  17632. (org-remove-latex-fragment-image-overlays)
  17633. (message "Temporary highlights/overlays removed from current buffer"))
  17634. ((and (local-variable-p 'org-finish-function (current-buffer))
  17635. (fboundp org-finish-function))
  17636. (funcall org-finish-function))
  17637. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  17638. ((org-in-regexp org-ts-regexp-both)
  17639. (org-timestamp-change 0 'day))
  17640. ((or (looking-at org-property-start-re)
  17641. (org-at-property-p))
  17642. (call-interactively 'org-property-action))
  17643. ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
  17644. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  17645. (or (org-at-heading-p) (org-at-item-p)))
  17646. (call-interactively 'org-update-statistics-cookies))
  17647. ((org-at-heading-p) (call-interactively 'org-set-tags))
  17648. ((org-at-table.el-p)
  17649. (message "Use C-c ' to edit table.el tables"))
  17650. ((org-at-table-p)
  17651. (org-table-maybe-eval-formula)
  17652. (if arg
  17653. (call-interactively 'org-table-recalculate)
  17654. (org-table-maybe-recalculate-line))
  17655. (call-interactively 'org-table-align)
  17656. (orgtbl-send-table 'maybe))
  17657. ((or (org-footnote-at-reference-p)
  17658. (org-footnote-at-definition-p))
  17659. (call-interactively 'org-footnote-action))
  17660. ((org-at-item-checkbox-p)
  17661. ;; Cursor at a checkbox: repair list and update checkboxes. Send
  17662. ;; list only if at top item.
  17663. (let* ((cbox (match-string 1))
  17664. (struct (org-list-struct))
  17665. (old-struct (copy-tree struct))
  17666. (parents (org-list-parents-alist struct))
  17667. (orderedp (org-entry-get nil "ORDERED"))
  17668. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17669. block-item)
  17670. ;; Use a light version of `org-toggle-checkbox' to avoid
  17671. ;; computing list structure twice.
  17672. (let ((new-box (cond
  17673. ((equal arg '(16)) "[-]")
  17674. ((equal arg '(4)) nil)
  17675. ((equal "[X]" cbox) "[ ]")
  17676. (t "[X]"))))
  17677. (if (and firstp arg)
  17678. ;; If at first item of sub-list, remove check-box from
  17679. ;; every item at the same level.
  17680. (mapc
  17681. (lambda (pos) (org-list-set-checkbox pos struct new-box))
  17682. (org-list-get-all-items
  17683. (point-at-bol) struct (org-list-prevs-alist struct)))
  17684. (org-list-set-checkbox (point-at-bol) struct new-box)))
  17685. ;; Replicate `org-list-write-struct', while grabbing a return
  17686. ;; value from `org-list-struct-fix-box'.
  17687. (org-list-struct-fix-ind struct parents 2)
  17688. (org-list-struct-fix-item-end struct)
  17689. (let ((prevs (org-list-prevs-alist struct)))
  17690. (org-list-struct-fix-bul struct prevs)
  17691. (org-list-struct-fix-ind struct parents)
  17692. (setq block-item
  17693. (org-list-struct-fix-box struct parents prevs orderedp)))
  17694. (org-list-struct-apply-struct struct old-struct)
  17695. (org-update-checkbox-count-maybe)
  17696. (when block-item
  17697. (message
  17698. "Checkboxes were removed due to unchecked box at line %d"
  17699. (org-current-line block-item)))
  17700. (when firstp (org-list-send-list 'maybe))))
  17701. ((org-at-item-p)
  17702. ;; Cursor at an item: repair list. Do checkbox related actions
  17703. ;; only if function was called with an argument. Send list only
  17704. ;; if at top item.
  17705. (let* ((struct (org-list-struct))
  17706. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17707. old-struct)
  17708. (when arg
  17709. (setq old-struct (copy-tree struct))
  17710. (if firstp
  17711. ;; If at first item of sub-list, add check-box to every
  17712. ;; item at the same level.
  17713. (mapc
  17714. (lambda (pos)
  17715. (unless (org-list-get-checkbox pos struct)
  17716. (org-list-set-checkbox pos struct "[ ]")))
  17717. (org-list-get-all-items
  17718. (point-at-bol) struct (org-list-prevs-alist struct)))
  17719. (org-list-set-checkbox (point-at-bol) struct "[ ]")))
  17720. (org-list-write-struct
  17721. struct (org-list-parents-alist struct) old-struct)
  17722. (when arg (org-update-checkbox-count-maybe))
  17723. (when firstp (org-list-send-list 'maybe))))
  17724. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  17725. ;; Dynamic block
  17726. (beginning-of-line 1)
  17727. (save-excursion (org-update-dblock)))
  17728. ((save-excursion
  17729. (let ((case-fold-search t))
  17730. (beginning-of-line 1)
  17731. (looking-at "[ \t]*#\\+\\([a-z]+\\)")))
  17732. (cond
  17733. ((or (equal (match-string 1) "TBLFM")
  17734. (equal (match-string 1) "tblfm"))
  17735. ;; Recalculate the table before this line
  17736. (save-excursion
  17737. (beginning-of-line 1)
  17738. (skip-chars-backward " \r\n\t")
  17739. (if (org-at-table-p)
  17740. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  17741. (t
  17742. (let ((org-inhibit-startup-visibility-stuff t)
  17743. (org-startup-align-all-tables nil))
  17744. (when (boundp 'org-table-coordinate-overlays)
  17745. (mapc 'delete-overlay org-table-coordinate-overlays)
  17746. (setq org-table-coordinate-overlays nil))
  17747. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  17748. (message "Local setup has been refreshed"))))
  17749. ((org-clock-update-time-maybe))
  17750. (t
  17751. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  17752. (error "C-c C-c can do nothing useful at this location"))))))
  17753. (defun org-mode-restart ()
  17754. "Restart Org-mode, to scan again for special lines.
  17755. Also updates the keyword regular expressions."
  17756. (interactive)
  17757. (org-mode)
  17758. (message "Org-mode restarted"))
  17759. (defun org-kill-note-or-show-branches ()
  17760. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  17761. (interactive)
  17762. (if (not org-finish-function)
  17763. (progn
  17764. (hide-subtree)
  17765. (call-interactively 'show-branches))
  17766. (let ((org-note-abort t))
  17767. (funcall org-finish-function))))
  17768. (defun org-return (&optional indent)
  17769. "Goto next table row or insert a newline.
  17770. Calls `org-table-next-row' or `newline', depending on context.
  17771. See the individual commands for more information."
  17772. (interactive)
  17773. (let (org-ts-what)
  17774. (cond
  17775. ((or (bobp) (org-in-src-block-p))
  17776. (if indent (newline-and-indent) (newline)))
  17777. ((org-at-table-p)
  17778. (org-table-justify-field-maybe)
  17779. (call-interactively 'org-table-next-row))
  17780. ;; when `newline-and-indent' is called within a list, make sure
  17781. ;; text moved stays inside the item.
  17782. ((and (org-in-item-p) indent)
  17783. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  17784. (progn
  17785. (save-match-data (newline))
  17786. (org-indent-line-to (length (match-string 0))))
  17787. (let ((ind (org-get-indentation)))
  17788. (newline)
  17789. (if (org-looking-back org-list-end-re)
  17790. (org-indent-line)
  17791. (org-indent-line-to ind)))))
  17792. ((and org-return-follows-link
  17793. (org-at-timestamp-p t)
  17794. (not (eq org-ts-what 'after)))
  17795. (org-follow-timestamp-link))
  17796. ((and org-return-follows-link
  17797. (let ((tprop (get-text-property (point) 'face)))
  17798. (or (eq tprop 'org-link)
  17799. (and (listp tprop) (memq 'org-link tprop)))))
  17800. (call-interactively 'org-open-at-point))
  17801. ((and (org-at-heading-p)
  17802. (looking-at
  17803. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  17804. (org-show-entry)
  17805. (end-of-line 1)
  17806. (newline))
  17807. (t (if indent (newline-and-indent) (newline))))))
  17808. (defun org-return-indent ()
  17809. "Goto next table row or insert a newline and indent.
  17810. Calls `org-table-next-row' or `newline-and-indent', depending on
  17811. context. See the individual commands for more information."
  17812. (interactive)
  17813. (org-return t))
  17814. (defun org-ctrl-c-star ()
  17815. "Compute table, or change heading status of lines.
  17816. Calls `org-table-recalculate' or `org-toggle-heading',
  17817. depending on context."
  17818. (interactive)
  17819. (cond
  17820. ((org-at-table-p)
  17821. (call-interactively 'org-table-recalculate))
  17822. (t
  17823. ;; Convert all lines in region to list items
  17824. (call-interactively 'org-toggle-heading))))
  17825. (defun org-ctrl-c-minus ()
  17826. "Insert separator line in table or modify bullet status of line.
  17827. Also turns a plain line or a region of lines into list items.
  17828. Calls `org-table-insert-hline', `org-toggle-item', or
  17829. `org-cycle-list-bullet', depending on context."
  17830. (interactive)
  17831. (cond
  17832. ((org-at-table-p)
  17833. (call-interactively 'org-table-insert-hline))
  17834. ((org-region-active-p)
  17835. (call-interactively 'org-toggle-item))
  17836. ((org-in-item-p)
  17837. (call-interactively 'org-cycle-list-bullet))
  17838. (t
  17839. (call-interactively 'org-toggle-item))))
  17840. (defun org-toggle-item (arg)
  17841. "Convert headings or normal lines to items, items to normal lines.
  17842. If there is no active region, only the current line is considered.
  17843. If the first non blank line in the region is an headline, convert
  17844. all headlines to items, shifting text accordingly.
  17845. If it is an item, convert all items to normal lines.
  17846. If it is normal text, change region into an item. With a prefix
  17847. argument ARG, change each line in region into an item."
  17848. (interactive "P")
  17849. (let ((shift-text
  17850. (function
  17851. ;; Shift text in current section to IND, from point to END.
  17852. ;; The function leaves point to END line.
  17853. (lambda (ind end)
  17854. (let ((min-i 1000) (end (copy-marker end)))
  17855. ;; First determine the minimum indentation (MIN-I) of
  17856. ;; the text.
  17857. (save-excursion
  17858. (catch 'exit
  17859. (while (< (point) end)
  17860. (let ((i (org-get-indentation)))
  17861. (cond
  17862. ;; Skip blank lines and inline tasks.
  17863. ((looking-at "^[ \t]*$"))
  17864. ((looking-at org-outline-regexp-bol))
  17865. ;; We can't find less than 0 indentation.
  17866. ((zerop i) (throw 'exit (setq min-i 0)))
  17867. ((< i min-i) (setq min-i i))))
  17868. (forward-line))))
  17869. ;; Then indent each line so that a line indented to
  17870. ;; MIN-I becomes indented to IND. Ignore blank lines
  17871. ;; and inline tasks in the process.
  17872. (let ((delta (- ind min-i)))
  17873. (while (< (point) end)
  17874. (unless (or (looking-at "^[ \t]*$")
  17875. (looking-at org-outline-regexp-bol))
  17876. (org-indent-line-to (+ (org-get-indentation) delta)))
  17877. (forward-line)))))))
  17878. (skip-blanks
  17879. (function
  17880. ;; Return beginning of first non-blank line, starting from
  17881. ;; line at POS.
  17882. (lambda (pos)
  17883. (save-excursion
  17884. (goto-char pos)
  17885. (skip-chars-forward " \r\t\n")
  17886. (point-at-bol)))))
  17887. beg end)
  17888. ;; Determine boundaries of changes.
  17889. (if (org-region-active-p)
  17890. (setq beg (funcall skip-blanks (region-beginning))
  17891. end (copy-marker (region-end)))
  17892. (setq beg (funcall skip-blanks (point-at-bol))
  17893. end (copy-marker (point-at-eol))))
  17894. ;; Depending on the starting line, choose an action on the text
  17895. ;; between BEG and END.
  17896. (org-with-limited-levels
  17897. (save-excursion
  17898. (goto-char beg)
  17899. (cond
  17900. ;; Case 1. Start at an item: de-itemize. Note that it only
  17901. ;; happens when a region is active: `org-ctrl-c-minus'
  17902. ;; would call `org-cycle-list-bullet' otherwise.
  17903. ((org-at-item-p)
  17904. (while (< (point) end)
  17905. (when (org-at-item-p)
  17906. (skip-chars-forward " \t")
  17907. (delete-region (point) (match-end 0)))
  17908. (forward-line)))
  17909. ;; Case 2. Start at an heading: convert to items.
  17910. ((org-at-heading-p)
  17911. (let* ((bul (org-list-bullet-string "-"))
  17912. (bul-len (length bul))
  17913. ;; Indentation of the first heading. It should be
  17914. ;; relative to the indentation of its parent, if any.
  17915. (start-ind (save-excursion
  17916. (cond
  17917. ((not org-adapt-indentation) 0)
  17918. ((not (outline-previous-heading)) 0)
  17919. (t (length (match-string 0))))))
  17920. ;; Level of first heading. Further headings will be
  17921. ;; compared to it to determine hierarchy in the list.
  17922. (ref-level (org-reduced-level (org-outline-level))))
  17923. (while (< (point) end)
  17924. (let* ((level (org-reduced-level (org-outline-level)))
  17925. (delta (max 0 (- level ref-level))))
  17926. ;; If current headline is less indented than the first
  17927. ;; one, set it as reference, in order to preserve
  17928. ;; subtrees.
  17929. (when (< level ref-level) (setq ref-level level))
  17930. (replace-match bul t t)
  17931. (org-indent-line-to (+ start-ind (* delta bul-len)))
  17932. ;; Ensure all text down to END (or SECTION-END) belongs
  17933. ;; to the newly created item.
  17934. (let ((section-end (save-excursion
  17935. (or (outline-next-heading) (point)))))
  17936. (forward-line)
  17937. (funcall shift-text
  17938. (+ start-ind (* (1+ delta) bul-len))
  17939. (min end section-end)))))))
  17940. ;; Case 3. Normal line with ARG: turn each non-item line into
  17941. ;; an item.
  17942. (arg
  17943. (while (< (point) end)
  17944. (unless (or (org-at-heading-p) (org-at-item-p))
  17945. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  17946. (replace-match
  17947. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  17948. (forward-line)))
  17949. ;; Case 4. Normal line without ARG: make the first line of
  17950. ;; region an item, and shift indentation of others
  17951. ;; lines to set them as item's body.
  17952. (t (let* ((bul (org-list-bullet-string "-"))
  17953. (bul-len (length bul))
  17954. (ref-ind (org-get-indentation)))
  17955. (skip-chars-forward " \t")
  17956. (insert bul)
  17957. (forward-line)
  17958. (while (< (point) end)
  17959. ;; Ensure that lines less indented than first one
  17960. ;; still get included in item body.
  17961. (funcall shift-text
  17962. (+ ref-ind bul-len)
  17963. (min end (save-excursion (or (outline-next-heading)
  17964. (point)))))
  17965. (forward-line)))))))))
  17966. (defun org-toggle-heading (&optional nstars)
  17967. "Convert headings to normal text, or items or text to headings.
  17968. If there is no active region, only the current line is considered.
  17969. With a \\[universal-argument] prefix, convert the whole list at
  17970. point into heading.
  17971. In a region:
  17972. - If the first non blank line is an headline, remove the stars
  17973. from all headlines in the region.
  17974. - If it is a normal line turn each and every normal line (i.e. not an
  17975. heading or an item) in the region into a heading.
  17976. - If it is a plain list item, turn all plain list items into headings.
  17977. When converting a line into a heading, the number of stars is chosen
  17978. such that the lines become children of the current entry. However,
  17979. when a prefix argument is given, its value determines the number of
  17980. stars to add."
  17981. (interactive "P")
  17982. (let ((skip-blanks
  17983. (function
  17984. ;; Return beginning of first non-blank line, starting from
  17985. ;; line at POS.
  17986. (lambda (pos)
  17987. (save-excursion
  17988. (goto-char pos)
  17989. (while (org-at-comment-p) (forward-line))
  17990. (skip-chars-forward " \r\t\n")
  17991. (point-at-bol)))))
  17992. beg end toggled)
  17993. ;; Determine boundaries of changes. If a universal prefix has
  17994. ;; been given, put the list in a region. If region ends at a bol,
  17995. ;; do not consider the last line to be in the region.
  17996. (when (and current-prefix-arg (org-at-item-p))
  17997. (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
  17998. (org-mark-element))
  17999. (if (org-region-active-p)
  18000. (setq beg (funcall skip-blanks (region-beginning))
  18001. end (copy-marker (save-excursion
  18002. (goto-char (region-end))
  18003. (if (bolp) (point) (point-at-eol)))))
  18004. (setq beg (funcall skip-blanks (point-at-bol))
  18005. end (copy-marker (point-at-eol))))
  18006. ;; Ensure inline tasks don't count as headings.
  18007. (org-with-limited-levels
  18008. (save-excursion
  18009. (goto-char beg)
  18010. (cond
  18011. ;; Case 1. Started at an heading: de-star headings.
  18012. ((org-at-heading-p)
  18013. (while (< (point) end)
  18014. (when (org-at-heading-p t)
  18015. (looking-at org-outline-regexp) (replace-match "")
  18016. (setq toggled t))
  18017. (forward-line)))
  18018. ;; Case 2. Started at an item: change items into headlines.
  18019. ;; One star will be added by `org-list-to-subtree'.
  18020. ((org-at-item-p)
  18021. (let* ((stars (make-string
  18022. (if nstars
  18023. ;; subtract the star that will be added again by
  18024. ;; `org-list-to-subtree'
  18025. (1- (prefix-numeric-value current-prefix-arg))
  18026. (or (org-current-level) 0))
  18027. ?*))
  18028. (add-stars
  18029. (cond (nstars "") ; stars from prefix only
  18030. ((equal stars "") "") ; before first heading
  18031. (org-odd-levels-only "*") ; inside heading, odd
  18032. (t "")))) ; inside heading, oddeven
  18033. (while (< (point) end)
  18034. (when (org-at-item-p)
  18035. ;; Pay attention to cases when region ends before list.
  18036. (let* ((struct (org-list-struct))
  18037. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  18038. (save-restriction
  18039. (narrow-to-region (point) list-end)
  18040. (insert
  18041. (org-list-to-subtree
  18042. (org-list-parse-list t)
  18043. '(:istart (concat stars add-stars (funcall get-stars depth))
  18044. :icount (concat stars add-stars (funcall get-stars depth)))))))
  18045. (setq toggled t))
  18046. (forward-line))))
  18047. ;; Case 3. Started at normal text: make every line an heading,
  18048. ;; skipping headlines and items.
  18049. (t (let* ((stars (make-string
  18050. (if nstars
  18051. (prefix-numeric-value current-prefix-arg)
  18052. (or (org-current-level) 0))
  18053. ?*))
  18054. (add-stars
  18055. (cond (nstars "") ; stars from prefix only
  18056. ((equal stars "") "*") ; before first heading
  18057. (org-odd-levels-only "**") ; inside heading, odd
  18058. (t "*"))) ; inside heading, oddeven
  18059. (rpl (concat stars add-stars " ")))
  18060. (while (< (point) end)
  18061. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  18062. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  18063. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  18064. (forward-line)))))))
  18065. (unless toggled (message "Cannot toggle heading from here"))))
  18066. (defun org-meta-return (&optional arg)
  18067. "Insert a new heading or wrap a region in a table.
  18068. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  18069. See the individual commands for more information."
  18070. (interactive "P")
  18071. (cond
  18072. ((run-hook-with-args-until-success 'org-metareturn-hook))
  18073. ((or (org-at-drawer-p) (org-at-property-p))
  18074. (newline-and-indent))
  18075. ((org-at-table-p)
  18076. (call-interactively 'org-table-wrap-region))
  18077. (t (call-interactively 'org-insert-heading))))
  18078. ;;; Menu entries
  18079. ;; Define the Org-mode menus
  18080. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  18081. '("Tbl"
  18082. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  18083. ["Next Field" org-cycle (org-at-table-p)]
  18084. ["Previous Field" org-shifttab (org-at-table-p)]
  18085. ["Next Row" org-return (org-at-table-p)]
  18086. "--"
  18087. ["Blank Field" org-table-blank-field (org-at-table-p)]
  18088. ["Edit Field" org-table-edit-field (org-at-table-p)]
  18089. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  18090. "--"
  18091. ("Column"
  18092. ["Move Column Left" org-metaleft (org-at-table-p)]
  18093. ["Move Column Right" org-metaright (org-at-table-p)]
  18094. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  18095. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  18096. ("Row"
  18097. ["Move Row Up" org-metaup (org-at-table-p)]
  18098. ["Move Row Down" org-metadown (org-at-table-p)]
  18099. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  18100. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  18101. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  18102. "--"
  18103. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  18104. ("Rectangle"
  18105. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  18106. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  18107. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  18108. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  18109. "--"
  18110. ("Calculate"
  18111. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  18112. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  18113. ["Edit Formulas" org-edit-special (org-at-table-p)]
  18114. "--"
  18115. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  18116. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  18117. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  18118. "--"
  18119. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  18120. "--"
  18121. ["Sum Column/Rectangle" org-table-sum
  18122. (or (org-at-table-p) (org-region-active-p))]
  18123. ["Which Column?" org-table-current-column (org-at-table-p)])
  18124. ["Debug Formulas"
  18125. org-table-toggle-formula-debugger
  18126. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  18127. ["Show Col/Row Numbers"
  18128. org-table-toggle-coordinate-overlays
  18129. :style toggle
  18130. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  18131. "--"
  18132. ["Create" org-table-create (and (not (org-at-table-p))
  18133. org-enable-table-editor)]
  18134. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  18135. ["Import from File" org-table-import (not (org-at-table-p))]
  18136. ["Export to File" org-table-export (org-at-table-p)]
  18137. "--"
  18138. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  18139. (easy-menu-define org-org-menu org-mode-map "Org menu"
  18140. '("Org"
  18141. ("Show/Hide"
  18142. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  18143. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  18144. ["Sparse Tree..." org-sparse-tree t]
  18145. ["Reveal Context" org-reveal t]
  18146. ["Show All" show-all t]
  18147. "--"
  18148. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  18149. "--"
  18150. ["New Heading" org-insert-heading t]
  18151. ("Navigate Headings"
  18152. ["Up" outline-up-heading t]
  18153. ["Next" outline-next-visible-heading t]
  18154. ["Previous" outline-previous-visible-heading t]
  18155. ["Next Same Level" outline-forward-same-level t]
  18156. ["Previous Same Level" outline-backward-same-level t]
  18157. "--"
  18158. ["Jump" org-goto t])
  18159. ("Edit Structure"
  18160. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  18161. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  18162. "--"
  18163. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  18164. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  18165. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  18166. "--"
  18167. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  18168. "--"
  18169. ["Copy visible text" org-copy-visible t]
  18170. "--"
  18171. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  18172. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  18173. ["Demote Heading" org-metaright (not (org-at-table-p))]
  18174. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  18175. "--"
  18176. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  18177. "--"
  18178. ["Convert to odd levels" org-convert-to-odd-levels t]
  18179. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  18180. ("Editing"
  18181. ["Emphasis..." org-emphasize t]
  18182. ["Edit Source Example" org-edit-special t]
  18183. "--"
  18184. ["Footnote new/jump" org-footnote-action t]
  18185. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  18186. ("Archive"
  18187. ["Archive (default method)" org-archive-subtree-default t]
  18188. "--"
  18189. ["Move Subtree to Archive file" org-advertized-archive-subtree t]
  18190. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  18191. ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
  18192. )
  18193. "--"
  18194. ("Hyperlinks"
  18195. ["Store Link (Global)" org-store-link t]
  18196. ["Find existing link to here" org-occur-link-in-agenda-files t]
  18197. ["Insert Link" org-insert-link t]
  18198. ["Follow Link" org-open-at-point t]
  18199. "--"
  18200. ["Next link" org-next-link t]
  18201. ["Previous link" org-previous-link t]
  18202. "--"
  18203. ["Descriptive Links"
  18204. org-toggle-link-display
  18205. :style radio
  18206. :selected org-descriptive-links
  18207. ]
  18208. ["Literal Links"
  18209. org-toggle-link-display
  18210. :style radio
  18211. :selected (not org-descriptive-links)])
  18212. "--"
  18213. ("TODO Lists"
  18214. ["TODO/DONE/-" org-todo t]
  18215. ("Select keyword"
  18216. ["Next keyword" org-shiftright (org-at-heading-p)]
  18217. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  18218. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  18219. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  18220. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  18221. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  18222. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  18223. "--"
  18224. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  18225. :selected org-enforce-todo-dependencies :style toggle :active t]
  18226. "Settings for tree at point"
  18227. ["Do Children sequentially" org-toggle-ordered-property :style radio
  18228. :selected (org-entry-get nil "ORDERED")
  18229. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18230. ["Do Children parallel" org-toggle-ordered-property :style radio
  18231. :selected (not (org-entry-get nil "ORDERED"))
  18232. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18233. "--"
  18234. ["Set Priority" org-priority t]
  18235. ["Priority Up" org-shiftup t]
  18236. ["Priority Down" org-shiftdown t]
  18237. "--"
  18238. ["Get news from all feeds" org-feed-update-all t]
  18239. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  18240. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  18241. ("TAGS and Properties"
  18242. ["Set Tags" org-set-tags-command t]
  18243. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  18244. "--"
  18245. ["Set property" org-set-property t]
  18246. ["Column view of properties" org-columns t]
  18247. ["Insert Column View DBlock" org-insert-columns-dblock t])
  18248. ("Dates and Scheduling"
  18249. ["Timestamp" org-time-stamp t]
  18250. ["Timestamp (inactive)" org-time-stamp-inactive t]
  18251. ("Change Date"
  18252. ["1 Day Later" org-shiftright t]
  18253. ["1 Day Earlier" org-shiftleft t]
  18254. ["1 ... Later" org-shiftup t]
  18255. ["1 ... Earlier" org-shiftdown t])
  18256. ["Compute Time Range" org-evaluate-time-range t]
  18257. ["Schedule Item" org-schedule t]
  18258. ["Deadline" org-deadline t]
  18259. "--"
  18260. ["Custom time format" org-toggle-time-stamp-overlays
  18261. :style radio :selected org-display-custom-times]
  18262. "--"
  18263. ["Goto Calendar" org-goto-calendar t]
  18264. ["Date from Calendar" org-date-from-calendar t]
  18265. "--"
  18266. ["Start/Restart Timer" org-timer-start t]
  18267. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  18268. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  18269. ["Insert Timer String" org-timer t]
  18270. ["Insert Timer Item" org-timer-item t])
  18271. ("Logging work"
  18272. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  18273. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  18274. ["Clock out" org-clock-out t]
  18275. ["Clock cancel" org-clock-cancel t]
  18276. "--"
  18277. ["Mark as default task" org-clock-mark-default-task t]
  18278. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  18279. ["Goto running clock" org-clock-goto t]
  18280. "--"
  18281. ["Display times" org-clock-display t]
  18282. ["Create clock table" org-clock-report t]
  18283. "--"
  18284. ["Record DONE time"
  18285. (progn (setq org-log-done (not org-log-done))
  18286. (message "Switching to %s will %s record a timestamp"
  18287. (car org-done-keywords)
  18288. (if org-log-done "automatically" "not")))
  18289. :style toggle :selected org-log-done])
  18290. "--"
  18291. ["Agenda Command..." org-agenda t]
  18292. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  18293. ("File List for Agenda")
  18294. ("Special views current file"
  18295. ["TODO Tree" org-show-todo-tree t]
  18296. ["Check Deadlines" org-check-deadlines t]
  18297. ["Timeline" org-timeline t]
  18298. ["Tags/Property tree" org-match-sparse-tree t])
  18299. "--"
  18300. ["Export/Publish..." org-export t]
  18301. ("LaTeX"
  18302. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  18303. :selected org-cdlatex-mode]
  18304. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  18305. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  18306. ["Modify math symbol" org-cdlatex-math-modify
  18307. (org-inside-LaTeX-fragment-p)]
  18308. ["Insert citation" org-reftex-citation t]
  18309. "--"
  18310. ["Template for BEAMER" (progn (require 'org-beamer)
  18311. (org-insert-beamer-options-template)) t])
  18312. "--"
  18313. ("MobileOrg"
  18314. ["Push Files and Views" org-mobile-push t]
  18315. ["Get Captured and Flagged" org-mobile-pull t]
  18316. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  18317. "--"
  18318. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  18319. "--"
  18320. ("Documentation"
  18321. ["Show Version" org-version t]
  18322. ["Info Documentation" org-info t])
  18323. ("Customize"
  18324. ["Browse Org Group" org-customize t]
  18325. "--"
  18326. ["Expand This Menu" org-create-customize-menu
  18327. (fboundp 'customize-menu-create)])
  18328. ["Send bug report" org-submit-bug-report t]
  18329. "--"
  18330. ("Refresh/Reload"
  18331. ["Refresh setup current buffer" org-mode-restart t]
  18332. ["Reload Org (after update)" org-reload t]
  18333. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  18334. ))
  18335. (defun org-info (&optional node)
  18336. "Read documentation for Org-mode in the info system.
  18337. With optional NODE, go directly to that node."
  18338. (interactive)
  18339. (info (format "(org)%s" (or node ""))))
  18340. ;;;###autoload
  18341. (defun org-submit-bug-report ()
  18342. "Submit a bug report on Org-mode via mail.
  18343. Don't hesitate to report any problems or inaccurate documentation.
  18344. If you don't have setup sending mail from (X)Emacs, please copy the
  18345. output buffer into your mail program, as it gives us important
  18346. information about your Org-mode version and configuration."
  18347. (interactive)
  18348. (require 'reporter)
  18349. (org-load-modules-maybe)
  18350. (org-require-autoloaded-modules)
  18351. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  18352. (reporter-submit-bug-report
  18353. "emacs-orgmode@gnu.org"
  18354. (org-version nil 'full)
  18355. (let (list)
  18356. (save-window-excursion
  18357. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  18358. (delete-other-windows)
  18359. (erase-buffer)
  18360. (insert "You are about to submit a bug report to the Org-mode mailing list.
  18361. We would like to add your full Org-mode and Outline configuration to the
  18362. bug report. This greatly simplifies the work of the maintainer and
  18363. other experts on the mailing list.
  18364. HOWEVER, some variables you have customized may contain private
  18365. information. The names of customers, colleagues, or friends, might
  18366. appear in the form of file names, tags, todo states, or search strings.
  18367. If you answer yes to the prompt, you might want to check and remove
  18368. such private information before sending the email.")
  18369. (add-text-properties (point-min) (point-max) '(face org-warning))
  18370. (when (yes-or-no-p "Include your Org-mode configuration ")
  18371. (mapatoms
  18372. (lambda (v)
  18373. (and (boundp v)
  18374. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  18375. (or (and (symbol-value v)
  18376. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  18377. (and
  18378. (get v 'custom-type) (get v 'standard-value)
  18379. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  18380. (push v list)))))
  18381. (kill-buffer (get-buffer "*Warn about privacy*"))
  18382. list))
  18383. nil nil
  18384. "Remember to cover the basics, that is, what you expected to happen and
  18385. what in fact did happen. You don't know how to make a good report? See
  18386. http://orgmode.org/manual/Feedback.html#Feedback
  18387. Your bug report will be posted to the Org-mode mailing list.
  18388. ------------------------------------------------------------------------")
  18389. (save-excursion
  18390. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  18391. (replace-match "\\1Bug: \\3 [\\2]")))))
  18392. (defun org-install-agenda-files-menu ()
  18393. (let ((bl (buffer-list)))
  18394. (save-excursion
  18395. (while bl
  18396. (set-buffer (pop bl))
  18397. (if (derived-mode-p 'org-mode) (setq bl nil)))
  18398. (when (derived-mode-p 'org-mode)
  18399. (easy-menu-change
  18400. '("Org") "File List for Agenda"
  18401. (append
  18402. (list
  18403. ["Edit File List" (org-edit-agenda-file-list) t]
  18404. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  18405. ["Remove Current File from List" org-remove-file t]
  18406. ["Cycle through agenda files" org-cycle-agenda-files t]
  18407. ["Occur in all agenda files" org-occur-in-agenda-files t]
  18408. "--")
  18409. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  18410. ;;;; Documentation
  18411. ;;;###autoload
  18412. (defun org-require-autoloaded-modules ()
  18413. (interactive)
  18414. (mapc 'require
  18415. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  18416. org-docbook org-exp org-html org-icalendar
  18417. org-id org-latex
  18418. org-publish org-remember org-table
  18419. org-timer org-xoxo)))
  18420. ;;;###autoload
  18421. (defun org-reload (&optional uncompiled)
  18422. "Reload all org lisp files.
  18423. With prefix arg UNCOMPILED, load the uncompiled versions."
  18424. (interactive "P")
  18425. (require 'find-func)
  18426. (let* ((file-re "^org\\(-.*\\)?\\.el")
  18427. (dir-org (file-name-directory (org-find-library-dir "org")))
  18428. (dir-org-contrib (ignore-errors
  18429. (file-name-directory
  18430. (org-find-library-dir "org-contribdir"))))
  18431. (babel-files
  18432. (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
  18433. (append (list nil "comint" "eval" "exp" "keys"
  18434. "lob" "ref" "table" "tangle")
  18435. (delq nil
  18436. (mapcar
  18437. (lambda (lang)
  18438. (when (cdr lang) (symbol-name (car lang))))
  18439. org-babel-load-languages)))))
  18440. (files
  18441. (append babel-files
  18442. (and dir-org-contrib
  18443. (directory-files dir-org-contrib t file-re))
  18444. (directory-files dir-org t file-re)))
  18445. (remove-re (concat (if (featurep 'xemacs)
  18446. "org-colview" "org-colview-xemacs")
  18447. "\\'")))
  18448. (setq files (mapcar 'file-name-sans-extension files))
  18449. (setq files (mapcar
  18450. (lambda (x) (if (string-match remove-re x) nil x))
  18451. files))
  18452. (setq files (delq nil files))
  18453. (mapc
  18454. (lambda (f)
  18455. (when (featurep (intern (file-name-nondirectory f)))
  18456. (if (and (not uncompiled)
  18457. (file-exists-p (concat f ".elc")))
  18458. (load (concat f ".elc") nil nil 'nosuffix)
  18459. (load (concat f ".el") nil nil 'nosuffix))))
  18460. files)
  18461. (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
  18462. (org-version nil 'full 'message))
  18463. ;;;###autoload
  18464. (defun org-customize ()
  18465. "Call the customize function with org as argument."
  18466. (interactive)
  18467. (org-load-modules-maybe)
  18468. (org-require-autoloaded-modules)
  18469. (customize-browse 'org))
  18470. (defun org-create-customize-menu ()
  18471. "Create a full customization menu for Org-mode, insert it into the menu."
  18472. (interactive)
  18473. (org-load-modules-maybe)
  18474. (org-require-autoloaded-modules)
  18475. (if (fboundp 'customize-menu-create)
  18476. (progn
  18477. (easy-menu-change
  18478. '("Org") "Customize"
  18479. `(["Browse Org group" org-customize t]
  18480. "--"
  18481. ,(customize-menu-create 'org)
  18482. ["Set" Custom-set t]
  18483. ["Save" Custom-save t]
  18484. ["Reset to Current" Custom-reset-current t]
  18485. ["Reset to Saved" Custom-reset-saved t]
  18486. ["Reset to Standard Settings" Custom-reset-standard t]))
  18487. (message "\"Org\"-menu now contains full customization menu"))
  18488. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  18489. ;;;; Miscellaneous stuff
  18490. ;;; Generally useful functions
  18491. (defun org-get-at-bol (property)
  18492. "Get text property PROPERTY at beginning of line."
  18493. (get-text-property (point-at-bol) property))
  18494. (defun org-find-text-property-in-string (prop s)
  18495. "Return the first non-nil value of property PROP in string S."
  18496. (or (get-text-property 0 prop s)
  18497. (get-text-property (or (next-single-property-change 0 prop s) 0)
  18498. prop s)))
  18499. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  18500. "Display the given MESSAGE as a warning."
  18501. (if (fboundp 'display-warning)
  18502. (display-warning 'org message
  18503. (if (featurep 'xemacs) 'warning :warning))
  18504. (let ((buf (get-buffer-create "*Org warnings*")))
  18505. (with-current-buffer buf
  18506. (goto-char (point-max))
  18507. (insert "Warning (Org): " message)
  18508. (unless (bolp)
  18509. (newline)))
  18510. (display-buffer buf)
  18511. (sit-for 0))))
  18512. (defun org-eval (form)
  18513. "Eval FORM and return result."
  18514. (condition-case error
  18515. (eval form)
  18516. (error (format "%%![Error: %s]" error))))
  18517. (defun org-in-clocktable-p ()
  18518. "Check if the cursor is in a clocktable."
  18519. (let ((pos (point)) start)
  18520. (save-excursion
  18521. (end-of-line 1)
  18522. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  18523. (setq start (match-beginning 0))
  18524. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  18525. (>= (match-end 0) pos)
  18526. start))))
  18527. (defun org-in-commented-line ()
  18528. "Is point in a line starting with `#'?"
  18529. (equal (char-after (point-at-bol)) ?#))
  18530. (defun org-in-indented-comment-line ()
  18531. "Is point in a line starting with `#' after some white space?"
  18532. (save-excursion
  18533. (save-match-data
  18534. (goto-char (point-at-bol))
  18535. (looking-at "[ \t]*#"))))
  18536. (defun org-in-verbatim-emphasis ()
  18537. (save-match-data
  18538. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  18539. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  18540. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  18541. (if (and marker (marker-buffer marker)
  18542. (buffer-live-p (marker-buffer marker)))
  18543. (progn
  18544. (org-pop-to-buffer-same-window (marker-buffer marker))
  18545. (if (or (> marker (point-max)) (< marker (point-min)))
  18546. (widen))
  18547. (goto-char marker)
  18548. (org-show-context 'org-goto))
  18549. (if bookmark
  18550. (bookmark-jump bookmark)
  18551. (error "Cannot find location"))))
  18552. (defun org-quote-csv-field (s)
  18553. "Quote field for inclusion in CSV material."
  18554. (if (string-match "[\",]" s)
  18555. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  18556. s))
  18557. (defun org-force-self-insert (N)
  18558. "Needed to enforce self-insert under remapping."
  18559. (interactive "p")
  18560. (self-insert-command N))
  18561. (defun org-string-width (s)
  18562. "Compute width of string, ignoring invisible characters.
  18563. This ignores character with invisibility property `org-link', and also
  18564. characters with property `org-cwidth', because these will become invisible
  18565. upon the next fontification round."
  18566. (let (b l)
  18567. (when (or (eq t buffer-invisibility-spec)
  18568. (assq 'org-link buffer-invisibility-spec))
  18569. (while (setq b (text-property-any 0 (length s)
  18570. 'invisible 'org-link s))
  18571. (setq s (concat (substring s 0 b)
  18572. (substring s (or (next-single-property-change
  18573. b 'invisible s) (length s)))))))
  18574. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  18575. (setq s (concat (substring s 0 b)
  18576. (substring s (or (next-single-property-change
  18577. b 'org-cwidth s) (length s))))))
  18578. (setq l (string-width s) b -1)
  18579. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  18580. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  18581. l))
  18582. (defun org-shorten-string (s maxlength)
  18583. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  18584. If the string is shorter or has length MAXLENGTH, just return the
  18585. original string. If it is longer, the functions finds a space in the
  18586. string, breaks this string off at that locations and adds three dots
  18587. as ellipsis. Including the ellipsis, the string will not be longer
  18588. than MAXLENGTH. If finding a good breaking point in the string does
  18589. not work, the string is just chopped off in the middle of a word
  18590. if necessary."
  18591. (if (<= (length s) maxlength)
  18592. s
  18593. (let* ((n (max (- maxlength 4) 1))
  18594. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  18595. (if (string-match re s)
  18596. (concat (match-string 1 s) "...")
  18597. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  18598. (defun org-get-indentation (&optional line)
  18599. "Get the indentation of the current line, interpreting tabs.
  18600. When LINE is given, assume it represents a line and compute its indentation."
  18601. (if line
  18602. (if (string-match "^ *" (org-remove-tabs line))
  18603. (match-end 0))
  18604. (save-excursion
  18605. (beginning-of-line 1)
  18606. (skip-chars-forward " \t")
  18607. (current-column))))
  18608. (defun org-get-string-indentation (s)
  18609. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  18610. (let ((n -1) (i 0) (w tab-width) c)
  18611. (catch 'exit
  18612. (while (< (setq n (1+ n)) (length s))
  18613. (setq c (aref s n))
  18614. (cond ((= c ?\ ) (setq i (1+ i)))
  18615. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  18616. (t (throw 'exit t)))))
  18617. i))
  18618. (defun org-remove-tabs (s &optional width)
  18619. "Replace tabulators in S with spaces.
  18620. Assumes that s is a single line, starting in column 0."
  18621. (setq width (or width tab-width))
  18622. (while (string-match "\t" s)
  18623. (setq s (replace-match
  18624. (make-string
  18625. (- (* width (/ (+ (match-beginning 0) width) width))
  18626. (match-beginning 0)) ?\ )
  18627. t t s)))
  18628. s)
  18629. (defun org-fix-indentation (line ind)
  18630. "Fix indentation in LINE.
  18631. IND is a cons cell with target and minimum indentation.
  18632. If the current indentation in LINE is smaller than the minimum,
  18633. leave it alone. If it is larger than ind, set it to the target."
  18634. (let* ((l (org-remove-tabs line))
  18635. (i (org-get-indentation l))
  18636. (i1 (car ind)) (i2 (cdr ind)))
  18637. (if (>= i i2) (setq l (substring line i2)))
  18638. (if (> i1 0)
  18639. (concat (make-string i1 ?\ ) l)
  18640. l)))
  18641. (defun org-remove-indentation (code &optional n)
  18642. "Remove the maximum common indentation from the lines in CODE.
  18643. N may optionally be the number of spaces to remove."
  18644. (with-temp-buffer
  18645. (insert code)
  18646. (org-do-remove-indentation n)
  18647. (buffer-string)))
  18648. (defun org-do-remove-indentation (&optional n)
  18649. "Remove the maximum common indentation from the buffer."
  18650. (untabify (point-min) (point-max))
  18651. (let ((min 10000) re)
  18652. (if n
  18653. (setq min n)
  18654. (goto-char (point-min))
  18655. (while (re-search-forward "^ *[^ \n]" nil t)
  18656. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  18657. (unless (or (= min 0) (= min 10000))
  18658. (setq re (format "^ \\{%d\\}" min))
  18659. (goto-char (point-min))
  18660. (while (re-search-forward re nil t)
  18661. (replace-match "")
  18662. (end-of-line 1))
  18663. min)))
  18664. (defun org-fill-template (template alist)
  18665. "Find each %key of ALIST in TEMPLATE and replace it."
  18666. (let ((case-fold-search nil)
  18667. entry key value)
  18668. (setq alist (sort (copy-sequence alist)
  18669. (lambda (a b) (< (length (car a)) (length (car b))))))
  18670. (while (setq entry (pop alist))
  18671. (setq template
  18672. (replace-regexp-in-string
  18673. (concat "%" (regexp-quote (car entry)))
  18674. (or (cdr entry) "") template t t)))
  18675. template))
  18676. (defun org-base-buffer (buffer)
  18677. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  18678. (if (not buffer)
  18679. buffer
  18680. (or (buffer-base-buffer buffer)
  18681. buffer)))
  18682. (defun org-trim (s)
  18683. "Remove whitespace at beginning and end of string."
  18684. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  18685. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  18686. s)
  18687. (defun org-wrap (string &optional width lines)
  18688. "Wrap string to either a number of lines, or a width in characters.
  18689. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  18690. that costs. If there is a word longer than WIDTH, the text is actually
  18691. wrapped to the length of that word.
  18692. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  18693. many lines, whatever width that takes.
  18694. The return value is a list of lines, without newlines at the end."
  18695. (let* ((words (org-split-string string "[ \t\n]+"))
  18696. (maxword (apply 'max (mapcar 'org-string-width words)))
  18697. w ll)
  18698. (cond (width
  18699. (org-do-wrap words (max maxword width)))
  18700. (lines
  18701. (setq w maxword)
  18702. (setq ll (org-do-wrap words maxword))
  18703. (if (<= (length ll) lines)
  18704. ll
  18705. (setq ll words)
  18706. (while (> (length ll) lines)
  18707. (setq w (1+ w))
  18708. (setq ll (org-do-wrap words w)))
  18709. ll))
  18710. (t (error "Cannot wrap this")))))
  18711. (defun org-do-wrap (words width)
  18712. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  18713. (let (lines line)
  18714. (while words
  18715. (setq line (pop words))
  18716. (while (and words (< (+ (length line) (length (car words))) width))
  18717. (setq line (concat line " " (pop words))))
  18718. (setq lines (push line lines)))
  18719. (nreverse lines)))
  18720. (defun org-split-string (string &optional separators)
  18721. "Splits STRING into substrings at SEPARATORS.
  18722. No empty strings are returned if there are matches at the beginning
  18723. and end of string."
  18724. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  18725. (start 0)
  18726. notfirst
  18727. (list nil))
  18728. (while (and (string-match rexp string
  18729. (if (and notfirst
  18730. (= start (match-beginning 0))
  18731. (< start (length string)))
  18732. (1+ start) start))
  18733. (< (match-beginning 0) (length string)))
  18734. (setq notfirst t)
  18735. (or (eq (match-beginning 0) 0)
  18736. (and (eq (match-beginning 0) (match-end 0))
  18737. (eq (match-beginning 0) start))
  18738. (setq list
  18739. (cons (substring string start (match-beginning 0))
  18740. list)))
  18741. (setq start (match-end 0)))
  18742. (or (eq start (length string))
  18743. (setq list
  18744. (cons (substring string start)
  18745. list)))
  18746. (nreverse list)))
  18747. (defun org-quote-vert (s)
  18748. "Replace \"|\" with \"\\vert\"."
  18749. (while (string-match "|" s)
  18750. (setq s (replace-match "\\vert" t t s)))
  18751. s)
  18752. (defun org-uuidgen-p (s)
  18753. "Is S an ID created by UUIDGEN?"
  18754. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  18755. (defun org-in-src-block-p nil
  18756. "Whether point is in a code source block."
  18757. (let (ov)
  18758. (when (setq ov (overlays-at (point)))
  18759. (memq 'org-block-background
  18760. (overlay-properties
  18761. (car ov))))))
  18762. (defun org-context ()
  18763. "Return a list of contexts of the current cursor position.
  18764. If several contexts apply, all are returned.
  18765. Each context entry is a list with a symbol naming the context, and
  18766. two positions indicating start and end of the context. Possible
  18767. contexts are:
  18768. :headline anywhere in a headline
  18769. :headline-stars on the leading stars in a headline
  18770. :todo-keyword on a TODO keyword (including DONE) in a headline
  18771. :tags on the TAGS in a headline
  18772. :priority on the priority cookie in a headline
  18773. :item on the first line of a plain list item
  18774. :item-bullet on the bullet/number of a plain list item
  18775. :checkbox on the checkbox in a plain list item
  18776. :table in an org-mode table
  18777. :table-special on a special filed in a table
  18778. :table-table in a table.el table
  18779. :clocktable in a clocktable
  18780. :src-block in a source block
  18781. :link on a hyperlink
  18782. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  18783. :target on a <<target>>
  18784. :radio-target on a <<<radio-target>>>
  18785. :latex-fragment on a LaTeX fragment
  18786. :latex-preview on a LaTeX fragment with overlaid preview image
  18787. This function expects the position to be visible because it uses font-lock
  18788. faces as a help to recognize the following contexts: :table-special, :link,
  18789. and :keyword."
  18790. (let* ((f (get-text-property (point) 'face))
  18791. (faces (if (listp f) f (list f)))
  18792. (case-fold-search t)
  18793. (p (point)) clist o)
  18794. ;; First the large context
  18795. (cond
  18796. ((org-at-heading-p t)
  18797. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  18798. (when (progn
  18799. (beginning-of-line 1)
  18800. (looking-at org-todo-line-tags-regexp))
  18801. (push (org-point-in-group p 1 :headline-stars) clist)
  18802. (push (org-point-in-group p 2 :todo-keyword) clist)
  18803. (push (org-point-in-group p 4 :tags) clist))
  18804. (goto-char p)
  18805. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  18806. (if (looking-at "\\[#[A-Z0-9]\\]")
  18807. (push (org-point-in-group p 0 :priority) clist)))
  18808. ((org-at-item-p)
  18809. (push (org-point-in-group p 2 :item-bullet) clist)
  18810. (push (list :item (point-at-bol)
  18811. (save-excursion (org-end-of-item) (point)))
  18812. clist)
  18813. (and (org-at-item-checkbox-p)
  18814. (push (org-point-in-group p 0 :checkbox) clist)))
  18815. ((org-at-table-p)
  18816. (push (list :table (org-table-begin) (org-table-end)) clist)
  18817. (if (memq 'org-formula faces)
  18818. (push (list :table-special
  18819. (previous-single-property-change p 'face)
  18820. (next-single-property-change p 'face)) clist)))
  18821. ((org-at-table-p 'any)
  18822. (push (list :table-table) clist)))
  18823. (goto-char p)
  18824. (let ((case-fold-search t))
  18825. ;; New the "medium" contexts: clocktables, source blocks
  18826. (cond ((org-in-clocktable-p)
  18827. (push (list :clocktable
  18828. (and (or (looking-at "#\\+BEGIN: clocktable")
  18829. (search-backward "#+BEGIN: clocktable" nil t))
  18830. (match-beginning 0))
  18831. (and (re-search-forward "#\\+END:?" nil t)
  18832. (match-end 0))) clist))
  18833. ((org-in-src-block-p)
  18834. (push (list :src-block
  18835. (and (or (looking-at "#\\+BEGIN_SRC")
  18836. (search-backward "#+BEGIN_SRC" nil t))
  18837. (match-beginning 0))
  18838. (and (search-forward "#+END_SRC" nil t)
  18839. (match-beginning 0))) clist))))
  18840. (goto-char p)
  18841. ;; Now the small context
  18842. (cond
  18843. ((org-at-timestamp-p)
  18844. (push (org-point-in-group p 0 :timestamp) clist))
  18845. ((memq 'org-link faces)
  18846. (push (list :link
  18847. (previous-single-property-change p 'face)
  18848. (next-single-property-change p 'face)) clist))
  18849. ((memq 'org-special-keyword faces)
  18850. (push (list :keyword
  18851. (previous-single-property-change p 'face)
  18852. (next-single-property-change p 'face)) clist))
  18853. ((org-at-target-p)
  18854. (push (org-point-in-group p 0 :target) clist)
  18855. (goto-char (1- (match-beginning 0)))
  18856. (if (looking-at org-radio-target-regexp)
  18857. (push (org-point-in-group p 0 :radio-target) clist))
  18858. (goto-char p))
  18859. ((setq o (car (delq nil
  18860. (mapcar
  18861. (lambda (x)
  18862. (if (memq x org-latex-fragment-image-overlays) x))
  18863. (overlays-at (point))))))
  18864. (push (list :latex-fragment
  18865. (overlay-start o) (overlay-end o)) clist)
  18866. (push (list :latex-preview
  18867. (overlay-start o) (overlay-end o)) clist))
  18868. ((org-inside-LaTeX-fragment-p)
  18869. ;; FIXME: positions wrong.
  18870. (push (list :latex-fragment (point) (point)) clist)))
  18871. (setq clist (nreverse (delq nil clist)))
  18872. clist))
  18873. ;; FIXME: Compare with at-regexp-p Do we need both?
  18874. (defun org-in-regexp (re &optional nlines visually)
  18875. "Check if point is inside a match of regexp.
  18876. Normally only the current line is checked, but you can include NLINES extra
  18877. lines both before and after point into the search.
  18878. If VISUALLY is set, require that the cursor is not after the match but
  18879. really on, so that the block visually is on the match."
  18880. (catch 'exit
  18881. (let ((pos (point))
  18882. (eol (point-at-eol (+ 1 (or nlines 0))))
  18883. (inc (if visually 1 0)))
  18884. (save-excursion
  18885. (beginning-of-line (- 1 (or nlines 0)))
  18886. (while (re-search-forward re eol t)
  18887. (if (and (<= (match-beginning 0) pos)
  18888. (>= (+ inc (match-end 0)) pos))
  18889. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  18890. (defun org-at-regexp-p (regexp)
  18891. "Is point inside a match of REGEXP in the current line?"
  18892. (catch 'exit
  18893. (save-excursion
  18894. (let ((pos (point)) (end (point-at-eol)))
  18895. (beginning-of-line 1)
  18896. (while (re-search-forward regexp end t)
  18897. (if (and (<= (match-beginning 0) pos)
  18898. (>= (match-end 0) pos))
  18899. (throw 'exit t)))
  18900. nil))))
  18901. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  18902. "Non-nil when point is between matches of START-RE and END-RE.
  18903. Also return a non-nil value when point is on one of the matches.
  18904. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  18905. buffer positions. Default values are the positions of headlines
  18906. surrounding the point.
  18907. The functions returns a cons cell whose car (resp. cdr) is the
  18908. position before START-RE (resp. after END-RE)."
  18909. (save-match-data
  18910. (let ((pos (point))
  18911. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  18912. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  18913. beg end)
  18914. (save-excursion
  18915. ;; Point is on a block when on START-RE or if START-RE can be
  18916. ;; found before it...
  18917. (and (or (org-at-regexp-p start-re)
  18918. (re-search-backward start-re limit-up t))
  18919. (setq beg (match-beginning 0))
  18920. ;; ... and END-RE after it...
  18921. (goto-char (match-end 0))
  18922. (re-search-forward end-re limit-down t)
  18923. (> (setq end (match-end 0)) pos)
  18924. ;; ... without another START-RE in-between.
  18925. (goto-char (match-beginning 0))
  18926. (not (re-search-backward start-re (1+ beg) t))
  18927. ;; Return value.
  18928. (cons beg end))))))
  18929. (defun org-in-block-p (names)
  18930. "Non-nil when point belongs to a block whose name belongs to NAMES.
  18931. NAMES is a list of strings containing names of blocks.
  18932. Return first block name matched, or nil. Beware that in case of
  18933. nested blocks, the returned name may not belong to the closest
  18934. block from point."
  18935. (save-match-data
  18936. (catch 'exit
  18937. (let ((case-fold-search t)
  18938. (lim-up (save-excursion (outline-previous-heading)))
  18939. (lim-down (save-excursion (outline-next-heading))))
  18940. (mapc (lambda (name)
  18941. (let ((n (regexp-quote name)))
  18942. (when (org-between-regexps-p
  18943. (concat "^[ \t]*#\\+begin_" n)
  18944. (concat "^[ \t]*#\\+end_" n)
  18945. lim-up lim-down)
  18946. (throw 'exit n))))
  18947. names))
  18948. nil)))
  18949. (defun org-occur-in-agenda-files (regexp &optional nlines)
  18950. "Call `multi-occur' with buffers for all agenda files."
  18951. (interactive "sOrg-files matching: \np")
  18952. (let* ((files (org-agenda-files))
  18953. (tnames (mapcar 'file-truename files))
  18954. (extra org-agenda-text-search-extra-files)
  18955. f)
  18956. (when (eq (car extra) 'agenda-archives)
  18957. (setq extra (cdr extra))
  18958. (setq files (org-add-archive-files files)))
  18959. (while (setq f (pop extra))
  18960. (unless (member (file-truename f) tnames)
  18961. (add-to-list 'files f 'append)
  18962. (add-to-list 'tnames (file-truename f) 'append)))
  18963. (multi-occur
  18964. (mapcar (lambda (x)
  18965. (with-current-buffer
  18966. (or (get-file-buffer x) (find-file-noselect x))
  18967. (widen)
  18968. (current-buffer)))
  18969. files)
  18970. regexp)))
  18971. (if (boundp 'occur-mode-find-occurrence-hook)
  18972. ;; Emacs 23
  18973. (add-hook 'occur-mode-find-occurrence-hook
  18974. (lambda ()
  18975. (when (derived-mode-p 'org-mode)
  18976. (org-reveal))))
  18977. ;; Emacs 22
  18978. (defadvice occur-mode-goto-occurrence
  18979. (after org-occur-reveal activate)
  18980. (and (derived-mode-p 'org-mode) (org-reveal)))
  18981. (defadvice occur-mode-goto-occurrence-other-window
  18982. (after org-occur-reveal activate)
  18983. (and (derived-mode-p 'org-mode) (org-reveal)))
  18984. (defadvice occur-mode-display-occurrence
  18985. (after org-occur-reveal activate)
  18986. (when (derived-mode-p 'org-mode)
  18987. (let ((pos (occur-mode-find-occurrence)))
  18988. (with-current-buffer (marker-buffer pos)
  18989. (save-excursion
  18990. (goto-char pos)
  18991. (org-reveal)))))))
  18992. (defun org-occur-link-in-agenda-files ()
  18993. "Create a link and search for it in the agendas.
  18994. The link is not stored in `org-stored-links', it is just created
  18995. for the search purpose."
  18996. (interactive)
  18997. (let ((link (condition-case nil
  18998. (org-store-link nil)
  18999. (error "Unable to create a link to here"))))
  19000. (org-occur-in-agenda-files (regexp-quote link))))
  19001. (defun org-uniquify (list)
  19002. "Remove duplicate elements from LIST."
  19003. (let (res)
  19004. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  19005. res))
  19006. (defun org-delete-all (elts list)
  19007. "Remove all elements in ELTS from LIST."
  19008. (while elts
  19009. (setq list (delete (pop elts) list)))
  19010. list)
  19011. (defun org-count (cl-item cl-seq)
  19012. "Count the number of occurrences of ITEM in SEQ.
  19013. Taken from `count' in cl-seq.el with all keyword arguments removed."
  19014. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  19015. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  19016. (while (< cl-start cl-end)
  19017. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  19018. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  19019. (setq cl-start (1+ cl-start)))
  19020. cl-count))
  19021. (defun org-remove-if (predicate seq)
  19022. "Remove everything from SEQ that fulfills PREDICATE."
  19023. (let (res e)
  19024. (while seq
  19025. (setq e (pop seq))
  19026. (if (not (funcall predicate e)) (push e res)))
  19027. (nreverse res)))
  19028. (defun org-remove-if-not (predicate seq)
  19029. "Remove everything from SEQ that does not fulfill PREDICATE."
  19030. (let (res e)
  19031. (while seq
  19032. (setq e (pop seq))
  19033. (if (funcall predicate e) (push e res)))
  19034. (nreverse res)))
  19035. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  19036. "Reduce two-argument FUNCTION across SEQ.
  19037. Taken from `reduce' in cl-seq.el with all keyword arguments but
  19038. \":initial-value\" removed."
  19039. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  19040. (cadr (memq :initial-value cl-keys)))
  19041. (cl-seq (pop cl-seq))
  19042. (t (funcall cl-func)))))
  19043. (while cl-seq
  19044. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  19045. cl-accum))
  19046. (defun org-back-over-empty-lines ()
  19047. "Move backwards over whitespace, to the beginning of the first empty line.
  19048. Returns the number of empty lines passed."
  19049. (let ((pos (point)))
  19050. (if (cdr (assoc 'heading org-blank-before-new-entry))
  19051. (skip-chars-backward " \t\n\r")
  19052. (unless (eobp)
  19053. (forward-line -1)))
  19054. (beginning-of-line 2)
  19055. (goto-char (min (point) pos))
  19056. (count-lines (point) pos)))
  19057. (defun org-skip-whitespace ()
  19058. (skip-chars-forward " \t\n\r"))
  19059. (defun org-point-in-group (point group &optional context)
  19060. "Check if POINT is in match-group GROUP.
  19061. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  19062. match. If the match group does not exist or point is not inside it,
  19063. return nil."
  19064. (and (match-beginning group)
  19065. (>= point (match-beginning group))
  19066. (<= point (match-end group))
  19067. (if context
  19068. (list context (match-beginning group) (match-end group))
  19069. t)))
  19070. (defun org-switch-to-buffer-other-window (&rest args)
  19071. "Switch to buffer in a second window on the current frame.
  19072. In particular, do not allow pop-up frames.
  19073. Returns the newly created buffer."
  19074. (let (pop-up-frames special-display-buffer-names special-display-regexps
  19075. special-display-function)
  19076. (apply 'switch-to-buffer-other-window args)))
  19077. (defun org-combine-plists (&rest plists)
  19078. "Create a single property list from all plists in PLISTS.
  19079. The process starts by copying the first list, and then setting properties
  19080. from the other lists. Settings in the last list are the most significant
  19081. ones and overrule settings in the other lists."
  19082. (let ((rtn (copy-sequence (pop plists)))
  19083. p v ls)
  19084. (while plists
  19085. (setq ls (pop plists))
  19086. (while ls
  19087. (setq p (pop ls) v (pop ls))
  19088. (setq rtn (plist-put rtn p v))))
  19089. rtn))
  19090. (defun org-replace-escapes (string table)
  19091. "Replace %-escapes in STRING with values in TABLE.
  19092. TABLE is an association list with keys like \"%a\" and string values.
  19093. The sequences in STRING may contain normal field width and padding information,
  19094. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  19095. so values can contain further %-escapes if they are define later in TABLE."
  19096. (let ((tbl (copy-alist table))
  19097. (case-fold-search nil)
  19098. (pchg 0)
  19099. e re rpl)
  19100. (while (setq e (pop tbl))
  19101. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  19102. (when (and (cdr e) (string-match re (cdr e)))
  19103. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  19104. (safe "SREF"))
  19105. (add-text-properties 0 3 (list 'sref sref) safe)
  19106. (setcdr e (replace-match safe t t (cdr e)))))
  19107. (while (string-match re string)
  19108. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  19109. (cdr e)))
  19110. (setq string (replace-match rpl t t string))))
  19111. (while (setq pchg (next-property-change pchg string))
  19112. (let ((sref (get-text-property pchg 'sref string)))
  19113. (when (and sref (string-match "SREF" string pchg))
  19114. (setq string (replace-match sref t t string)))))
  19115. string))
  19116. (defun org-sublist (list start end)
  19117. "Return a section of LIST, from START to END.
  19118. Counting starts at 1."
  19119. (let (rtn (c start))
  19120. (setq list (nthcdr (1- start) list))
  19121. (while (and list (<= c end))
  19122. (push (pop list) rtn)
  19123. (setq c (1+ c)))
  19124. (nreverse rtn)))
  19125. (defun org-find-base-buffer-visiting (file)
  19126. "Like `find-buffer-visiting' but always return the base buffer and
  19127. not an indirect buffer."
  19128. (let ((buf (or (get-file-buffer file)
  19129. (find-buffer-visiting file))))
  19130. (if buf
  19131. (or (buffer-base-buffer buf) buf)
  19132. nil)))
  19133. (defun org-image-file-name-regexp (&optional extensions)
  19134. "Return regexp matching the file names of images.
  19135. If EXTENSIONS is given, only match these."
  19136. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  19137. (image-file-name-regexp)
  19138. (let ((image-file-name-extensions
  19139. (or extensions
  19140. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  19141. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  19142. (concat "\\."
  19143. (regexp-opt (nconc (mapcar 'upcase
  19144. image-file-name-extensions)
  19145. image-file-name-extensions)
  19146. t)
  19147. "\\'"))))
  19148. (defun org-file-image-p (file &optional extensions)
  19149. "Return non-nil if FILE is an image."
  19150. (save-match-data
  19151. (string-match (org-image-file-name-regexp extensions) file)))
  19152. (defun org-get-cursor-date ()
  19153. "Return the date at cursor in as a time.
  19154. This works in the calendar and in the agenda, anywhere else it just
  19155. returns the current time."
  19156. (let (date day defd)
  19157. (cond
  19158. ((eq major-mode 'calendar-mode)
  19159. (setq date (calendar-cursor-to-date)
  19160. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  19161. ((eq major-mode 'org-agenda-mode)
  19162. (setq day (get-text-property (point) 'day))
  19163. (if day
  19164. (setq date (calendar-gregorian-from-absolute day)
  19165. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  19166. (nth 2 date))))))
  19167. (or defd (current-time))))
  19168. (defvar org-agenda-action-marker (make-marker)
  19169. "Marker pointing to the entry for the next agenda action.")
  19170. (defun org-mark-entry-for-agenda-action ()
  19171. "Mark the current entry as target of an agenda action.
  19172. Agenda actions are actions executed from the agenda with the key `k',
  19173. which make use of the date at the cursor."
  19174. (interactive)
  19175. (move-marker org-agenda-action-marker
  19176. (save-excursion (org-back-to-heading t) (point))
  19177. (current-buffer))
  19178. (message
  19179. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  19180. (defun org-mark-subtree (&optional up)
  19181. "Mark the current subtree.
  19182. This puts point at the start of the current subtree, and mark at
  19183. the end. If a numeric prefix UP is given, move up into the
  19184. hierarchy of headlines by UP levels before marking the subtree."
  19185. (interactive "P")
  19186. (org-with-limited-levels
  19187. (cond ((org-at-heading-p) (beginning-of-line))
  19188. ((org-before-first-heading-p) (error "Not in a subtree"))
  19189. (t (outline-previous-visible-heading 1))))
  19190. (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
  19191. (if (org-called-interactively-p 'any)
  19192. (call-interactively 'org-mark-element)
  19193. (org-mark-element)))
  19194. ;;; Macros
  19195. ;; Macros are expanded with `org-macro-replace-all', which relies
  19196. ;; internally on `org-macro-expand'.
  19197. ;; Templates for expansion are stored in the buffer-local variable
  19198. ;; `org-macro-templates'. This variable is updated by
  19199. ;; `org-macro-initialize-templates'.
  19200. (defvar org-macro-templates nil
  19201. "Alist containing all macro templates in current buffer.
  19202. Associations are in the shape of (NAME . TEMPLATE) where NAME
  19203. stands for macro's name and template for its replacement value,
  19204. both as strings. This is an internal variable. Do not set it
  19205. directly, use instead:
  19206. #+MACRO: name template")
  19207. (make-variable-buffer-local 'org-macro-templates)
  19208. (defun org-macro-expand (macro)
  19209. "Return expanded MACRO, as a string.
  19210. MACRO is an object, obtained, for example, with
  19211. `org-element-context'. Return nil if no template was found."
  19212. (let ((template
  19213. (cdr (assoc-string (org-element-property :key macro)
  19214. org-macro-templates
  19215. ;; Macro names are case-insensitive.
  19216. t))))
  19217. (when template
  19218. (let ((value (replace-regexp-in-string
  19219. "\\$[0-9]+"
  19220. (lambda (arg)
  19221. (or (nth (1- (string-to-number (substring arg 1)))
  19222. (org-element-property :args macro))
  19223. ;; No argument provided: remove
  19224. ;; place-holder.
  19225. ""))
  19226. template)))
  19227. ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
  19228. (when (string-match "\\`(eval\\>" value)
  19229. (setq value (eval (read value))))
  19230. ;; Return string.
  19231. (format "%s" (or value ""))))))
  19232. (defun org-macro-replace-all ()
  19233. "Replace all macros in current buffer by their expansion."
  19234. (save-excursion
  19235. (goto-char (point-min))
  19236. (while (re-search-forward "{{{[-A-Za-z0-9_]" nil t)
  19237. (let ((object (org-element-context)))
  19238. (when (eq (org-element-type object) 'macro)
  19239. (let ((value (org-macro-expand object)))
  19240. (when value
  19241. (delete-region
  19242. (org-element-property :begin object)
  19243. ;; Preserve white spaces after the macro.
  19244. (progn (goto-char (org-element-property :end object))
  19245. (skip-chars-backward " \t")
  19246. (point)))
  19247. ;; Leave point before replacement in case of recursive
  19248. ;; expansions.
  19249. (save-excursion (insert value)))))))))
  19250. (defun org-macro-initialize-templates ()
  19251. "Collect macro templates defined in current buffer.
  19252. Templates are stored in buffer-local variable
  19253. `org-macro-templates'. In addition to buffer-defined macros, the
  19254. function installs the following ones: \"property\", \"date\",
  19255. \"time\". and, if appropriate, \"input-file\" and
  19256. \"modification-time\"."
  19257. (let ((case-fold-search t)
  19258. (set-template
  19259. (lambda (cell)
  19260. ;; Add CELL to `org-macro-templates' if there's no
  19261. ;; association matching its name already. Otherwise,
  19262. ;; replace old association with the new one in that
  19263. ;; variable.
  19264. (let ((old-template (assoc (car cell) org-macro-templates)))
  19265. (if old-template (setcdr old-template (cdr cell))
  19266. (push cell org-macro-templates))))))
  19267. ;; Install buffer-local macros.
  19268. (org-with-wide-buffer
  19269. (goto-char (point-min))
  19270. (while (re-search-forward "^[ \t]*#\\+MACRO:" nil t)
  19271. (let ((element (org-element-at-point)))
  19272. (when (eq (org-element-type element) 'keyword)
  19273. (let ((value (org-element-property :value element)))
  19274. (when (string-match "^\\(.*?\\)\\(?:\\s-+\\(.*\\)\\)?\\s-*$" value)
  19275. (funcall set-template
  19276. (cons (match-string 1 value)
  19277. (or (match-string 2 value) "")))))))))
  19278. ;; Install hard-coded macros.
  19279. (mapc (lambda (cell) (funcall set-template cell))
  19280. (list
  19281. (cons "property" "(eval (org-entry-get nil \"$1\" 'selective))")
  19282. (cons "date" "(eval (format-time-string \"$1\"))")
  19283. (cons "time" "(eval (format-time-string \"$1\"))")))
  19284. (let ((visited-file (buffer-file-name (buffer-base-buffer))))
  19285. (when (and visited-file (file-exists-p visited-file))
  19286. (mapc (lambda (cell) (funcall set-template cell))
  19287. (list
  19288. (cons "input-file" (file-name-nondirectory visited-file))
  19289. (cons "modification-time"
  19290. (format "(eval (format-time-string \"$1\" '%s))"
  19291. (prin1-to-string
  19292. (nth 5 (file-attributes visited-file)))))))))))
  19293. ;;; Indentation
  19294. (defun org-indent-line ()
  19295. "Indent line depending on context."
  19296. (interactive)
  19297. (let* ((pos (point))
  19298. (itemp (org-at-item-p))
  19299. (case-fold-search t)
  19300. (org-drawer-regexp (or org-drawer-regexp "\000"))
  19301. (inline-task-p (and (featurep 'org-inlinetask)
  19302. (org-inlinetask-in-task-p)))
  19303. (inline-re (and inline-task-p
  19304. (org-inlinetask-outline-regexp)))
  19305. column)
  19306. (if (and orgstruct-is-++ (eq pos (point)))
  19307. (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
  19308. (indent-according-to-mode))
  19309. (beginning-of-line 1)
  19310. (cond
  19311. ;; Headings
  19312. ((looking-at org-outline-regexp) (setq column 0))
  19313. ;; Included files
  19314. ((looking-at "#\\+include:") (setq column 0))
  19315. ;; Footnote definition
  19316. ((looking-at org-footnote-definition-re) (setq column 0))
  19317. ;; Literal examples
  19318. ((looking-at "[ \t]*:\\( \\|$\\)")
  19319. (setq column (org-get-indentation))) ; do nothing
  19320. ;; Lists
  19321. ((ignore-errors (goto-char (org-in-item-p)))
  19322. (setq column (if itemp
  19323. (org-get-indentation)
  19324. (org-list-item-body-column (point))))
  19325. (goto-char pos))
  19326. ;; Drawers
  19327. ((and (looking-at "[ \t]*:END:")
  19328. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  19329. (save-excursion
  19330. (goto-char (1- (match-beginning 1)))
  19331. (setq column (current-column))))
  19332. ;; Special blocks
  19333. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  19334. (save-excursion
  19335. (re-search-backward
  19336. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  19337. (setq column (org-get-indentation (match-string 0))))
  19338. ((and (not (looking-at "[ \t]*#\\+begin_"))
  19339. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  19340. (save-excursion
  19341. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  19342. (setq column
  19343. (cond ((equal (downcase (match-string 1)) "src")
  19344. ;; src blocks: let `org-edit-src-exit' handle them
  19345. (org-get-indentation))
  19346. ((equal (downcase (match-string 1)) "example")
  19347. (max (org-get-indentation)
  19348. (org-get-indentation (match-string 0))))
  19349. (t
  19350. (org-get-indentation (match-string 0))))))
  19351. ;; This line has nothing special, look at the previous relevant
  19352. ;; line to compute indentation
  19353. (t
  19354. (beginning-of-line 0)
  19355. (while (and (not (bobp))
  19356. (not (looking-at org-drawer-regexp))
  19357. ;; When point started in an inline task, do not move
  19358. ;; above task starting line.
  19359. (not (and inline-task-p (looking-at inline-re)))
  19360. ;; Skip drawers, blocks, empty lines, verbatim,
  19361. ;; comments, tables, footnotes definitions, lists,
  19362. ;; inline tasks.
  19363. (or (and (looking-at "[ \t]*:END:")
  19364. (re-search-backward org-drawer-regexp nil t))
  19365. (and (looking-at "[ \t]*#\\+end_")
  19366. (re-search-backward "[ \t]*#\\+begin_"nil t))
  19367. (looking-at "[ \t]*[\n:#|]")
  19368. (looking-at org-footnote-definition-re)
  19369. (and (ignore-errors (goto-char (org-in-item-p)))
  19370. (goto-char
  19371. (org-list-get-top-point (org-list-struct))))
  19372. (and (not inline-task-p)
  19373. (featurep 'org-inlinetask)
  19374. (org-inlinetask-in-task-p)
  19375. (or (org-inlinetask-goto-beginning) t))))
  19376. (beginning-of-line 0))
  19377. (cond
  19378. ;; There was an heading above.
  19379. ((looking-at "\\*+[ \t]+")
  19380. (if (not org-adapt-indentation)
  19381. (setq column 0)
  19382. (goto-char (match-end 0))
  19383. (setq column (current-column))))
  19384. ;; A drawer had started and is unfinished
  19385. ((looking-at org-drawer-regexp)
  19386. (goto-char (1- (match-beginning 1)))
  19387. (setq column (current-column)))
  19388. ;; Else, nothing noticeable found: get indentation and go on.
  19389. (t (setq column (org-get-indentation))))))
  19390. ;; Now apply indentation and move cursor accordingly
  19391. (goto-char pos)
  19392. (if (<= (current-column) (current-indentation))
  19393. (org-indent-line-to column)
  19394. (save-excursion (org-indent-line-to column)))
  19395. ;; Special polishing for properties, see `org-property-format'
  19396. (setq column (current-column))
  19397. (beginning-of-line 1)
  19398. (if (looking-at
  19399. "\\([ \t]*\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  19400. (replace-match (concat (match-string 1)
  19401. (format org-property-format
  19402. (match-string 2) (match-string 3)))
  19403. t t))
  19404. (org-move-to-column column))))
  19405. (defun org-indent-drawer ()
  19406. "Indent the drawer at point."
  19407. (interactive)
  19408. (let ((p (point))
  19409. (e (and (save-excursion (re-search-forward ":END:" nil t))
  19410. (match-end 0)))
  19411. (folded
  19412. (save-excursion
  19413. (end-of-line)
  19414. (when (overlays-at (point))
  19415. (member 'invisible (overlay-properties
  19416. (car (overlays-at (point)))))))))
  19417. (when folded (org-cycle))
  19418. (indent-for-tab-command)
  19419. (while (and (move-beginning-of-line 2) (< (point) e))
  19420. (indent-for-tab-command))
  19421. (goto-char p)
  19422. (when folded (org-cycle)))
  19423. (message "Drawer at point indented"))
  19424. (defun org-indent-block ()
  19425. "Indent the block at point."
  19426. (interactive)
  19427. (let ((p (point))
  19428. (case-fold-search t)
  19429. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  19430. (match-end 0)))
  19431. (folded
  19432. (save-excursion
  19433. (end-of-line)
  19434. (when (overlays-at (point))
  19435. (member 'invisible (overlay-properties
  19436. (car (overlays-at (point)))))))))
  19437. (when folded (org-cycle))
  19438. (indent-for-tab-command)
  19439. (while (and (move-beginning-of-line 2) (< (point) e))
  19440. (indent-for-tab-command))
  19441. (goto-char p)
  19442. (when folded (org-cycle)))
  19443. (message "Block at point indented"))
  19444. (defun org-indent-region (start end)
  19445. "Indent region."
  19446. (interactive "r")
  19447. (save-excursion
  19448. (let ((line-end (org-current-line end)))
  19449. (goto-char start)
  19450. (while (< (org-current-line) line-end)
  19451. (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
  19452. (t (call-interactively 'org-indent-line)))
  19453. (move-beginning-of-line 2)))))
  19454. ;;; Filling
  19455. ;; We use our own fill-paragraph and auto-fill functions.
  19456. ;; `org-fill-paragraph' relies on adaptive filling and context
  19457. ;; checking. Appropriate `fill-prefix' is computed with
  19458. ;; `org-adaptive-fill-function'.
  19459. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  19460. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  19461. ;; `org-adaptive-fill-function' value. Internally,
  19462. ;; `org-comment-line-break-function' breaks the line.
  19463. ;; `org-setup-filling' installs filling and auto-filling related
  19464. ;; variables during `org-mode' initialization.
  19465. (defun org-setup-filling ()
  19466. (interactive)
  19467. ;; Prevent auto-fill from inserting unwanted new items.
  19468. (when (boundp 'fill-nobreak-predicate)
  19469. (org-set-local
  19470. 'fill-nobreak-predicate
  19471. (org-uniquify
  19472. (append fill-nobreak-predicate
  19473. '(org-fill-paragraph-separate-nobreak-p
  19474. org-fill-line-break-nobreak-p)))))
  19475. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  19476. (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
  19477. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  19478. (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
  19479. (defvar org-element-paragraph-separate) ; org-element.el
  19480. (defun org-fill-paragraph-separate-nobreak-p ()
  19481. "Non-nil when a line break at point would insert a new item."
  19482. (looking-at (substring org-element-paragraph-separate 1)))
  19483. (defun org-fill-line-break-nobreak-p ()
  19484. "Non-nil when a line break at point would create an Org line break."
  19485. (save-excursion
  19486. (skip-chars-backward "[ \t]")
  19487. (skip-chars-backward "\\\\")
  19488. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  19489. (declare-function message-in-body-p "message" ())
  19490. (defvar org-element--affiliated-re) ; From org-element.el
  19491. (defun org-adaptive-fill-function ()
  19492. "Compute a fill prefix for the current line.
  19493. Return fill prefix, as a string, or nil if current line isn't
  19494. meant to be filled."
  19495. (org-with-wide-buffer
  19496. (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
  19497. ;; FIXME: This is really the job of orgstruct++-mode
  19498. (let* ((p (line-beginning-position))
  19499. (element (save-excursion (beginning-of-line)
  19500. (org-element-at-point)))
  19501. (type (org-element-type element))
  19502. (post-affiliated
  19503. (save-excursion
  19504. (goto-char (org-element-property :begin element))
  19505. (while (looking-at org-element--affiliated-re) (forward-line))
  19506. (point))))
  19507. (unless (< p post-affiliated)
  19508. (case type
  19509. (comment (looking-at "[ \t]*# ?") (match-string 0))
  19510. (footnote-definition "")
  19511. ((item plain-list)
  19512. (make-string (org-list-item-body-column post-affiliated) ? ))
  19513. (paragraph
  19514. ;; Fill prefix is usually the same as the current line,
  19515. ;; except if the paragraph is at the beginning of an item.
  19516. (let ((parent (org-element-property :parent element)))
  19517. (cond ((eq (org-element-type parent) 'item)
  19518. (make-string (org-list-item-body-column
  19519. (org-element-property :begin parent))
  19520. ? ))
  19521. ((save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  19522. (match-string 0))
  19523. (t ""))))
  19524. (comment-block
  19525. ;; Only fill contents if P is within block boundaries.
  19526. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  19527. (forward-line)
  19528. (point)))
  19529. (cend (save-excursion
  19530. (goto-char (org-element-property :end element))
  19531. (skip-chars-backward " \r\t\n")
  19532. (line-beginning-position))))
  19533. (when (and (>= p cbeg) (< p cend))
  19534. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  19535. (match-string 0)
  19536. ""))))))))))
  19537. (declare-function message-goto-body "message" ())
  19538. (defvar message-cite-prefix-regexp) ; From message.el
  19539. (defvar org-element-all-objects) ; From org-element.el
  19540. (defun org-fill-paragraph (&optional justify)
  19541. "Fill element at point, when applicable.
  19542. This function only applies to comment blocks, comments, example
  19543. blocks and paragraphs. Also, as a special case, re-align table
  19544. when point is at one.
  19545. If JUSTIFY is non-nil (interactively, with prefix argument),
  19546. justify as well. If `sentence-end-double-space' is non-nil, then
  19547. period followed by one space does not end a sentence, so don't
  19548. break a line there. The variable `fill-column' controls the
  19549. width for filling.
  19550. For convenience, when point is at a plain list, an item or
  19551. a footnote definition, try to fill the first paragraph within."
  19552. ;; Falls back on message-fill-paragraph when necessary
  19553. (interactive)
  19554. (if (and (derived-mode-p 'message-mode)
  19555. (or (not (message-in-body-p))
  19556. (save-excursion (move-beginning-of-line 1)
  19557. (looking-at message-cite-prefix-regexp))))
  19558. (let ((fill-paragraph-function
  19559. (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
  19560. (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
  19561. (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
  19562. (paragraph-separate
  19563. (cadadr (assoc 'paragraph-separate org-fb-vars))))
  19564. (fill-paragraph nil))
  19565. (save-excursion
  19566. ;; Move to end of line in order to get the first paragraph
  19567. ;; within a plain list or a footnote definition.
  19568. (end-of-line)
  19569. (let ((element (org-element-at-point)))
  19570. ;; First check if point is in a blank line at the beginning of
  19571. ;; the buffer. In that case, ignore filling.
  19572. (if (< (point) (org-element-property :begin element)) t
  19573. (case (org-element-type element)
  19574. ;; Align Org tables, leave table.el tables as-is.
  19575. (table-row (org-table-align) t)
  19576. (table
  19577. (when (eq (org-element-property :type element) 'org)
  19578. (org-table-align))
  19579. t)
  19580. (paragraph
  19581. ;; Paragraphs may contain `line-break' type objects.
  19582. (let ((beg (max (point-min)
  19583. (org-element-property :contents-begin element)))
  19584. (end (min (point-max)
  19585. (org-element-property :contents-end element))))
  19586. ;; Do nothing if point is at an affiliated keyword.
  19587. (if (< (point) beg) t
  19588. (when (derived-mode-p 'message-mode)
  19589. ;; In `message-mode', do not fill following
  19590. ;; citation in current paragraph nor text before
  19591. ;; message body.
  19592. (let ((body-start (save-excursion (message-goto-body))))
  19593. (when body-start (setq beg (max body-start beg))))
  19594. (when (save-excursion
  19595. (re-search-forward
  19596. (concat "^" message-cite-prefix-regexp) end t))
  19597. (setq end (match-beginning 0))))
  19598. ;; Fill paragraph, taking line breaks into
  19599. ;; consideration. For that, slice the paragraph
  19600. ;; using line breaks as separators, and fill the
  19601. ;; parts in reverse order to avoid messing with
  19602. ;; markers.
  19603. (save-excursion
  19604. (goto-char end)
  19605. (mapc
  19606. (lambda (pos)
  19607. (fill-region-as-paragraph pos (point) justify)
  19608. (goto-char pos))
  19609. ;; Find the list of ending positions for line
  19610. ;; breaks in the current paragraph. Add paragraph
  19611. ;; beginning to include first slice.
  19612. (nreverse
  19613. (cons
  19614. beg
  19615. (org-element-map
  19616. (org-element--parse-objects
  19617. beg end nil org-element-all-objects)
  19618. 'line-break
  19619. (lambda (lb) (org-element-property :end lb)))))))
  19620. t)))
  19621. ;; Contents of `comment-block' type elements should be
  19622. ;; filled as plain text, but only if point is within block
  19623. ;; markers.
  19624. (comment-block
  19625. (let* ((case-fold-search t)
  19626. (beg (save-excursion
  19627. (goto-char (org-element-property :begin element))
  19628. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  19629. (forward-line)
  19630. (point)))
  19631. (end (save-excursion
  19632. (goto-char (org-element-property :end element))
  19633. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  19634. (line-beginning-position))))
  19635. (when (and (>= (point) beg) (< (point) end))
  19636. (fill-region-as-paragraph
  19637. (save-excursion
  19638. (end-of-line)
  19639. (re-search-backward "^[ \t]*$" beg 'move)
  19640. (line-beginning-position))
  19641. (save-excursion
  19642. (beginning-of-line)
  19643. (re-search-forward "^[ \t]*$" end 'move)
  19644. (line-beginning-position))
  19645. justify)))
  19646. t)
  19647. ;; Fill comments.
  19648. (comment (fill-comment-paragraph justify))
  19649. ;; Ignore every other element.
  19650. (otherwise t)))))))
  19651. (defun org-auto-fill-function ()
  19652. "Auto-fill function."
  19653. ;; Check if auto-filling is meaningful.
  19654. (let ((fc (current-fill-column)))
  19655. (when (and fc (> (current-column) fc))
  19656. (let ((fill-prefix (org-adaptive-fill-function)))
  19657. (when fill-prefix (do-auto-fill))))))
  19658. (defun org-comment-line-break-function (&optional soft)
  19659. "Break line at point and indent, continuing comment if within one.
  19660. The inserted newline is marked hard if variable
  19661. `use-hard-newlines' is true, unless optional argument SOFT is
  19662. non-nil."
  19663. (if soft (insert-and-inherit ?\n) (newline 1))
  19664. (save-excursion (forward-char -1) (delete-horizontal-space))
  19665. (delete-horizontal-space)
  19666. (indent-to-left-margin)
  19667. (insert-before-markers-and-inherit fill-prefix))
  19668. ;;; Comments
  19669. ;; Org comments syntax is quite complex. It requires the entire line
  19670. ;; to be just a comment. Also, even with the right syntax at the
  19671. ;; beginning of line, some some elements (i.e. verse-block or
  19672. ;; example-block) don't accept comments. Usual Emacs comment commands
  19673. ;; cannot cope with those requirements. Therefore, Org replaces them.
  19674. ;; Org still relies on `comment-dwim', but cannot trust
  19675. ;; `comment-only-p'. So, `comment-region-function' and
  19676. ;; `uncomment-region-function' both point
  19677. ;; to`org-comment-or-uncomment-region'. Eventually,
  19678. ;; `org-insert-comment' takes care of insertion of comments at the
  19679. ;; beginning of line.
  19680. ;; `org-setup-comments-handling' install comments related variables
  19681. ;; during `org-mode' initialization.
  19682. (defun org-setup-comments-handling ()
  19683. (interactive)
  19684. (org-set-local 'comment-use-syntax nil)
  19685. (org-set-local 'comment-start "# ")
  19686. (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  19687. (org-set-local 'comment-insert-comment-function 'org-insert-comment)
  19688. (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
  19689. (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
  19690. (defun org-insert-comment ()
  19691. "Insert an empty comment above current line.
  19692. If the line is empty, insert comment at its beginning."
  19693. (beginning-of-line)
  19694. (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
  19695. (org-indent-line)
  19696. (insert "# "))
  19697. (defvar comment-empty-lines) ; From newcomment.el.
  19698. (defun org-comment-or-uncomment-region (beg end &rest ignore)
  19699. "Comment or uncomment each non-blank line in the region.
  19700. Uncomment each non-blank line between BEG and END if it only
  19701. contains commented lines. Otherwise, comment them."
  19702. (save-restriction
  19703. ;; Restrict region
  19704. (narrow-to-region (save-excursion (goto-char beg)
  19705. (skip-chars-forward " \r\t\n" end)
  19706. (line-beginning-position))
  19707. (save-excursion (goto-char end)
  19708. (skip-chars-backward " \r\t\n" beg)
  19709. (line-end-position)))
  19710. (let ((uncommentp
  19711. ;; UNCOMMENTP is non-nil when every non blank line between
  19712. ;; BEG and END is a comment.
  19713. (save-excursion
  19714. (goto-char (point-min))
  19715. (while (and (not (eobp))
  19716. (let ((element (org-element-at-point)))
  19717. (and (eq (org-element-type element) 'comment)
  19718. (goto-char (min (point-max)
  19719. (org-element-property
  19720. :end element)))))))
  19721. (eobp))))
  19722. (if uncommentp
  19723. ;; Only blank lines and comments in region: uncomment it.
  19724. (save-excursion
  19725. (goto-char (point-min))
  19726. (while (not (eobp))
  19727. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  19728. (replace-match "" nil nil nil 1))
  19729. (forward-line)))
  19730. ;; Comment each line in region.
  19731. (let ((min-indent (point-max)))
  19732. ;; First find the minimum indentation across all lines.
  19733. (save-excursion
  19734. (goto-char (point-min))
  19735. (while (and (not (eobp)) (not (zerop min-indent)))
  19736. (unless (looking-at "[ \t]*$")
  19737. (setq min-indent (min min-indent (current-indentation))))
  19738. (forward-line)))
  19739. ;; Then loop over all lines.
  19740. (save-excursion
  19741. (goto-char (point-min))
  19742. (while (not (eobp))
  19743. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  19744. (org-move-to-column min-indent t)
  19745. (insert comment-start))
  19746. (forward-line))))))))
  19747. ;;; Other stuff.
  19748. (defun org-toggle-fixed-width-section (arg)
  19749. "Toggle the fixed-width export.
  19750. If there is no active region, the QUOTE keyword at the current headline is
  19751. inserted or removed. When present, it causes the text between this headline
  19752. and the next to be exported as fixed-width text, and unmodified.
  19753. If there is an active region, this command adds or removes a colon as the
  19754. first character of this line. If the first character of a line is a colon,
  19755. this line is also exported in fixed-width font."
  19756. (interactive "P")
  19757. (let* ((cc 0)
  19758. (regionp (org-region-active-p))
  19759. (beg (if regionp (region-beginning) (point)))
  19760. (end (if regionp (region-end)))
  19761. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  19762. (case-fold-search nil)
  19763. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  19764. off)
  19765. (if regionp
  19766. (save-excursion
  19767. (goto-char beg)
  19768. (setq cc (current-column))
  19769. (beginning-of-line 1)
  19770. (setq off (looking-at re))
  19771. (while (> nlines 0)
  19772. (setq nlines (1- nlines))
  19773. (beginning-of-line 1)
  19774. (cond
  19775. (arg
  19776. (org-move-to-column cc t)
  19777. (insert ": \n")
  19778. (forward-line -1))
  19779. ((and off (looking-at re))
  19780. (replace-match "" t t nil 1))
  19781. ((not off) (org-move-to-column cc t) (insert ": ")))
  19782. (forward-line 1)))
  19783. (save-excursion
  19784. (org-back-to-heading)
  19785. (cond
  19786. ((looking-at (format org-heading-keyword-regexp-format
  19787. org-quote-string))
  19788. (goto-char (match-end 1))
  19789. (looking-at (concat " +" org-quote-string))
  19790. (replace-match "" t t)
  19791. (when (eolp) (insert " ")))
  19792. ((looking-at org-outline-regexp)
  19793. (goto-char (match-end 0))
  19794. (insert org-quote-string " ")))))))
  19795. (defun org-reftex-citation ()
  19796. "Use reftex-citation to insert a citation into the buffer.
  19797. This looks for a line like
  19798. #+BIBLIOGRAPHY: foo plain option:-d
  19799. and derives from it that foo.bib is the bibliography file relevant
  19800. for this document. It then installs the necessary environment for RefTeX
  19801. to work in this buffer and calls `reftex-citation' to insert a citation
  19802. into the buffer.
  19803. Export of such citations to both LaTeX and HTML is handled by the contributed
  19804. package org-exp-bibtex by Taru Karttunen."
  19805. (interactive)
  19806. (let ((reftex-docstruct-symbol 'rds)
  19807. (reftex-cite-format "\\cite{%l}")
  19808. rds bib)
  19809. (save-excursion
  19810. (save-restriction
  19811. (widen)
  19812. (let ((case-fold-search t)
  19813. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  19814. (if (not (save-excursion
  19815. (or (re-search-forward re nil t)
  19816. (re-search-backward re nil t))))
  19817. (error "No bibliography defined in file")
  19818. (setq bib (concat (match-string 1) ".bib")
  19819. rds (list (list 'bib bib)))))))
  19820. (call-interactively 'reftex-citation)))
  19821. ;;;; Functions extending outline functionality
  19822. (defun org-beginning-of-line (&optional arg)
  19823. "Go to the beginning of the current line. If that is invisible, continue
  19824. to a visible line beginning. This makes the function of C-a more intuitive.
  19825. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19826. first attempt, and only move to after the tags when the cursor is already
  19827. beyond the end of the headline."
  19828. (interactive "P")
  19829. (let ((pos (point))
  19830. (special (if (consp org-special-ctrl-a/e)
  19831. (car org-special-ctrl-a/e)
  19832. org-special-ctrl-a/e))
  19833. refpos)
  19834. (if (org-bound-and-true-p line-move-visual)
  19835. (beginning-of-visual-line 1)
  19836. (beginning-of-line 1))
  19837. (if (and arg (fboundp 'move-beginning-of-line))
  19838. (call-interactively 'move-beginning-of-line)
  19839. (if (bobp)
  19840. nil
  19841. (backward-char 1)
  19842. (if (org-truely-invisible-p)
  19843. (while (and (not (bobp)) (org-truely-invisible-p))
  19844. (backward-char 1)
  19845. (beginning-of-line 1))
  19846. (forward-char 1))))
  19847. (when special
  19848. (cond
  19849. ((and (looking-at org-complex-heading-regexp)
  19850. (= (char-after (match-end 1)) ?\ ))
  19851. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  19852. (point-at-eol)))
  19853. (goto-char
  19854. (if (eq special t)
  19855. (cond ((> pos refpos) refpos)
  19856. ((= pos (point)) refpos)
  19857. (t (point)))
  19858. (cond ((> pos (point)) (point))
  19859. ((not (eq last-command this-command)) (point))
  19860. (t refpos)))))
  19861. ((org-at-item-p)
  19862. ;; Being at an item and not looking at an the item means point
  19863. ;; was previously moved to beginning of a visual line, which
  19864. ;; doesn't contain the item. Therefore, do nothing special,
  19865. ;; just stay here.
  19866. (when (looking-at org-list-full-item-re)
  19867. ;; Set special position at first white space character after
  19868. ;; bullet, and check-box, if any.
  19869. (let ((after-bullet
  19870. (let ((box (match-end 3)))
  19871. (if (not box) (match-end 1)
  19872. (let ((after (char-after box)))
  19873. (if (and after (= after ? )) (1+ box) box))))))
  19874. ;; Special case: Move point to special position when
  19875. ;; currently after it or at beginning of line.
  19876. (if (eq special t)
  19877. (when (or (> pos after-bullet) (= (point) pos))
  19878. (goto-char after-bullet))
  19879. ;; Reversed case: Move point to special position when
  19880. ;; point was already at beginning of line and command is
  19881. ;; repeated.
  19882. (when (and (= (point) pos) (eq last-command this-command))
  19883. (goto-char after-bullet))))))))
  19884. (org-no-warnings
  19885. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19886. (defun org-end-of-line (&optional arg)
  19887. "Go to the end of the line.
  19888. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19889. first attempt, and only move to after the tags when the cursor is already
  19890. beyond the end of the headline."
  19891. (interactive "P")
  19892. (let ((special (if (consp org-special-ctrl-a/e)
  19893. (cdr org-special-ctrl-a/e)
  19894. org-special-ctrl-a/e)))
  19895. (cond
  19896. ((or (not special) arg
  19897. (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
  19898. (call-interactively
  19899. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19900. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19901. (t 'end-of-line))))
  19902. ((org-at-heading-p)
  19903. (let ((pos (point)))
  19904. (beginning-of-line 1)
  19905. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  19906. (if (eq special t)
  19907. (if (or (< pos (match-beginning 1))
  19908. (= pos (match-end 0)))
  19909. (goto-char (match-beginning 1))
  19910. (goto-char (match-end 0)))
  19911. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  19912. (goto-char (match-end 0))
  19913. (goto-char (match-beginning 1))))
  19914. (call-interactively (if (fboundp 'move-end-of-line)
  19915. 'move-end-of-line
  19916. 'end-of-line)))))
  19917. ((org-at-drawer-p)
  19918. (move-end-of-line 1)
  19919. (when (overlays-at (1- (point))) (backward-char 1)))
  19920. ;; At an item: Move before any hidden text.
  19921. (t (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-no-warnings
  19926. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19927. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  19928. (define-key org-mode-map "\C-e" 'org-end-of-line)
  19929. (defun org-backward-sentence (&optional arg)
  19930. "Go to beginning of sentence, or beginning of table field.
  19931. This will call `backward-sentence' or `org-table-beginning-of-field',
  19932. depending on context."
  19933. (interactive "P")
  19934. (cond
  19935. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  19936. (t (call-interactively 'backward-sentence))))
  19937. (defun org-forward-sentence (&optional arg)
  19938. "Go to end of sentence, or end of table field.
  19939. This will call `forward-sentence' or `org-table-end-of-field',
  19940. depending on context."
  19941. (interactive "P")
  19942. (cond
  19943. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  19944. (t (call-interactively 'forward-sentence))))
  19945. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  19946. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  19947. (defun org-kill-line (&optional arg)
  19948. "Kill line, to tags or end of line."
  19949. (interactive "P")
  19950. (cond
  19951. ((or (not org-special-ctrl-k)
  19952. (bolp)
  19953. (not (org-at-heading-p)))
  19954. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  19955. org-ctrl-k-protect-subtree)
  19956. (if (or (eq org-ctrl-k-protect-subtree 'error)
  19957. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  19958. (error "C-k aborted - would kill hidden subtree")))
  19959. (call-interactively
  19960. (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
  19961. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  19962. (kill-region (point) (match-beginning 1))
  19963. (org-set-tags nil t))
  19964. (t (kill-region (point) (point-at-eol)))))
  19965. (define-key org-mode-map "\C-k" 'org-kill-line)
  19966. (defun org-yank (&optional arg)
  19967. "Yank. If the kill is a subtree, treat it specially.
  19968. This command will look at the current kill and check if is a single
  19969. subtree, or a series of subtrees[1]. If it passes the test, and if the
  19970. cursor is at the beginning of a line or after the stars of a currently
  19971. empty headline, then the yank is handled specially. How exactly depends
  19972. on the value of the following variables, both set by default.
  19973. org-yank-folded-subtrees
  19974. When set, the subtree(s) will be folded after insertion, but only
  19975. if doing so would now swallow text after the yanked text.
  19976. org-yank-adjusted-subtrees
  19977. When set, the subtree will be promoted or demoted in order to
  19978. fit into the local outline tree structure, which means that the level
  19979. will be adjusted so that it becomes the smaller one of the two
  19980. *visible* surrounding headings.
  19981. Any prefix to this command will cause `yank' to be called directly with
  19982. no special treatment. In particular, a simple \\[universal-argument] prefix \
  19983. will just
  19984. plainly yank the text as it is.
  19985. \[1] The test checks if the first non-white line is a heading
  19986. and if there are no other headings with fewer stars."
  19987. (interactive "P")
  19988. (org-yank-generic 'yank arg))
  19989. (defun org-yank-generic (command arg)
  19990. "Perform some yank-like command.
  19991. This function implements the behavior described in the `org-yank'
  19992. documentation. However, it has been generalized to work for any
  19993. interactive command with similar behavior."
  19994. ;; pretend to be command COMMAND
  19995. (setq this-command command)
  19996. (if arg
  19997. (call-interactively command)
  19998. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  19999. (and (org-kill-is-subtree-p)
  20000. (or (bolp)
  20001. (and (looking-at "[ \t]*$")
  20002. (string-match
  20003. "\\`\\*+\\'"
  20004. (buffer-substring (point-at-bol) (point)))))))
  20005. swallowp)
  20006. (cond
  20007. ((and subtreep org-yank-folded-subtrees)
  20008. (let ((beg (point))
  20009. end)
  20010. (if (and subtreep org-yank-adjusted-subtrees)
  20011. (org-paste-subtree nil nil 'for-yank)
  20012. (call-interactively command))
  20013. (setq end (point))
  20014. (goto-char beg)
  20015. (when (and (bolp) subtreep
  20016. (not (setq swallowp
  20017. (org-yank-folding-would-swallow-text beg end))))
  20018. (org-with-limited-levels
  20019. (or (looking-at org-outline-regexp)
  20020. (re-search-forward org-outline-regexp-bol end t))
  20021. (while (and (< (point) end) (looking-at org-outline-regexp))
  20022. (hide-subtree)
  20023. (org-cycle-show-empty-lines 'folded)
  20024. (condition-case nil
  20025. (outline-forward-same-level 1)
  20026. (error (goto-char end))))))
  20027. (when swallowp
  20028. (message
  20029. "Inserted text not folded because that would swallow text"))
  20030. (goto-char end)
  20031. (skip-chars-forward " \t\n\r")
  20032. (beginning-of-line 1)
  20033. (push-mark beg 'nomsg)))
  20034. ((and subtreep org-yank-adjusted-subtrees)
  20035. (let ((beg (point-at-bol)))
  20036. (org-paste-subtree nil nil 'for-yank)
  20037. (push-mark beg 'nomsg)))
  20038. (t
  20039. (call-interactively command))))))
  20040. (defun org-yank-folding-would-swallow-text (beg end)
  20041. "Would hide-subtree at BEG swallow any text after END?"
  20042. (let (level)
  20043. (org-with-limited-levels
  20044. (save-excursion
  20045. (goto-char beg)
  20046. (when (or (looking-at org-outline-regexp)
  20047. (re-search-forward org-outline-regexp-bol end t))
  20048. (setq level (org-outline-level)))
  20049. (goto-char end)
  20050. (skip-chars-forward " \t\r\n\v\f")
  20051. (if (or (eobp)
  20052. (and (bolp) (looking-at org-outline-regexp)
  20053. (<= (org-outline-level) level)))
  20054. nil ; Nothing would be swallowed
  20055. t))))) ; something would swallow
  20056. (define-key org-mode-map "\C-y" 'org-yank)
  20057. (defun org-truely-invisible-p ()
  20058. "Check if point is at a character currently not visible.
  20059. This version does not only check the character property, but also
  20060. `visible-mode'."
  20061. ;; Early versions of noutline don't have `outline-invisible-p'.
  20062. (if (org-bound-and-true-p visible-mode)
  20063. nil
  20064. (outline-invisible-p)))
  20065. (defun org-invisible-p2 ()
  20066. "Check if point is at a character currently not visible."
  20067. (save-excursion
  20068. (if (and (eolp) (not (bobp))) (backward-char 1))
  20069. ;; Early versions of noutline don't have `outline-invisible-p'.
  20070. (outline-invisible-p)))
  20071. (defun org-back-to-heading (&optional invisible-ok)
  20072. "Call `outline-back-to-heading', but provide a better error message."
  20073. (condition-case nil
  20074. (outline-back-to-heading invisible-ok)
  20075. (error (error "Before first headline at position %d in buffer %s"
  20076. (point) (current-buffer)))))
  20077. (defun org-before-first-heading-p ()
  20078. "Before first heading?"
  20079. (save-excursion
  20080. (end-of-line)
  20081. (null (re-search-backward org-outline-regexp-bol nil t))))
  20082. (defun org-at-heading-p (&optional ignored)
  20083. (outline-on-heading-p t))
  20084. ;; Compatibility alias with Org versions < 7.8.03
  20085. (defalias 'org-on-heading-p 'org-at-heading-p)
  20086. (defun org-at-comment-p nil
  20087. "Is cursor in a line starting with a # character?"
  20088. (save-excursion
  20089. (beginning-of-line)
  20090. (looking-at "^#")))
  20091. (defun org-at-drawer-p nil
  20092. "Is cursor at a drawer keyword?"
  20093. (save-excursion
  20094. (move-beginning-of-line 1)
  20095. (looking-at org-drawer-regexp)))
  20096. (defun org-at-block-p nil
  20097. "Is cursor at a block keyword?"
  20098. (save-excursion
  20099. (move-beginning-of-line 1)
  20100. (looking-at org-block-regexp)))
  20101. (defun org-point-at-end-of-empty-headline ()
  20102. "If point is at the end of an empty headline, return t, else nil.
  20103. If the heading only contains a TODO keyword, it is still still considered
  20104. empty."
  20105. (and (looking-at "[ \t]*$")
  20106. (when org-todo-line-regexp
  20107. (save-excursion
  20108. (beginning-of-line 1)
  20109. (let ((case-fold-search nil))
  20110. (looking-at org-todo-line-regexp)
  20111. (string= (match-string 3) ""))))))
  20112. (defun org-at-heading-or-item-p ()
  20113. (or (org-at-heading-p) (org-at-item-p)))
  20114. (defun org-at-target-p ()
  20115. (or (org-in-regexp org-radio-target-regexp)
  20116. (org-in-regexp org-target-regexp)))
  20117. ;; Compatibility alias with Org versions < 7.8.03
  20118. (defalias 'org-on-target-p 'org-at-target-p)
  20119. (defun org-up-heading-all (arg)
  20120. "Move to the heading line of which the present line is a subheading.
  20121. This function considers both visible and invisible heading lines.
  20122. With argument, move up ARG levels."
  20123. (if (fboundp 'outline-up-heading-all)
  20124. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  20125. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  20126. (defun org-up-heading-safe ()
  20127. "Move to the heading line of which the present line is a subheading.
  20128. This version will not throw an error. It will return the level of the
  20129. headline found, or nil if no higher level is found.
  20130. Also, this function will be a lot faster than `outline-up-heading',
  20131. because it relies on stars being the outline starters. This can really
  20132. make a significant difference in outlines with very many siblings."
  20133. (let (start-level re)
  20134. (org-back-to-heading t)
  20135. (setq start-level (funcall outline-level))
  20136. (if (equal start-level 1)
  20137. nil
  20138. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  20139. (if (re-search-backward re nil t)
  20140. (funcall outline-level)))))
  20141. (defun org-first-sibling-p ()
  20142. "Is this heading the first child of its parents?"
  20143. (interactive)
  20144. (let ((re org-outline-regexp-bol)
  20145. level l)
  20146. (unless (org-at-heading-p t)
  20147. (error "Not at a heading"))
  20148. (setq level (funcall outline-level))
  20149. (save-excursion
  20150. (if (not (re-search-backward re nil t))
  20151. t
  20152. (setq l (funcall outline-level))
  20153. (< l level)))))
  20154. (defun org-goto-sibling (&optional previous)
  20155. "Goto the next sibling, even if it is invisible.
  20156. When PREVIOUS is set, go to the previous sibling instead. Returns t
  20157. when a sibling was found. When none is found, return nil and don't
  20158. move point."
  20159. (let ((fun (if previous 're-search-backward 're-search-forward))
  20160. (pos (point))
  20161. (re org-outline-regexp-bol)
  20162. level l)
  20163. (when (condition-case nil (org-back-to-heading t) (error nil))
  20164. (setq level (funcall outline-level))
  20165. (catch 'exit
  20166. (or previous (forward-char 1))
  20167. (while (funcall fun re nil t)
  20168. (setq l (funcall outline-level))
  20169. (when (< l level) (goto-char pos) (throw 'exit nil))
  20170. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  20171. (goto-char pos)
  20172. nil))))
  20173. (defun org-show-siblings ()
  20174. "Show all siblings of the current headline."
  20175. (save-excursion
  20176. (while (org-goto-sibling) (org-flag-heading nil)))
  20177. (save-excursion
  20178. (while (org-goto-sibling 'previous)
  20179. (org-flag-heading nil))))
  20180. (defun org-goto-first-child ()
  20181. "Goto the first child, even if it is invisible.
  20182. Return t when a child was found. Otherwise don't move point and
  20183. return nil."
  20184. (let (level (pos (point)) (re org-outline-regexp-bol))
  20185. (when (condition-case nil (org-back-to-heading t) (error nil))
  20186. (setq level (outline-level))
  20187. (forward-char 1)
  20188. (if (and (re-search-forward re nil t) (> (outline-level) level))
  20189. (progn (goto-char (match-beginning 0)) t)
  20190. (goto-char pos) nil))))
  20191. (defun org-show-hidden-entry ()
  20192. "Show an entry where even the heading is hidden."
  20193. (save-excursion
  20194. (org-show-entry)))
  20195. (defun org-flag-heading (flag &optional entry)
  20196. "Flag the current heading. FLAG non-nil means make invisible.
  20197. When ENTRY is non-nil, show the entire entry."
  20198. (save-excursion
  20199. (org-back-to-heading t)
  20200. ;; Check if we should show the entire entry
  20201. (if entry
  20202. (progn
  20203. (org-show-entry)
  20204. (save-excursion
  20205. (and (outline-next-heading)
  20206. (org-flag-heading nil))))
  20207. (outline-flag-region (max (point-min) (1- (point)))
  20208. (save-excursion (outline-end-of-heading) (point))
  20209. flag))))
  20210. (defun org-get-next-sibling ()
  20211. "Move to next heading of the same level, and return point.
  20212. If there is no such heading, return nil.
  20213. This is like outline-next-sibling, but invisible headings are ok."
  20214. (let ((level (funcall outline-level)))
  20215. (outline-next-heading)
  20216. (while (and (not (eobp)) (> (funcall outline-level) level))
  20217. (outline-next-heading))
  20218. (if (or (eobp) (< (funcall outline-level) level))
  20219. nil
  20220. (point))))
  20221. (defun org-get-last-sibling ()
  20222. "Move to previous heading of the same level, and return point.
  20223. If there is no such heading, return nil."
  20224. (let ((opoint (point))
  20225. (level (funcall outline-level)))
  20226. (outline-previous-heading)
  20227. (when (and (/= (point) opoint) (outline-on-heading-p t))
  20228. (while (and (> (funcall outline-level) level)
  20229. (not (bobp)))
  20230. (outline-previous-heading))
  20231. (if (< (funcall outline-level) level)
  20232. nil
  20233. (point)))))
  20234. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  20235. ;; This contains an exact copy of the original function, but it uses
  20236. ;; `org-back-to-heading', to make it work also in invisible
  20237. ;; trees. And is uses an invisible-OK argument.
  20238. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  20239. ;; Furthermore, when used inside Org, finding the end of a large subtree
  20240. ;; with many children and grandchildren etc, this can be much faster
  20241. ;; than the outline version.
  20242. (org-back-to-heading invisible-OK)
  20243. (let ((first t)
  20244. (level (funcall outline-level)))
  20245. (if (and (derived-mode-p 'org-mode) (< level 1000))
  20246. ;; A true heading (not a plain list item), in Org-mode
  20247. ;; This means we can easily find the end by looking
  20248. ;; only for the right number of stars. Using a regexp to do
  20249. ;; this is so much faster than using a Lisp loop.
  20250. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  20251. (forward-char 1)
  20252. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  20253. ;; something else, do it the slow way
  20254. (while (and (not (eobp))
  20255. (or first (> (funcall outline-level) level)))
  20256. (setq first nil)
  20257. (outline-next-heading)))
  20258. (unless to-heading
  20259. (if (memq (preceding-char) '(?\n ?\^M))
  20260. (progn
  20261. ;; Go to end of line before heading
  20262. (forward-char -1)
  20263. (if (memq (preceding-char) '(?\n ?\^M))
  20264. ;; leave blank line before heading
  20265. (forward-char -1))))))
  20266. (point))
  20267. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  20268. "Use Org version in org-mode, for dramatic speed-up."
  20269. (if (derived-mode-p 'org-mode)
  20270. (progn
  20271. (org-end-of-subtree nil t)
  20272. (unless (eobp) (backward-char 1)))
  20273. ad-do-it))
  20274. (defun org-end-of-meta-data-and-drawers ()
  20275. "Jump to the first text after meta data and drawers in the current entry.
  20276. This will move over empty lines, lines with planning time stamps,
  20277. clocking lines, and drawers."
  20278. (org-back-to-heading t)
  20279. (let ((end (save-excursion (outline-next-heading) (point)))
  20280. (re (concat "\\(" org-drawer-regexp "\\)"
  20281. "\\|" "[ \t]*" org-keyword-time-regexp)))
  20282. (forward-line 1)
  20283. (while (re-search-forward re end t)
  20284. (if (not (match-end 1))
  20285. ;; empty or planning line
  20286. (forward-line 1)
  20287. ;; a drawer, find the end
  20288. (re-search-forward "^[ \t]*:END:" end 'move)
  20289. (forward-line 1)))
  20290. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  20291. (point)))
  20292. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  20293. "Move forward to the arg'th subheading at same level as this one.
  20294. Stop at the first and last subheadings of a superior heading.
  20295. Normally this only looks at visible headings, but when INVISIBLE-OK is
  20296. non-nil it will also look at invisible ones."
  20297. (interactive "p")
  20298. (org-back-to-heading invisible-ok)
  20299. (org-at-heading-p)
  20300. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20301. (re (format "^\\*\\{1,%d\\} " level))
  20302. l)
  20303. (forward-char 1)
  20304. (while (> arg 0)
  20305. (while (and (re-search-forward re nil 'move)
  20306. (setq l (- (match-end 0) (match-beginning 0) 1))
  20307. (= l level)
  20308. (not invisible-ok)
  20309. (progn (backward-char 1) (outline-invisible-p)))
  20310. (if (< l level) (setq arg 1)))
  20311. (setq arg (1- arg)))
  20312. (beginning-of-line 1)))
  20313. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  20314. "Move backward to the arg'th subheading at same level as this one.
  20315. Stop at the first and last subheadings of a superior heading."
  20316. (interactive "p")
  20317. (org-back-to-heading)
  20318. (org-at-heading-p)
  20319. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20320. (re (format "^\\*\\{1,%d\\} " level))
  20321. l)
  20322. (while (> arg 0)
  20323. (while (and (re-search-backward re nil 'move)
  20324. (setq l (- (match-end 0) (match-beginning 0) 1))
  20325. (= l level)
  20326. (not invisible-ok)
  20327. (outline-invisible-p))
  20328. (if (< l level) (setq arg 1)))
  20329. (setq arg (1- arg)))))
  20330. ;;;###autoload
  20331. (defun org-forward-element ()
  20332. "Move forward by one element.
  20333. Move to the next element at the same level, when possible."
  20334. (interactive)
  20335. (cond ((eobp) (error "Cannot move further down"))
  20336. ((org-with-limited-levels (org-at-heading-p))
  20337. (let ((origin (point)))
  20338. (org-forward-heading-same-level 1)
  20339. (unless (org-with-limited-levels (org-at-heading-p))
  20340. (goto-char origin)
  20341. (error "Cannot move further down"))))
  20342. (t
  20343. (let* ((elem (org-element-at-point))
  20344. (end (org-element-property :end elem))
  20345. (parent (org-element-property :parent elem)))
  20346. (if (and parent (= (org-element-property :contents-end parent) end))
  20347. (goto-char (org-element-property :end parent))
  20348. (goto-char end))))))
  20349. ;;;###autoload
  20350. (defun org-backward-element ()
  20351. "Move backward by one element.
  20352. Move to the previous element at the same level, when possible."
  20353. (interactive)
  20354. (cond ((bobp) (error "Cannot move further up"))
  20355. ((org-with-limited-levels (org-at-heading-p))
  20356. ;; At an headline, move to the previous one, if any, or stay
  20357. ;; here.
  20358. (let ((origin (point)))
  20359. (org-backward-heading-same-level 1)
  20360. (unless (org-with-limited-levels (org-at-heading-p))
  20361. (goto-char origin)
  20362. (error "Cannot move further up"))))
  20363. (t
  20364. (let* ((trail (org-element-at-point 'keep-trail))
  20365. (elem (car trail))
  20366. (prev-elem (nth 1 trail))
  20367. (beg (org-element-property :begin elem)))
  20368. (cond
  20369. ;; Move to beginning of current element if point isn't
  20370. ;; there already.
  20371. ((/= (point) beg) (goto-char beg))
  20372. (prev-elem (goto-char (org-element-property :begin prev-elem)))
  20373. ((org-before-first-heading-p) (goto-char (point-min)))
  20374. (t (org-back-to-heading)))))))
  20375. ;;;###autoload
  20376. (defun org-up-element ()
  20377. "Move to upper element."
  20378. (interactive)
  20379. (if (org-with-limited-levels (org-at-heading-p))
  20380. (unless (org-up-heading-safe) (error "No surrounding element"))
  20381. (let* ((elem (org-element-at-point))
  20382. (parent (org-element-property :parent elem)))
  20383. (if parent (goto-char (org-element-property :begin parent))
  20384. (if (org-with-limited-levels (org-before-first-heading-p))
  20385. (error "No surrounding element")
  20386. (org-with-limited-levels (org-back-to-heading)))))))
  20387. ;;;###autoload
  20388. (defvar org-element-greater-elements)
  20389. (defun org-down-element ()
  20390. "Move to inner element."
  20391. (interactive)
  20392. (let ((element (org-element-at-point)))
  20393. (cond
  20394. ((memq (org-element-type element) '(plain-list table))
  20395. (goto-char (org-element-property :contents-begin element))
  20396. (forward-char))
  20397. ((memq (org-element-type element) org-element-greater-elements)
  20398. ;; If contents are hidden, first disclose them.
  20399. (when (org-element-property :hiddenp element) (org-cycle))
  20400. (goto-char (or (org-element-property :contents-begin element)
  20401. (error "No content for this element"))))
  20402. (t (error "No inner element")))))
  20403. ;;;###autoload
  20404. (defun org-drag-element-backward ()
  20405. "Move backward element at point."
  20406. (interactive)
  20407. (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
  20408. (let* ((trail (org-element-at-point 'keep-trail))
  20409. (elem (car trail))
  20410. (prev-elem (nth 1 trail)))
  20411. ;; Error out if no previous element or previous element is
  20412. ;; a parent of the current one.
  20413. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  20414. (error "Cannot drag element backward")
  20415. (let ((pos (point)))
  20416. (org-element-swap-A-B prev-elem elem)
  20417. (goto-char (+ (org-element-property :begin prev-elem)
  20418. (- pos (org-element-property :begin elem)))))))))
  20419. ;;;###autoload
  20420. (defun org-drag-element-forward ()
  20421. "Move forward element at point."
  20422. (interactive)
  20423. (let* ((pos (point))
  20424. (elem (org-element-at-point)))
  20425. (when (= (point-max) (org-element-property :end elem))
  20426. (error "Cannot drag element forward"))
  20427. (goto-char (org-element-property :end elem))
  20428. (let ((next-elem (org-element-at-point)))
  20429. (when (or (org-element-nested-p elem next-elem)
  20430. (and (eq (org-element-type next-elem) 'headline)
  20431. (not (eq (org-element-type elem) 'headline))))
  20432. (goto-char pos)
  20433. (error "Cannot drag element forward"))
  20434. ;; Compute new position of point: it's shifted by NEXT-ELEM
  20435. ;; body's length (without final blanks) and by the length of
  20436. ;; blanks between ELEM and NEXT-ELEM.
  20437. (let ((size-next (- (save-excursion
  20438. (goto-char (org-element-property :end next-elem))
  20439. (skip-chars-backward " \r\t\n")
  20440. (forward-line)
  20441. ;; Small correction if buffer doesn't end
  20442. ;; with a newline character.
  20443. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  20444. (org-element-property :begin next-elem)))
  20445. (size-blank (- (org-element-property :end elem)
  20446. (save-excursion
  20447. (goto-char (org-element-property :end elem))
  20448. (skip-chars-backward " \r\t\n")
  20449. (forward-line)
  20450. (point)))))
  20451. (org-element-swap-A-B elem next-elem)
  20452. (goto-char (+ pos size-next size-blank))))))
  20453. ;;;###autoload
  20454. (defun org-mark-element ()
  20455. "Put point at beginning of this element, mark at end.
  20456. Interactively, if this command is repeated or (in Transient Mark
  20457. mode) if the mark is active, it marks the next element after the
  20458. ones already marked."
  20459. (interactive)
  20460. (let (deactivate-mark)
  20461. (if (and (org-called-interactively-p 'any)
  20462. (or (and (eq last-command this-command) (mark t))
  20463. (and transient-mark-mode mark-active)))
  20464. (set-mark
  20465. (save-excursion
  20466. (goto-char (mark))
  20467. (goto-char (org-element-property :end (org-element-at-point)))))
  20468. (let ((element (org-element-at-point)))
  20469. (end-of-line)
  20470. (push-mark (org-element-property :end element) t t)
  20471. (goto-char (org-element-property :begin element))))))
  20472. ;;;###autoload
  20473. (defun org-narrow-to-element ()
  20474. "Narrow buffer to current element."
  20475. (interactive)
  20476. (let ((elem (org-element-at-point)))
  20477. (cond
  20478. ((eq (car elem) 'headline)
  20479. (narrow-to-region
  20480. (org-element-property :begin elem)
  20481. (org-element-property :end elem)))
  20482. ((memq (car elem) org-element-greater-elements)
  20483. (narrow-to-region
  20484. (org-element-property :contents-begin elem)
  20485. (org-element-property :contents-end elem)))
  20486. (t
  20487. (narrow-to-region
  20488. (org-element-property :begin elem)
  20489. (org-element-property :end elem))))))
  20490. ;;;###autoload
  20491. (defun org-transpose-element ()
  20492. "Transpose current and previous elements, keeping blank lines between.
  20493. Point is moved after both elements."
  20494. (interactive)
  20495. (org-skip-whitespace)
  20496. (let ((end (org-element-property :end (org-element-at-point))))
  20497. (org-drag-element-backward)
  20498. (goto-char end)))
  20499. ;;;###autoload
  20500. (defun org-unindent-buffer ()
  20501. "Un-indent the visible part of the buffer.
  20502. Relative indentation (between items, inside blocks, etc.) isn't
  20503. modified."
  20504. (interactive)
  20505. (unless (eq major-mode 'org-mode)
  20506. (error "Cannot un-indent a buffer not in Org mode"))
  20507. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  20508. unindent-tree ; For byte-compiler.
  20509. (unindent-tree
  20510. (function
  20511. (lambda (contents)
  20512. (mapc
  20513. (lambda (element)
  20514. (if (memq (org-element-type element) '(headline section))
  20515. (funcall unindent-tree (org-element-contents element))
  20516. (save-excursion
  20517. (save-restriction
  20518. (narrow-to-region
  20519. (org-element-property :begin element)
  20520. (org-element-property :end element))
  20521. (org-do-remove-indentation)))))
  20522. (reverse contents))))))
  20523. (funcall unindent-tree (org-element-contents parse-tree))))
  20524. (defun org-show-subtree ()
  20525. "Show everything after this heading at deeper levels."
  20526. (interactive)
  20527. (outline-flag-region
  20528. (point)
  20529. (save-excursion
  20530. (org-end-of-subtree t t))
  20531. nil))
  20532. (defun org-show-entry ()
  20533. "Show the body directly following this heading.
  20534. Show the heading too, if it is currently invisible."
  20535. (interactive)
  20536. (save-excursion
  20537. (condition-case nil
  20538. (progn
  20539. (org-back-to-heading t)
  20540. (outline-flag-region
  20541. (max (point-min) (1- (point)))
  20542. (save-excursion
  20543. (if (re-search-forward
  20544. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  20545. (match-beginning 1)
  20546. (point-max)))
  20547. nil)
  20548. (org-cycle-hide-drawers 'children))
  20549. (error nil))))
  20550. (defun org-make-options-regexp (kwds &optional extra)
  20551. "Make a regular expression for keyword lines."
  20552. (concat
  20553. "^#\\+\\("
  20554. (mapconcat 'regexp-quote kwds "\\|")
  20555. (if extra (concat "\\|" extra))
  20556. "\\):[ \t]*\\(.*\\)"))
  20557. ;; Make isearch reveal the necessary context
  20558. (defun org-isearch-end ()
  20559. "Reveal context after isearch exits."
  20560. (when isearch-success ; only if search was successful
  20561. (if (featurep 'xemacs)
  20562. ;; Under XEmacs, the hook is run in the correct place,
  20563. ;; we directly show the context.
  20564. (org-show-context 'isearch)
  20565. ;; In Emacs the hook runs *before* restoring the overlays.
  20566. ;; So we have to use a one-time post-command-hook to do this.
  20567. ;; (Emacs 22 has a special variable, see function `org-mode')
  20568. (unless (and (boundp 'isearch-mode-end-hook-quit)
  20569. isearch-mode-end-hook-quit)
  20570. ;; Only when the isearch was not quitted.
  20571. (org-add-hook 'post-command-hook 'org-isearch-post-command
  20572. 'append 'local)))))
  20573. (defun org-isearch-post-command ()
  20574. "Remove self from hook, and show context."
  20575. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  20576. (org-show-context 'isearch))
  20577. ;;;; Integration with and fixes for other packages
  20578. ;;; Imenu support
  20579. (defvar org-imenu-markers nil
  20580. "All markers currently used by Imenu.")
  20581. (make-variable-buffer-local 'org-imenu-markers)
  20582. (defun org-imenu-new-marker (&optional pos)
  20583. "Return a new marker for use by Imenu, and remember the marker."
  20584. (let ((m (make-marker)))
  20585. (move-marker m (or pos (point)))
  20586. (push m org-imenu-markers)
  20587. m))
  20588. (defun org-imenu-get-tree ()
  20589. "Produce the index for Imenu."
  20590. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  20591. (setq org-imenu-markers nil)
  20592. (let* ((n org-imenu-depth)
  20593. (re (concat "^" (org-get-limited-outline-regexp)))
  20594. (subs (make-vector (1+ n) nil))
  20595. (last-level 0)
  20596. m level head)
  20597. (save-excursion
  20598. (save-restriction
  20599. (widen)
  20600. (goto-char (point-max))
  20601. (while (re-search-backward re nil t)
  20602. (setq level (org-reduced-level (funcall outline-level)))
  20603. (when (and (<= level n)
  20604. (looking-at org-complex-heading-regexp))
  20605. (setq head (org-link-display-format
  20606. (org-match-string-no-properties 4))
  20607. m (org-imenu-new-marker))
  20608. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  20609. (if (>= level last-level)
  20610. (push (cons head m) (aref subs level))
  20611. (push (cons head (aref subs (1+ level))) (aref subs level))
  20612. (loop for i from (1+ level) to n do (aset subs i nil)))
  20613. (setq last-level level)))))
  20614. (aref subs 1)))
  20615. (eval-after-load "imenu"
  20616. '(progn
  20617. (add-hook 'imenu-after-jump-hook
  20618. (lambda ()
  20619. (if (derived-mode-p 'org-mode)
  20620. (org-show-context 'org-goto))))))
  20621. (defun org-link-display-format (link)
  20622. "Replace a link with either the description, or the link target
  20623. if no description is present"
  20624. (save-match-data
  20625. (if (string-match org-bracket-link-analytic-regexp link)
  20626. (replace-match (if (match-end 5)
  20627. (match-string 5 link)
  20628. (concat (match-string 1 link)
  20629. (match-string 3 link)))
  20630. nil t link)
  20631. link)))
  20632. (defun org-toggle-link-display ()
  20633. "Toggle the literal or descriptive display of links."
  20634. (interactive)
  20635. (if org-descriptive-links
  20636. (progn (org-remove-from-invisibility-spec '(org-link))
  20637. (org-restart-font-lock)
  20638. (setq org-descriptive-links nil))
  20639. (progn (add-to-invisibility-spec '(org-link))
  20640. (org-restart-font-lock)
  20641. (setq org-descriptive-links t))))
  20642. ;; Speedbar support
  20643. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  20644. "Overlay marking the agenda restriction line in speedbar.")
  20645. (overlay-put org-speedbar-restriction-lock-overlay
  20646. 'face 'org-agenda-restriction-lock)
  20647. (overlay-put org-speedbar-restriction-lock-overlay
  20648. 'help-echo "Agendas are currently limited to this item.")
  20649. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  20650. (defun org-speedbar-set-agenda-restriction ()
  20651. "Restrict future agenda commands to the location at point in speedbar.
  20652. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  20653. (interactive)
  20654. (require 'org-agenda)
  20655. (let (p m tp np dir txt)
  20656. (cond
  20657. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20658. 'org-imenu t))
  20659. (setq m (get-text-property p 'org-imenu-marker))
  20660. (with-current-buffer (marker-buffer m)
  20661. (goto-char m)
  20662. (org-agenda-set-restriction-lock 'subtree)))
  20663. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20664. 'speedbar-function 'speedbar-find-file))
  20665. (setq tp (previous-single-property-change
  20666. (1+ p) 'speedbar-function)
  20667. np (next-single-property-change
  20668. tp 'speedbar-function)
  20669. dir (speedbar-line-directory)
  20670. txt (buffer-substring-no-properties (or tp (point-min))
  20671. (or np (point-max))))
  20672. (with-current-buffer (find-file-noselect
  20673. (let ((default-directory dir))
  20674. (expand-file-name txt)))
  20675. (unless (derived-mode-p 'org-mode)
  20676. (error "Cannot restrict to non-Org-mode file"))
  20677. (org-agenda-set-restriction-lock 'file)))
  20678. (t (error "Don't know how to restrict Org-mode's agenda")))
  20679. (move-overlay org-speedbar-restriction-lock-overlay
  20680. (point-at-bol) (point-at-eol))
  20681. (setq current-prefix-arg nil)
  20682. (org-agenda-maybe-redo)))
  20683. (eval-after-load "speedbar"
  20684. '(progn
  20685. (speedbar-add-supported-extension ".org")
  20686. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  20687. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  20688. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  20689. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  20690. (add-hook 'speedbar-visiting-tag-hook
  20691. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  20692. ;;; Fixes and Hacks for problems with other packages
  20693. ;; Make flyspell not check words in links, to not mess up our keymap
  20694. (defun org-mode-flyspell-verify ()
  20695. "Don't let flyspell put overlays at active buttons, or on
  20696. {todo,all-time,additional-option-like}-keywords."
  20697. (let ((pos (max (1- (point)) (point-min)))
  20698. (word (thing-at-point 'word)))
  20699. (and (not (get-text-property pos 'keymap))
  20700. (not (get-text-property pos 'org-no-flyspell))
  20701. (not (member word org-todo-keywords-1))
  20702. (not (member word org-all-time-keywords))
  20703. (not (member word org-options-keywords))
  20704. (not (member word (mapcar 'car org-startup-options)))
  20705. (not (member word org-additional-option-like-keywords-for-flyspell)))))
  20706. (defun org-remove-flyspell-overlays-in (beg end)
  20707. "Remove flyspell overlays in region."
  20708. (and (org-bound-and-true-p flyspell-mode)
  20709. (fboundp 'flyspell-delete-region-overlays)
  20710. (flyspell-delete-region-overlays beg end))
  20711. (add-text-properties beg end '(org-no-flyspell t)))
  20712. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  20713. (eval-after-load "bookmark"
  20714. '(if (boundp 'bookmark-after-jump-hook)
  20715. ;; We can use the hook
  20716. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  20717. ;; Hook not available, use advice
  20718. (defadvice bookmark-jump (after org-make-visible activate)
  20719. "Make the position visible."
  20720. (org-bookmark-jump-unhide))))
  20721. ;; Make sure saveplace shows the location if it was hidden
  20722. (eval-after-load "saveplace"
  20723. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  20724. "Make the position visible."
  20725. (org-bookmark-jump-unhide)))
  20726. ;; Make sure ecb shows the location if it was hidden
  20727. (eval-after-load "ecb"
  20728. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  20729. "Make hierarchy visible when jumping into location from ECB tree buffer."
  20730. (if (derived-mode-p 'org-mode)
  20731. (org-show-context))))
  20732. (defun org-bookmark-jump-unhide ()
  20733. "Unhide the current position, to show the bookmark location."
  20734. (and (derived-mode-p 'org-mode)
  20735. (or (outline-invisible-p)
  20736. (save-excursion (goto-char (max (point-min) (1- (point))))
  20737. (outline-invisible-p)))
  20738. (org-show-context 'bookmark-jump)))
  20739. ;; Make session.el ignore our circular variable
  20740. (eval-after-load "session"
  20741. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  20742. ;;;; Experimental code
  20743. (defun org-closed-in-range ()
  20744. "Sparse tree of items closed in a certain time range.
  20745. Still experimental, may disappear in the future."
  20746. (interactive)
  20747. ;; Get the time interval from the user.
  20748. (let* ((time1 (org-float-time
  20749. (org-read-date nil 'to-time nil "Starting date: ")))
  20750. (time2 (org-float-time
  20751. (org-read-date nil 'to-time nil "End date:")))
  20752. ;; callback function
  20753. (callback (lambda ()
  20754. (let ((time
  20755. (org-float-time
  20756. (apply 'encode-time
  20757. (org-parse-time-string
  20758. (match-string 1))))))
  20759. ;; check if time in interval
  20760. (and (>= time time1) (<= time time2))))))
  20761. ;; make tree, check each match with the callback
  20762. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  20763. ;;;; Finish up
  20764. (provide 'org)
  20765. (run-hooks 'org-load-hook)
  20766. ;;; org.el ends here