org.el 855 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
  4. ;;
  5. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  6. ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
  7. ;; Keywords: outlines, hypermedia, calendar, wp
  8. ;; Homepage: http://orgmode.org
  9. ;;
  10. ;; This file is part of GNU Emacs.
  11. ;;
  12. ;; GNU Emacs is free software: you can redistribute it and/or modify
  13. ;; it under the terms of the GNU General Public License as published by
  14. ;; the Free Software Foundation, either version 3 of the License, or
  15. ;; (at your option) any later version.
  16. ;; GNU Emacs is distributed in the hope that it will be useful,
  17. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. ;; GNU General Public License for more details.
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  22. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  23. ;;
  24. ;;; Commentary:
  25. ;;
  26. ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  27. ;; project planning with a fast and effective plain-text system.
  28. ;;
  29. ;; Org-mode develops organizational tasks around NOTES files that contain
  30. ;; information about projects as plain text. Org-mode is implemented on
  31. ;; top of outline-mode, which makes it possible to keep the content of
  32. ;; large files well structured. Visibility cycling and structure editing
  33. ;; help to work with the tree. Tables are easily created with a built-in
  34. ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
  35. ;; and scheduling. It dynamically compiles entries into an agenda that
  36. ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
  37. ;; Plain text URL-like links connect to websites, emails, Usenet
  38. ;; messages, BBDB entries, and any files related to the projects. For
  39. ;; printing and sharing of notes, an Org-mode file can be exported as a
  40. ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
  41. ;; iCalendar file. It can also serve as a publishing tool for a set of
  42. ;; linked webpages.
  43. ;;
  44. ;; Installation and Activation
  45. ;; ---------------------------
  46. ;; See the corresponding sections in the manual at
  47. ;;
  48. ;; http://orgmode.org/org.html#Installation
  49. ;;
  50. ;; Documentation
  51. ;; -------------
  52. ;; The documentation of Org-mode can be found in the TeXInfo file. The
  53. ;; distribution also contains a PDF version of it. At the homepage of
  54. ;; Org-mode, you can read the same text online as HTML. There is also an
  55. ;; excellent reference card made by Philip Rooke. This card can be found
  56. ;; in the etc/ directory of Emacs 22.
  57. ;;
  58. ;; A list of recent changes can be found at
  59. ;; http://orgmode.org/Changes.html
  60. ;;
  61. ;;; Code:
  62. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  63. (defvar org-table-formula-constants-local nil
  64. "Local version of `org-table-formula-constants'.")
  65. (make-variable-buffer-local 'org-table-formula-constants-local)
  66. ;;;; Require other packages
  67. (eval-when-compile
  68. (require 'cl)
  69. (require 'gnus-sum))
  70. (require 'calendar)
  71. (require 'find-func)
  72. (require 'format-spec)
  73. ;; `org-outline-regexp' ought to be a defconst but is let-binding in
  74. ;; some places -- e.g. see the macro org-with-limited-levels.
  75. ;;
  76. ;; In Org buffers, the value of `outline-regexp' is that of
  77. ;; `org-outline-regexp'. The only function still directly relying on
  78. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  79. ;; job when `orgstruct-mode' is active.
  80. (defvar org-outline-regexp "\\*+ "
  81. "Regexp to match Org headlines.")
  82. (defvar org-outline-regexp-bol "^\\*+ "
  83. "Regexp to match Org headlines.
  84. This is similar to `org-outline-regexp' but additionally makes
  85. sure that we are at the beginning of the line.")
  86. (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  87. "Matches an headline, putting stars and text into groups.
  88. Stars are put in group 1 and the trimmed body in group 2.")
  89. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  90. (when (fboundp 'defvaralias)
  91. (unless (boundp 'calendar-view-holidays-initially-flag)
  92. (defvaralias 'calendar-view-holidays-initially-flag
  93. 'view-calendar-holidays-initially))
  94. (unless (boundp 'calendar-view-diary-initially-flag)
  95. (defvaralias 'calendar-view-diary-initially-flag
  96. 'view-diary-entries-initially))
  97. (unless (boundp 'diary-fancy-buffer)
  98. (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
  99. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  100. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  101. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  102. (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
  103. (declare-function org-at-clock-log-p "org-clock" ())
  104. (declare-function org-clock-get-last-clock-out-time "org-clock" ())
  105. (declare-function org-clock-timestamps-up "org-clock" ())
  106. (declare-function org-clock-timestamps-down "org-clock" ())
  107. (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
  108. ;; load languages based on value of `org-babel-load-languages'
  109. (defvar org-babel-load-languages)
  110. ;;;###autoload
  111. (defun org-babel-do-load-languages (sym value)
  112. "Load the languages defined in `org-babel-load-languages'."
  113. (set-default sym value)
  114. (mapc (lambda (pair)
  115. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  116. (if active
  117. (progn
  118. (require (intern (concat "ob-" lang))))
  119. (progn
  120. (funcall 'fmakunbound
  121. (intern (concat "org-babel-execute:" lang)))
  122. (funcall 'fmakunbound
  123. (intern (concat "org-babel-expand-body:" lang)))))))
  124. org-babel-load-languages))
  125. (defcustom org-babel-load-languages '((emacs-lisp . t))
  126. "Languages which can be evaluated in Org-mode buffers.
  127. This list can be used to load support for any of the languages
  128. below, note that each language will depend on a different set of
  129. system executables and/or Emacs modes. When a language is
  130. \"loaded\", then code blocks in that language can be evaluated
  131. with `org-babel-execute-src-block' bound by default to C-c
  132. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  133. be set to remove code block evaluation from the C-c C-c
  134. keybinding. By default only Emacs Lisp (which has no
  135. requirements) is loaded."
  136. :group 'org-babel
  137. :set 'org-babel-do-load-languages
  138. :version "24.1"
  139. :type '(alist :tag "Babel Languages"
  140. :key-type
  141. (choice
  142. (const :tag "Awk" awk)
  143. (const :tag "C" C)
  144. (const :tag "R" R)
  145. (const :tag "Asymptote" asymptote)
  146. (const :tag "Calc" calc)
  147. (const :tag "Clojure" clojure)
  148. (const :tag "CSS" css)
  149. (const :tag "Ditaa" ditaa)
  150. (const :tag "Dot" dot)
  151. (const :tag "Emacs Lisp" emacs-lisp)
  152. (const :tag "Fortran" fortran)
  153. (const :tag "Gnuplot" gnuplot)
  154. (const :tag "Haskell" haskell)
  155. (const :tag "IO" io)
  156. (const :tag "Java" java)
  157. (const :tag "Javascript" js)
  158. (const :tag "LaTeX" latex)
  159. (const :tag "Ledger" ledger)
  160. (const :tag "Lilypond" lilypond)
  161. (const :tag "Lisp" lisp)
  162. (const :tag "Maxima" maxima)
  163. (const :tag "Matlab" matlab)
  164. (const :tag "Mscgen" mscgen)
  165. (const :tag "Ocaml" ocaml)
  166. (const :tag "Octave" octave)
  167. (const :tag "Org" org)
  168. (const :tag "Perl" perl)
  169. (const :tag "Pico Lisp" picolisp)
  170. (const :tag "PlantUML" plantuml)
  171. (const :tag "Python" python)
  172. (const :tag "Ruby" ruby)
  173. (const :tag "Sass" sass)
  174. (const :tag "Scala" scala)
  175. (const :tag "Scheme" scheme)
  176. (const :tag "Screen" screen)
  177. (const :tag "Shell Script" sh)
  178. (const :tag "Shen" shen)
  179. (const :tag "Sql" sql)
  180. (const :tag "Sqlite" sqlite))
  181. :value-type (boolean :tag "Activate" :value t)))
  182. ;;;; Customization variables
  183. (defcustom org-clone-delete-id nil
  184. "Remove ID property of clones of a subtree.
  185. When non-nil, clones of a subtree don't inherit the ID property.
  186. Otherwise they inherit the ID property with a new unique
  187. identifier."
  188. :type 'boolean
  189. :version "24.1"
  190. :group 'org-id)
  191. ;;; Version
  192. (require 'org-compat)
  193. (org-check-version)
  194. ;;;###autoload
  195. (defun org-version (&optional here full message)
  196. "Show the org-mode version in the echo area.
  197. With prefix argument HERE, insert it at point.
  198. When FULL is non-nil, use a verbose version string.
  199. When MESSAGE is non-nil, display a message with the version."
  200. (interactive "P")
  201. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  202. (org-install-dir (ignore-errors (org-find-library-dir "org-install.el")))
  203. (org-trash (or
  204. (and (fboundp 'org-release) (fboundp 'org-git-version))
  205. (load (concat org-dir "org-version.el")
  206. 'noerror 'nomessage 'nosuffix)))
  207. (org-version (org-release))
  208. (git-version (org-git-version))
  209. (version (format "Org-mode version %s (%s @ %s)"
  210. org-version
  211. git-version
  212. (if org-install-dir
  213. (if (string= org-dir org-install-dir)
  214. org-install-dir
  215. (concat "mixed installation! " org-install-dir " and " org-dir))
  216. "org-install.el can not be found!")))
  217. (_version (if full version org-version)))
  218. (if (org-called-interactively-p 'interactive)
  219. (if here
  220. (insert version)
  221. (message version))
  222. (if message (message _version))
  223. _version)))
  224. (defconst org-version (org-version))
  225. ;;; Compatibility constants
  226. ;;; The custom variables
  227. (defgroup org nil
  228. "Outline-based notes management and organizer."
  229. :tag "Org"
  230. :group 'outlines
  231. :group 'calendar)
  232. (defcustom org-mode-hook nil
  233. "Mode hook for Org-mode, run after the mode was turned on."
  234. :group 'org
  235. :type 'hook)
  236. (defcustom org-load-hook nil
  237. "Hook that is run after org.el has been loaded."
  238. :group 'org
  239. :type 'hook)
  240. (defcustom org-log-buffer-setup-hook nil
  241. "Hook that is run after an Org log buffer is created."
  242. :group 'org
  243. :version "24.1"
  244. :type 'hook)
  245. (defvar org-modules) ; defined below
  246. (defvar org-modules-loaded nil
  247. "Have the modules been loaded already?")
  248. (defun org-load-modules-maybe (&optional force)
  249. "Load all extensions listed in `org-modules'."
  250. (when (or force (not org-modules-loaded))
  251. (mapc (lambda (ext)
  252. (condition-case nil (require ext)
  253. (error (message "Problems while trying to load feature `%s'" ext))))
  254. org-modules)
  255. (setq org-modules-loaded t)))
  256. (defun org-set-modules (var value)
  257. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  258. (set var value)
  259. (when (featurep 'org)
  260. (org-load-modules-maybe 'force)))
  261. (when (org-bound-and-true-p org-modules)
  262. (let ((a (member 'org-infojs org-modules)))
  263. (and a (setcar a 'org-jsinfo))))
  264. (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
  265. "Modules that should always be loaded together with org.el.
  266. If a description starts with <C>, the file is not part of Emacs
  267. and loading it will require that you have downloaded and properly installed
  268. the org-mode distribution.
  269. You can also use this system to load external packages (i.e. neither Org
  270. core modules, nor modules from the CONTRIB directory). Just add symbols
  271. to the end of the list. If the package is called org-xyz.el, then you need
  272. to add the symbol `xyz', and the package must have a call to
  273. (provide 'org-xyz)"
  274. :group 'org
  275. :set 'org-set-modules
  276. :type
  277. '(set :greedy t
  278. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  279. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  280. (const :tag " crypt: Encryption of subtrees" org-crypt)
  281. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  282. (const :tag " docview: Links to doc-view buffers" org-docview)
  283. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  284. (const :tag " id: Global IDs for identifying entries" org-id)
  285. (const :tag " info: Links to Info nodes" org-info)
  286. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  287. (const :tag " habit: Track your consistency with habits" org-habit)
  288. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  289. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  290. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  291. (const :tag " mew Links to Mew folders/messages" org-mew)
  292. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  293. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  294. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  295. (const :tag " special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  296. (const :tag " vm: Links to VM folders/messages" org-vm)
  297. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  298. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  299. (const :tag " mouse: Additional mouse support" org-mouse)
  300. (const :tag " TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  301. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  302. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  303. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  304. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  305. (const :tag "C collector: Collect properties into tables" org-collector)
  306. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  307. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  308. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  309. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  310. (const :tag "C eval: Include command output as text" org-eval)
  311. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  312. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  313. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  314. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  315. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  316. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  317. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  318. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  319. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  320. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  321. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  322. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  323. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  324. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  325. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  326. (const :tag "C registry: A registry for Org-mode links" org-registry)
  327. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  328. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  329. (const :tag "C secretary: Team management with org-mode" org-secretary)
  330. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  331. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  332. (const :tag "C track: Keep up with Org-mode development" org-track)
  333. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  334. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  335. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  336. (defcustom org-support-shift-select nil
  337. "Non-nil means make shift-cursor commands select text when possible.
  338. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  339. start selecting a region, or enlarge regions started in this way.
  340. In Org-mode, in special contexts, these same keys are used for
  341. other purposes, important enough to compete with shift selection.
  342. Org tries to balance these needs by supporting `shift-select-mode'
  343. outside these special contexts, under control of this variable.
  344. The default of this variable is nil, to avoid confusing behavior. Shifted
  345. cursor keys will then execute Org commands in the following contexts:
  346. - on a headline, changing TODO state (left/right) and priority (up/down)
  347. - on a time stamp, changing the time
  348. - in a plain list item, changing the bullet type
  349. - in a property definition line, switching between allowed values
  350. - in the BEGIN line of a clock table (changing the time block).
  351. Outside these contexts, the commands will throw an error.
  352. When this variable is t and the cursor is not in a special
  353. context, Org-mode will support shift-selection for making and
  354. enlarging regions. To make this more effective, the bullet
  355. cycling will no longer happen anywhere in an item line, but only
  356. if the cursor is exactly on the bullet.
  357. If you set this variable to the symbol `always', then the keys
  358. will not be special in headlines, property lines, and item lines,
  359. to make shift selection work there as well. If this is what you
  360. want, you can use the following alternative commands: `C-c C-t'
  361. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  362. can be used to switch TODO sets, `C-c -' to cycle item bullet
  363. types, and properties can be edited by hand or in column view.
  364. However, when the cursor is on a timestamp, shift-cursor commands
  365. will still edit the time stamp - this is just too good to give up.
  366. XEmacs user should have this variable set to nil, because
  367. `shift-select-mode' is in Emacs 23 or later only."
  368. :group 'org
  369. :type '(choice
  370. (const :tag "Never" nil)
  371. (const :tag "When outside special context" t)
  372. (const :tag "Everywhere except timestamps" always)))
  373. (defcustom org-loop-over-headlines-in-active-region nil
  374. "Shall some commands act upon headlines in the active region?
  375. When set to `t', some commands will be performed in all headlines
  376. within the active region.
  377. When set to `start-level', some commands will be performed in all
  378. headlines within the active region, provided that these headlines
  379. are of the same level than the first one.
  380. When set to a string, those commands will be performed on the
  381. matching headlines within the active region. Such string must be
  382. a tags/property/todo match as it is used in the agenda tags view.
  383. The list of commands is: `org-schedule', `org-deadline',
  384. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  385. `org-archive-to-archive-sibling'. The archiving commands skip
  386. already archived entries."
  387. :type '(choice (const :tag "Don't loop" nil)
  388. (const :tag "All headlines in active region" t)
  389. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  390. (string :tag "Tags/Property/Todo matcher"))
  391. :version "24.1"
  392. :group 'org-todo
  393. :group 'org-archive)
  394. (defgroup org-startup nil
  395. "Options concerning startup of Org-mode."
  396. :tag "Org Startup"
  397. :group 'org)
  398. (defcustom org-startup-folded t
  399. "Non-nil means entering Org-mode will switch to OVERVIEW.
  400. This can also be configured on a per-file basis by adding one of
  401. the following lines anywhere in the buffer:
  402. #+STARTUP: fold (or `overview', this is equivalent)
  403. #+STARTUP: nofold (or `showall', this is equivalent)
  404. #+STARTUP: content
  405. #+STARTUP: showeverything"
  406. :group 'org-startup
  407. :type '(choice
  408. (const :tag "nofold: show all" nil)
  409. (const :tag "fold: overview" t)
  410. (const :tag "content: all headlines" content)
  411. (const :tag "show everything, even drawers" showeverything)))
  412. (defcustom org-startup-truncated t
  413. "Non-nil means entering Org-mode will set `truncate-lines'.
  414. This is useful since some lines containing links can be very long and
  415. uninteresting. Also tables look terrible when wrapped."
  416. :group 'org-startup
  417. :type 'boolean)
  418. (defcustom org-startup-indented nil
  419. "Non-nil means turn on `org-indent-mode' on startup.
  420. This can also be configured on a per-file basis by adding one of
  421. the following lines anywhere in the buffer:
  422. #+STARTUP: indent
  423. #+STARTUP: noindent"
  424. :group 'org-structure
  425. :type '(choice
  426. (const :tag "Not" nil)
  427. (const :tag "Globally (slow on startup in large files)" t)))
  428. (defcustom org-use-sub-superscripts t
  429. "Non-nil means interpret \"_\" and \"^\" for export.
  430. When this option is turned on, you can use TeX-like syntax for sub- and
  431. superscripts. Several characters after \"_\" or \"^\" will be
  432. considered as a single item - so grouping with {} is normally not
  433. needed. For example, the following things will be parsed as single
  434. sub- or superscripts.
  435. 10^24 or 10^tau several digits will be considered 1 item.
  436. 10^-12 or 10^-tau a leading sign with digits or a word
  437. x^2-y^3 will be read as x^2 - y^3, because items are
  438. terminated by almost any nonword/nondigit char.
  439. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  440. Still, ambiguity is possible - so when in doubt use {} to enclose the
  441. sub/superscript. If you set this variable to the symbol `{}',
  442. the braces are *required* in order to trigger interpretations as
  443. sub/superscript. This can be helpful in documents that need \"_\"
  444. frequently in plain text.
  445. Not all export backends support this, but HTML does.
  446. This option can also be set with the #+OPTIONS line, e.g. \"^:nil\"."
  447. :group 'org-startup
  448. :group 'org-export-translation
  449. :version "24.1"
  450. :type '(choice
  451. (const :tag "Always interpret" t)
  452. (const :tag "Only with braces" {})
  453. (const :tag "Never interpret" nil)))
  454. (if (fboundp 'defvaralias)
  455. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
  456. (defcustom org-startup-with-beamer-mode nil
  457. "Non-nil means turn on `org-beamer-mode' on startup.
  458. This can also be configured on a per-file basis by adding one of
  459. the following lines anywhere in the buffer:
  460. #+STARTUP: beamer"
  461. :group 'org-startup
  462. :version "24.1"
  463. :type 'boolean)
  464. (defcustom org-startup-align-all-tables nil
  465. "Non-nil means align all tables when visiting a file.
  466. This is useful when the column width in tables is forced with <N> cookies
  467. in table fields. Such tables will look correct only after the first re-align.
  468. This can also be configured on a per-file basis by adding one of
  469. the following lines anywhere in the buffer:
  470. #+STARTUP: align
  471. #+STARTUP: noalign"
  472. :group 'org-startup
  473. :type 'boolean)
  474. (defcustom org-startup-with-inline-images nil
  475. "Non-nil means show inline images when loading a new Org file.
  476. This can also be configured on a per-file basis by adding one of
  477. the following lines anywhere in the buffer:
  478. #+STARTUP: inlineimages
  479. #+STARTUP: noinlineimages"
  480. :group 'org-startup
  481. :version "24.1"
  482. :type 'boolean)
  483. (defcustom org-insert-mode-line-in-empty-file nil
  484. "Non-nil means insert the first line setting Org-mode in empty files.
  485. When the function `org-mode' is called interactively in an empty file, this
  486. normally means that the file name does not automatically trigger Org-mode.
  487. To ensure that the file will always be in Org-mode in the future, a
  488. line enforcing Org-mode will be inserted into the buffer, if this option
  489. has been set."
  490. :group 'org-startup
  491. :type 'boolean)
  492. (defcustom org-replace-disputed-keys nil
  493. "Non-nil means use alternative key bindings for some keys.
  494. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  495. These keys are also used by other packages like shift-selection-mode'
  496. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  497. If you want to use Org-mode together with one of these other modes,
  498. or more generally if you would like to move some Org-mode commands to
  499. other keys, set this variable and configure the keys with the variable
  500. `org-disputed-keys'.
  501. This option is only relevant at load-time of Org-mode, and must be set
  502. *before* org.el is loaded. Changing it requires a restart of Emacs to
  503. become effective."
  504. :group 'org-startup
  505. :type 'boolean)
  506. (defcustom org-use-extra-keys nil
  507. "Non-nil means use extra key sequence definitions for certain commands.
  508. This happens automatically if you run XEmacs or if `window-system'
  509. is nil. This variable lets you do the same manually. You must
  510. set it before loading org.
  511. Example: on Carbon Emacs 22 running graphically, with an external
  512. keyboard on a Powerbook, the default way of setting M-left might
  513. not work for either Alt or ESC. Setting this variable will make
  514. it work for ESC."
  515. :group 'org-startup
  516. :type 'boolean)
  517. (if (fboundp 'defvaralias)
  518. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  519. (defcustom org-disputed-keys
  520. '(([(shift up)] . [(meta p)])
  521. ([(shift down)] . [(meta n)])
  522. ([(shift left)] . [(meta -)])
  523. ([(shift right)] . [(meta +)])
  524. ([(control shift right)] . [(meta shift +)])
  525. ([(control shift left)] . [(meta shift -)]))
  526. "Keys for which Org-mode and other modes compete.
  527. This is an alist, cars are the default keys, second element specifies
  528. the alternative to use when `org-replace-disputed-keys' is t.
  529. Keys can be specified in any syntax supported by `define-key'.
  530. The value of this option takes effect only at Org-mode's startup,
  531. therefore you'll have to restart Emacs to apply it after changing."
  532. :group 'org-startup
  533. :type 'alist)
  534. (defun org-key (key)
  535. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  536. Or return the original if not disputed.
  537. Also apply the translations defined in `org-xemacs-key-equivalents'."
  538. (when org-replace-disputed-keys
  539. (let* ((nkey (key-description key))
  540. (x (org-find-if (lambda (x)
  541. (equal (key-description (car x)) nkey))
  542. org-disputed-keys)))
  543. (setq key (if x (cdr x) key))))
  544. (when (featurep 'xemacs)
  545. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  546. key)
  547. (defun org-find-if (predicate seq)
  548. (catch 'exit
  549. (while seq
  550. (if (funcall predicate (car seq))
  551. (throw 'exit (car seq))
  552. (pop seq)))))
  553. (defun org-defkey (keymap key def)
  554. "Define a key, possibly translated, as returned by `org-key'."
  555. (define-key keymap (org-key key) def))
  556. (defcustom org-ellipsis nil
  557. "The ellipsis to use in the Org-mode outline.
  558. When nil, just use the standard three dots. When a string, use that instead,
  559. When a face, use the standard 3 dots, but with the specified face.
  560. The change affects only Org-mode (which will then use its own display table).
  561. Changing this requires executing `M-x org-mode' in a buffer to become
  562. effective."
  563. :group 'org-startup
  564. :type '(choice (const :tag "Default" nil)
  565. (face :tag "Face" :value org-warning)
  566. (string :tag "String" :value "...#")))
  567. (defvar org-display-table nil
  568. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  569. (defgroup org-keywords nil
  570. "Keywords in Org-mode."
  571. :tag "Org Keywords"
  572. :group 'org)
  573. (defcustom org-deadline-string "DEADLINE:"
  574. "String to mark deadline entries.
  575. A deadline is this string, followed by a time stamp. Should be a word,
  576. terminated by a colon. You can insert a schedule keyword and
  577. a timestamp with \\[org-deadline].
  578. Changes become only effective after restarting Emacs."
  579. :group 'org-keywords
  580. :type 'string)
  581. (defcustom org-scheduled-string "SCHEDULED:"
  582. "String to mark scheduled TODO entries.
  583. A schedule is this string, followed by a time stamp. Should be a word,
  584. terminated by a colon. You can insert a schedule keyword and
  585. a timestamp with \\[org-schedule].
  586. Changes become only effective after restarting Emacs."
  587. :group 'org-keywords
  588. :type 'string)
  589. (defcustom org-closed-string "CLOSED:"
  590. "String used as the prefix for timestamps logging closing a TODO entry."
  591. :group 'org-keywords
  592. :type 'string)
  593. (defcustom org-clock-string "CLOCK:"
  594. "String used as prefix for timestamps clocking work hours on an item."
  595. :group 'org-keywords
  596. :type 'string)
  597. (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
  598. org-scheduled-string "\\|"
  599. org-deadline-string "\\|"
  600. org-closed-string "\\|"
  601. org-clock-string "\\)")
  602. "Matches a line with planning or clock info.")
  603. (defcustom org-comment-string "COMMENT"
  604. "Entries starting with this keyword will never be exported.
  605. An entry can be toggled between COMMENT and normal with
  606. \\[org-toggle-comment].
  607. Changes become only effective after restarting Emacs."
  608. :group 'org-keywords
  609. :type 'string)
  610. (defcustom org-quote-string "QUOTE"
  611. "Entries starting with this keyword will be exported in fixed-width font.
  612. Quoting applies only to the text in the entry following the headline, and does
  613. not extend beyond the next headline, even if that is lower level.
  614. An entry can be toggled between QUOTE and normal with
  615. \\[org-toggle-fixed-width-section]."
  616. :group 'org-keywords
  617. :type 'string)
  618. (defconst org-repeat-re
  619. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  620. "Regular expression for specifying repeated events.
  621. After a match, group 1 contains the repeat expression.")
  622. (defgroup org-structure nil
  623. "Options concerning the general structure of Org-mode files."
  624. :tag "Org Structure"
  625. :group 'org)
  626. (defgroup org-reveal-location nil
  627. "Options about how to make context of a location visible."
  628. :tag "Org Reveal Location"
  629. :group 'org-structure)
  630. (defconst org-context-choice
  631. '(choice
  632. (const :tag "Always" t)
  633. (const :tag "Never" nil)
  634. (repeat :greedy t :tag "Individual contexts"
  635. (cons
  636. (choice :tag "Context"
  637. (const agenda)
  638. (const org-goto)
  639. (const occur-tree)
  640. (const tags-tree)
  641. (const link-search)
  642. (const mark-goto)
  643. (const bookmark-jump)
  644. (const isearch)
  645. (const default))
  646. (boolean))))
  647. "Contexts for the reveal options.")
  648. (defcustom org-show-hierarchy-above '((default . t))
  649. "Non-nil means show full hierarchy when revealing a location.
  650. Org-mode often shows locations in an org-mode file which might have
  651. been invisible before. When this is set, the hierarchy of headings
  652. above the exposed location is shown.
  653. Turning this off for example for sparse trees makes them very compact.
  654. Instead of t, this can also be an alist specifying this option for different
  655. contexts. Valid contexts are
  656. agenda when exposing an entry from the agenda
  657. org-goto when using the command `org-goto' on key C-c C-j
  658. occur-tree when using the command `org-occur' on key C-c /
  659. tags-tree when constructing a sparse tree based on tags matches
  660. link-search when exposing search matches associated with a link
  661. mark-goto when exposing the jump goal of a mark
  662. bookmark-jump when exposing a bookmark location
  663. isearch when exiting from an incremental search
  664. default default for all contexts not set explicitly"
  665. :group 'org-reveal-location
  666. :type org-context-choice)
  667. (defcustom org-show-following-heading '((default . nil))
  668. "Non-nil means show following heading when revealing a location.
  669. Org-mode often shows locations in an org-mode file which might have
  670. been invisible before. When this is set, the heading following the
  671. match is shown.
  672. Turning this off for example for sparse trees makes them very compact,
  673. but makes it harder to edit the location of the match. In such a case,
  674. use the command \\[org-reveal] to show more context.
  675. Instead of t, this can also be an alist specifying this option for different
  676. contexts. See `org-show-hierarchy-above' for valid contexts."
  677. :group 'org-reveal-location
  678. :type org-context-choice)
  679. (defcustom org-show-siblings '((default . nil) (isearch t))
  680. "Non-nil means show all sibling heading when revealing a location.
  681. Org-mode often shows locations in an org-mode file which might have
  682. been invisible before. When this is set, the sibling of the current entry
  683. heading are all made visible. If `org-show-hierarchy-above' is t,
  684. the same happens on each level of the hierarchy above the current entry.
  685. By default this is on for the isearch context, off for all other contexts.
  686. Turning this off for example for sparse trees makes them very compact,
  687. but makes it harder to edit the location of the match. In such a case,
  688. use the command \\[org-reveal] to show more context.
  689. Instead of t, this can also be an alist specifying this option for different
  690. contexts. See `org-show-hierarchy-above' for valid contexts."
  691. :group 'org-reveal-location
  692. :type org-context-choice)
  693. (defcustom org-show-entry-below '((default . nil))
  694. "Non-nil means show the entry below a headline when revealing a location.
  695. Org-mode often shows locations in an org-mode file which might have
  696. been invisible before. When this is set, the text below the headline that is
  697. exposed is also shown.
  698. By default this is off for all contexts.
  699. Instead of t, this can also be an alist specifying this option for different
  700. contexts. See `org-show-hierarchy-above' for valid contexts."
  701. :group 'org-reveal-location
  702. :type org-context-choice)
  703. (defcustom org-indirect-buffer-display 'other-window
  704. "How should indirect tree buffers be displayed?
  705. This applies to indirect buffers created with the commands
  706. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  707. Valid values are:
  708. current-window Display in the current window
  709. other-window Just display in another window.
  710. dedicated-frame Create one new frame, and re-use it each time.
  711. new-frame Make a new frame each time. Note that in this case
  712. previously-made indirect buffers are kept, and you need to
  713. kill these buffers yourself."
  714. :group 'org-structure
  715. :group 'org-agenda-windows
  716. :type '(choice
  717. (const :tag "In current window" current-window)
  718. (const :tag "In current frame, other window" other-window)
  719. (const :tag "Each time a new frame" new-frame)
  720. (const :tag "One dedicated frame" dedicated-frame)))
  721. (defcustom org-use-speed-commands nil
  722. "Non-nil means activate single letter commands at beginning of a headline.
  723. This may also be a function to test for appropriate locations where speed
  724. commands should be active."
  725. :group 'org-structure
  726. :type '(choice
  727. (const :tag "Never" nil)
  728. (const :tag "At beginning of headline stars" t)
  729. (function)))
  730. (defcustom org-speed-commands-user nil
  731. "Alist of additional speed commands.
  732. This list will be checked before `org-speed-commands-default'
  733. when the variable `org-use-speed-commands' is non-nil
  734. and when the cursor is at the beginning of a headline.
  735. The car if each entry is a string with a single letter, which must
  736. be assigned to `self-insert-command' in the global map.
  737. The cdr is either a command to be called interactively, a function
  738. to be called, or a form to be evaluated.
  739. An entry that is just a list with a single string will be interpreted
  740. as a descriptive headline that will be added when listing the speed
  741. commands in the Help buffer using the `?' speed command."
  742. :group 'org-structure
  743. :type '(repeat :value ("k" . ignore)
  744. (choice :value ("k" . ignore)
  745. (list :tag "Descriptive Headline" (string :tag "Headline"))
  746. (cons :tag "Letter and Command"
  747. (string :tag "Command letter")
  748. (choice
  749. (function)
  750. (sexp))))))
  751. (defgroup org-cycle nil
  752. "Options concerning visibility cycling in Org-mode."
  753. :tag "Org Cycle"
  754. :group 'org-structure)
  755. (defcustom org-cycle-skip-children-state-if-no-children t
  756. "Non-nil means skip CHILDREN state in entries that don't have any."
  757. :group 'org-cycle
  758. :type 'boolean)
  759. (defcustom org-cycle-max-level nil
  760. "Maximum level which should still be subject to visibility cycling.
  761. Levels higher than this will, for cycling, be treated as text, not a headline.
  762. When `org-odd-levels-only' is set, a value of N in this variable actually
  763. means 2N-1 stars as the limiting headline.
  764. When nil, cycle all levels.
  765. Note that the limiting level of cycling is also influenced by
  766. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  767. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  768. than its value."
  769. :group 'org-cycle
  770. :type '(choice
  771. (const :tag "No limit" nil)
  772. (integer :tag "Maximum level")))
  773. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  774. "Names of drawers. Drawers are not opened by cycling on the headline above.
  775. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  776. this:
  777. :DRAWERNAME:
  778. .....
  779. :END:
  780. The drawer \"PROPERTIES\" is special for capturing properties through
  781. the property API.
  782. Drawers can be defined on the per-file basis with a line like:
  783. #+DRAWERS: HIDDEN STATE PROPERTIES"
  784. :group 'org-structure
  785. :group 'org-cycle
  786. :type '(repeat (string :tag "Drawer Name")))
  787. (defcustom org-hide-block-startup nil
  788. "Non-nil means entering Org-mode will fold all blocks.
  789. This can also be set in on a per-file basis with
  790. #+STARTUP: hideblocks
  791. #+STARTUP: showblocks"
  792. :group 'org-startup
  793. :group 'org-cycle
  794. :type 'boolean)
  795. (defcustom org-cycle-global-at-bob nil
  796. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  797. This makes it possible to do global cycling without having to use S-TAB or
  798. \\[universal-argument] TAB. For this special case to work, the first line
  799. of the buffer must not be a headline -- it may be empty or some other text.
  800. When used in this way, `org-cycle-hook' is disabled temporarily to make
  801. sure the cursor stays at the beginning of the buffer. When this option is
  802. nil, don't do anything special at the beginning 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-hide-inline-tasks
  860. org-cycle-show-empty-lines
  861. org-optimize-window-after-visibility-change)
  862. "Hook that is run after `org-cycle' has changed the buffer visibility.
  863. The function(s) in this hook must accept a single argument which indicates
  864. the new state that was set by the most recent `org-cycle' command. The
  865. argument is a symbol. After a global state change, it can have the values
  866. `overview', `contents', or `all'. After a local state change, it can have
  867. the values `folded', `children', or `subtree'."
  868. :group 'org-cycle
  869. :type 'hook)
  870. (defgroup org-edit-structure nil
  871. "Options concerning structure editing in Org-mode."
  872. :tag "Org Edit Structure"
  873. :group 'org-structure)
  874. (defcustom org-odd-levels-only nil
  875. "Non-nil means skip even levels and only use odd levels for the outline.
  876. This has the effect that two stars are being added/taken away in
  877. promotion/demotion commands. It also influences how levels are
  878. handled by the exporters.
  879. Changing it requires restart of `font-lock-mode' to become effective
  880. for fontification also in regions already fontified.
  881. You may also set this on a per-file basis by adding one of the following
  882. lines to the buffer:
  883. #+STARTUP: odd
  884. #+STARTUP: oddeven"
  885. :group 'org-edit-structure
  886. :group 'org-appearance
  887. :type 'boolean)
  888. (defcustom org-adapt-indentation t
  889. "Non-nil means adapt indentation to outline node level.
  890. When this variable is set, Org assumes that you write outlines by
  891. indenting text in each node to align with the headline (after the stars).
  892. The following issues are influenced by this variable:
  893. - When this is set and the *entire* text in an entry is indented, the
  894. indentation is increased by one space in a demotion command, and
  895. decreased by one in a promotion command. If any line in the entry
  896. body starts with text at column 0, indentation is not changed at all.
  897. - Property drawers and planning information is inserted indented when
  898. this variable s set. When nil, they will not be indented.
  899. - TAB indents a line relative to context. The lines below a headline
  900. will be indented when this variable is set.
  901. Note that this is all about true indentation, by adding and removing
  902. space characters. See also `org-indent.el' which does level-dependent
  903. indentation in a virtual way, i.e. at display time in Emacs."
  904. :group 'org-edit-structure
  905. :type 'boolean)
  906. (defcustom org-special-ctrl-a/e nil
  907. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  908. When t, `C-a' will bring back the cursor to the beginning of the
  909. headline text, i.e. after the stars and after a possible TODO
  910. keyword. In an item, this will be the position after bullet and
  911. check-box, if any. When the cursor is already at that position,
  912. another `C-a' will bring it to the beginning of the line.
  913. `C-e' will jump to the end of the headline, ignoring the presence
  914. of tags in the headline. A second `C-e' will then jump to the
  915. true end of the line, after any tags. This also means that, when
  916. this variable is non-nil, `C-e' also will never jump beyond the
  917. end of the heading of a folded section, i.e. not after the
  918. ellipses.
  919. When set to the symbol `reversed', the first `C-a' or `C-e' works
  920. normally, going to the true line boundary first. Only a directly
  921. following, identical keypress will bring the cursor to the
  922. special positions.
  923. This may also be a cons cell where the behavior for `C-a' and
  924. `C-e' is set separately."
  925. :group 'org-edit-structure
  926. :type '(choice
  927. (const :tag "off" nil)
  928. (const :tag "on: after stars/bullet and before tags first" t)
  929. (const :tag "reversed: true line boundary first" reversed)
  930. (cons :tag "Set C-a and C-e separately"
  931. (choice :tag "Special C-a"
  932. (const :tag "off" nil)
  933. (const :tag "on: after stars/bullet first" t)
  934. (const :tag "reversed: before stars/bullet first" reversed))
  935. (choice :tag "Special C-e"
  936. (const :tag "off" nil)
  937. (const :tag "on: before tags first" t)
  938. (const :tag "reversed: after tags first" reversed)))))
  939. (if (fboundp 'defvaralias)
  940. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  941. (defcustom org-special-ctrl-k nil
  942. "Non-nil means `C-k' will behave specially in headlines.
  943. When nil, `C-k' will call the default `kill-line' command.
  944. When t, the following will happen while the cursor is in the headline:
  945. - When the cursor is at the beginning of a headline, kill the entire
  946. line and possible the folded subtree below the line.
  947. - When in the middle of the headline text, kill the headline up to the tags.
  948. - When after the headline text, kill the tags."
  949. :group 'org-edit-structure
  950. :type 'boolean)
  951. (defcustom org-ctrl-k-protect-subtree nil
  952. "Non-nil means, do not delete a hidden subtree with C-k.
  953. When set to the symbol `error', simply throw an error when C-k is
  954. used to kill (part-of) a headline that has hidden text behind it.
  955. Any other non-nil value will result in a query to the user, if it is
  956. OK to kill that hidden subtree. When nil, kill without remorse."
  957. :group 'org-edit-structure
  958. :version "24.1"
  959. :type '(choice
  960. (const :tag "Do not protect hidden subtrees" nil)
  961. (const :tag "Protect hidden subtrees with a security query" t)
  962. (const :tag "Never kill a hidden subtree with C-k" error)))
  963. (defcustom org-catch-invisible-edits nil
  964. "Check if in invisible region before inserting or deleting a character.
  965. Valid values are:
  966. nil Do not check, so just do invisible edits.
  967. error Throw an error and do nothing.
  968. show Make point visible, and do the requested edit.
  969. show-and-error Make point visible, then throw an error and abort the edit.
  970. smart Make point visible, and do insertion/deletion if it is
  971. adjacent to visible text and the change feels predictable.
  972. Never delete a previously invisible character or add in the
  973. middle or right after an invisible region. Basically, this
  974. allows insertion and backward-delete right before ellipses.
  975. FIXME: maybe in this case we should not even show?"
  976. :group 'org-edit-structure
  977. :version "24.1"
  978. :type '(choice
  979. (const :tag "Do not check" nil)
  980. (const :tag "Throw error when trying to edit" error)
  981. (const :tag "Unhide, but do not do the edit" show-and-error)
  982. (const :tag "Show invisible part and do the edit" show)
  983. (const :tag "Be smart and do the right thing" smart)))
  984. (defcustom org-yank-folded-subtrees t
  985. "Non-nil means when yanking subtrees, fold them.
  986. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  987. it starts with a heading and all other headings in it are either children
  988. or siblings, then fold all the subtrees. However, do this only if no
  989. text after the yank would be swallowed into a folded tree by this action."
  990. :group 'org-edit-structure
  991. :type 'boolean)
  992. (defcustom org-yank-adjusted-subtrees nil
  993. "Non-nil means when yanking subtrees, adjust the level.
  994. With this setting, `org-paste-subtree' is used to insert the subtree, see
  995. this function for details."
  996. :group 'org-edit-structure
  997. :type 'boolean)
  998. (defcustom org-M-RET-may-split-line '((default . t))
  999. "Non-nil means M-RET will split the line at the cursor position.
  1000. When nil, it will go to the end of the line before making a
  1001. new line.
  1002. You may also set this option in a different way for different
  1003. contexts. Valid contexts are:
  1004. headline when creating a new headline
  1005. item when creating a new item
  1006. table in a table field
  1007. default the value to be used for all contexts not explicitly
  1008. customized"
  1009. :group 'org-structure
  1010. :group 'org-table
  1011. :type '(choice
  1012. (const :tag "Always" t)
  1013. (const :tag "Never" nil)
  1014. (repeat :greedy t :tag "Individual contexts"
  1015. (cons
  1016. (choice :tag "Context"
  1017. (const headline)
  1018. (const item)
  1019. (const table)
  1020. (const default))
  1021. (boolean)))))
  1022. (defcustom org-insert-heading-respect-content nil
  1023. "Non-nil means insert new headings after the current subtree.
  1024. When nil, the new heading is created directly after the current line.
  1025. The commands \\[org-insert-heading-respect-content] and
  1026. \\[org-insert-todo-heading-respect-content] turn this variable on
  1027. for the duration of the command."
  1028. :group 'org-structure
  1029. :type 'boolean)
  1030. (defcustom org-blank-before-new-entry '((heading . auto)
  1031. (plain-list-item . auto))
  1032. "Should `org-insert-heading' leave a blank line before new heading/item?
  1033. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1034. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1035. which case Org will look at the surrounding headings/items and try to
  1036. make an intelligent decision whether to insert a blank line or not.
  1037. For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
  1038. set, the setting here is ignored and no empty line is inserted, to avoid
  1039. breaking the list structure."
  1040. :group 'org-edit-structure
  1041. :type '(list
  1042. (cons (const heading)
  1043. (choice (const :tag "Never" nil)
  1044. (const :tag "Always" t)
  1045. (const :tag "Auto" auto)))
  1046. (cons (const plain-list-item)
  1047. (choice (const :tag "Never" nil)
  1048. (const :tag "Always" t)
  1049. (const :tag "Auto" auto)))))
  1050. (defcustom org-insert-heading-hook nil
  1051. "Hook being run after inserting a new heading."
  1052. :group 'org-edit-structure
  1053. :type 'hook)
  1054. (defcustom org-enable-fixed-width-editor t
  1055. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1056. This currently only means they are never auto-wrapped.
  1057. When nil, such lines will be treated like ordinary lines.
  1058. See also the QUOTE keyword."
  1059. :group 'org-edit-structure
  1060. :type 'boolean)
  1061. (defcustom org-goto-auto-isearch t
  1062. "Non-nil means typing characters in `org-goto' starts incremental search."
  1063. :group 'org-edit-structure
  1064. :type 'boolean)
  1065. (defgroup org-sparse-trees nil
  1066. "Options concerning sparse trees in Org-mode."
  1067. :tag "Org Sparse Trees"
  1068. :group 'org-structure)
  1069. (defcustom org-highlight-sparse-tree-matches t
  1070. "Non-nil means highlight all matches that define a sparse tree.
  1071. The highlights will automatically disappear the next time the buffer is
  1072. changed by an edit command."
  1073. :group 'org-sparse-trees
  1074. :type 'boolean)
  1075. (defcustom org-remove-highlights-with-change t
  1076. "Non-nil means any change to the buffer will remove temporary highlights.
  1077. Such highlights are created by `org-occur' and `org-clock-display'.
  1078. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1079. The highlights created by `org-preview-latex-fragment' always need
  1080. `C-c C-c' to be removed."
  1081. :group 'org-sparse-trees
  1082. :group 'org-time
  1083. :type 'boolean)
  1084. (defcustom org-occur-hook '(org-first-headline-recenter)
  1085. "Hook that is run after `org-occur' has constructed a sparse tree.
  1086. This can be used to recenter the window to show as much of the structure
  1087. as possible."
  1088. :group 'org-sparse-trees
  1089. :type 'hook)
  1090. (defgroup org-imenu-and-speedbar nil
  1091. "Options concerning imenu and speedbar in Org-mode."
  1092. :tag "Org Imenu and Speedbar"
  1093. :group 'org-structure)
  1094. (defcustom org-imenu-depth 2
  1095. "The maximum level for Imenu access to Org-mode headlines.
  1096. This also applied for speedbar access."
  1097. :group 'org-imenu-and-speedbar
  1098. :type 'integer)
  1099. (defgroup org-table nil
  1100. "Options concerning tables in Org-mode."
  1101. :tag "Org Table"
  1102. :group 'org)
  1103. (defcustom org-enable-table-editor 'optimized
  1104. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1105. When nil, such lines will be treated like ordinary lines.
  1106. When equal to the symbol `optimized', the table editor will be optimized to
  1107. do the following:
  1108. - Automatic overwrite mode in front of whitespace in table fields.
  1109. This makes the structure of the table stay in tact as long as the edited
  1110. field does not exceed the column width.
  1111. - Minimize the number of realigns. Normally, the table is aligned each time
  1112. TAB or RET are pressed to move to another field. With optimization this
  1113. happens only if changes to a field might have changed the column width.
  1114. Optimization requires replacing the functions `self-insert-command',
  1115. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1116. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1117. very good at guessing when a re-align will be necessary, but you can always
  1118. force one with \\[org-ctrl-c-ctrl-c].
  1119. If you would like to use the optimized version in Org-mode, but the
  1120. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1121. This variable can be used to turn on and off the table editor during a session,
  1122. but in order to toggle optimization, a restart is required.
  1123. See also the variable `org-table-auto-blank-field'."
  1124. :group 'org-table
  1125. :type '(choice
  1126. (const :tag "off" nil)
  1127. (const :tag "on" t)
  1128. (const :tag "on, optimized" optimized)))
  1129. (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
  1130. (version<= emacs-version "24.1"))
  1131. "Non-nil means cluster self-insert commands for undo when possible.
  1132. If this is set, then, like in the Emacs command loop, 20 consecutive
  1133. characters will be undone together.
  1134. This is configurable, because there is some impact on typing performance."
  1135. :group 'org-table
  1136. :type 'boolean)
  1137. (defcustom org-table-tab-recognizes-table.el t
  1138. "Non-nil means TAB will automatically notice a table.el table.
  1139. When it sees such a table, it moves point into it and - if necessary -
  1140. calls `table-recognize-table'."
  1141. :group 'org-table-editing
  1142. :type 'boolean)
  1143. (defgroup org-link nil
  1144. "Options concerning links in Org-mode."
  1145. :tag "Org Link"
  1146. :group 'org)
  1147. (defvar org-link-abbrev-alist-local nil
  1148. "Buffer-local version of `org-link-abbrev-alist', which see.
  1149. The value of this is taken from the #+LINK lines.")
  1150. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1151. (defcustom org-link-abbrev-alist nil
  1152. "Alist of link abbreviations.
  1153. The car of each element is a string, to be replaced at the start of a link.
  1154. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1155. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1156. [[linkkey:tag][description]]
  1157. The 'linkkey' must be a word word, starting with a letter, followed
  1158. by letters, numbers, '-' or '_'.
  1159. If REPLACE is a string, the tag will simply be appended to create the link.
  1160. If the string contains \"%s\", the tag will be inserted there. If the string
  1161. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1162. at that point (see the function `url-hexify-string'). If the string contains
  1163. the specifier \"%(my-function)\", then the custom function `my-function' will
  1164. be invoked: this function takes the tag as its only argument and must return
  1165. a string.
  1166. REPLACE may also be a function that will be called with the tag as the
  1167. only argument to create the link, which should be returned as a string.
  1168. See the manual for examples."
  1169. :group 'org-link
  1170. :type '(repeat
  1171. (cons
  1172. (string :tag "Protocol")
  1173. (choice
  1174. (string :tag "Format")
  1175. (function)))))
  1176. (defcustom org-descriptive-links t
  1177. "Non-nil means Org will display descriptive links.
  1178. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1179. \"Org Website\", hiding the link itself and just displaying its
  1180. description. When set to `nil', Org will display the full links
  1181. literally.
  1182. You can interactively set the value of this variable by calling
  1183. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1184. :group 'org-link
  1185. :type 'boolean)
  1186. (defcustom org-link-file-path-type 'adaptive
  1187. "How the path name in file links should be stored.
  1188. Valid values are:
  1189. relative Relative to the current directory, i.e. the directory of the file
  1190. into which the link is being inserted.
  1191. absolute Absolute path, if possible with ~ for home directory.
  1192. noabbrev Absolute path, no abbreviation of home directory.
  1193. adaptive Use relative path for files in the current directory and sub-
  1194. directories of it. For other files, use an absolute path."
  1195. :group 'org-link
  1196. :type '(choice
  1197. (const relative)
  1198. (const absolute)
  1199. (const noabbrev)
  1200. (const adaptive)))
  1201. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1202. "Types of links that should be activated in Org-mode files.
  1203. This is a list of symbols, each leading to the activation of a certain link
  1204. type. In principle, it does not hurt to turn on most link types - there may
  1205. be a small gain when turning off unused link types. The types are:
  1206. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1207. angle Links in angular brackets that may contain whitespace like
  1208. <bbdb:Carsten Dominik>.
  1209. plain Plain links in normal text, no whitespace, like http://google.com.
  1210. radio Text that is matched by a radio target, see manual for details.
  1211. tag Tag settings in a headline (link to tag search).
  1212. date Time stamps (link to calendar).
  1213. footnote Footnote labels.
  1214. Changing this variable requires a restart of Emacs to become effective."
  1215. :group 'org-link
  1216. :type '(set :greedy t
  1217. (const :tag "Double bracket links" bracket)
  1218. (const :tag "Angular bracket links" angle)
  1219. (const :tag "Plain text links" plain)
  1220. (const :tag "Radio target matches" radio)
  1221. (const :tag "Tags" tag)
  1222. (const :tag "Timestamps" date)
  1223. (const :tag "Footnotes" footnote)))
  1224. (defcustom org-make-link-description-function nil
  1225. "Function to use to generate link descriptions from links.
  1226. If nil the link location will be used. This function must take
  1227. two parameters; the first is the link and the second the
  1228. description `org-insert-link' has generated, and should return the
  1229. description to use."
  1230. :group 'org-link
  1231. :type 'function)
  1232. (defgroup org-link-store nil
  1233. "Options concerning storing links in Org-mode."
  1234. :tag "Org Store Link"
  1235. :group 'org-link)
  1236. (defcustom org-url-hexify-p t
  1237. "When non-nil, hexify URL when creating a link."
  1238. :type 'boolean
  1239. ;; :version "24.3"
  1240. :group 'org-link-store)
  1241. (defcustom org-email-link-description-format "Email %c: %.30s"
  1242. "Format of the description part of a link to an email or usenet message.
  1243. The following %-escapes will be replaced by corresponding information:
  1244. %F full \"From\" field
  1245. %f name, taken from \"From\" field, address if no name
  1246. %T full \"To\" field
  1247. %t first name in \"To\" field, address if no name
  1248. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1249. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1250. %s subject
  1251. %d date
  1252. %m message-id.
  1253. You may use normal field width specification between the % and the letter.
  1254. This is for example useful to limit the length of the subject.
  1255. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1256. :group 'org-link-store
  1257. :type 'string)
  1258. (defcustom org-from-is-user-regexp
  1259. (let (r1 r2)
  1260. (when (and user-mail-address (not (string= user-mail-address "")))
  1261. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1262. (when (and user-full-name (not (string= user-full-name "")))
  1263. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1264. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1265. "Regexp matched against the \"From:\" header of an email or usenet message.
  1266. It should match if the message is from the user him/herself."
  1267. :group 'org-link-store
  1268. :type 'regexp)
  1269. (defcustom org-context-in-file-links t
  1270. "Non-nil means file links from `org-store-link' contain context.
  1271. A search string will be added to the file name with :: as separator and
  1272. used to find the context when the link is activated by the command
  1273. `org-open-at-point'. When this option is t, the entire active region
  1274. will be placed in the search string of the file link. If set to a
  1275. positive integer, only the first n lines of context will be stored.
  1276. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1277. negates this setting for the duration of the command."
  1278. :group 'org-link-store
  1279. :type '(choice boolean integer))
  1280. (defcustom org-keep-stored-link-after-insertion nil
  1281. "Non-nil means keep link in list for entire session.
  1282. The command `org-store-link' adds a link pointing to the current
  1283. location to an internal list. These links accumulate during a session.
  1284. The command `org-insert-link' can be used to insert links into any
  1285. Org-mode file (offering completion for all stored links). When this
  1286. option is nil, every link which has been inserted once using \\[org-insert-link]
  1287. will be removed from the list, to make completing the unused links
  1288. more efficient."
  1289. :group 'org-link-store
  1290. :type 'boolean)
  1291. (defgroup org-link-follow nil
  1292. "Options concerning following links in Org-mode."
  1293. :tag "Org Follow Link"
  1294. :group 'org-link)
  1295. (defcustom org-link-translation-function nil
  1296. "Function to translate links with different syntax to Org syntax.
  1297. This can be used to translate links created for example by the Planner
  1298. or emacs-wiki packages to Org syntax.
  1299. The function must accept two parameters, a TYPE containing the link
  1300. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1301. which is everything after the link protocol. It should return a cons
  1302. with possibly modified values of type and path.
  1303. Org contains a function for this, so if you set this variable to
  1304. `org-translate-link-from-planner', you should be able follow many
  1305. links created by planner."
  1306. :group 'org-link-follow
  1307. :type 'function)
  1308. (defcustom org-follow-link-hook nil
  1309. "Hook that is run after a link has been followed."
  1310. :group 'org-link-follow
  1311. :type 'hook)
  1312. (defcustom org-tab-follows-link nil
  1313. "Non-nil means on links TAB will follow the link.
  1314. Needs to be set before org.el is loaded.
  1315. This really should not be used, it does not make sense, and the
  1316. implementation is bad."
  1317. :group 'org-link-follow
  1318. :type 'boolean)
  1319. (defcustom org-return-follows-link nil
  1320. "Non-nil means on links RET will follow the link."
  1321. :group 'org-link-follow
  1322. :type 'boolean)
  1323. (defcustom org-mouse-1-follows-link
  1324. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1325. "Non-nil means mouse-1 on a link will follow the link.
  1326. A longer mouse click will still set point. Does not work on XEmacs.
  1327. Needs to be set before org.el is loaded."
  1328. :group 'org-link-follow
  1329. :type 'boolean)
  1330. (defcustom org-mark-ring-length 4
  1331. "Number of different positions to be recorded in the ring.
  1332. Changing this requires a restart of Emacs to work correctly."
  1333. :group 'org-link-follow
  1334. :type 'integer)
  1335. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1336. "Non-nil means internal links in Org files must exactly match a headline.
  1337. When nil, the link search tries to match a phrase with all words
  1338. in the search text."
  1339. :group 'org-link-follow
  1340. :version "24.1"
  1341. :type '(choice
  1342. (const :tag "Use fuzzy text search" nil)
  1343. (const :tag "Match only exact headline" t)
  1344. (const :tag "Match exact headline or query to create it"
  1345. query-to-create)))
  1346. (defcustom org-link-frame-setup
  1347. '((vm . vm-visit-folder-other-frame)
  1348. (vm-imap . vm-visit-imap-folder-other-frame)
  1349. (gnus . org-gnus-no-new-news)
  1350. (file . find-file-other-window)
  1351. (wl . wl-other-frame))
  1352. "Setup the frame configuration for following links.
  1353. When following a link with Emacs, it may often be useful to display
  1354. this link in another window or frame. This variable can be used to
  1355. set this up for the different types of links.
  1356. For VM, use any of
  1357. `vm-visit-folder'
  1358. `vm-visit-folder-other-window'
  1359. `vm-visit-folder-other-frame'
  1360. For Gnus, use any of
  1361. `gnus'
  1362. `gnus-other-frame'
  1363. `org-gnus-no-new-news'
  1364. For FILE, use any of
  1365. `find-file'
  1366. `find-file-other-window'
  1367. `find-file-other-frame'
  1368. For Wanderlust use any of
  1369. `wl'
  1370. `wl-other-frame'
  1371. For the calendar, use the variable `calendar-setup'.
  1372. For BBDB, it is currently only possible to display the matches in
  1373. another window."
  1374. :group 'org-link-follow
  1375. :type '(list
  1376. (cons (const vm)
  1377. (choice
  1378. (const vm-visit-folder)
  1379. (const vm-visit-folder-other-window)
  1380. (const vm-visit-folder-other-frame)))
  1381. (cons (const gnus)
  1382. (choice
  1383. (const gnus)
  1384. (const gnus-other-frame)
  1385. (const org-gnus-no-new-news)))
  1386. (cons (const file)
  1387. (choice
  1388. (const find-file)
  1389. (const find-file-other-window)
  1390. (const find-file-other-frame)))
  1391. (cons (const wl)
  1392. (choice
  1393. (const wl)
  1394. (const wl-other-frame)))))
  1395. (defcustom org-display-internal-link-with-indirect-buffer nil
  1396. "Non-nil means use indirect buffer to display infile links.
  1397. Activating internal links (from one location in a file to another location
  1398. in the same file) normally just jumps to the location. When the link is
  1399. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1400. is displayed in
  1401. another window. When this option is set, the other window actually displays
  1402. an indirect buffer clone of the current buffer, to avoid any visibility
  1403. changes to the current buffer."
  1404. :group 'org-link-follow
  1405. :type 'boolean)
  1406. (defcustom org-open-non-existing-files nil
  1407. "Non-nil means `org-open-file' will open non-existing files.
  1408. When nil, an error will be generated.
  1409. This variable applies only to external applications because they
  1410. might choke on non-existing files. If the link is to a file that
  1411. will be opened in Emacs, the variable is ignored."
  1412. :group 'org-link-follow
  1413. :type 'boolean)
  1414. (defcustom org-open-directory-means-index-dot-org nil
  1415. "Non-nil means a link to a directory really means to index.org.
  1416. When nil, following a directory link will run dired or open a finder/explorer
  1417. window on that directory."
  1418. :group 'org-link-follow
  1419. :type 'boolean)
  1420. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1421. "Function and arguments to call for following mailto links.
  1422. This is a list with the first element being a Lisp function, and the
  1423. remaining elements being arguments to the function. In string arguments,
  1424. %a will be replaced by the address, and %s will be replaced by the subject
  1425. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1426. :group 'org-link-follow
  1427. :type '(choice
  1428. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1429. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1430. (const :tag "message-mail" (message-mail "%a" "%s"))
  1431. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1432. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1433. "Non-nil means ask for confirmation before executing shell links.
  1434. Shell links can be dangerous: just think about a link
  1435. [[shell:rm -rf ~/*][Google Search]]
  1436. This link would show up in your Org-mode document as \"Google Search\",
  1437. but really it would remove your entire home directory.
  1438. Therefore we advise against setting this variable to nil.
  1439. Just change it to `y-or-n-p' if you want to confirm with a
  1440. single keystroke rather than having to type \"yes\"."
  1441. :group 'org-link-follow
  1442. :type '(choice
  1443. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1444. (const :tag "with y-or-n (faster)" y-or-n-p)
  1445. (const :tag "no confirmation (dangerous)" nil)))
  1446. (put 'org-confirm-shell-link-function
  1447. 'safe-local-variable
  1448. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1449. (defcustom org-confirm-shell-link-not-regexp ""
  1450. "A regexp to skip confirmation for shell links."
  1451. :group 'org-link-follow
  1452. :version "24.1"
  1453. :type 'regexp)
  1454. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1455. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1456. Elisp links can be dangerous: just think about a link
  1457. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1458. This link would show up in your Org-mode document as \"Google Search\",
  1459. but really it would remove your entire home directory.
  1460. Therefore we advise against setting this variable to nil.
  1461. Just change it to `y-or-n-p' if you want to confirm with a
  1462. single keystroke rather than having to type \"yes\"."
  1463. :group 'org-link-follow
  1464. :type '(choice
  1465. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1466. (const :tag "with y-or-n (faster)" y-or-n-p)
  1467. (const :tag "no confirmation (dangerous)" nil)))
  1468. (put 'org-confirm-shell-link-function
  1469. 'safe-local-variable
  1470. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1471. (defcustom org-confirm-elisp-link-not-regexp ""
  1472. "A regexp to skip confirmation for Elisp links."
  1473. :group 'org-link-follow
  1474. :version "24.1"
  1475. :type 'regexp)
  1476. (defconst org-file-apps-defaults-gnu
  1477. '((remote . emacs)
  1478. (system . mailcap)
  1479. (t . mailcap))
  1480. "Default file applications on a UNIX or GNU/Linux system.
  1481. See `org-file-apps'.")
  1482. (defconst org-file-apps-defaults-macosx
  1483. '((remote . emacs)
  1484. (t . "open %s")
  1485. (system . "open %s")
  1486. ("ps.gz" . "gv %s")
  1487. ("eps.gz" . "gv %s")
  1488. ("dvi" . "xdvi %s")
  1489. ("fig" . "xfig %s"))
  1490. "Default file applications on a MacOS X system.
  1491. The system \"open\" is known as a default, but we use X11 applications
  1492. for some files for which the OS does not have a good default.
  1493. See `org-file-apps'.")
  1494. (defconst org-file-apps-defaults-windowsnt
  1495. (list
  1496. '(remote . emacs)
  1497. (cons t
  1498. (list (if (featurep 'xemacs)
  1499. 'mswindows-shell-execute
  1500. 'w32-shell-execute)
  1501. "open" 'file))
  1502. (cons 'system
  1503. (list (if (featurep 'xemacs)
  1504. 'mswindows-shell-execute
  1505. 'w32-shell-execute)
  1506. "open" 'file)))
  1507. "Default file applications on a Windows NT system.
  1508. The system \"open\" is used for most files.
  1509. See `org-file-apps'.")
  1510. (defcustom org-file-apps
  1511. '(
  1512. (auto-mode . emacs)
  1513. ("\\.mm\\'" . default)
  1514. ("\\.x?html?\\'" . default)
  1515. ("\\.pdf\\'" . default)
  1516. )
  1517. "External applications for opening `file:path' items in a document.
  1518. Org-mode uses system defaults for different file types, but
  1519. you can use this variable to set the application for a given file
  1520. extension. The entries in this list are cons cells where the car identifies
  1521. files and the cdr the corresponding command. Possible values for the
  1522. file identifier are
  1523. \"string\" A string as a file identifier can be interpreted in different
  1524. ways, depending on its contents:
  1525. - Alphanumeric characters only:
  1526. Match links with this file extension.
  1527. Example: (\"pdf\" . \"evince %s\")
  1528. to open PDFs with evince.
  1529. - Regular expression: Match links where the
  1530. filename matches the regexp. If you want to
  1531. use groups here, use shy groups.
  1532. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1533. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1534. to open *.html and *.xhtml with firefox.
  1535. - Regular expression which contains (non-shy) groups:
  1536. Match links where the whole link, including \"::\", and
  1537. anything after that, matches the regexp.
  1538. In a custom command string, %1, %2, etc. are replaced with
  1539. the parts of the link that were matched by the groups.
  1540. For backwards compatibility, if a command string is given
  1541. that does not use any of the group matches, this case is
  1542. handled identically to the second one (i.e. match against
  1543. file name only).
  1544. In a custom lisp form, you can access the group matches with
  1545. (match-string n link).
  1546. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1547. to open [[file:document.pdf::5]] with evince at page 5.
  1548. `directory' Matches a directory
  1549. `remote' Matches a remote file, accessible through tramp or efs.
  1550. Remote files most likely should be visited through Emacs
  1551. because external applications cannot handle such paths.
  1552. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1553. so all files Emacs knows how to handle. Using this with
  1554. command `emacs' will open most files in Emacs. Beware that this
  1555. will also open html files inside Emacs, unless you add
  1556. (\"html\" . default) to the list as well.
  1557. t Default for files not matched by any of the other options.
  1558. `system' The system command to open files, like `open' on Windows
  1559. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1560. that will be selected if you call `C-c C-o' with a double
  1561. \\[universal-argument] \\[universal-argument] prefix.
  1562. Possible values for the command are:
  1563. `emacs' The file will be visited by the current Emacs process.
  1564. `default' Use the default application for this file type, which is the
  1565. association for t in the list, most likely in the system-specific
  1566. part.
  1567. This can be used to overrule an unwanted setting in the
  1568. system-specific variable.
  1569. `system' Use the system command for opening files, like \"open\".
  1570. This command is specified by the entry whose car is `system'.
  1571. Most likely, the system-specific version of this variable
  1572. does define this command, but you can overrule/replace it
  1573. here.
  1574. string A command to be executed by a shell; %s will be replaced
  1575. by the path to the file.
  1576. sexp A Lisp form which will be evaluated. The file path will
  1577. be available in the Lisp variable `file'.
  1578. For more examples, see the system specific constants
  1579. `org-file-apps-defaults-macosx'
  1580. `org-file-apps-defaults-windowsnt'
  1581. `org-file-apps-defaults-gnu'."
  1582. :group 'org-link-follow
  1583. :type '(repeat
  1584. (cons (choice :value ""
  1585. (string :tag "Extension")
  1586. (const :tag "System command to open files" system)
  1587. (const :tag "Default for unrecognized files" t)
  1588. (const :tag "Remote file" remote)
  1589. (const :tag "Links to a directory" directory)
  1590. (const :tag "Any files that have Emacs modes"
  1591. auto-mode))
  1592. (choice :value ""
  1593. (const :tag "Visit with Emacs" emacs)
  1594. (const :tag "Use default" default)
  1595. (const :tag "Use the system command" system)
  1596. (string :tag "Command")
  1597. (sexp :tag "Lisp form")))))
  1598. (defcustom org-doi-server-url "http://dx.doi.org/"
  1599. "The URL of the DOI server."
  1600. :type 'string
  1601. ;; :version "24.3"
  1602. :group 'org-link-follow)
  1603. (defgroup org-refile nil
  1604. "Options concerning refiling entries in Org-mode."
  1605. :tag "Org Refile"
  1606. :group 'org)
  1607. (defcustom org-directory "~/org"
  1608. "Directory with org files.
  1609. This is just a default location to look for Org files. There is no need
  1610. at all to put your files into this directory. It is only used in the
  1611. following situations:
  1612. 1. When a capture template specifies a target file that is not an
  1613. absolute path. The path will then be interpreted relative to
  1614. `org-directory'
  1615. 2. When a capture note is filed away in an interactive way (when exiting the
  1616. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1617. with `org-directory' as the default path."
  1618. :group 'org-refile
  1619. :group 'org-remember
  1620. :group 'org-capture
  1621. :type 'directory)
  1622. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1623. "Default target for storing notes.
  1624. Used as a fall back file for org-remember.el and org-capture.el, for
  1625. templates that do not specify a target file."
  1626. :group 'org-refile
  1627. :group 'org-remember
  1628. :group 'org-capture
  1629. :type '(choice
  1630. (const :tag "Default from remember-data-file" nil)
  1631. file))
  1632. (defcustom org-goto-interface 'outline
  1633. "The default interface to be used for `org-goto'.
  1634. Allowed values are:
  1635. outline The interface shows an outline of the relevant file
  1636. and the correct heading is found by moving through
  1637. the outline or by searching with incremental search.
  1638. outline-path-completion Headlines in the current buffer are offered via
  1639. completion. This is the interface also used by
  1640. the refile command."
  1641. :group 'org-refile
  1642. :type '(choice
  1643. (const :tag "Outline" outline)
  1644. (const :tag "Outline-path-completion" outline-path-completion)))
  1645. (defcustom org-goto-max-level 5
  1646. "Maximum target level when running `org-goto' with refile interface."
  1647. :group 'org-refile
  1648. :type 'integer)
  1649. (defcustom org-reverse-note-order nil
  1650. "Non-nil means store new notes at the beginning of a file or entry.
  1651. When nil, new notes will be filed to the end of a file or entry.
  1652. This can also be a list with cons cells of regular expressions that
  1653. are matched against file names, and values."
  1654. :group 'org-remember
  1655. :group 'org-capture
  1656. :group 'org-refile
  1657. :type '(choice
  1658. (const :tag "Reverse always" t)
  1659. (const :tag "Reverse never" nil)
  1660. (repeat :tag "By file name regexp"
  1661. (cons regexp boolean))))
  1662. (defcustom org-log-refile nil
  1663. "Information to record when a task is refiled.
  1664. Possible values are:
  1665. nil Don't add anything
  1666. time Add a time stamp to the task
  1667. note Prompt for a note and add it with template `org-log-note-headings'
  1668. This option can also be set with on a per-file-basis with
  1669. #+STARTUP: nologrefile
  1670. #+STARTUP: logrefile
  1671. #+STARTUP: lognoterefile
  1672. You can have local logging settings for a subtree by setting the LOGGING
  1673. property to one or more of these keywords.
  1674. When bulk-refiling from the agenda, the value `note' is forbidden and
  1675. will temporarily be changed to `time'."
  1676. :group 'org-refile
  1677. :group 'org-progress
  1678. :version "24.1"
  1679. :type '(choice
  1680. (const :tag "No logging" nil)
  1681. (const :tag "Record timestamp" time)
  1682. (const :tag "Record timestamp with note." note)))
  1683. (defcustom org-refile-targets nil
  1684. "Targets for refiling entries with \\[org-refile].
  1685. This is a list of cons cells. Each cell contains:
  1686. - a specification of the files to be considered, either a list of files,
  1687. or a symbol whose function or variable value will be used to retrieve
  1688. a file name or a list of file names. If you use `org-agenda-files' for
  1689. that, all agenda files will be scanned for targets. Nil means consider
  1690. headings in the current buffer.
  1691. - A specification of how to find candidate refile targets. This may be
  1692. any of:
  1693. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1694. This tag has to be present in all target headlines, inheritance will
  1695. not be considered.
  1696. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1697. todo keyword.
  1698. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1699. headlines that are refiling targets.
  1700. - a cons cell (:level . N). Any headline of level N is considered a target.
  1701. Note that, when `org-odd-levels-only' is set, level corresponds to
  1702. order in hierarchy, not to the number of stars.
  1703. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1704. Note that, when `org-odd-levels-only' is set, level corresponds to
  1705. order in hierarchy, not to the number of stars.
  1706. Each element of this list generates a set of possible targets.
  1707. The union of these sets is presented (with completion) to
  1708. the user by `org-refile'.
  1709. You can set the variable `org-refile-target-verify-function' to a function
  1710. to verify each headline found by the simple criteria above.
  1711. When this variable is nil, all top-level headlines in the current buffer
  1712. are used, equivalent to the value `((nil . (:level . 1))'."
  1713. :group 'org-refile
  1714. :type '(repeat
  1715. (cons
  1716. (choice :value org-agenda-files
  1717. (const :tag "All agenda files" org-agenda-files)
  1718. (const :tag "Current buffer" nil)
  1719. (function) (variable) (file))
  1720. (choice :tag "Identify target headline by"
  1721. (cons :tag "Specific tag" (const :value :tag) (string))
  1722. (cons :tag "TODO keyword" (const :value :todo) (string))
  1723. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1724. (cons :tag "Level number" (const :value :level) (integer))
  1725. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1726. (defcustom org-refile-target-verify-function nil
  1727. "Function to verify if the headline at point should be a refile target.
  1728. The function will be called without arguments, with point at the
  1729. beginning of the headline. It should return t and leave point
  1730. where it is if the headline is a valid target for refiling.
  1731. If the target should not be selected, the function must return nil.
  1732. In addition to this, it may move point to a place from where the search
  1733. should be continued. For example, the function may decide that the entire
  1734. subtree of the current entry should be excluded and move point to the end
  1735. of the subtree."
  1736. :group 'org-refile
  1737. :type 'function)
  1738. (defcustom org-refile-use-cache nil
  1739. "Non-nil means cache refile targets to speed up the process.
  1740. The cache for a particular file will be updated automatically when
  1741. the buffer has been killed, or when any of the marker used for flagging
  1742. refile targets no longer points at a live buffer.
  1743. If you have added new entries to a buffer that might themselves be targets,
  1744. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1745. find that easier, `C-u C-u C-u C-c C-w'."
  1746. :group 'org-refile
  1747. :version "24.1"
  1748. :type 'boolean)
  1749. (defcustom org-refile-use-outline-path nil
  1750. "Non-nil means provide refile targets as paths.
  1751. So a level 3 headline will be available as level1/level2/level3.
  1752. When the value is `file', also include the file name (without directory)
  1753. into the path. In this case, you can also stop the completion after
  1754. the file name, to get entries inserted as top level in the file.
  1755. When `full-file-path', include the full file path."
  1756. :group 'org-refile
  1757. :type '(choice
  1758. (const :tag "Not" nil)
  1759. (const :tag "Yes" t)
  1760. (const :tag "Start with file name" file)
  1761. (const :tag "Start with full file path" full-file-path)))
  1762. (defcustom org-outline-path-complete-in-steps t
  1763. "Non-nil means complete the outline path in hierarchical steps.
  1764. When Org-mode uses the refile interface to select an outline path
  1765. \(see variable `org-refile-use-outline-path'), the completion of
  1766. the path can be done is a single go, or if can be done in steps down
  1767. the headline hierarchy. Going in steps is probably the best if you
  1768. do not use a special completion package like `ido' or `icicles'.
  1769. However, when using these packages, going in one step can be very
  1770. fast, while still showing the whole path to the entry."
  1771. :group 'org-refile
  1772. :type 'boolean)
  1773. (defcustom org-refile-allow-creating-parent-nodes nil
  1774. "Non-nil means allow to create new nodes as refile targets.
  1775. New nodes are then created by adding \"/new node name\" to the completion
  1776. of an existing node. When the value of this variable is `confirm',
  1777. new node creation must be confirmed by the user (recommended)
  1778. When nil, the completion must match an existing entry.
  1779. Note that, if the new heading is not seen by the criteria
  1780. listed in `org-refile-targets', multiple instances of the same
  1781. heading would be created by trying again to file under the new
  1782. heading."
  1783. :group 'org-refile
  1784. :type '(choice
  1785. (const :tag "Never" nil)
  1786. (const :tag "Always" t)
  1787. (const :tag "Prompt for confirmation" confirm)))
  1788. (defcustom org-refile-active-region-within-subtree nil
  1789. "Non-nil means also refile active region within a subtree.
  1790. By default `org-refile' doesn't allow refiling regions if they
  1791. don't contain a set of subtrees, but it might be convenient to
  1792. do so sometimes: in that case, the first line of the region is
  1793. converted to a headline before refiling."
  1794. :group 'org-refile
  1795. :version "24.1"
  1796. :type 'boolean)
  1797. (defgroup org-todo nil
  1798. "Options concerning TODO items in Org-mode."
  1799. :tag "Org TODO"
  1800. :group 'org)
  1801. (defgroup org-progress nil
  1802. "Options concerning Progress logging in Org-mode."
  1803. :tag "Org Progress"
  1804. :group 'org-time)
  1805. (defvar org-todo-interpretation-widgets
  1806. '((:tag "Sequence (cycling hits every state)" sequence)
  1807. (:tag "Type (cycling directly to DONE)" type))
  1808. "The available interpretation symbols for customizing `org-todo-keywords'.
  1809. Interested libraries should add to this list.")
  1810. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1811. "List of TODO entry keyword sequences and their interpretation.
  1812. \\<org-mode-map>This is a list of sequences.
  1813. Each sequence starts with a symbol, either `sequence' or `type',
  1814. indicating if the keywords should be interpreted as a sequence of
  1815. action steps, or as different types of TODO items. The first
  1816. keywords are states requiring action - these states will select a headline
  1817. for inclusion into the global TODO list Org-mode produces. If one of
  1818. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1819. signify that no further action is necessary. If \"|\" is not found,
  1820. the last keyword is treated as the only DONE state of the sequence.
  1821. The command \\[org-todo] cycles an entry through these states, and one
  1822. additional state where no keyword is present. For details about this
  1823. cycling, see the manual.
  1824. TODO keywords and interpretation can also be set on a per-file basis with
  1825. the special #+SEQ_TODO and #+TYP_TODO lines.
  1826. Each keyword can optionally specify a character for fast state selection
  1827. \(in combination with the variable `org-use-fast-todo-selection')
  1828. and specifiers for state change logging, using the same syntax that
  1829. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  1830. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1831. indicates to record a time stamp each time this state is selected.
  1832. Each keyword may also specify if a timestamp or a note should be
  1833. recorded when entering or leaving the state, by adding additional
  1834. characters in the parenthesis after the keyword. This looks like this:
  1835. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1836. record only the time of the state change. With X and Y being either
  1837. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1838. Y when leaving the state if and only if the *target* state does not
  1839. define X. You may omit any of the fast-selection key or X or /Y,
  1840. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1841. For backward compatibility, this variable may also be just a list
  1842. of keywords. In this case the interpretation (sequence or type) will be
  1843. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1844. :group 'org-todo
  1845. :group 'org-keywords
  1846. :type '(choice
  1847. (repeat :tag "Old syntax, just keywords"
  1848. (string :tag "Keyword"))
  1849. (repeat :tag "New syntax"
  1850. (cons
  1851. (choice
  1852. :tag "Interpretation"
  1853. ;;Quick and dirty way to see
  1854. ;;`org-todo-interpretations'. This takes the
  1855. ;;place of item arguments
  1856. :convert-widget
  1857. (lambda (widget)
  1858. (widget-put widget
  1859. :args (mapcar
  1860. #'(lambda (x)
  1861. (widget-convert
  1862. (cons 'const x)))
  1863. org-todo-interpretation-widgets))
  1864. widget))
  1865. (repeat
  1866. (string :tag "Keyword"))))))
  1867. (defvar org-todo-keywords-1 nil
  1868. "All TODO and DONE keywords active in a buffer.")
  1869. (make-variable-buffer-local 'org-todo-keywords-1)
  1870. (defvar org-todo-keywords-for-agenda nil)
  1871. (defvar org-done-keywords-for-agenda nil)
  1872. (defvar org-drawers-for-agenda nil)
  1873. (defvar org-todo-keyword-alist-for-agenda nil)
  1874. (defvar org-tag-alist-for-agenda nil)
  1875. (defvar org-agenda-contributing-files nil)
  1876. (defvar org-not-done-keywords nil)
  1877. (make-variable-buffer-local 'org-not-done-keywords)
  1878. (defvar org-done-keywords nil)
  1879. (make-variable-buffer-local 'org-done-keywords)
  1880. (defvar org-todo-heads nil)
  1881. (make-variable-buffer-local 'org-todo-heads)
  1882. (defvar org-todo-sets nil)
  1883. (make-variable-buffer-local 'org-todo-sets)
  1884. (defvar org-todo-log-states nil)
  1885. (make-variable-buffer-local 'org-todo-log-states)
  1886. (defvar org-todo-kwd-alist nil)
  1887. (make-variable-buffer-local 'org-todo-kwd-alist)
  1888. (defvar org-todo-key-alist nil)
  1889. (make-variable-buffer-local 'org-todo-key-alist)
  1890. (defvar org-todo-key-trigger nil)
  1891. (make-variable-buffer-local 'org-todo-key-trigger)
  1892. (defcustom org-todo-interpretation 'sequence
  1893. "Controls how TODO keywords are interpreted.
  1894. This variable is in principle obsolete and is only used for
  1895. backward compatibility, if the interpretation of todo keywords is
  1896. not given already in `org-todo-keywords'. See that variable for
  1897. more information."
  1898. :group 'org-todo
  1899. :group 'org-keywords
  1900. :type '(choice (const sequence)
  1901. (const type)))
  1902. (defcustom org-use-fast-todo-selection t
  1903. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1904. This variable describes if and under what circumstances the cycling
  1905. mechanism for TODO keywords will be replaced by a single-key, direct
  1906. selection scheme.
  1907. When nil, fast selection is never used.
  1908. When the symbol `prefix', it will be used when `org-todo' is called
  1909. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  1910. `C-u t' in an agenda buffer.
  1911. When t, fast selection is used by default. In this case, the prefix
  1912. argument forces cycling instead.
  1913. In all cases, the special interface is only used if access keys have
  1914. actually been assigned by the user, i.e. if keywords in the configuration
  1915. are followed by a letter in parenthesis, like TODO(t)."
  1916. :group 'org-todo
  1917. :type '(choice
  1918. (const :tag "Never" nil)
  1919. (const :tag "By default" t)
  1920. (const :tag "Only with C-u C-c C-t" prefix)))
  1921. (defcustom org-provide-todo-statistics t
  1922. "Non-nil means update todo statistics after insert and toggle.
  1923. ALL-HEADLINES means update todo statistics by including headlines
  1924. with no TODO keyword as well, counting them as not done.
  1925. A list of TODO keywords means the same, but skip keywords that are
  1926. not in this list.
  1927. When this is set, todo statistics is updated in the parent of the
  1928. current entry each time a todo state is changed."
  1929. :group 'org-todo
  1930. :type '(choice
  1931. (const :tag "Yes, only for TODO entries" t)
  1932. (const :tag "Yes, including all entries" 'all-headlines)
  1933. (repeat :tag "Yes, for TODOs in this list"
  1934. (string :tag "TODO keyword"))
  1935. (other :tag "No TODO statistics" nil)))
  1936. (defcustom org-hierarchical-todo-statistics t
  1937. "Non-nil means TODO statistics covers just direct children.
  1938. When nil, all entries in the subtree are considered.
  1939. This has only an effect if `org-provide-todo-statistics' is set.
  1940. To set this to nil for only a single subtree, use a COOKIE_DATA
  1941. property and include the word \"recursive\" into the value."
  1942. :group 'org-todo
  1943. :type 'boolean)
  1944. (defcustom org-after-todo-state-change-hook nil
  1945. "Hook which is run after the state of a TODO item was changed.
  1946. The new state (a string with a TODO keyword, or nil) is available in the
  1947. Lisp variable `org-state'."
  1948. :group 'org-todo
  1949. :type 'hook)
  1950. (defvar org-blocker-hook nil
  1951. "Hook for functions that are allowed to block a state change.
  1952. Each function gets as its single argument a property list, see
  1953. `org-trigger-hook' for more information about this list.
  1954. If any of the functions in this hook returns nil, the state change
  1955. is blocked.")
  1956. (defvar org-trigger-hook nil
  1957. "Hook for functions that are triggered by a state change.
  1958. Each function gets as its single argument a property list with at least
  1959. the following elements:
  1960. (:type type-of-change :position pos-at-entry-start
  1961. :from old-state :to new-state)
  1962. Depending on the type, more properties may be present.
  1963. This mechanism is currently implemented for:
  1964. TODO state changes
  1965. ------------------
  1966. :type todo-state-change
  1967. :from previous state (keyword as a string), or nil, or a symbol
  1968. 'todo' or 'done', to indicate the general type of state.
  1969. :to new state, like in :from")
  1970. (defcustom org-enforce-todo-dependencies nil
  1971. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1972. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1973. be blocked if any prior sibling is not yet done.
  1974. Finally, if the parent is blocked because of ordered siblings of its own,
  1975. the child will also be blocked."
  1976. :set (lambda (var val)
  1977. (set var val)
  1978. (if val
  1979. (add-hook 'org-blocker-hook
  1980. 'org-block-todo-from-children-or-siblings-or-parent)
  1981. (remove-hook 'org-blocker-hook
  1982. 'org-block-todo-from-children-or-siblings-or-parent)))
  1983. :group 'org-todo
  1984. :type 'boolean)
  1985. (defcustom org-enforce-todo-checkbox-dependencies nil
  1986. "Non-nil means unchecked boxes will block switching the parent to DONE.
  1987. When this is nil, checkboxes have no influence on switching TODO states.
  1988. When non-nil, you first need to check off all check boxes before the TODO
  1989. entry can be switched to DONE.
  1990. This variable needs to be set before org.el is loaded, and you need to
  1991. restart Emacs after a change to make the change effective. The only way
  1992. to change is while Emacs is running is through the customize interface."
  1993. :set (lambda (var val)
  1994. (set var val)
  1995. (if val
  1996. (add-hook 'org-blocker-hook
  1997. 'org-block-todo-from-checkboxes)
  1998. (remove-hook 'org-blocker-hook
  1999. 'org-block-todo-from-checkboxes)))
  2000. :group 'org-todo
  2001. :type 'boolean)
  2002. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2003. "Non-nil means inserting a TODO heading is treated as state change.
  2004. So when the command \\[org-insert-todo-heading] is used, state change
  2005. logging will apply if appropriate. When nil, the new TODO item will
  2006. be inserted directly, and no logging will take place."
  2007. :group 'org-todo
  2008. :type 'boolean)
  2009. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2010. "Non-nil means switching TODO states with S-cursor counts as state change.
  2011. This is the default behavior. However, setting this to nil allows a
  2012. convenient way to select a TODO state and bypass any logging associated
  2013. with that."
  2014. :group 'org-todo
  2015. :type 'boolean)
  2016. (defcustom org-todo-state-tags-triggers nil
  2017. "Tag changes that should be triggered by TODO state changes.
  2018. This is a list. Each entry is
  2019. (state-change (tag . flag) .......)
  2020. State-change can be a string with a state, and empty string to indicate the
  2021. state that has no TODO keyword, or it can be one of the symbols `todo'
  2022. or `done', meaning any not-done or done state, respectively."
  2023. :group 'org-todo
  2024. :group 'org-tags
  2025. :type '(repeat
  2026. (cons (choice :tag "When changing to"
  2027. (const :tag "Not-done state" todo)
  2028. (const :tag "Done state" done)
  2029. (string :tag "State"))
  2030. (repeat
  2031. (cons :tag "Tag action"
  2032. (string :tag "Tag")
  2033. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2034. (defcustom org-log-done nil
  2035. "Information to record when a task moves to the DONE state.
  2036. Possible values are:
  2037. nil Don't add anything, just change the keyword
  2038. time Add a time stamp to the task
  2039. note Prompt for a note and add it with template `org-log-note-headings'
  2040. This option can also be set with on a per-file-basis with
  2041. #+STARTUP: nologdone
  2042. #+STARTUP: logdone
  2043. #+STARTUP: lognotedone
  2044. You can have local logging settings for a subtree by setting the LOGGING
  2045. property to one or more of these keywords."
  2046. :group 'org-todo
  2047. :group 'org-progress
  2048. :type '(choice
  2049. (const :tag "No logging" nil)
  2050. (const :tag "Record CLOSED timestamp" time)
  2051. (const :tag "Record CLOSED timestamp with note." note)))
  2052. ;; Normalize old uses of org-log-done.
  2053. (cond
  2054. ((eq org-log-done t) (setq org-log-done 'time))
  2055. ((and (listp org-log-done) (memq 'done org-log-done))
  2056. (setq org-log-done 'note)))
  2057. (defcustom org-log-reschedule nil
  2058. "Information to record when the scheduling date of a tasks is modified.
  2059. Possible values are:
  2060. nil Don't add anything, just change the date
  2061. time Add a time stamp to the task
  2062. note Prompt for a note and add it with template `org-log-note-headings'
  2063. This option can also be set with on a per-file-basis with
  2064. #+STARTUP: nologreschedule
  2065. #+STARTUP: logreschedule
  2066. #+STARTUP: lognotereschedule"
  2067. :group 'org-todo
  2068. :group 'org-progress
  2069. :type '(choice
  2070. (const :tag "No logging" nil)
  2071. (const :tag "Record timestamp" time)
  2072. (const :tag "Record timestamp with note." note)))
  2073. (defcustom org-log-redeadline nil
  2074. "Information to record when the deadline date of a tasks is modified.
  2075. Possible values are:
  2076. nil Don't add anything, just change the date
  2077. time Add a time stamp to the task
  2078. note Prompt for a note and add it with template `org-log-note-headings'
  2079. This option can also be set with on a per-file-basis with
  2080. #+STARTUP: nologredeadline
  2081. #+STARTUP: logredeadline
  2082. #+STARTUP: lognoteredeadline
  2083. You can have local logging settings for a subtree by setting the LOGGING
  2084. property to one or more of these keywords."
  2085. :group 'org-todo
  2086. :group 'org-progress
  2087. :type '(choice
  2088. (const :tag "No logging" nil)
  2089. (const :tag "Record timestamp" time)
  2090. (const :tag "Record timestamp with note." note)))
  2091. (defcustom org-log-note-clock-out nil
  2092. "Non-nil means record a note when clocking out of an item.
  2093. This can also be configured on a per-file basis by adding one of
  2094. the following lines anywhere in the buffer:
  2095. #+STARTUP: lognoteclock-out
  2096. #+STARTUP: nolognoteclock-out"
  2097. :group 'org-todo
  2098. :group 'org-progress
  2099. :type 'boolean)
  2100. (defcustom org-log-done-with-time t
  2101. "Non-nil means the CLOSED time stamp will contain date and time.
  2102. When nil, only the date will be recorded."
  2103. :group 'org-progress
  2104. :type 'boolean)
  2105. (defcustom org-log-note-headings
  2106. '((done . "CLOSING NOTE %t")
  2107. (state . "State %-12s from %-12S %t")
  2108. (note . "Note taken on %t")
  2109. (reschedule . "Rescheduled from %S on %t")
  2110. (delschedule . "Not scheduled, was %S on %t")
  2111. (redeadline . "New deadline from %S on %t")
  2112. (deldeadline . "Removed deadline, was %S on %t")
  2113. (refile . "Refiled on %t")
  2114. (clock-out . ""))
  2115. "Headings for notes added to entries.
  2116. The value is an alist, with the car being a symbol indicating the note
  2117. context, and the cdr is the heading to be used. The heading may also be the
  2118. empty string.
  2119. %t in the heading will be replaced by a time stamp.
  2120. %T will be an active time stamp instead the default inactive one
  2121. %d will be replaced by a short-format time stamp.
  2122. %D will be replaced by an active short-format time stamp.
  2123. %s will be replaced by the new TODO state, in double quotes.
  2124. %S will be replaced by the old TODO state, in double quotes.
  2125. %u will be replaced by the user name.
  2126. %U will be replaced by the full user name.
  2127. In fact, it is not a good idea to change the `state' entry, because
  2128. agenda log mode depends on the format of these entries."
  2129. :group 'org-todo
  2130. :group 'org-progress
  2131. :type '(list :greedy t
  2132. (cons (const :tag "Heading when closing an item" done) string)
  2133. (cons (const :tag
  2134. "Heading when changing todo state (todo sequence only)"
  2135. state) string)
  2136. (cons (const :tag "Heading when just taking a note" note) string)
  2137. (cons (const :tag "Heading when clocking out" clock-out) string)
  2138. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2139. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2140. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2141. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2142. (cons (const :tag "Heading when refiling" refile) string)))
  2143. (unless (assq 'note org-log-note-headings)
  2144. (push '(note . "%t") org-log-note-headings))
  2145. (defcustom org-log-into-drawer nil
  2146. "Non-nil means insert state change notes and time stamps into a drawer.
  2147. When nil, state changes notes will be inserted after the headline and
  2148. any scheduling and clock lines, but not inside a drawer.
  2149. The value of this variable should be the name of the drawer to use.
  2150. LOGBOOK is proposed as the default drawer for this purpose, you can
  2151. also set this to a string to define the drawer of your choice.
  2152. A value of t is also allowed, representing \"LOGBOOK\".
  2153. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2154. will be ignored.
  2155. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2156. a subtree."
  2157. :group 'org-todo
  2158. :group 'org-progress
  2159. :type '(choice
  2160. (const :tag "Not into a drawer" nil)
  2161. (const :tag "LOGBOOK" t)
  2162. (string :tag "Other")))
  2163. (if (fboundp 'defvaralias)
  2164. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  2165. (defun org-log-into-drawer ()
  2166. "Return the value of `org-log-into-drawer', but let properties overrule.
  2167. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2168. used instead of the default value."
  2169. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
  2170. (cond
  2171. ((or (not p) (equal p "nil")) org-log-into-drawer)
  2172. ((equal p "t") "LOGBOOK")
  2173. (t p))))
  2174. (defcustom org-log-state-notes-insert-after-drawers nil
  2175. "Non-nil means insert state change notes after any drawers in entry.
  2176. Only the drawers that *immediately* follow the headline and the
  2177. deadline/scheduled line are skipped.
  2178. When nil, insert notes right after the heading and perhaps the line
  2179. with deadline/scheduling if present.
  2180. This variable will have no effect if `org-log-into-drawer' is
  2181. set."
  2182. :group 'org-todo
  2183. :group 'org-progress
  2184. :type 'boolean)
  2185. (defcustom org-log-states-order-reversed t
  2186. "Non-nil means the latest state note will be directly after heading.
  2187. When nil, the state change notes will be ordered according to time."
  2188. :group 'org-todo
  2189. :group 'org-progress
  2190. :type 'boolean)
  2191. (defcustom org-todo-repeat-to-state nil
  2192. "The TODO state to which a repeater should return the repeating task.
  2193. By default this is the first task in a TODO sequence, or the previous state
  2194. in a TODO_TYP set. But you can specify another task here.
  2195. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2196. :group 'org-todo
  2197. :version "24.1"
  2198. :type '(choice (const :tag "Head of sequence" nil)
  2199. (string :tag "Specific state")))
  2200. (defcustom org-log-repeat 'time
  2201. "Non-nil means record moving through the DONE state when triggering repeat.
  2202. An auto-repeating task is immediately switched back to TODO when
  2203. marked DONE. If you are not logging state changes (by adding \"@\"
  2204. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2205. record a closing note, there will be no record of the task moving
  2206. through DONE. This variable forces taking a note anyway.
  2207. nil Don't force a record
  2208. time Record a time stamp
  2209. note Prompt for a note and add it with template `org-log-note-headings'
  2210. This option can also be set with on a per-file-basis with
  2211. #+STARTUP: nologrepeat
  2212. #+STARTUP: logrepeat
  2213. #+STARTUP: lognoterepeat
  2214. You can have local logging settings for a subtree by setting the LOGGING
  2215. property to one or more of these keywords."
  2216. :group 'org-todo
  2217. :group 'org-progress
  2218. :type '(choice
  2219. (const :tag "Don't force a record" nil)
  2220. (const :tag "Force recording the DONE state" time)
  2221. (const :tag "Force recording a note with the DONE state" note)))
  2222. (defgroup org-priorities nil
  2223. "Priorities in Org-mode."
  2224. :tag "Org Priorities"
  2225. :group 'org-todo)
  2226. (defcustom org-enable-priority-commands t
  2227. "Non-nil means priority commands are active.
  2228. When nil, these commands will be disabled, so that you never accidentally
  2229. set a priority."
  2230. :group 'org-priorities
  2231. :type 'boolean)
  2232. (defcustom org-highest-priority ?A
  2233. "The highest priority of TODO items. A character like ?A, ?B etc.
  2234. Must have a smaller ASCII number than `org-lowest-priority'."
  2235. :group 'org-priorities
  2236. :type 'character)
  2237. (defcustom org-lowest-priority ?C
  2238. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2239. Must have a larger ASCII number than `org-highest-priority'."
  2240. :group 'org-priorities
  2241. :type 'character)
  2242. (defcustom org-default-priority ?B
  2243. "The default priority of TODO items.
  2244. This is the priority an item gets if no explicit priority is given.
  2245. When starting to cycle on an empty priority the first step in the cycle
  2246. depends on `org-priority-start-cycle-with-default'. The resulting first
  2247. step priority must not exceed the range from `org-highest-priority' to
  2248. `org-lowest-priority' which means that `org-default-priority' has to be
  2249. in this range exclusive or inclusive the range boundaries. Else the
  2250. first step refuses to set the default and the second will fall back
  2251. to (depending on the command used) the highest or lowest priority."
  2252. :group 'org-priorities
  2253. :type 'character)
  2254. (defcustom org-priority-start-cycle-with-default t
  2255. "Non-nil means start with default priority when starting to cycle.
  2256. When this is nil, the first step in the cycle will be (depending on the
  2257. command used) one higher or lower than the default priority.
  2258. See also `org-default-priority'."
  2259. :group 'org-priorities
  2260. :type 'boolean)
  2261. (defcustom org-get-priority-function nil
  2262. "Function to extract the priority from a string.
  2263. The string is normally the headline. If this is nil Org computes the
  2264. priority from the priority cookie like [#A] in the headline. It returns
  2265. an integer, increasing by 1000 for each priority level.
  2266. The user can set a different function here, which should take a string
  2267. as an argument and return the numeric priority."
  2268. :group 'org-priorities
  2269. :version "24.1"
  2270. :type 'function)
  2271. (defgroup org-time nil
  2272. "Options concerning time stamps and deadlines in Org-mode."
  2273. :tag "Org Time"
  2274. :group 'org)
  2275. (defcustom org-insert-labeled-timestamps-at-point nil
  2276. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2277. When nil, these labeled time stamps are forces into the second line of an
  2278. entry, just after the headline. When scheduling from the global TODO list,
  2279. the time stamp will always be forced into the second line."
  2280. :group 'org-time
  2281. :type 'boolean)
  2282. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2283. "Formats for `format-time-string' which are used for time stamps.
  2284. It is not recommended to change this constant.")
  2285. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2286. "Number of minutes to round time stamps to.
  2287. These are two values, the first applies when first creating a time stamp.
  2288. The second applies when changing it with the commands `S-up' and `S-down'.
  2289. When changing the time stamp, this means that it will change in steps
  2290. of N minutes, as given by the second value.
  2291. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2292. numbers should be factors of 60, so for example 5, 10, 15.
  2293. When this is larger than 1, you can still force an exact time stamp by using
  2294. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2295. and by using a prefix arg to `S-up/down' to specify the exact number
  2296. of minutes to shift."
  2297. :group 'org-time
  2298. :get #'(lambda (var) ; Make sure both elements are there
  2299. (if (integerp (default-value var))
  2300. (list (default-value var) 5)
  2301. (default-value var)))
  2302. :type '(list
  2303. (integer :tag "when inserting times")
  2304. (integer :tag "when modifying times")))
  2305. ;; Normalize old customizations of this variable.
  2306. (when (integerp org-time-stamp-rounding-minutes)
  2307. (setq org-time-stamp-rounding-minutes
  2308. (list org-time-stamp-rounding-minutes
  2309. org-time-stamp-rounding-minutes)))
  2310. (defcustom org-display-custom-times nil
  2311. "Non-nil means overlay custom formats over all time stamps.
  2312. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2313. To turn this on on a per-file basis, insert anywhere in the file:
  2314. #+STARTUP: customtime"
  2315. :group 'org-time
  2316. :set 'set-default
  2317. :type 'sexp)
  2318. (make-variable-buffer-local 'org-display-custom-times)
  2319. (defcustom org-time-stamp-custom-formats
  2320. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2321. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2322. These are overlaid over the default ISO format if the variable
  2323. `org-display-custom-times' is set. Time like %H:%M should be at the
  2324. end of the second format. The custom formats are also honored by export
  2325. commands, if custom time display is turned on at the time of export."
  2326. :group 'org-time
  2327. :type 'sexp)
  2328. (defun org-time-stamp-format (&optional long inactive)
  2329. "Get the right format for a time string."
  2330. (let ((f (if long (cdr org-time-stamp-formats)
  2331. (car org-time-stamp-formats))))
  2332. (if inactive
  2333. (concat "[" (substring f 1 -1) "]")
  2334. f)))
  2335. (defcustom org-time-clocksum-format "%d:%02d"
  2336. "The format string used when creating CLOCKSUM lines.
  2337. This is also used when org-mode generates a time duration."
  2338. :group 'org-time
  2339. :type 'string)
  2340. (defcustom org-time-clocksum-use-fractional nil
  2341. "If non-nil, \\[org-clock-display] uses fractional times.
  2342. org-mode generates a time duration."
  2343. :group 'org-time
  2344. :type 'boolean)
  2345. (defcustom org-time-clocksum-fractional-format "%.2f"
  2346. "The format string used when creating CLOCKSUM lines, or when
  2347. org-mode generates a time duration."
  2348. :group 'org-time
  2349. :type 'string)
  2350. (defcustom org-deadline-warning-days 14
  2351. "No. of days before expiration during which a deadline becomes active.
  2352. This variable governs the display in sparse trees and in the agenda.
  2353. When 0 or negative, it means use this number (the absolute value of it)
  2354. even if a deadline has a different individual lead time specified.
  2355. Custom commands can set this variable in the options section."
  2356. :group 'org-time
  2357. :group 'org-agenda-daily/weekly
  2358. :type 'integer)
  2359. (defcustom org-read-date-prefer-future t
  2360. "Non-nil means assume future for incomplete date input from user.
  2361. This affects the following situations:
  2362. 1. The user gives a month but not a year.
  2363. For example, if it is April and you enter \"feb 2\", this will be read
  2364. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2365. 2. The user gives a day, but no month.
  2366. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2367. read this as the third of *next* month. However, if you enter \"17\",
  2368. it will be considered as *this* month.
  2369. If you set this variable to the symbol `time', then also the following
  2370. will work:
  2371. 3. If the user gives a time.
  2372. If the time is before now, it will be interpreted as tomorrow.
  2373. Currently none of this works for ISO week specifications.
  2374. When this option is nil, the current day, month and year will always be
  2375. used as defaults.
  2376. See also `org-agenda-jump-prefer-future'."
  2377. :group 'org-time
  2378. :type '(choice
  2379. (const :tag "Never" nil)
  2380. (const :tag "Check month and day" t)
  2381. (const :tag "Check month, day, and time" time)))
  2382. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2383. "Should the agenda jump command prefer the future for incomplete dates?
  2384. The default is to do the same as configured in `org-read-date-prefer-future'.
  2385. But you can also set a deviating value here.
  2386. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2387. :group 'org-agenda
  2388. :group 'org-time
  2389. :version "24.1"
  2390. :type '(choice
  2391. (const :tag "Use org-read-date-prefer-future"
  2392. org-read-date-prefer-future)
  2393. (const :tag "Never" nil)
  2394. (const :tag "Always" t)))
  2395. (defcustom org-read-date-force-compatible-dates t
  2396. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2397. Depending on the system Emacs is running on, certain dates cannot
  2398. be represented with the type used internally to represent time.
  2399. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2400. correctly. Some systems allow for earlier dates, some for later,
  2401. some for both. One way to find out it to insert any date into an
  2402. Org buffer, putting the cursor on the year and hitting S-up and
  2403. S-down to test the range.
  2404. When this variable is set to t, the date/time prompt will not let
  2405. you specify dates outside the 1970-2037 range, so it is certain that
  2406. these dates will work in whatever version of Emacs you are
  2407. running, and also that you can move a file from one Emacs implementation
  2408. to another. WHenever Org is forcing the year for you, it will display
  2409. a message and beep.
  2410. When this variable is nil, Org will check if the date is
  2411. representable in the specific Emacs implementation you are using.
  2412. If not, it will force a year, usually the current year, and beep
  2413. to remind you. Currently this setting is not recommended because
  2414. the likelihood that you will open your Org files in an Emacs that
  2415. has limited date range is not negligible.
  2416. A workaround for this problem is to use diary sexp dates for time
  2417. stamps outside of this range."
  2418. :group 'org-time
  2419. :version "24.1"
  2420. :type 'boolean)
  2421. (defcustom org-read-date-display-live t
  2422. "Non-nil means display current interpretation of date prompt live.
  2423. This display will be in an overlay, in the minibuffer."
  2424. :group 'org-time
  2425. :type 'boolean)
  2426. (defcustom org-read-date-popup-calendar t
  2427. "Non-nil means pop up a calendar when prompting for a date.
  2428. In the calendar, the date can be selected with mouse-1. However, the
  2429. minibuffer will also be active, and you can simply enter the date as well.
  2430. When nil, only the minibuffer will be available."
  2431. :group 'org-time
  2432. :type 'boolean)
  2433. (if (fboundp 'defvaralias)
  2434. (defvaralias 'org-popup-calendar-for-date-prompt
  2435. 'org-read-date-popup-calendar))
  2436. (defcustom org-read-date-minibuffer-setup-hook nil
  2437. "Hook to be used to set up keys for the date/time interface.
  2438. Add key definitions to `minibuffer-local-map', which will be a temporary
  2439. copy."
  2440. :group 'org-time
  2441. :type 'hook)
  2442. (defcustom org-extend-today-until 0
  2443. "The hour when your day really ends. Must be an integer.
  2444. This has influence for the following applications:
  2445. - When switching the agenda to \"today\". It it is still earlier than
  2446. the time given here, the day recognized as TODAY is actually yesterday.
  2447. - When a date is read from the user and it is still before the time given
  2448. here, the current date and time will be assumed to be yesterday, 23:59.
  2449. Also, timestamps inserted in capture templates follow this rule.
  2450. IMPORTANT: This is a feature whose implementation is and likely will
  2451. remain incomplete. Really, it is only here because past midnight seems to
  2452. be the favorite working time of John Wiegley :-)"
  2453. :group 'org-time
  2454. :type 'integer)
  2455. (defcustom org-use-effective-time nil
  2456. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2457. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2458. \"effective time\" of any timestamps between midnight and 8am will be
  2459. 23:59 of the previous day."
  2460. :group 'org-time
  2461. :version "24.1"
  2462. :type 'boolean)
  2463. (defcustom org-use-last-clock-out-time-as-effective-time nil
  2464. "When non-nil, use the last clock out time for `org-todo'.
  2465. Note that this option has precedence over the combined use of
  2466. `org-use-effective-time' and `org-extend-today-until'."
  2467. :group 'org-time
  2468. ;; :version "24.3"
  2469. :type 'boolean)
  2470. (defcustom org-edit-timestamp-down-means-later nil
  2471. "Non-nil means S-down will increase the time in a time stamp.
  2472. When nil, S-up will increase."
  2473. :group 'org-time
  2474. :type 'boolean)
  2475. (defcustom org-calendar-follow-timestamp-change t
  2476. "Non-nil means make the calendar window follow timestamp changes.
  2477. When a timestamp is modified and the calendar window is visible, it will be
  2478. moved to the new date."
  2479. :group 'org-time
  2480. :type 'boolean)
  2481. (defgroup org-tags nil
  2482. "Options concerning tags in Org-mode."
  2483. :tag "Org Tags"
  2484. :group 'org)
  2485. (defcustom org-tag-alist nil
  2486. "List of tags allowed in Org-mode files.
  2487. When this list is nil, Org-mode will base TAG input on what is already in the
  2488. buffer.
  2489. The value of this variable is an alist, the car of each entry must be a
  2490. keyword as a string, the cdr may be a character that is used to select
  2491. that tag through the fast-tag-selection interface.
  2492. See the manual for details."
  2493. :group 'org-tags
  2494. :type '(repeat
  2495. (choice
  2496. (cons (string :tag "Tag name")
  2497. (character :tag "Access char"))
  2498. (list :tag "Start radio group"
  2499. (const :startgroup)
  2500. (option (string :tag "Group description")))
  2501. (list :tag "End radio group"
  2502. (const :endgroup)
  2503. (option (string :tag "Group description")))
  2504. (const :tag "New line" (:newline)))))
  2505. (defcustom org-tag-persistent-alist nil
  2506. "List of tags that will always appear in all Org-mode files.
  2507. This is in addition to any in buffer settings or customizations
  2508. of `org-tag-alist'.
  2509. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  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. To disable these tags on a per-file basis, insert anywhere in the file:
  2515. #+STARTUP: noptag"
  2516. :group 'org-tags
  2517. :type '(repeat
  2518. (choice
  2519. (cons (string :tag "Tag name")
  2520. (character :tag "Access char"))
  2521. (const :tag "Start radio group" (:startgroup))
  2522. (const :tag "End radio group" (:endgroup))
  2523. (const :tag "New line" (:newline)))))
  2524. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2525. "If non-nil, always offer completion for all tags of all agenda files.
  2526. Instead of customizing this variable directly, you might want to
  2527. set it locally for capture buffers, because there no list of
  2528. tags in that file can be created dynamically (there are none).
  2529. (add-hook 'org-capture-mode-hook
  2530. (lambda ()
  2531. (set (make-local-variable
  2532. 'org-complete-tags-always-offer-all-agenda-tags)
  2533. t)))"
  2534. :group 'org-tags
  2535. :version "24.1"
  2536. :type 'boolean)
  2537. (defvar org-file-tags nil
  2538. "List of tags that can be inherited by all entries in the file.
  2539. The tags will be inherited if the variable `org-use-tag-inheritance'
  2540. says they should be.
  2541. This variable is populated from #+FILETAGS lines.")
  2542. (defcustom org-use-fast-tag-selection 'auto
  2543. "Non-nil means use fast tag selection scheme.
  2544. This is a special interface to select and deselect tags with single keys.
  2545. When nil, fast selection is never used.
  2546. When the symbol `auto', fast selection is used if and only if selection
  2547. characters for tags have been configured, either through the variable
  2548. `org-tag-alist' or through a #+TAGS line in the buffer.
  2549. When t, fast selection is always used and selection keys are assigned
  2550. automatically if necessary."
  2551. :group 'org-tags
  2552. :type '(choice
  2553. (const :tag "Always" t)
  2554. (const :tag "Never" nil)
  2555. (const :tag "When selection characters are configured" 'auto)))
  2556. (defcustom org-fast-tag-selection-single-key nil
  2557. "Non-nil means fast tag selection exits after first change.
  2558. When nil, you have to press RET to exit it.
  2559. During fast tag selection, you can toggle this flag with `C-c'.
  2560. This variable can also have the value `expert'. In this case, the window
  2561. displaying the tags menu is not even shown, until you press C-c again."
  2562. :group 'org-tags
  2563. :type '(choice
  2564. (const :tag "No" nil)
  2565. (const :tag "Yes" t)
  2566. (const :tag "Expert" expert)))
  2567. (defvar org-fast-tag-selection-include-todo nil
  2568. "Non-nil means fast tags selection interface will also offer TODO states.
  2569. This is an undocumented feature, you should not rely on it.")
  2570. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2571. "The column to which tags should be indented in a headline.
  2572. If this number is positive, it specifies the column. If it is negative,
  2573. it means that the tags should be flushright to that column. For example,
  2574. -80 works well for a normal 80 character screen.
  2575. When 0, place tags directly after headline text, with only one space in
  2576. between."
  2577. :group 'org-tags
  2578. :type 'integer)
  2579. (defcustom org-auto-align-tags t
  2580. "Non-nil keeps tags aligned when modifying headlines.
  2581. Some operations (i.e. demoting) change the length of a headline and
  2582. therefore shift the tags around. With this option turned on, after
  2583. each such operation the tags are again aligned to `org-tags-column'."
  2584. :group 'org-tags
  2585. :type 'boolean)
  2586. (defcustom org-use-tag-inheritance t
  2587. "Non-nil means tags in levels apply also for sublevels.
  2588. When nil, only the tags directly given in a specific line apply there.
  2589. This may also be a list of tags that should be inherited, or a regexp that
  2590. matches tags that should be inherited. Additional control is possible
  2591. with the variable `org-tags-exclude-from-inheritance' which gives an
  2592. explicit list of tags to be excluded from inheritance., even if the value of
  2593. `org-use-tag-inheritance' would select it for inheritance.
  2594. If this option is t, a match early-on in a tree can lead to a large
  2595. number of matches in the subtree when constructing the agenda or creating
  2596. a sparse tree. If you only want to see the first match in a tree during
  2597. a search, check out the variable `org-tags-match-list-sublevels'."
  2598. :group 'org-tags
  2599. :type '(choice
  2600. (const :tag "Not" nil)
  2601. (const :tag "Always" t)
  2602. (repeat :tag "Specific tags" (string :tag "Tag"))
  2603. (regexp :tag "Tags matched by regexp")))
  2604. (defcustom org-tags-exclude-from-inheritance nil
  2605. "List of tags that should never be inherited.
  2606. This is a way to exclude a few tags from inheritance. For way to do
  2607. the opposite, to actively allow inheritance for selected tags,
  2608. see the variable `org-use-tag-inheritance'."
  2609. :group 'org-tags
  2610. :type '(repeat (string :tag "Tag")))
  2611. (defun org-tag-inherit-p (tag)
  2612. "Check if TAG is one that should be inherited."
  2613. (cond
  2614. ((member tag org-tags-exclude-from-inheritance) nil)
  2615. ((eq org-use-tag-inheritance t) t)
  2616. ((not org-use-tag-inheritance) nil)
  2617. ((stringp org-use-tag-inheritance)
  2618. (string-match org-use-tag-inheritance tag))
  2619. ((listp org-use-tag-inheritance)
  2620. (member tag org-use-tag-inheritance))
  2621. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2622. (defcustom org-tags-match-list-sublevels t
  2623. "Non-nil means list also sublevels of headlines matching a search.
  2624. This variable applies to tags/property searches, and also to stuck
  2625. projects because this search is based on a tags match as well.
  2626. When set to the symbol `indented', sublevels are indented with
  2627. leading dots.
  2628. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2629. the sublevels of a headline matching a tag search often also match
  2630. the same search. Listing all of them can create very long lists.
  2631. Setting this variable to nil causes subtrees of a match to be skipped.
  2632. This variable is semi-obsolete and probably should always be true. It
  2633. is better to limit inheritance to certain tags using the variables
  2634. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2635. :group 'org-tags
  2636. :type '(choice
  2637. (const :tag "No, don't list them" nil)
  2638. (const :tag "Yes, do list them" t)
  2639. (const :tag "List them, indented with leading dots" indented)))
  2640. (defcustom org-tags-sort-function nil
  2641. "When set, tags are sorted using this function as a comparator."
  2642. :group 'org-tags
  2643. :type '(choice
  2644. (const :tag "No sorting" nil)
  2645. (const :tag "Alphabetical" string<)
  2646. (const :tag "Reverse alphabetical" string>)
  2647. (function :tag "Custom function" nil)))
  2648. (defvar org-tags-history nil
  2649. "History of minibuffer reads for tags.")
  2650. (defvar org-last-tags-completion-table nil
  2651. "The last used completion table for tags.")
  2652. (defvar org-after-tags-change-hook nil
  2653. "Hook that is run after the tags in a line have changed.")
  2654. (defgroup org-properties nil
  2655. "Options concerning properties in Org-mode."
  2656. :tag "Org Properties"
  2657. :group 'org)
  2658. (defcustom org-property-format "%-10s %s"
  2659. "How property key/value pairs should be formatted by `indent-line'.
  2660. When `indent-line' hits a property definition, it will format the line
  2661. according to this format, mainly to make sure that the values are
  2662. lined-up with respect to each other."
  2663. :group 'org-properties
  2664. :type 'string)
  2665. (defcustom org-properties-postprocess-alist nil
  2666. "Alist of properties and functions to adjust inserted values.
  2667. Elements of this alist must be of the form
  2668. ([string] [function])
  2669. where [string] must be a property name and [function] must be a
  2670. lambda expression: this lambda expression must take one argument,
  2671. the value to adjust, and return the new value as a string.
  2672. For example, this element will allow the property \"Remaining\"
  2673. to be updated wrt the relation between the \"Effort\" property
  2674. and the clock summary:
  2675. ((\"Remaining\" (lambda(value)
  2676. (let ((clocksum (org-clock-sum-current-item))
  2677. (effort (org-duration-string-to-minutes
  2678. (org-entry-get (point) \"Effort\"))))
  2679. (org-minutes-to-hh:mm-string (- effort clocksum))))))"
  2680. :group 'org-properties
  2681. :version "24.1"
  2682. :type '(alist :key-type (string :tag "Property")
  2683. :value-type (function :tag "Function")))
  2684. (defcustom org-use-property-inheritance nil
  2685. "Non-nil means properties apply also for sublevels.
  2686. This setting is chiefly used during property searches. Turning it on can
  2687. cause significant overhead when doing a search, which is why it is not
  2688. on by default.
  2689. When nil, only the properties directly given in the current entry count.
  2690. When t, every property is inherited. The value may also be a list of
  2691. properties that should have inheritance, or a regular expression matching
  2692. properties that should be inherited.
  2693. However, note that some special properties use inheritance under special
  2694. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2695. and the properties ending in \"_ALL\" when they are used as descriptor
  2696. for valid values of a property.
  2697. Note for programmers:
  2698. When querying an entry with `org-entry-get', you can control if inheritance
  2699. should be used. By default, `org-entry-get' looks only at the local
  2700. properties. You can request inheritance by setting the inherit argument
  2701. to t (to force inheritance) or to `selective' (to respect the setting
  2702. in this variable)."
  2703. :group 'org-properties
  2704. :type '(choice
  2705. (const :tag "Not" nil)
  2706. (const :tag "Always" t)
  2707. (repeat :tag "Specific properties" (string :tag "Property"))
  2708. (regexp :tag "Properties matched by regexp")))
  2709. (defun org-property-inherit-p (property)
  2710. "Check if PROPERTY is one that should be inherited."
  2711. (cond
  2712. ((eq org-use-property-inheritance t) t)
  2713. ((not org-use-property-inheritance) nil)
  2714. ((stringp org-use-property-inheritance)
  2715. (string-match org-use-property-inheritance property))
  2716. ((listp org-use-property-inheritance)
  2717. (member property org-use-property-inheritance))
  2718. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2719. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2720. "The default column format, if no other format has been defined.
  2721. This variable can be set on the per-file basis by inserting a line
  2722. #+COLUMNS: %25ITEM ....."
  2723. :group 'org-properties
  2724. :type 'string)
  2725. (defcustom org-columns-ellipses ".."
  2726. "The ellipses to be used when a field in column view is truncated.
  2727. When this is the empty string, as many characters as possible are shown,
  2728. but then there will be no visual indication that the field has been truncated.
  2729. When this is a string of length N, the last N characters of a truncated
  2730. field are replaced by this string. If the column is narrower than the
  2731. ellipses string, only part of the ellipses string will be shown."
  2732. :group 'org-properties
  2733. :type 'string)
  2734. (defcustom org-columns-modify-value-for-display-function nil
  2735. "Function that modifies values for display in column view.
  2736. For example, it can be used to cut out a certain part from a time stamp.
  2737. The function must take 2 arguments:
  2738. column-title The title of the column (*not* the property name)
  2739. value The value that should be modified.
  2740. The function should return the value that should be displayed,
  2741. or nil if the normal value should be used."
  2742. :group 'org-properties
  2743. :type 'function)
  2744. (defcustom org-effort-property "Effort"
  2745. "The property that is being used to keep track of effort estimates.
  2746. Effort estimates given in this property need to have the format H:MM."
  2747. :group 'org-properties
  2748. :group 'org-progress
  2749. :type '(string :tag "Property"))
  2750. (defconst org-global-properties-fixed
  2751. '(("VISIBILITY_ALL" . "folded children content all")
  2752. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2753. "List of property/value pairs that can be inherited by any entry.
  2754. These are fixed values, for the preset properties. The user variable
  2755. that can be used to add to this list is `org-global-properties'.
  2756. The entries in this list are cons cells where the car is a property
  2757. name and cdr is a string with the value. If the value represents
  2758. multiple items like an \"_ALL\" property, separate the items by
  2759. spaces.")
  2760. (defcustom org-global-properties nil
  2761. "List of property/value pairs that can be inherited by any entry.
  2762. This list will be combined with the constant `org-global-properties-fixed'.
  2763. The entries in this list are cons cells where the car is a property
  2764. name and cdr is a string with the value.
  2765. You can set buffer-local values for the same purpose in the variable
  2766. `org-file-properties' this by adding lines like
  2767. #+PROPERTY: NAME VALUE"
  2768. :group 'org-properties
  2769. :type '(repeat
  2770. (cons (string :tag "Property")
  2771. (string :tag "Value"))))
  2772. (defvar org-file-properties nil
  2773. "List of property/value pairs that can be inherited by any entry.
  2774. Valid for the current buffer.
  2775. This variable is populated from #+PROPERTY lines.")
  2776. (make-variable-buffer-local 'org-file-properties)
  2777. (defgroup org-agenda nil
  2778. "Options concerning agenda views in Org-mode."
  2779. :tag "Org Agenda"
  2780. :group 'org)
  2781. (defvar org-category nil
  2782. "Variable used by org files to set a category for agenda display.
  2783. Such files should use a file variable to set it, for example
  2784. # -*- mode: org; org-category: \"ELisp\"
  2785. or contain a special line
  2786. #+CATEGORY: ELisp
  2787. If the file does not specify a category, then file's base name
  2788. is used instead.")
  2789. (make-variable-buffer-local 'org-category)
  2790. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  2791. (defcustom org-agenda-files nil
  2792. "The files to be used for agenda display.
  2793. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2794. \\[org-remove-file]. You can also use customize to edit the list.
  2795. If an entry is a directory, all files in that directory that are matched by
  2796. `org-agenda-file-regexp' will be part of the file list.
  2797. If the value of the variable is not a list but a single file name, then
  2798. the list of agenda files is actually stored and maintained in that file, one
  2799. agenda file per line. In this file paths can be given relative to
  2800. `org-directory'. Tilde expansion and environment variable substitution
  2801. are also made."
  2802. :group 'org-agenda
  2803. :type '(choice
  2804. (repeat :tag "List of files and directories" file)
  2805. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2806. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2807. "Regular expression to match files for `org-agenda-files'.
  2808. If any element in the list in that variable contains a directory instead
  2809. of a normal file, all files in that directory that are matched by this
  2810. regular expression will be included."
  2811. :group 'org-agenda
  2812. :type 'regexp)
  2813. (defcustom org-agenda-text-search-extra-files nil
  2814. "List of extra files to be searched by text search commands.
  2815. These files will be search in addition to the agenda files by the
  2816. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2817. Note that these files will only be searched for text search commands,
  2818. not for the other agenda views like todo lists, tag searches or the weekly
  2819. agenda. This variable is intended to list notes and possibly archive files
  2820. that should also be searched by these two commands.
  2821. In fact, if the first element in the list is the symbol `agenda-archives',
  2822. than all archive files of all agenda files will be added to the search
  2823. scope."
  2824. :group 'org-agenda
  2825. :type '(set :greedy t
  2826. (const :tag "Agenda Archives" agenda-archives)
  2827. (repeat :inline t (file))))
  2828. (if (fboundp 'defvaralias)
  2829. (defvaralias 'org-agenda-multi-occur-extra-files
  2830. 'org-agenda-text-search-extra-files))
  2831. (defcustom org-agenda-skip-unavailable-files nil
  2832. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2833. A nil value means to remove them, after a query, from the list."
  2834. :group 'org-agenda
  2835. :type 'boolean)
  2836. (defcustom org-calendar-to-agenda-key [?c]
  2837. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2838. The command `org-calendar-goto-agenda' will be bound to this key. The
  2839. default is the character `c' because then `c' can be used to switch back and
  2840. forth between agenda and calendar."
  2841. :group 'org-agenda
  2842. :type 'sexp)
  2843. (defcustom org-calendar-agenda-action-key [?k]
  2844. "The key to be installed in `calendar-mode-map' for agenda-action.
  2845. The command `org-agenda-action' will be bound to this key. The
  2846. default is the character `k' because we use the same key in the agenda."
  2847. :group 'org-agenda
  2848. :type 'sexp)
  2849. (defcustom org-calendar-insert-diary-entry-key [?i]
  2850. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2851. This option is irrelevant until `org-agenda-diary-file' has been configured
  2852. to point to an Org-mode file. When that is the case, the command
  2853. `org-agenda-diary-entry' will be bound to the key given here, by default
  2854. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2855. if you want to continue doing this, you need to change this to a different
  2856. key."
  2857. :group 'org-agenda
  2858. :type 'sexp)
  2859. (defcustom org-agenda-diary-file 'diary-file
  2860. "File to which to add new entries with the `i' key in agenda and calendar.
  2861. When this is the symbol `diary-file', the functionality in the Emacs
  2862. calendar will be used to add entries to the `diary-file'. But when this
  2863. points to a file, `org-agenda-diary-entry' will be used instead."
  2864. :group 'org-agenda
  2865. :type '(choice
  2866. (const :tag "The standard Emacs diary file" diary-file)
  2867. (file :tag "Special Org file diary entries")))
  2868. (eval-after-load "calendar"
  2869. '(progn
  2870. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2871. 'org-calendar-goto-agenda)
  2872. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2873. 'org-agenda-action)
  2874. (add-hook 'calendar-mode-hook
  2875. (lambda ()
  2876. (unless (eq org-agenda-diary-file 'diary-file)
  2877. (define-key calendar-mode-map
  2878. org-calendar-insert-diary-entry-key
  2879. 'org-agenda-diary-entry))))))
  2880. (defgroup org-latex nil
  2881. "Options for embedding LaTeX code into Org-mode."
  2882. :tag "Org LaTeX"
  2883. :group 'org)
  2884. (defcustom org-format-latex-options
  2885. '(:foreground default :background default :scale 1.0
  2886. :html-foreground "Black" :html-background "Transparent"
  2887. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2888. "Options for creating images from LaTeX fragments.
  2889. This is a property list with the following properties:
  2890. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2891. `default' means use the foreground of the default face.
  2892. `auto' means use the foreground from the text face.
  2893. :background the background color, or \"Transparent\".
  2894. `default' means use the background of the default face.
  2895. `auto' means use the background from the text face.
  2896. :scale a scaling factor for the size of the images, to get more pixels
  2897. :html-foreground, :html-background, :html-scale
  2898. the same numbers for HTML export.
  2899. :matchers a list indicating which matchers should be used to
  2900. find LaTeX fragments. Valid members of this list are:
  2901. \"begin\" find environments
  2902. \"$1\" find single characters surrounded by $.$
  2903. \"$\" find math expressions surrounded by $...$
  2904. \"$$\" find math expressions surrounded by $$....$$
  2905. \"\\(\" find math expressions surrounded by \\(...\\)
  2906. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2907. :group 'org-latex
  2908. :type 'plist)
  2909. (defcustom org-format-latex-signal-error t
  2910. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2911. When nil, just push out a message."
  2912. :group 'org-latex
  2913. :version "24.1"
  2914. :type 'boolean)
  2915. (defcustom org-latex-to-mathml-jar-file nil
  2916. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  2917. Use this to specify additional executable file say a jar file.
  2918. When using MathToWeb as the converter, specify the full-path to
  2919. your mathtoweb.jar file."
  2920. :group 'org-latex
  2921. :version "24.1"
  2922. :type '(choice
  2923. (const :tag "None" nil)
  2924. (file :tag "JAR file" :must-match t)))
  2925. (defcustom org-latex-to-mathml-convert-command nil
  2926. "Command to convert LaTeX fragments to MathML.
  2927. Replace format-specifiers in the command as noted below and use
  2928. `shell-command' to convert LaTeX to MathML.
  2929. %j: Executable file in fully expanded form as specified by
  2930. `org-latex-to-mathml-jar-file'.
  2931. %I: Input LaTeX file in fully expanded form
  2932. %o: Output MathML file
  2933. This command is used by `org-create-math-formula'.
  2934. When using MathToWeb as the converter, set this to
  2935. \"java -jar %j -unicode -force -df %o %I\"."
  2936. :group 'org-latex
  2937. :version "24.1"
  2938. :type '(choice
  2939. (const :tag "None" nil)
  2940. (string :tag "\nShell command")))
  2941. (defcustom org-latex-create-formula-image-program 'dvipng
  2942. "Program to convert LaTeX fragments with.
  2943. dvipng Process the LaTeX fragments to dvi file, then convert
  2944. dvi files to png files using dvipng.
  2945. This will also include processing of non-math environments.
  2946. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  2947. to convert pdf files to png files"
  2948. :group 'org-latex
  2949. :version "24.1"
  2950. :type '(choice
  2951. (const :tag "dvipng" dvipng)
  2952. (const :tag "imagemagick" imagemagick)))
  2953. (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
  2954. "Path to store latex preview images. A relative path here creates many
  2955. directories relative to the processed org files paths. An absolute path
  2956. puts all preview images at the same place."
  2957. :group 'org-latex
  2958. ;; :version "24.3"
  2959. :type 'string)
  2960. (defun org-format-latex-mathml-available-p ()
  2961. "Return t if `org-latex-to-mathml-convert-command' is usable."
  2962. (save-match-data
  2963. (when (and (boundp 'org-latex-to-mathml-convert-command)
  2964. org-latex-to-mathml-convert-command)
  2965. (let ((executable (car (split-string
  2966. org-latex-to-mathml-convert-command))))
  2967. (when (executable-find executable)
  2968. (if (string-match
  2969. "%j" org-latex-to-mathml-convert-command)
  2970. (file-readable-p org-latex-to-mathml-jar-file)
  2971. t))))))
  2972. (defcustom org-format-latex-header "\\documentclass{article}
  2973. \\usepackage[usenames]{color}
  2974. \\usepackage{amsmath}
  2975. \\usepackage[mathscr]{eucal}
  2976. \\pagestyle{empty} % do not remove
  2977. \[PACKAGES]
  2978. \[DEFAULT-PACKAGES]
  2979. % The settings below are copied from fullpage.sty
  2980. \\setlength{\\textwidth}{\\paperwidth}
  2981. \\addtolength{\\textwidth}{-3cm}
  2982. \\setlength{\\oddsidemargin}{1.5cm}
  2983. \\addtolength{\\oddsidemargin}{-2.54cm}
  2984. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2985. \\setlength{\\textheight}{\\paperheight}
  2986. \\addtolength{\\textheight}{-\\headheight}
  2987. \\addtolength{\\textheight}{-\\headsep}
  2988. \\addtolength{\\textheight}{-\\footskip}
  2989. \\addtolength{\\textheight}{-3cm}
  2990. \\setlength{\\topmargin}{1.5cm}
  2991. \\addtolength{\\topmargin}{-2.54cm}"
  2992. "The document header used for processing LaTeX fragments.
  2993. It is imperative that this header make sure that no page number
  2994. appears on the page. The package defined in the variables
  2995. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  2996. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  2997. will be appended."
  2998. :group 'org-latex
  2999. :type 'string)
  3000. (defvar org-format-latex-header-extra nil)
  3001. (defun org-set-packages-alist (var val)
  3002. "Set the packages alist and make sure it has 3 elements per entry."
  3003. (set var (mapcar (lambda (x)
  3004. (if (and (consp x) (= (length x) 2))
  3005. (list (car x) (nth 1 x) t)
  3006. x))
  3007. val)))
  3008. (defun org-get-packages-alist (var)
  3009. "Get the packages alist and make sure it has 3 elements per entry."
  3010. (mapcar (lambda (x)
  3011. (if (and (consp x) (= (length x) 2))
  3012. (list (car x) (nth 1 x) t)
  3013. x))
  3014. (default-value var)))
  3015. ;; The following variables are defined here because is it also used
  3016. ;; when formatting latex fragments. Originally it was part of the
  3017. ;; LaTeX exporter, which is why the name includes "export".
  3018. (defcustom org-export-latex-default-packages-alist
  3019. '(("AUTO" "inputenc" t)
  3020. ("T1" "fontenc" t)
  3021. ("" "fixltx2e" nil)
  3022. ("" "graphicx" t)
  3023. ("" "longtable" nil)
  3024. ("" "float" nil)
  3025. ("" "wrapfig" nil)
  3026. ("" "soul" t)
  3027. ("" "textcomp" t)
  3028. ("" "marvosym" t)
  3029. ("" "wasysym" t)
  3030. ("" "latexsym" t)
  3031. ("" "amssymb" t)
  3032. ("" "hyperref" nil)
  3033. "\\tolerance=1000"
  3034. )
  3035. "Alist of default packages to be inserted in the header.
  3036. Change this only if one of the packages here causes an incompatibility
  3037. with another package you are using.
  3038. The packages in this list are needed by one part or another of Org-mode
  3039. to function properly.
  3040. - inputenc, fontenc: for basic font and character selection
  3041. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  3042. for interpreting the entities in `org-entities'. You can skip some of these
  3043. packages if you don't use any of the symbols in it.
  3044. - graphicx: for including images
  3045. - float, wrapfig: for figure placement
  3046. - longtable: for long tables
  3047. - hyperref: for cross references
  3048. Therefore you should not modify this variable unless you know what you
  3049. are doing. The one reason to change it anyway is that you might be loading
  3050. some other package that conflicts with one of the default packages.
  3051. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  3052. If SNIPPET-FLAG is t, the package also needs to be included when
  3053. compiling LaTeX snippets into images for inclusion into HTML."
  3054. :group 'org-export-latex
  3055. :set 'org-set-packages-alist
  3056. :get 'org-get-packages-alist
  3057. :version "24.1"
  3058. :type '(repeat
  3059. (choice
  3060. (list :tag "options/package pair"
  3061. (string :tag "options")
  3062. (string :tag "package")
  3063. (boolean :tag "Snippet"))
  3064. (string :tag "A line of LaTeX"))))
  3065. (defcustom org-export-latex-packages-alist nil
  3066. "Alist of packages to be inserted in every LaTeX header.
  3067. These will be inserted after `org-export-latex-default-packages-alist'.
  3068. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  3069. SNIPPET-FLAG, when t, indicates that this package is also needed when
  3070. turning LaTeX snippets into images for inclusion into HTML.
  3071. Make sure that you only list packages here which:
  3072. - you want in every file
  3073. - do not conflict with the default packages in
  3074. `org-export-latex-default-packages-alist'
  3075. - do not conflict with the setup in `org-format-latex-header'."
  3076. :group 'org-export-latex
  3077. :set 'org-set-packages-alist
  3078. :get 'org-get-packages-alist
  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. (defgroup org-appearance nil
  3087. "Settings for Org-mode appearance."
  3088. :tag "Org Appearance"
  3089. :group 'org)
  3090. (defcustom org-level-color-stars-only nil
  3091. "Non-nil means fontify only the stars in each headline.
  3092. When nil, the entire headline is fontified.
  3093. Changing it requires restart of `font-lock-mode' to become effective
  3094. also in regions already fontified."
  3095. :group 'org-appearance
  3096. :type 'boolean)
  3097. (defcustom org-hide-leading-stars nil
  3098. "Non-nil means hide the first N-1 stars in a headline.
  3099. This works by using the face `org-hide' for these stars. This
  3100. face is white for a light background, and black for a dark
  3101. background. You may have to customize the face `org-hide' to
  3102. make this work.
  3103. Changing it requires restart of `font-lock-mode' to become effective
  3104. also in regions already fontified.
  3105. You may also set this on a per-file basis by adding one of the following
  3106. lines to the buffer:
  3107. #+STARTUP: hidestars
  3108. #+STARTUP: showstars"
  3109. :group 'org-appearance
  3110. :type 'boolean)
  3111. (defcustom org-hidden-keywords nil
  3112. "List of symbols corresponding to keywords to be hidden the org buffer.
  3113. For example, a value '(title) for this list will make the document's title
  3114. appear in the buffer without the initial #+TITLE: keyword."
  3115. :group 'org-appearance
  3116. :version "24.1"
  3117. :type '(set (const :tag "#+AUTHOR" author)
  3118. (const :tag "#+DATE" date)
  3119. (const :tag "#+EMAIL" email)
  3120. (const :tag "#+TITLE" title)))
  3121. (defcustom org-custom-properties nil
  3122. "List of properties (as strings) with a special meaning.
  3123. The default use of these custom properties is to let the user
  3124. hide them with `org-toggle-custom-properties-visibility'."
  3125. :group 'org-properties
  3126. :group 'org-appearance
  3127. ;; :version "24.3"
  3128. :type '(repeat (string :tag "Property Name")))
  3129. (defcustom org-fontify-done-headline nil
  3130. "Non-nil means change the face of a headline if it is marked DONE.
  3131. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3132. When this is non-nil, the headline after the keyword is set to the
  3133. `org-headline-done' as an additional indication."
  3134. :group 'org-appearance
  3135. :type 'boolean)
  3136. (defcustom org-fontify-emphasized-text t
  3137. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3138. Changing this variable requires a restart of Emacs to take effect."
  3139. :group 'org-appearance
  3140. :type 'boolean)
  3141. (defcustom org-fontify-whole-heading-line nil
  3142. "Non-nil means fontify the whole line for headings.
  3143. This is useful when setting a background color for the
  3144. org-level-* faces."
  3145. :group 'org-appearance
  3146. :type 'boolean)
  3147. (defcustom org-highlight-latex-fragments-and-specials nil
  3148. "Non-nil means fontify what is treated specially by the exporters."
  3149. :group 'org-appearance
  3150. :type 'boolean)
  3151. (defcustom org-hide-emphasis-markers nil
  3152. "Non-nil mean font-lock should hide the emphasis marker characters."
  3153. :group 'org-appearance
  3154. :type 'boolean)
  3155. (defcustom org-pretty-entities nil
  3156. "Non-nil means show entities as UTF8 characters.
  3157. When nil, the \\name form remains in the buffer."
  3158. :group 'org-appearance
  3159. :version "24.1"
  3160. :type 'boolean)
  3161. (defcustom org-pretty-entities-include-sub-superscripts t
  3162. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3163. :group 'org-appearance
  3164. :version "24.1"
  3165. :type 'boolean)
  3166. (defvar org-emph-re nil
  3167. "Regular expression for matching emphasis.
  3168. After a match, the match groups contain these elements:
  3169. 0 The match of the full regular expression, including the characters
  3170. before and after the proper match
  3171. 1 The character before the proper match, or empty at beginning of line
  3172. 2 The proper match, including the leading and trailing markers
  3173. 3 The leading marker like * or /, indicating the type of highlighting
  3174. 4 The text between the emphasis markers, not including the markers
  3175. 5 The character after the match, empty at the end of a line")
  3176. (defvar org-verbatim-re nil
  3177. "Regular expression for matching verbatim text.")
  3178. (defvar org-emphasis-regexp-components) ; defined just below
  3179. (defvar org-emphasis-alist) ; defined just below
  3180. (defun org-set-emph-re (var val)
  3181. "Set variable and compute the emphasis regular expression."
  3182. (set var val)
  3183. (when (and (boundp 'org-emphasis-alist)
  3184. (boundp 'org-emphasis-regexp-components)
  3185. org-emphasis-alist org-emphasis-regexp-components)
  3186. (let* ((e org-emphasis-regexp-components)
  3187. (pre (car e))
  3188. (post (nth 1 e))
  3189. (border (nth 2 e))
  3190. (body (nth 3 e))
  3191. (nl (nth 4 e))
  3192. (body1 (concat body "*?"))
  3193. (markers (mapconcat 'car org-emphasis-alist ""))
  3194. (vmarkers (mapconcat
  3195. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  3196. org-emphasis-alist "")))
  3197. ;; make sure special characters appear at the right position in the class
  3198. (if (string-match "\\^" markers)
  3199. (setq markers (concat (replace-match "" t t markers) "^")))
  3200. (if (string-match "-" markers)
  3201. (setq markers (concat (replace-match "" t t markers) "-")))
  3202. (if (string-match "\\^" vmarkers)
  3203. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3204. (if (string-match "-" vmarkers)
  3205. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3206. (if (> nl 0)
  3207. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3208. (int-to-string nl) "\\}")))
  3209. ;; Make the regexp
  3210. (setq org-emph-re
  3211. (concat "\\([" pre "]\\|^\\)"
  3212. "\\("
  3213. "\\([" markers "]\\)"
  3214. "\\("
  3215. "[^" border "]\\|"
  3216. "[^" border "]"
  3217. body1
  3218. "[^" border "]"
  3219. "\\)"
  3220. "\\3\\)"
  3221. "\\([" post "]\\|$\\)"))
  3222. (setq org-verbatim-re
  3223. (concat "\\([" pre "]\\|^\\)"
  3224. "\\("
  3225. "\\([" vmarkers "]\\)"
  3226. "\\("
  3227. "[^" border "]\\|"
  3228. "[^" border "]"
  3229. body1
  3230. "[^" border "]"
  3231. "\\)"
  3232. "\\3\\)"
  3233. "\\([" post "]\\|$\\)")))))
  3234. (defcustom org-emphasis-regexp-components
  3235. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3236. "Components used to build the regular expression for emphasis.
  3237. This is a list with five entries. Terminology: In an emphasis string
  3238. like \" *strong word* \", we call the initial space PREMATCH, the final
  3239. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3240. and \"trong wor\" is the body. The different components in this variable
  3241. specify what is allowed/forbidden in each part:
  3242. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3243. post Chars allowed as postmatch. End of line will be allowed too.
  3244. border The chars *forbidden* as border characters.
  3245. body-regexp A regexp like \".\" to match a body character. Don't use
  3246. non-shy groups here, and don't allow newline here.
  3247. newline The maximum number of newlines allowed in an emphasis exp.
  3248. Use customize to modify this, or restart Emacs after changing it."
  3249. :group 'org-appearance
  3250. :set 'org-set-emph-re
  3251. :type '(list
  3252. (sexp :tag "Allowed chars in pre ")
  3253. (sexp :tag "Allowed chars in post ")
  3254. (sexp :tag "Forbidden chars in border ")
  3255. (sexp :tag "Regexp for body ")
  3256. (integer :tag "number of newlines allowed")
  3257. (option (boolean :tag "Please ignore this button"))))
  3258. (defcustom org-emphasis-alist
  3259. `(("*" bold "<b>" "</b>")
  3260. ("/" italic "<i>" "</i>")
  3261. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  3262. ("=" org-code "<code>" "</code>" verbatim)
  3263. ("~" org-verbatim "<code>" "</code>" verbatim)
  3264. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  3265. "<del>" "</del>")
  3266. )
  3267. "Special syntax for emphasized text.
  3268. Text starting and ending with a special character will be emphasized, for
  3269. example *bold*, _underlined_ and /italic/. This variable sets the marker
  3270. characters, the face to be used by font-lock for highlighting in Org-mode
  3271. Emacs buffers, and the HTML tags to be used for this.
  3272. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  3273. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  3274. Use customize to modify this, or restart Emacs after changing it."
  3275. :group 'org-appearance
  3276. :set 'org-set-emph-re
  3277. :type '(repeat
  3278. (list
  3279. (string :tag "Marker character")
  3280. (choice
  3281. (face :tag "Font-lock-face")
  3282. (plist :tag "Face property list"))
  3283. (string :tag "HTML start tag")
  3284. (string :tag "HTML end tag")
  3285. (option (const verbatim)))))
  3286. (defvar org-protecting-blocks
  3287. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  3288. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3289. This is needed for font-lock setup.")
  3290. ;;; Miscellaneous options
  3291. (defgroup org-completion nil
  3292. "Completion in Org-mode."
  3293. :tag "Org Completion"
  3294. :group 'org)
  3295. (defcustom org-completion-use-ido nil
  3296. "Non-nil means use ido completion wherever possible.
  3297. Note that `ido-mode' must be active for this variable to be relevant.
  3298. If you decide to turn this variable on, you might well want to turn off
  3299. `org-outline-path-complete-in-steps'.
  3300. See also `org-completion-use-iswitchb'."
  3301. :group 'org-completion
  3302. :type 'boolean)
  3303. (defcustom org-completion-use-iswitchb nil
  3304. "Non-nil means use iswitchb completion wherever possible.
  3305. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3306. If you decide to turn this variable on, you might well want to turn off
  3307. `org-outline-path-complete-in-steps'.
  3308. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3309. :group 'org-completion
  3310. :type 'boolean)
  3311. (defcustom org-completion-fallback-command 'hippie-expand
  3312. "The expansion command called by \\[pcomplete] in normal context.
  3313. Normal means, no org-mode-specific context."
  3314. :group 'org-completion
  3315. :type 'function)
  3316. ;;; Functions and variables from their packages
  3317. ;; Declared here to avoid compiler warnings
  3318. ;; XEmacs only
  3319. (defvar outline-mode-menu-heading)
  3320. (defvar outline-mode-menu-show)
  3321. (defvar outline-mode-menu-hide)
  3322. (defvar zmacs-regions) ; XEmacs regions
  3323. ;; Emacs only
  3324. (defvar mark-active)
  3325. ;; Various packages
  3326. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3327. (declare-function calendar-forward-day "cal-move" (arg))
  3328. (declare-function calendar-goto-date "cal-move" (date))
  3329. (declare-function calendar-goto-today "cal-move" ())
  3330. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3331. (defvar calc-embedded-close-formula)
  3332. (defvar calc-embedded-open-formula)
  3333. (declare-function cdlatex-tab "ext:cdlatex" ())
  3334. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3335. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3336. (defvar font-lock-unfontify-region-function)
  3337. (declare-function iswitchb-read-buffer "iswitchb"
  3338. (prompt &optional default require-match start matches-set))
  3339. (defvar iswitchb-temp-buflist)
  3340. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3341. (defvar org-agenda-tags-todo-honor-ignore-options)
  3342. (declare-function org-agenda-skip "org-agenda" ())
  3343. (declare-function
  3344. org-agenda-format-item "org-agenda"
  3345. (extra txt &optional level category tags dotime noprefix remove-re habitp))
  3346. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3347. (declare-function org-agenda-change-all-lines "org-agenda"
  3348. (newhead hdmarker &optional fixface just-this))
  3349. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3350. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3351. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3352. (beg end))
  3353. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3354. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3355. "org-agenda" (&optional end))
  3356. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3357. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3358. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3359. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3360. (declare-function org-indent-mode "org-indent" (&optional arg))
  3361. (declare-function parse-time-string "parse-time" (string))
  3362. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3363. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3364. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3365. (defvar remember-data-file)
  3366. (defvar texmathp-why)
  3367. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3368. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3369. (defvar w3m-current-url)
  3370. (defvar w3m-current-title)
  3371. (defvar org-latex-regexps)
  3372. ;;; Autoload and prepare some org modules
  3373. ;; Some table stuff that needs to be defined here, because it is used
  3374. ;; by the functions setting up org-mode or checking for table context.
  3375. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3376. "Detect an org-type or table-type table.")
  3377. (defconst org-table-line-regexp "^[ \t]*|"
  3378. "Detect an org-type table line.")
  3379. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3380. "Detect an org-type table line.")
  3381. (defconst org-table-hline-regexp "^[ \t]*|-"
  3382. "Detect an org-type table hline.")
  3383. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3384. "Detect a table-type table hline.")
  3385. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3386. "Detect the first line outside a table when searching from within it.
  3387. This works for both table types.")
  3388. ;; Autoload the functions in org-table.el that are needed by functions here.
  3389. (eval-and-compile
  3390. (org-autoload "org-table"
  3391. '(org-table-align org-table-begin org-table-blank-field
  3392. org-table-convert org-table-convert-region org-table-copy-down
  3393. org-table-copy-region org-table-create
  3394. org-table-create-or-convert-from-region
  3395. org-table-create-with-table.el org-table-current-dline
  3396. org-table-cut-region org-table-delete-column org-table-edit-field
  3397. org-table-edit-formulas org-table-end org-table-eval-formula
  3398. org-table-export org-table-field-info
  3399. org-table-get-stored-formulas org-table-goto-column
  3400. org-table-hline-and-move org-table-import org-table-insert-column
  3401. org-table-insert-hline org-table-insert-row org-table-iterate
  3402. org-table-justify-field-maybe org-table-kill-row
  3403. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  3404. org-table-move-column org-table-move-column-left
  3405. org-table-move-column-right org-table-move-row
  3406. org-table-move-row-down org-table-move-row-up
  3407. org-table-next-field org-table-next-row org-table-paste-rectangle
  3408. org-table-previous-field org-table-recalculate
  3409. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  3410. org-table-toggle-coordinate-overlays
  3411. org-table-toggle-formula-debugger org-table-wrap-region
  3412. orgtbl-mode turn-on-orgtbl org-table-to-lisp
  3413. orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
  3414. orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
  3415. (defun org-at-table-p (&optional table-type)
  3416. "Return t if the cursor is inside an org-type table.
  3417. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3418. (if org-enable-table-editor
  3419. (save-excursion
  3420. (beginning-of-line 1)
  3421. (looking-at (if table-type org-table-any-line-regexp
  3422. org-table-line-regexp)))
  3423. nil))
  3424. (defsubst org-table-p () (org-at-table-p))
  3425. (defun org-at-table.el-p ()
  3426. "Return t if and only if we are at a table.el table."
  3427. (and (org-at-table-p 'any)
  3428. (save-excursion
  3429. (goto-char (org-table-begin 'any))
  3430. (looking-at org-table1-hline-regexp))))
  3431. (defun org-table-recognize-table.el ()
  3432. "If there is a table.el table nearby, recognize it and move into it."
  3433. (if org-table-tab-recognizes-table.el
  3434. (if (org-at-table.el-p)
  3435. (progn
  3436. (beginning-of-line 1)
  3437. (if (looking-at org-table-dataline-regexp)
  3438. nil
  3439. (if (looking-at org-table1-hline-regexp)
  3440. (progn
  3441. (beginning-of-line 2)
  3442. (if (looking-at org-table-any-border-regexp)
  3443. (beginning-of-line -1)))))
  3444. (if (re-search-forward "|" (org-table-end t) t)
  3445. (progn
  3446. (require 'table)
  3447. (if (table--at-cell-p (point))
  3448. t
  3449. (message "recognizing table.el table...")
  3450. (table-recognize-table)
  3451. (message "recognizing table.el table...done")))
  3452. (error "This should not happen"))
  3453. t)
  3454. nil)
  3455. nil))
  3456. (defun org-at-table-hline-p ()
  3457. "Return t if the cursor is inside a hline in a table."
  3458. (if org-enable-table-editor
  3459. (save-excursion
  3460. (beginning-of-line 1)
  3461. (looking-at org-table-hline-regexp))
  3462. nil))
  3463. (defvar org-table-clean-did-remove-column nil)
  3464. (defun org-table-map-tables (function &optional quietly)
  3465. "Apply FUNCTION to the start of all tables in the buffer."
  3466. (save-excursion
  3467. (save-restriction
  3468. (widen)
  3469. (goto-char (point-min))
  3470. (while (re-search-forward org-table-any-line-regexp nil t)
  3471. (unless quietly
  3472. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3473. (beginning-of-line 1)
  3474. (when (and (looking-at org-table-line-regexp)
  3475. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3476. (not (org-in-block-p '("src" "example"))))
  3477. (save-excursion (funcall function))
  3478. (or (looking-at org-table-line-regexp)
  3479. (forward-char 1)))
  3480. (re-search-forward org-table-any-border-regexp nil 1))))
  3481. (unless quietly (message "Mapping tables: done")))
  3482. ;; Declare and autoload functions from org-exp.el & Co
  3483. (declare-function org-default-export-plist "org-exp")
  3484. (declare-function org-infile-export-plist "org-exp")
  3485. (declare-function org-get-current-options "org-exp")
  3486. (eval-and-compile
  3487. (org-autoload "org-exp"
  3488. '(org-export org-export-visible
  3489. org-insert-export-options-template
  3490. org-table-clean-before-export))
  3491. (org-autoload "org-ascii"
  3492. '(org-export-as-ascii org-export-ascii-preprocess
  3493. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3494. org-export-region-as-ascii))
  3495. (org-autoload "org-latex"
  3496. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3497. org-replace-region-by-latex org-export-region-as-latex
  3498. org-export-as-latex org-export-as-pdf
  3499. org-export-as-pdf-and-open))
  3500. (org-autoload "org-html"
  3501. '(org-export-as-html-and-open
  3502. org-export-as-html-batch org-export-as-html-to-buffer
  3503. org-replace-region-by-html org-export-region-as-html
  3504. org-export-as-html))
  3505. (org-autoload "org-docbook"
  3506. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3507. org-replace-region-by-docbook org-export-region-as-docbook
  3508. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3509. org-export-as-docbook))
  3510. (org-autoload "org-icalendar"
  3511. '(org-export-icalendar-this-file
  3512. org-export-icalendar-all-agenda-files
  3513. org-export-icalendar-combine-agenda-files))
  3514. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3515. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3516. ;; Declare and autoload functions from org-agenda.el
  3517. (eval-and-compile
  3518. (org-autoload "org-agenda"
  3519. '(org-agenda org-agenda-list org-search-view
  3520. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3521. org-diary org-agenda-to-appt
  3522. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3523. ;; Autoload org-remember
  3524. (eval-and-compile
  3525. (org-autoload "org-remember"
  3526. '(org-remember-insinuate org-remember-annotation
  3527. org-remember-apply-template org-remember org-remember-handler)))
  3528. (eval-and-compile
  3529. (org-autoload "org-capture"
  3530. '(org-capture org-capture-insert-template-here
  3531. org-capture-import-remember-templates)))
  3532. ;; Autoload org-clock.el
  3533. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3534. (beg end))
  3535. (declare-function org-clock-update-mode-line "org-clock" ())
  3536. (declare-function org-resolve-clocks "org-clock"
  3537. (&optional also-non-dangling-p prompt last-valid))
  3538. (defvar org-clock-start-time)
  3539. (defvar org-clock-marker (make-marker)
  3540. "Marker recording the last clock-in.")
  3541. (defvar org-clock-hd-marker (make-marker)
  3542. "Marker recording the last clock-in, but the headline position.")
  3543. (defvar org-clock-heading ""
  3544. "The heading of the current clock entry.")
  3545. (defun org-clock-is-active ()
  3546. "Return non-nil if clock is currently running.
  3547. The return value is actually the clock marker."
  3548. (marker-buffer org-clock-marker))
  3549. (eval-and-compile
  3550. (org-autoload
  3551. "org-clock"
  3552. '(org-clock-in org-clock-out org-clock-cancel
  3553. org-clock-goto org-clock-sum org-clock-display
  3554. org-clock-remove-overlays org-clock-report
  3555. org-clocktable-shift org-dblock-write:clocktable
  3556. org-get-clocktable org-resolve-clocks)))
  3557. (defun org-clock-update-time-maybe ()
  3558. "If this is a CLOCK line, update it and return t.
  3559. Otherwise, return nil."
  3560. (interactive)
  3561. (save-excursion
  3562. (beginning-of-line 1)
  3563. (skip-chars-forward " \t")
  3564. (when (looking-at org-clock-string)
  3565. (let ((re (concat "[ \t]*" org-clock-string
  3566. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3567. "\\([ \t]*=>.*\\)?\\)?"))
  3568. ts te h m s neg)
  3569. (cond
  3570. ((not (looking-at re))
  3571. nil)
  3572. ((not (match-end 2))
  3573. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3574. (> org-clock-marker (point))
  3575. (<= org-clock-marker (point-at-eol)))
  3576. ;; The clock is running here
  3577. (setq org-clock-start-time
  3578. (apply 'encode-time
  3579. (org-parse-time-string (match-string 1))))
  3580. (org-clock-update-mode-line)))
  3581. (t
  3582. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3583. (end-of-line 1)
  3584. (setq ts (match-string 1)
  3585. te (match-string 3))
  3586. (setq s (- (org-float-time
  3587. (apply 'encode-time (org-parse-time-string te)))
  3588. (org-float-time
  3589. (apply 'encode-time (org-parse-time-string ts))))
  3590. neg (< s 0)
  3591. s (abs s)
  3592. h (floor (/ s 3600))
  3593. s (- s (* 3600 h))
  3594. m (floor (/ s 60))
  3595. s (- s (* 60 s)))
  3596. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3597. t))))))
  3598. (defun org-check-running-clock ()
  3599. "Check if the current buffer contains the running clock.
  3600. If yes, offer to stop it and to save the buffer with the changes."
  3601. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3602. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3603. (buffer-name))))
  3604. (org-clock-out)
  3605. (when (y-or-n-p "Save changed buffer?")
  3606. (save-buffer))))
  3607. (defun org-clocktable-try-shift (dir n)
  3608. "Check if this line starts a clock table, if yes, shift the time block."
  3609. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3610. (org-clocktable-shift dir n)))
  3611. ;; Autoload org-timer.el
  3612. (eval-and-compile
  3613. (org-autoload
  3614. "org-timer"
  3615. '(org-timer-start org-timer org-timer-item
  3616. org-timer-change-times-in-region
  3617. org-timer-set-timer
  3618. org-timer-reset-timers
  3619. org-timer-show-remaining-time)))
  3620. ;; Autoload org-feed.el
  3621. (eval-and-compile
  3622. (org-autoload
  3623. "org-feed"
  3624. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3625. ;; Autoload org-indent.el
  3626. ;; Define the variable already here, to make sure we have it.
  3627. (defvar org-indent-mode nil
  3628. "Non-nil if Org-Indent mode is enabled.
  3629. Use the command `org-indent-mode' to change this variable.")
  3630. (eval-and-compile
  3631. (org-autoload
  3632. "org-indent"
  3633. '(org-indent-mode)))
  3634. ;; Autoload org-mobile.el
  3635. (eval-and-compile
  3636. (org-autoload
  3637. "org-mobile"
  3638. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3639. ;; Autoload archiving code
  3640. ;; The stuff that is needed for cycling and tags has to be defined here.
  3641. (defgroup org-archive nil
  3642. "Options concerning archiving in Org-mode."
  3643. :tag "Org Archive"
  3644. :group 'org-structure)
  3645. (defcustom org-archive-location "%s_archive::"
  3646. "The location where subtrees should be archived.
  3647. The value of this variable is a string, consisting of two parts,
  3648. separated by a double-colon. The first part is a filename and
  3649. the second part is a headline.
  3650. When the filename is omitted, archiving happens in the same file.
  3651. %s in the filename will be replaced by the current file
  3652. name (without the directory part). Archiving to a different file
  3653. is useful to keep archived entries from contributing to the
  3654. Org-mode Agenda.
  3655. The archived entries will be filed as subtrees of the specified
  3656. headline. When the headline is omitted, the subtrees are simply
  3657. filed away at the end of the file, as top-level entries. Also in
  3658. the heading you can use %s to represent the file name, this can be
  3659. useful when using the same archive for a number of different files.
  3660. Here are a few examples:
  3661. \"%s_archive::\"
  3662. If the current file is Projects.org, archive in file
  3663. Projects.org_archive, as top-level trees. This is the default.
  3664. \"::* Archived Tasks\"
  3665. Archive in the current file, under the top-level headline
  3666. \"* Archived Tasks\".
  3667. \"~/org/archive.org::\"
  3668. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3669. \"~/org/archive.org::* From %s\"
  3670. Archive in file ~/org/archive.org (absolute path), under headlines
  3671. \"From FILENAME\" where file name is the current file name.
  3672. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3673. The \"datetree/\" string is special, signifying to archive
  3674. items to the datetree. Items are placed in either the CLOSED
  3675. date of the item, or the current date if there is no CLOSED date.
  3676. The heading will be a subentry to the current date. There doesn't
  3677. need to be a heading, but there always needs to be a slash after
  3678. datetree. For example, to store archived items directly in the
  3679. datetree, use \"~/org/datetree.org::datetree/\".
  3680. \"basement::** Finished Tasks\"
  3681. Archive in file ./basement (relative path), as level 3 trees
  3682. below the level 2 heading \"** Finished Tasks\".
  3683. You may set this option on a per-file basis by adding to the buffer a
  3684. line like
  3685. #+ARCHIVE: basement::** Finished Tasks
  3686. You may also define it locally for a subtree by setting an ARCHIVE property
  3687. in the entry. If such a property is found in an entry, or anywhere up
  3688. the hierarchy, it will be used."
  3689. :group 'org-archive
  3690. :type 'string)
  3691. (defcustom org-archive-tag "ARCHIVE"
  3692. "The tag that marks a subtree as archived.
  3693. An archived subtree does not open during visibility cycling, and does
  3694. not contribute to the agenda listings.
  3695. After changing this, font-lock must be restarted in the relevant buffers to
  3696. get the proper fontification."
  3697. :group 'org-archive
  3698. :group 'org-keywords
  3699. :type 'string)
  3700. (defcustom org-agenda-skip-archived-trees t
  3701. "Non-nil means the agenda will skip any items located in archived trees.
  3702. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3703. variable is no longer recommended, you should leave it at the value t.
  3704. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3705. :group 'org-archive
  3706. :group 'org-agenda-skip
  3707. :type 'boolean)
  3708. (defcustom org-columns-skip-archived-trees t
  3709. "Non-nil means ignore archived trees when creating column view."
  3710. :group 'org-archive
  3711. :group 'org-properties
  3712. :type 'boolean)
  3713. (defcustom org-cycle-open-archived-trees nil
  3714. "Non-nil means `org-cycle' will open archived trees.
  3715. An archived tree is a tree marked with the tag ARCHIVE.
  3716. When nil, archived trees will stay folded. You can still open them with
  3717. normal outline commands like `show-all', but not with the cycling commands."
  3718. :group 'org-archive
  3719. :group 'org-cycle
  3720. :type 'boolean)
  3721. (defcustom org-sparse-tree-open-archived-trees nil
  3722. "Non-nil means sparse tree construction shows matches in archived trees.
  3723. When nil, matches in these trees are highlighted, but the trees are kept in
  3724. collapsed state."
  3725. :group 'org-archive
  3726. :group 'org-sparse-trees
  3727. :type 'boolean)
  3728. (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
  3729. "The default date type when building a sparse tree.
  3730. When this is nil, a date is a scheduled or a deadline timestamp.
  3731. Otherwise, these types are allowed:
  3732. all: all timestamps
  3733. active: only active timestamps (<...>)
  3734. inactive: only inactive timestamps (<...)
  3735. scheduled: only scheduled timestamps
  3736. deadline: only deadline timestamps"
  3737. :type '(choice (const :tag "Scheduled or deadline" 'scheduled-or-deadline)
  3738. (const :tag "All timestamps" all)
  3739. (const :tag "Only active timestamps" active)
  3740. (const :tag "Only inactive timestamps" inactive)
  3741. (const :tag "Only scheduled timestamps" scheduled)
  3742. (const :tag "Only deadline timestamps" deadline))
  3743. ;; :version "24.3"
  3744. :group 'org-sparse-trees)
  3745. (defun org-cycle-hide-archived-subtrees (state)
  3746. "Re-hide all archived subtrees after a visibility state change."
  3747. (when (and (not org-cycle-open-archived-trees)
  3748. (not (memq state '(overview folded))))
  3749. (save-excursion
  3750. (let* ((globalp (memq state '(contents all)))
  3751. (beg (if globalp (point-min) (point)))
  3752. (end (if globalp (point-max) (org-end-of-subtree t))))
  3753. (org-hide-archived-subtrees beg end)
  3754. (goto-char beg)
  3755. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3756. (message "%s" (substitute-command-keys
  3757. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3758. (defun org-force-cycle-archived ()
  3759. "Cycle subtree even if it is archived."
  3760. (interactive)
  3761. (setq this-command 'org-cycle)
  3762. (let ((org-cycle-open-archived-trees t))
  3763. (call-interactively 'org-cycle)))
  3764. (defun org-hide-archived-subtrees (beg end)
  3765. "Re-hide all archived subtrees after a visibility state change."
  3766. (save-excursion
  3767. (let* ((re (concat ":" org-archive-tag ":")))
  3768. (goto-char beg)
  3769. (while (re-search-forward re end t)
  3770. (when (org-at-heading-p)
  3771. (org-flag-subtree t)
  3772. (org-end-of-subtree t))))))
  3773. (declare-function outline-end-of-heading "outline" ())
  3774. (declare-function outline-flag-region "outline" (from to flag))
  3775. (defun org-flag-subtree (flag)
  3776. (save-excursion
  3777. (org-back-to-heading t)
  3778. (outline-end-of-heading)
  3779. (outline-flag-region (point)
  3780. (progn (org-end-of-subtree t) (point))
  3781. flag)))
  3782. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3783. (eval-and-compile
  3784. (org-autoload "org-archive"
  3785. '(org-add-archive-files org-archive-subtree
  3786. org-archive-to-archive-sibling org-toggle-archive-tag
  3787. org-archive-subtree-default
  3788. org-archive-subtree-default-with-confirmation)))
  3789. ;; Autoload Column View Code
  3790. (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
  3791. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  3792. (declare-function org-columns-compute "org-colview" (property))
  3793. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3794. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3795. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3796. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3797. ;; Autoload ID code
  3798. (declare-function org-id-store-link "org-id")
  3799. (declare-function org-id-locations-load "org-id")
  3800. (declare-function org-id-locations-save "org-id")
  3801. (defvar org-id-track-globally)
  3802. (org-autoload "org-id"
  3803. '(org-id-get-create org-id-new org-id-copy org-id-get
  3804. org-id-get-with-outline-path-completion
  3805. org-id-get-with-outline-drilling org-id-store-link
  3806. org-id-goto org-id-find org-id-store-link))
  3807. ;; Autoload Plotting Code
  3808. (org-autoload "org-plot"
  3809. '(org-plot/gnuplot))
  3810. ;;; Variables for pre-computed regular expressions, all buffer local
  3811. (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
  3812. "Matches first line of a hidden block.")
  3813. (make-variable-buffer-local 'org-drawer-regexp)
  3814. (defvar org-todo-regexp nil
  3815. "Matches any of the TODO state keywords.")
  3816. (make-variable-buffer-local 'org-todo-regexp)
  3817. (defvar org-not-done-regexp nil
  3818. "Matches any of the TODO state keywords except the last one.")
  3819. (make-variable-buffer-local 'org-not-done-regexp)
  3820. (defvar org-not-done-heading-regexp nil
  3821. "Matches a TODO headline that is not done.")
  3822. (make-variable-buffer-local 'org-not-done-regexp)
  3823. (defvar org-todo-line-regexp nil
  3824. "Matches a headline and puts TODO state into group 2 if present.")
  3825. (make-variable-buffer-local 'org-todo-line-regexp)
  3826. (defvar org-complex-heading-regexp nil
  3827. "Matches a headline and puts everything into groups:
  3828. group 1: the stars
  3829. group 2: The todo keyword, maybe
  3830. group 3: Priority cookie
  3831. group 4: True headline
  3832. group 5: Tags")
  3833. (make-variable-buffer-local 'org-complex-heading-regexp)
  3834. (defvar org-complex-heading-regexp-format nil
  3835. "Printf format to make regexp to match an exact headline.
  3836. This regexp will match the headline of any node which has the
  3837. exact headline text that is put into the format, but may have any
  3838. TODO state, priority and tags.")
  3839. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3840. (defvar org-todo-line-tags-regexp nil
  3841. "Matches a headline and puts TODO state into group 2 if present.
  3842. Also put tags into group 4 if tags are present.")
  3843. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3844. (defvar org-ds-keyword-length 12
  3845. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  3846. (make-variable-buffer-local 'org-ds-keyword-length)
  3847. (defvar org-deadline-regexp nil
  3848. "Matches the DEADLINE keyword.")
  3849. (make-variable-buffer-local 'org-deadline-regexp)
  3850. (defvar org-deadline-time-regexp nil
  3851. "Matches the DEADLINE keyword together with a time stamp.")
  3852. (make-variable-buffer-local 'org-deadline-time-regexp)
  3853. (defvar org-deadline-line-regexp nil
  3854. "Matches the DEADLINE keyword and the rest of the line.")
  3855. (make-variable-buffer-local 'org-deadline-line-regexp)
  3856. (defvar org-scheduled-regexp nil
  3857. "Matches the SCHEDULED keyword.")
  3858. (make-variable-buffer-local 'org-scheduled-regexp)
  3859. (defvar org-scheduled-time-regexp nil
  3860. "Matches the SCHEDULED keyword together with a time stamp.")
  3861. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3862. (defvar org-closed-time-regexp nil
  3863. "Matches the CLOSED keyword together with a time stamp.")
  3864. (make-variable-buffer-local 'org-closed-time-regexp)
  3865. (defvar org-keyword-time-regexp nil
  3866. "Matches any of the 4 keywords, together with the time stamp.")
  3867. (make-variable-buffer-local 'org-keyword-time-regexp)
  3868. (defvar org-keyword-time-not-clock-regexp nil
  3869. "Matches any of the 3 keywords, together with the time stamp.")
  3870. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3871. (defvar org-maybe-keyword-time-regexp nil
  3872. "Matches a timestamp, possibly preceded by a keyword.")
  3873. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3874. (defvar org-all-time-keywords nil
  3875. "List of time keywords.")
  3876. (make-variable-buffer-local 'org-all-time-keywords)
  3877. (defconst org-plain-time-of-day-regexp
  3878. (concat
  3879. "\\(\\<[012]?[0-9]"
  3880. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3881. "\\(--?"
  3882. "\\(\\<[012]?[0-9]"
  3883. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3884. "\\)?")
  3885. "Regular expression to match a plain time or time range.
  3886. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3887. groups carry important information:
  3888. 0 the full match
  3889. 1 the first time, range or not
  3890. 8 the second time, if it is a range.")
  3891. (defconst org-plain-time-extension-regexp
  3892. (concat
  3893. "\\(\\<[012]?[0-9]"
  3894. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3895. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3896. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3897. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3898. groups carry important information:
  3899. 0 the full match
  3900. 7 hours of duration
  3901. 9 minutes of duration")
  3902. (defconst org-stamp-time-of-day-regexp
  3903. (concat
  3904. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3905. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3906. "\\(--?"
  3907. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3908. "Regular expression to match a timestamp time or time range.
  3909. After a match, the following groups carry important information:
  3910. 0 the full match
  3911. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3912. 2 the first time, range or not
  3913. 4 the second time, if it is a range.")
  3914. (defconst org-startup-options
  3915. '(("fold" org-startup-folded t)
  3916. ("overview" org-startup-folded t)
  3917. ("nofold" org-startup-folded nil)
  3918. ("showall" org-startup-folded nil)
  3919. ("showeverything" org-startup-folded showeverything)
  3920. ("content" org-startup-folded content)
  3921. ("indent" org-startup-indented t)
  3922. ("noindent" org-startup-indented nil)
  3923. ("hidestars" org-hide-leading-stars t)
  3924. ("showstars" org-hide-leading-stars nil)
  3925. ("odd" org-odd-levels-only t)
  3926. ("oddeven" org-odd-levels-only nil)
  3927. ("align" org-startup-align-all-tables t)
  3928. ("noalign" org-startup-align-all-tables nil)
  3929. ("inlineimages" org-startup-with-inline-images t)
  3930. ("noinlineimages" org-startup-with-inline-images nil)
  3931. ("customtime" org-display-custom-times t)
  3932. ("logdone" org-log-done time)
  3933. ("lognotedone" org-log-done note)
  3934. ("nologdone" org-log-done nil)
  3935. ("lognoteclock-out" org-log-note-clock-out t)
  3936. ("nolognoteclock-out" org-log-note-clock-out nil)
  3937. ("logrepeat" org-log-repeat state)
  3938. ("lognoterepeat" org-log-repeat note)
  3939. ("nologrepeat" org-log-repeat nil)
  3940. ("logreschedule" org-log-reschedule time)
  3941. ("lognotereschedule" org-log-reschedule note)
  3942. ("nologreschedule" org-log-reschedule nil)
  3943. ("logredeadline" org-log-redeadline time)
  3944. ("lognoteredeadline" org-log-redeadline note)
  3945. ("nologredeadline" org-log-redeadline nil)
  3946. ("logrefile" org-log-refile time)
  3947. ("lognoterefile" org-log-refile note)
  3948. ("nologrefile" org-log-refile nil)
  3949. ("fninline" org-footnote-define-inline t)
  3950. ("nofninline" org-footnote-define-inline nil)
  3951. ("fnlocal" org-footnote-section nil)
  3952. ("fnauto" org-footnote-auto-label t)
  3953. ("fnprompt" org-footnote-auto-label nil)
  3954. ("fnconfirm" org-footnote-auto-label confirm)
  3955. ("fnplain" org-footnote-auto-label plain)
  3956. ("fnadjust" org-footnote-auto-adjust t)
  3957. ("nofnadjust" org-footnote-auto-adjust nil)
  3958. ("constcgs" constants-unit-system cgs)
  3959. ("constSI" constants-unit-system SI)
  3960. ("noptag" org-tag-persistent-alist nil)
  3961. ("hideblocks" org-hide-block-startup t)
  3962. ("nohideblocks" org-hide-block-startup nil)
  3963. ("beamer" org-startup-with-beamer-mode t)
  3964. ("entitiespretty" org-pretty-entities t)
  3965. ("entitiesplain" org-pretty-entities nil))
  3966. "Variable associated with STARTUP options for org-mode.
  3967. Each element is a list of three items: the startup options (as written
  3968. in the #+STARTUP line), the corresponding variable, and the value to set
  3969. this variable to if the option is found. An optional forth element PUSH
  3970. means to push this value onto the list in the variable.")
  3971. (defun org-update-property-plist (key val props)
  3972. "Update PROPS with KEY and VAL."
  3973. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  3974. (key (if appending (substring key 0 (- (length key) 1)) key))
  3975. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  3976. (previous (cdr (assoc key props))))
  3977. (if appending
  3978. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  3979. (cons (cons key val) remainder))))
  3980. (defconst org-block-regexp
  3981. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  3982. "Regular expression for hiding blocks.")
  3983. (defconst org-heading-keyword-regexp-format
  3984. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  3985. "Printf format for a regexp matching an headline with some keyword.
  3986. This regexp will match the headline of any node which has the
  3987. exact keyword that is put into the format. The keyword isn't in
  3988. any group by default, but the stars and the body are.")
  3989. (defconst org-heading-keyword-maybe-regexp-format
  3990. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  3991. "Printf format for a regexp matching an headline, possibly with some keyword.
  3992. This regexp can match any headline with the specified keyword, or
  3993. without a keyword. The keyword isn't in any group by default,
  3994. but the stars and the body are.")
  3995. (defun org-set-regexps-and-options ()
  3996. "Precompute regular expressions for current buffer."
  3997. (when (derived-mode-p 'org-mode)
  3998. (org-set-local 'org-todo-kwd-alist nil)
  3999. (org-set-local 'org-todo-key-alist nil)
  4000. (org-set-local 'org-todo-key-trigger nil)
  4001. (org-set-local 'org-todo-keywords-1 nil)
  4002. (org-set-local 'org-done-keywords nil)
  4003. (org-set-local 'org-todo-heads nil)
  4004. (org-set-local 'org-todo-sets nil)
  4005. (org-set-local 'org-todo-log-states nil)
  4006. (org-set-local 'org-file-properties nil)
  4007. (org-set-local 'org-file-tags nil)
  4008. (let ((re (org-make-options-regexp
  4009. '("CATEGORY" "TODO" "COLUMNS"
  4010. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  4011. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  4012. "OPTIONS")
  4013. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  4014. (splitre "[ \t]+")
  4015. (scripts org-use-sub-superscripts)
  4016. kwds kws0 kwsa key log value cat arch tags const links hw dws
  4017. tail sep kws1 prio props ftags drawers beamer-p
  4018. ext-setup-or-nil setup-contents (start 0))
  4019. (save-excursion
  4020. (save-restriction
  4021. (widen)
  4022. (goto-char (point-min))
  4023. (while (or (and ext-setup-or-nil
  4024. (string-match re ext-setup-or-nil start)
  4025. (setq start (match-end 0)))
  4026. (and (setq ext-setup-or-nil nil start 0)
  4027. (re-search-forward re nil t)))
  4028. (setq key (upcase (match-string 1 ext-setup-or-nil))
  4029. value (org-match-string-no-properties 2 ext-setup-or-nil))
  4030. (if (stringp value) (setq value (org-trim value)))
  4031. (cond
  4032. ((equal key "CATEGORY")
  4033. (setq cat value))
  4034. ((member key '("SEQ_TODO" "TODO"))
  4035. (push (cons 'sequence (org-split-string value splitre)) kwds))
  4036. ((equal key "TYP_TODO")
  4037. (push (cons 'type (org-split-string value splitre)) kwds))
  4038. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  4039. ;; general TODO-like setup
  4040. (push (cons (intern (downcase (match-string 1 key)))
  4041. (org-split-string value splitre)) kwds))
  4042. ((equal key "TAGS")
  4043. (setq tags (append tags (if tags '("\\n") nil)
  4044. (org-split-string value splitre))))
  4045. ((equal key "COLUMNS")
  4046. (org-set-local 'org-columns-default-format value))
  4047. ((equal key "LINK")
  4048. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4049. (push (cons (match-string 1 value)
  4050. (org-trim (match-string 2 value)))
  4051. links)))
  4052. ((equal key "PRIORITIES")
  4053. (setq prio (org-split-string value " +")))
  4054. ((equal key "PROPERTY")
  4055. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4056. (setq props (org-update-property-plist (match-string 1 value)
  4057. (match-string 2 value)
  4058. props))))
  4059. ((equal key "FILETAGS")
  4060. (when (string-match "\\S-" value)
  4061. (setq ftags
  4062. (append
  4063. ftags
  4064. (apply 'append
  4065. (mapcar (lambda (x) (org-split-string x ":"))
  4066. (org-split-string value)))))))
  4067. ((equal key "DRAWERS")
  4068. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  4069. ((equal key "CONSTANTS")
  4070. (setq const (append const (org-split-string value splitre))))
  4071. ((equal key "STARTUP")
  4072. (let ((opts (org-split-string value splitre))
  4073. l var val)
  4074. (while (setq l (pop opts))
  4075. (when (setq l (assoc l org-startup-options))
  4076. (setq var (nth 1 l) val (nth 2 l))
  4077. (if (not (nth 3 l))
  4078. (set (make-local-variable var) val)
  4079. (if (not (listp (symbol-value var)))
  4080. (set (make-local-variable var) nil))
  4081. (set (make-local-variable var) (symbol-value var))
  4082. (add-to-list var val))))))
  4083. ((equal key "ARCHIVE")
  4084. (setq arch value)
  4085. (remove-text-properties 0 (length arch)
  4086. '(face t fontified t) arch))
  4087. ((equal key "LATEX_CLASS")
  4088. (setq beamer-p (equal value "beamer")))
  4089. ((equal key "OPTIONS")
  4090. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  4091. (setq scripts (read (match-string 2 value)))))
  4092. ((equal key "SETUPFILE")
  4093. (setq setup-contents (org-file-contents
  4094. (expand-file-name
  4095. (org-remove-double-quotes value))
  4096. 'noerror))
  4097. (if (not ext-setup-or-nil)
  4098. (setq ext-setup-or-nil setup-contents start 0)
  4099. (setq ext-setup-or-nil
  4100. (concat (substring ext-setup-or-nil 0 start)
  4101. "\n" setup-contents "\n"
  4102. (substring ext-setup-or-nil start)))))))
  4103. ;; search for property blocks
  4104. (goto-char (point-min))
  4105. (while (re-search-forward org-block-regexp nil t)
  4106. (when (equal "PROPERTY" (upcase (match-string 1)))
  4107. (setq value (replace-regexp-in-string
  4108. "[\n\r]" " " (match-string 4)))
  4109. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4110. (setq props (org-update-property-plist (match-string 1 value)
  4111. (match-string 2 value)
  4112. props)))))))
  4113. (org-set-local 'org-use-sub-superscripts scripts)
  4114. (when cat
  4115. (org-set-local 'org-category (intern cat))
  4116. (push (cons "CATEGORY" cat) props))
  4117. (when prio
  4118. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  4119. (setq prio (mapcar 'string-to-char prio))
  4120. (org-set-local 'org-highest-priority (nth 0 prio))
  4121. (org-set-local 'org-lowest-priority (nth 1 prio))
  4122. (org-set-local 'org-default-priority (nth 2 prio)))
  4123. (and props (org-set-local 'org-file-properties (nreverse props)))
  4124. (and ftags (org-set-local 'org-file-tags
  4125. (mapcar 'org-add-prop-inherited ftags)))
  4126. (and drawers (org-set-local 'org-drawers drawers))
  4127. (and arch (org-set-local 'org-archive-location arch))
  4128. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4129. ;; Process the TODO keywords
  4130. (unless kwds
  4131. ;; Use the global values as if they had been given locally.
  4132. (setq kwds (default-value 'org-todo-keywords))
  4133. (if (stringp (car kwds))
  4134. (setq kwds (list (cons org-todo-interpretation
  4135. (default-value 'org-todo-keywords)))))
  4136. (setq kwds (reverse kwds)))
  4137. (setq kwds (nreverse kwds))
  4138. (let (inter kws kw)
  4139. (while (setq kws (pop kwds))
  4140. (let ((kws (or
  4141. (run-hook-with-args-until-success
  4142. 'org-todo-setup-filter-hook kws)
  4143. kws)))
  4144. (setq inter (pop kws) sep (member "|" kws)
  4145. kws0 (delete "|" (copy-sequence kws))
  4146. kwsa nil
  4147. kws1 (mapcar
  4148. (lambda (x)
  4149. ;; 1 2
  4150. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4151. (progn
  4152. (setq kw (match-string 1 x)
  4153. key (and (match-end 2) (match-string 2 x))
  4154. log (org-extract-log-state-settings x))
  4155. (push (cons kw (and key (string-to-char key))) kwsa)
  4156. (and log (push log org-todo-log-states))
  4157. kw)
  4158. (error "Invalid TODO keyword %s" x)))
  4159. kws0)
  4160. kwsa (if kwsa (append '((:startgroup))
  4161. (nreverse kwsa)
  4162. '((:endgroup))))
  4163. hw (car kws1)
  4164. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4165. tail (list inter hw (car dws) (org-last dws))))
  4166. (add-to-list 'org-todo-heads hw 'append)
  4167. (push kws1 org-todo-sets)
  4168. (setq org-done-keywords (append org-done-keywords dws nil))
  4169. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4170. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4171. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4172. (setq org-todo-sets (nreverse org-todo-sets)
  4173. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4174. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4175. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4176. ;; Process the constants
  4177. (when const
  4178. (let (e cst)
  4179. (while (setq e (pop const))
  4180. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  4181. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  4182. (setq org-table-formula-constants-local cst)))
  4183. ;; Process the tags.
  4184. (when tags
  4185. (let (e tgs)
  4186. (while (setq e (pop tags))
  4187. (cond
  4188. ((equal e "{") (push '(:startgroup) tgs))
  4189. ((equal e "}") (push '(:endgroup) tgs))
  4190. ((equal e "\\n") (push '(:newline) tgs))
  4191. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4192. (push (cons (match-string 1 e)
  4193. (string-to-char (match-string 2 e)))
  4194. tgs))
  4195. (t (push (list e) tgs))))
  4196. (org-set-local 'org-tag-alist nil)
  4197. (while (setq e (pop tgs))
  4198. (or (and (stringp (car e))
  4199. (assoc (car e) org-tag-alist))
  4200. (push e org-tag-alist)))))
  4201. ;; Compute the regular expressions and other local variables.
  4202. ;; Using `org-outline-regexp-bol' would complicate them much,
  4203. ;; because of the fixed white space at the end of that string.
  4204. (if (not org-done-keywords)
  4205. (setq org-done-keywords (and org-todo-keywords-1
  4206. (list (org-last org-todo-keywords-1)))))
  4207. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4208. (length org-scheduled-string)
  4209. (length org-clock-string)
  4210. (length org-closed-string)))
  4211. org-drawer-regexp
  4212. (concat "^[ \t]*:\\("
  4213. (mapconcat 'regexp-quote org-drawers "\\|")
  4214. "\\):[ \t]*$")
  4215. org-not-done-keywords
  4216. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4217. org-todo-regexp
  4218. (concat "\\("
  4219. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4220. "\\)")
  4221. org-not-done-regexp
  4222. (concat "\\("
  4223. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4224. "\\)")
  4225. org-not-done-heading-regexp
  4226. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4227. org-todo-line-regexp
  4228. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4229. org-complex-heading-regexp
  4230. (concat "^\\(\\*+\\)"
  4231. "\\(?: +" org-todo-regexp "\\)?"
  4232. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4233. "\\(?: +\\(.*?\\)\\)??"
  4234. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4235. "[ \t]*$")
  4236. org-complex-heading-regexp-format
  4237. (concat "^\\(\\*+\\)"
  4238. "\\(?: +" org-todo-regexp "\\)?"
  4239. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4240. "\\(?: +"
  4241. ;; Stats cookies can be stuck to body.
  4242. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4243. "\\(%s\\)"
  4244. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4245. "\\)"
  4246. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4247. "[ \t]*$")
  4248. org-todo-line-tags-regexp
  4249. (concat "^\\(\\*+\\)"
  4250. "\\(?: +" org-todo-regexp "\\)?"
  4251. "\\(?: +\\(.*?\\)\\)??"
  4252. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4253. "[ \t]*$")
  4254. org-deadline-regexp (concat "\\<" org-deadline-string)
  4255. org-deadline-time-regexp
  4256. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4257. org-deadline-line-regexp
  4258. (concat "\\<\\(" org-deadline-string "\\).*")
  4259. org-scheduled-regexp
  4260. (concat "\\<" org-scheduled-string)
  4261. org-scheduled-time-regexp
  4262. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4263. org-closed-time-regexp
  4264. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4265. org-keyword-time-regexp
  4266. (concat "\\<\\(" org-scheduled-string
  4267. "\\|" org-deadline-string
  4268. "\\|" org-closed-string
  4269. "\\|" org-clock-string "\\)"
  4270. " *[[<]\\([^]>]+\\)[]>]")
  4271. org-keyword-time-not-clock-regexp
  4272. (concat "\\<\\(" org-scheduled-string
  4273. "\\|" org-deadline-string
  4274. "\\|" org-closed-string
  4275. "\\)"
  4276. " *[[<]\\([^]>]+\\)[]>]")
  4277. org-maybe-keyword-time-regexp
  4278. (concat "\\(\\<\\(" org-scheduled-string
  4279. "\\|" org-deadline-string
  4280. "\\|" org-closed-string
  4281. "\\|" org-clock-string "\\)\\)?"
  4282. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4283. org-all-time-keywords
  4284. (mapcar (lambda (w) (substring w 0 -1))
  4285. (list org-scheduled-string org-deadline-string
  4286. org-clock-string org-closed-string))
  4287. )
  4288. (org-compute-latex-and-specials-regexp)
  4289. (org-set-font-lock-defaults))))
  4290. (defun org-file-contents (file &optional noerror)
  4291. "Return the contents of FILE, as a string."
  4292. (if (or (not file)
  4293. (not (file-readable-p file)))
  4294. (if noerror
  4295. (progn
  4296. (message "Cannot read file \"%s\"" file)
  4297. (ding) (sit-for 2)
  4298. "")
  4299. (error "Cannot read file \"%s\"" file))
  4300. (with-temp-buffer
  4301. (insert-file-contents file)
  4302. (buffer-string))))
  4303. (defun org-extract-log-state-settings (x)
  4304. "Extract the log state setting from a TODO keyword string.
  4305. This will extract info from a string like \"WAIT(w@/!)\"."
  4306. (let (kw key log1 log2)
  4307. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4308. (setq kw (match-string 1 x)
  4309. key (and (match-end 2) (match-string 2 x))
  4310. log1 (and (match-end 3) (match-string 3 x))
  4311. log2 (and (match-end 4) (match-string 4 x)))
  4312. (and (or log1 log2)
  4313. (list kw
  4314. (and log1 (if (equal log1 "!") 'time 'note))
  4315. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4316. (defun org-remove-keyword-keys (list)
  4317. "Remove a pair of parenthesis at the end of each string in LIST."
  4318. (mapcar (lambda (x)
  4319. (if (string-match "(.*)$" x)
  4320. (substring x 0 (match-beginning 0))
  4321. x))
  4322. list))
  4323. (defun org-assign-fast-keys (alist)
  4324. "Assign fast keys to a keyword-key alist.
  4325. Respect keys that are already there."
  4326. (let (new e (alt ?0))
  4327. (while (setq e (pop alist))
  4328. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  4329. (cdr e)) ;; Key already assigned.
  4330. (push e new)
  4331. (let ((clist (string-to-list (downcase (car e))))
  4332. (used (append new alist)))
  4333. (when (= (car clist) ?@)
  4334. (pop clist))
  4335. (while (and clist (rassoc (car clist) used))
  4336. (pop clist))
  4337. (unless clist
  4338. (while (rassoc alt used)
  4339. (incf alt)))
  4340. (push (cons (car e) (or (car clist) alt)) new))))
  4341. (nreverse new)))
  4342. ;;; Some variables used in various places
  4343. (defvar org-window-configuration nil
  4344. "Used in various places to store a window configuration.")
  4345. (defvar org-selected-window nil
  4346. "Used in various places to store a window configuration.")
  4347. (defvar org-finish-function nil
  4348. "Function to be called when `C-c C-c' is used.
  4349. This is for getting out of special buffers like capture.")
  4350. ;; FIXME: Occasionally check by commenting these, to make sure
  4351. ;; no other functions uses these, forgetting to let-bind them.
  4352. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4353. (defvar org-last-state)
  4354. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4355. ;; Defined somewhere in this file, but used before definition.
  4356. (defvar org-entities) ;; defined in org-entities.el
  4357. (defvar org-struct-menu)
  4358. (defvar org-org-menu)
  4359. (defvar org-tbl-menu)
  4360. ;;;; Define the Org-mode
  4361. ;; We use a before-change function to check if a table might need
  4362. ;; an update.
  4363. (defvar org-table-may-need-update t
  4364. "Indicates that a table might need an update.
  4365. This variable is set by `org-before-change-function'.
  4366. `org-table-align' sets it back to nil.")
  4367. (defun org-before-change-function (beg end)
  4368. "Every change indicates that a table might need an update."
  4369. (setq org-table-may-need-update t))
  4370. (defvar org-mode-map)
  4371. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4372. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4373. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4374. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4375. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4376. (defvar org-table-buffer-is-an nil)
  4377. (defvar bidi-paragraph-direction)
  4378. (defvar buffer-face-mode-face)
  4379. (require 'outline)
  4380. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4381. (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"))
  4382. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  4383. ;; Other stuff we need.
  4384. (require 'time-date)
  4385. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4386. (require 'easymenu)
  4387. (require 'overlay)
  4388. (require 'org-macs)
  4389. (require 'org-entities)
  4390. ;; (require 'org-compat) moved higher up in the file before it is first used
  4391. (require 'org-faces)
  4392. (require 'org-list)
  4393. (require 'org-pcomplete)
  4394. (require 'org-src)
  4395. (require 'org-footnote)
  4396. ;; babel
  4397. (require 'ob)
  4398. (require 'ob-table)
  4399. (require 'ob-lob)
  4400. (require 'ob-ref)
  4401. (require 'ob-tangle)
  4402. (require 'ob-comint)
  4403. (require 'ob-keys)
  4404. ;;;###autoload
  4405. (define-derived-mode org-mode outline-mode "Org"
  4406. "Outline-based notes management and organizer, alias
  4407. \"Carsten's outline-mode for keeping track of everything.\"
  4408. Org-mode develops organizational tasks around a NOTES file which
  4409. contains information about projects as plain text. Org-mode is
  4410. implemented on top of outline-mode, which is ideal to keep the content
  4411. of large files well structured. It supports ToDo items, deadlines and
  4412. time stamps, which magically appear in the diary listing of the Emacs
  4413. calendar. Tables are easily created with a built-in table editor.
  4414. Plain text URL-like links connect to websites, emails (VM), Usenet
  4415. messages (Gnus), BBDB entries, and any files related to the project.
  4416. For printing and sharing of notes, an Org-mode file (or a part of it)
  4417. can be exported as a structured ASCII or HTML file.
  4418. The following commands are available:
  4419. \\{org-mode-map}"
  4420. ;; Get rid of Outline menus, they are not needed
  4421. ;; Need to do this here because define-derived-mode sets up
  4422. ;; the keymap so late. Still, it is a waste to call this each time
  4423. ;; we switch another buffer into org-mode.
  4424. (if (featurep 'xemacs)
  4425. (when (boundp 'outline-mode-menu-heading)
  4426. ;; Assume this is Greg's port, it uses easymenu
  4427. (easy-menu-remove outline-mode-menu-heading)
  4428. (easy-menu-remove outline-mode-menu-show)
  4429. (easy-menu-remove outline-mode-menu-hide))
  4430. (define-key org-mode-map [menu-bar headings] 'undefined)
  4431. (define-key org-mode-map [menu-bar hide] 'undefined)
  4432. (define-key org-mode-map [menu-bar show] 'undefined))
  4433. (org-load-modules-maybe)
  4434. (easy-menu-add org-org-menu)
  4435. (easy-menu-add org-tbl-menu)
  4436. (org-install-agenda-files-menu)
  4437. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4438. (add-to-invisibility-spec '(org-cwidth))
  4439. (add-to-invisibility-spec '(org-hide-block . t))
  4440. (when (featurep 'xemacs)
  4441. (org-set-local 'line-move-ignore-invisible t))
  4442. (org-set-local 'outline-regexp org-outline-regexp)
  4443. (org-set-local 'outline-level 'org-outline-level)
  4444. (setq bidi-paragraph-direction 'left-to-right)
  4445. (when (and org-ellipsis
  4446. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4447. (fboundp 'make-glyph-code))
  4448. (unless org-display-table
  4449. (setq org-display-table (make-display-table)))
  4450. (set-display-table-slot
  4451. org-display-table 4
  4452. (vconcat (mapcar
  4453. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4454. org-ellipsis)))
  4455. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4456. (setq buffer-display-table org-display-table))
  4457. (org-set-regexps-and-options)
  4458. (when (and org-tag-faces (not org-tags-special-faces-re))
  4459. ;; tag faces set outside customize.... force initialization.
  4460. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4461. ;; Calc embedded
  4462. (org-set-local 'calc-embedded-open-mode "# ")
  4463. (modify-syntax-entry ?@ "w")
  4464. (modify-syntax-entry ?\" "\"")
  4465. (if org-startup-truncated (setq truncate-lines t))
  4466. (org-set-local 'font-lock-unfontify-region-function
  4467. 'org-unfontify-region)
  4468. ;; Activate before-change-function
  4469. (org-set-local 'org-table-may-need-update t)
  4470. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4471. 'local)
  4472. ;; Check for running clock before killing a buffer
  4473. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4474. ;; Initialize macros templates.
  4475. (org-macro-initialize-templates)
  4476. ;; Initialize radio targets.
  4477. (org-update-radio-target-regexp)
  4478. ;; Indentation.
  4479. (org-set-local 'indent-line-function 'org-indent-line)
  4480. (org-set-local 'indent-region-function 'org-indent-region)
  4481. ;; Filling and auto-filling.
  4482. (org-setup-filling)
  4483. ;; Comments.
  4484. (org-setup-comments-handling)
  4485. ;; Beginning/end of defun
  4486. (org-set-local 'beginning-of-defun-function 'org-back-to-heading)
  4487. (org-set-local 'end-of-defun-function (lambda () (interactive) (org-end-of-subtree nil t)))
  4488. ;; Next error for sparse trees
  4489. (org-set-local 'next-error-function 'org-occur-next-match)
  4490. ;; Make sure dependence stuff works reliably, even for users who set it
  4491. ;; too late :-(
  4492. (if org-enforce-todo-dependencies
  4493. (add-hook 'org-blocker-hook
  4494. 'org-block-todo-from-children-or-siblings-or-parent)
  4495. (remove-hook 'org-blocker-hook
  4496. 'org-block-todo-from-children-or-siblings-or-parent))
  4497. (if org-enforce-todo-checkbox-dependencies
  4498. (add-hook 'org-blocker-hook
  4499. 'org-block-todo-from-checkboxes)
  4500. (remove-hook 'org-blocker-hook
  4501. 'org-block-todo-from-checkboxes))
  4502. ;; Align options lines
  4503. (org-set-local
  4504. 'align-mode-rules-list
  4505. '((org-in-buffer-settings
  4506. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4507. (modes . '(org-mode)))))
  4508. ;; Imenu
  4509. (org-set-local 'imenu-create-index-function
  4510. 'org-imenu-get-tree)
  4511. ;; Make isearch reveal context
  4512. (if (or (featurep 'xemacs)
  4513. (not (boundp 'outline-isearch-open-invisible-function)))
  4514. ;; Emacs 21 and XEmacs make use of the hook
  4515. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4516. ;; Emacs 22 deals with this through a special variable
  4517. (org-set-local 'outline-isearch-open-invisible-function
  4518. (lambda (&rest ignore) (org-show-context 'isearch))))
  4519. ;; Turn on org-beamer-mode?
  4520. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  4521. ;; Setup the pcomplete hooks
  4522. (set (make-local-variable 'pcomplete-command-completion-function)
  4523. 'org-pcomplete-initial)
  4524. (set (make-local-variable 'pcomplete-command-name-function)
  4525. 'org-command-at-point)
  4526. (set (make-local-variable 'pcomplete-default-completion-function)
  4527. 'ignore)
  4528. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4529. 'org-parse-arguments)
  4530. (set (make-local-variable 'pcomplete-termination-string) "")
  4531. (when (>= emacs-major-version 23)
  4532. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4533. ;; If empty file that did not turn on org-mode automatically, make it to.
  4534. (if (and org-insert-mode-line-in-empty-file
  4535. (org-called-interactively-p 'any)
  4536. (= (point-min) (point-max)))
  4537. (insert "# -*- mode: org -*-\n\n"))
  4538. (unless org-inhibit-startup
  4539. (when org-startup-align-all-tables
  4540. (let ((bmp (buffer-modified-p)))
  4541. (org-table-map-tables 'org-table-align 'quietly)
  4542. (set-buffer-modified-p bmp)))
  4543. (when org-startup-with-inline-images
  4544. (org-display-inline-images))
  4545. (when org-startup-indented
  4546. (require 'org-indent)
  4547. (org-indent-mode 1))
  4548. (unless org-inhibit-startup-visibility-stuff
  4549. (org-set-startup-visibility)))
  4550. ;; Try to set org-hide correctly
  4551. (set-face-foreground
  4552. 'org-hide
  4553. (or (face-background 'default)
  4554. (face-background 'org-default)
  4555. (cdr (assoc 'background-color default-frame-alist))
  4556. (cdr (assoc 'background-color initial-frame-alist))
  4557. (cdr (assoc 'background-color window-system-default-frame-alist))
  4558. (face-foreground 'org-hide))))
  4559. (when (fboundp 'abbrev-table-put)
  4560. (abbrev-table-put org-mode-abbrev-table
  4561. :parents (list text-mode-abbrev-table)))
  4562. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4563. (defun org-current-time ()
  4564. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4565. (if (> (car org-time-stamp-rounding-minutes) 1)
  4566. (let ((r (car org-time-stamp-rounding-minutes))
  4567. (time (decode-time)))
  4568. (apply 'encode-time
  4569. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4570. (nthcdr 2 time))))
  4571. (current-time)))
  4572. (defun org-today ()
  4573. "Return today date, considering `org-extend-today-until'."
  4574. (time-to-days
  4575. (time-subtract (current-time)
  4576. (list 0 (* 3600 org-extend-today-until) 0))))
  4577. ;;;; Font-Lock stuff, including the activators
  4578. (defvar org-mouse-map (make-sparse-keymap))
  4579. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4580. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4581. (when org-mouse-1-follows-link
  4582. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4583. (when org-tab-follows-link
  4584. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4585. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4586. (require 'font-lock)
  4587. (defconst org-non-link-chars "]\t\n\r<>")
  4588. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4589. "shell" "elisp" "doi" "message"))
  4590. (defvar org-link-types-re nil
  4591. "Matches a link that has a url-like prefix like \"http:\"")
  4592. (defvar org-link-re-with-space nil
  4593. "Matches a link with spaces, optional angular brackets around it.")
  4594. (defvar org-link-re-with-space2 nil
  4595. "Matches a link with spaces, optional angular brackets around it.")
  4596. (defvar org-link-re-with-space3 nil
  4597. "Matches a link with spaces, only for internal part in bracket links.")
  4598. (defvar org-angle-link-re nil
  4599. "Matches link with angular brackets, spaces are allowed.")
  4600. (defvar org-plain-link-re nil
  4601. "Matches plain link, without spaces.")
  4602. (defvar org-bracket-link-regexp nil
  4603. "Matches a link in double brackets.")
  4604. (defvar org-bracket-link-analytic-regexp nil
  4605. "Regular expression used to analyze links.
  4606. Here is what the match groups contain after a match:
  4607. 1: http:
  4608. 2: http
  4609. 3: path
  4610. 4: [desc]
  4611. 5: desc")
  4612. (defvar org-bracket-link-analytic-regexp++ nil
  4613. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4614. (defvar org-any-link-re nil
  4615. "Regular expression matching any link.")
  4616. (defcustom org-match-sexp-depth 3
  4617. "Number of stacked braces for sub/superscript matching.
  4618. This has to be set before loading org.el to be effective."
  4619. :group 'org-export-translation ; ??????????????????????????/
  4620. :type 'integer)
  4621. (defun org-create-multibrace-regexp (left right n)
  4622. "Create a regular expression which will match a balanced sexp.
  4623. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4624. as single character strings.
  4625. The regexp returned will match the entire expression including the
  4626. delimiters. It will also define a single group which contains the
  4627. match except for the outermost delimiters. The maximum depth of
  4628. stacked delimiters is N. Escaping delimiters is not possible."
  4629. (let* ((nothing (concat "[^" left right "]*?"))
  4630. (or "\\|")
  4631. (re nothing)
  4632. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4633. (while (> n 1)
  4634. (setq n (1- n)
  4635. re (concat re or next)
  4636. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4637. (concat left "\\(" re "\\)" right)))
  4638. (defvar org-match-substring-regexp
  4639. (concat
  4640. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4641. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4642. "\\|"
  4643. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4644. "\\|"
  4645. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4646. "The regular expression matching a sub- or superscript.")
  4647. (defvar org-match-substring-with-braces-regexp
  4648. (concat
  4649. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4650. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4651. "\\)")
  4652. "The regular expression matching a sub- or superscript, forcing braces.")
  4653. (defun org-make-link-regexps ()
  4654. "Update the link regular expressions.
  4655. This should be called after the variable `org-link-types' has changed."
  4656. (setq org-link-types-re
  4657. (concat
  4658. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4659. org-link-re-with-space
  4660. (concat
  4661. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4662. "\\([^" org-non-link-chars " ]"
  4663. "[^" org-non-link-chars "]*"
  4664. "[^" org-non-link-chars " ]\\)>?")
  4665. org-link-re-with-space2
  4666. (concat
  4667. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4668. "\\([^" org-non-link-chars " ]"
  4669. "[^\t\n\r]*"
  4670. "[^" org-non-link-chars " ]\\)>?")
  4671. org-link-re-with-space3
  4672. (concat
  4673. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4674. "\\([^" org-non-link-chars " ]"
  4675. "[^\t\n\r]*\\)")
  4676. org-angle-link-re
  4677. (concat
  4678. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4679. "\\([^" org-non-link-chars " ]"
  4680. "[^" org-non-link-chars "]*"
  4681. "\\)>")
  4682. org-plain-link-re
  4683. (concat
  4684. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4685. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4686. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4687. org-bracket-link-regexp
  4688. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4689. org-bracket-link-analytic-regexp
  4690. (concat
  4691. "\\[\\["
  4692. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4693. "\\([^]]+\\)"
  4694. "\\]"
  4695. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4696. "\\]")
  4697. org-bracket-link-analytic-regexp++
  4698. (concat
  4699. "\\[\\["
  4700. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4701. "\\([^]]+\\)"
  4702. "\\]"
  4703. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4704. "\\]")
  4705. org-any-link-re
  4706. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4707. org-angle-link-re "\\)\\|\\("
  4708. org-plain-link-re "\\)")))
  4709. (org-make-link-regexps)
  4710. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  4711. "Regular expression for fast time stamp matching.")
  4712. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  4713. "Regular expression for fast time stamp matching.")
  4714. (defconst org-ts-regexp0
  4715. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4716. "Regular expression matching time strings for analysis.
  4717. This one does not require the space after the date, so it can be used
  4718. on a string that terminates immediately after the date.")
  4719. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4720. "Regular expression matching time strings for analysis.")
  4721. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4722. "Regular expression matching time stamps, with groups.")
  4723. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4724. "Regular expression matching time stamps (also [..]), with groups.")
  4725. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4726. "Regular expression matching a time stamp range.")
  4727. (defconst org-tr-regexp-both
  4728. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4729. "Regular expression matching a time stamp range.")
  4730. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4731. org-ts-regexp "\\)?")
  4732. "Regular expression matching a time stamp or time stamp range.")
  4733. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4734. org-ts-regexp-both "\\)?")
  4735. "Regular expression matching a time stamp or time stamp range.
  4736. The time stamps may be either active or inactive.")
  4737. (defvar org-emph-face nil)
  4738. (defun org-do-emphasis-faces (limit)
  4739. "Run through the buffer and add overlays to emphasized strings."
  4740. (let (rtn a)
  4741. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4742. (if (not (= (char-after (match-beginning 3))
  4743. (char-after (match-beginning 4))))
  4744. (progn
  4745. (setq rtn t)
  4746. (setq a (assoc (match-string 3) org-emphasis-alist))
  4747. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4748. 'face
  4749. (nth 1 a))
  4750. (and (nth 4 a)
  4751. (org-remove-flyspell-overlays-in
  4752. (match-beginning 0) (match-end 0)))
  4753. (add-text-properties (match-beginning 2) (match-end 2)
  4754. '(font-lock-multiline t org-emphasis t))
  4755. (when org-hide-emphasis-markers
  4756. (add-text-properties (match-end 4) (match-beginning 5)
  4757. '(invisible org-link))
  4758. (add-text-properties (match-beginning 3) (match-end 3)
  4759. '(invisible org-link)))))
  4760. (backward-char 1))
  4761. rtn))
  4762. (defun org-emphasize (&optional char)
  4763. "Insert or change an emphasis, i.e. a font like bold or italic.
  4764. If there is an active region, change that region to a new emphasis.
  4765. If there is no region, just insert the marker characters and position
  4766. the cursor between them.
  4767. CHAR should be either the marker character, or the first character of the
  4768. HTML tag associated with that emphasis. If CHAR is a space, the means
  4769. to remove the emphasis of the selected region.
  4770. If char is not given (for example in an interactive call) it
  4771. will be prompted for."
  4772. (interactive)
  4773. (let ((eal org-emphasis-alist) e det
  4774. (erc org-emphasis-regexp-components)
  4775. (prompt "")
  4776. (string "") beg end move tag c s)
  4777. (if (org-region-active-p)
  4778. (setq beg (region-beginning) end (region-end)
  4779. string (buffer-substring beg end))
  4780. (setq move t))
  4781. (while (setq e (pop eal))
  4782. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4783. c (aref tag 0))
  4784. (push (cons c (string-to-char (car e))) det)
  4785. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4786. (substring tag 1)))))
  4787. (setq det (nreverse det))
  4788. (unless char
  4789. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4790. (setq char (read-char-exclusive)))
  4791. (setq char (or (cdr (assoc char det)) char))
  4792. (if (equal char ?\ )
  4793. (setq s "" move nil)
  4794. (unless (assoc (char-to-string char) org-emphasis-alist)
  4795. (error "No such emphasis marker: \"%c\"" char))
  4796. (setq s (char-to-string char)))
  4797. (while (and (> (length string) 1)
  4798. (equal (substring string 0 1) (substring string -1))
  4799. (assoc (substring string 0 1) org-emphasis-alist))
  4800. (setq string (substring string 1 -1)))
  4801. (setq string (concat s string s))
  4802. (if beg (delete-region beg end))
  4803. (unless (or (bolp)
  4804. (string-match (concat "[" (nth 0 erc) "\n]")
  4805. (char-to-string (char-before (point)))))
  4806. (insert " "))
  4807. (unless (or (eobp)
  4808. (string-match (concat "[" (nth 1 erc) "\n]")
  4809. (char-to-string (char-after (point)))))
  4810. (insert " ") (backward-char 1))
  4811. (insert string)
  4812. (and move (backward-char 1))))
  4813. (defconst org-nonsticky-props
  4814. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4815. (defsubst org-rear-nonsticky-at (pos)
  4816. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4817. (defun org-activate-plain-links (limit)
  4818. "Run through the buffer and add overlays to links."
  4819. (catch 'exit
  4820. (let (f hl)
  4821. (when (re-search-forward (concat org-plain-link-re) limit t)
  4822. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4823. (setq f (get-text-property (match-beginning 0) 'face))
  4824. (setq hl (org-match-string-no-properties 0))
  4825. (if (or (eq f 'org-tag)
  4826. (and (listp f) (memq 'org-tag f)))
  4827. nil
  4828. (add-text-properties (match-beginning 0) (match-end 0)
  4829. (list 'mouse-face 'highlight
  4830. 'face 'org-link
  4831. 'htmlize-link `(:uri ,hl)
  4832. 'keymap org-mouse-map))
  4833. (org-rear-nonsticky-at (match-end 0)))
  4834. t))))
  4835. (defun org-activate-code (limit)
  4836. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  4837. (progn
  4838. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4839. (remove-text-properties (match-beginning 0) (match-end 0)
  4840. '(display t invisible t intangible t))
  4841. t)))
  4842. (defcustom org-src-fontify-natively nil
  4843. "When non-nil, fontify code in code blocks."
  4844. :type 'boolean
  4845. :version "24.1"
  4846. :group 'org-appearance
  4847. :group 'org-babel)
  4848. (defcustom org-allow-promoting-top-level-subtree nil
  4849. "When non-nil, allow promoting a top level subtree.
  4850. The leading star of the top level headline will be replaced
  4851. by a #."
  4852. :type 'boolean
  4853. :version "24.1"
  4854. :group 'org-appearance)
  4855. (defun org-fontify-meta-lines-and-blocks (limit)
  4856. (condition-case nil
  4857. (org-fontify-meta-lines-and-blocks-1 limit)
  4858. (error (message "org-mode fontification error"))))
  4859. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  4860. "Fontify #+ lines and blocks, in the correct ways."
  4861. (let ((case-fold-search t))
  4862. (if (re-search-forward
  4863. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  4864. limit t)
  4865. (let ((beg (match-beginning 0))
  4866. (block-start (match-end 0))
  4867. (block-end nil)
  4868. (lang (match-string 7))
  4869. (beg1 (line-beginning-position 2))
  4870. (dc1 (downcase (match-string 2)))
  4871. (dc3 (downcase (match-string 3)))
  4872. end end1 quoting block-type ovl)
  4873. (cond
  4874. ((member dc1 '("+html:" "+ascii:" "+latex:" "+docbook:"))
  4875. ;; a single line of backend-specific content
  4876. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4877. (remove-text-properties (match-beginning 0) (match-end 0)
  4878. '(display t invisible t intangible t))
  4879. (add-text-properties (match-beginning 1) (match-end 3)
  4880. '(font-lock-fontified t face org-meta-line))
  4881. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  4882. '(font-lock-fontified t face org-block))
  4883. ; for backend-specific code
  4884. t)
  4885. ((and (match-end 4) (equal dc3 "+begin"))
  4886. ;; Truly a block
  4887. (setq block-type (downcase (match-string 5))
  4888. quoting (member block-type org-protecting-blocks))
  4889. (when (re-search-forward
  4890. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4891. nil t) ;; on purpose, we look further than LIMIT
  4892. (setq end (min (point-max) (match-end 0))
  4893. end1 (min (point-max) (1- (match-beginning 0))))
  4894. (setq block-end (match-beginning 0))
  4895. (when quoting
  4896. (remove-text-properties beg end
  4897. '(display t invisible t intangible t)))
  4898. (add-text-properties
  4899. beg end
  4900. '(font-lock-fontified t font-lock-multiline t))
  4901. (add-text-properties beg beg1 '(face org-meta-line))
  4902. (add-text-properties end1 (min (point-max) (1+ end))
  4903. '(face org-meta-line)) ; for end_src
  4904. (cond
  4905. ((and lang (not (string= lang "")) org-src-fontify-natively)
  4906. (org-src-font-lock-fontify-block lang block-start block-end)
  4907. ;; remove old background overlays
  4908. (mapc (lambda (ov)
  4909. (if (eq (overlay-get ov 'face) 'org-block-background)
  4910. (delete-overlay ov)))
  4911. (overlays-at (/ (+ beg1 block-end) 2)))
  4912. ;; add a background overlay
  4913. (setq ovl (make-overlay beg1 block-end))
  4914. (overlay-put ovl 'face 'org-block-background)
  4915. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  4916. (quoting
  4917. (add-text-properties beg1 (min (point-max) (1+ end1))
  4918. '(face org-block))) ; end of source block
  4919. ((not org-fontify-quote-and-verse-blocks))
  4920. ((string= block-type "quote")
  4921. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  4922. ((string= block-type "verse")
  4923. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  4924. (add-text-properties beg beg1 '(face org-block-begin-line))
  4925. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  4926. '(face org-block-end-line))
  4927. t))
  4928. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  4929. (add-text-properties
  4930. beg (match-end 3)
  4931. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4932. '(font-lock-fontified t invisible t)
  4933. '(font-lock-fontified t face org-document-info-keyword)))
  4934. (add-text-properties
  4935. (match-beginning 6) (match-end 6)
  4936. (if (string-equal dc1 "+title:")
  4937. '(font-lock-fontified t face org-document-title)
  4938. '(font-lock-fontified t face org-document-info))))
  4939. ((or (equal dc1 "+results")
  4940. (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
  4941. "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
  4942. "+call:" "+header:" "+headers:" "+name:"))
  4943. (and (match-end 4) (equal dc3 "+attr")))
  4944. (add-text-properties
  4945. beg (match-end 0)
  4946. '(font-lock-fontified t face org-meta-line))
  4947. t)
  4948. ((member dc3 '(" " ""))
  4949. (add-text-properties
  4950. beg (match-end 0)
  4951. '(font-lock-fontified t face font-lock-comment-face)))
  4952. ((not (member (char-after beg) '(?\ ?\t)))
  4953. ;; just any other in-buffer setting, but not indented
  4954. (add-text-properties
  4955. beg (match-end 0)
  4956. '(font-lock-fontified t face org-meta-line))
  4957. t)
  4958. (t nil))))))
  4959. (defun org-strip-protective-commas (beg end)
  4960. "Strip protective commas between BEG and END in the current buffer."
  4961. (interactive "r")
  4962. (save-excursion
  4963. (save-match-data
  4964. (goto-char beg)
  4965. (let ((front-line (save-excursion
  4966. (re-search-forward
  4967. "[^[:space:]]" end t)
  4968. (goto-char (match-beginning 0))
  4969. (current-column))))
  4970. (while (re-search-forward "^[ \t]*\\(,\\)\\([*]\\|#\\)" end t)
  4971. (goto-char (match-beginning 1))
  4972. (when (= (current-column) front-line)
  4973. (replace-match "" nil nil nil 1)))))))
  4974. (defun org-activate-angle-links (limit)
  4975. "Run through the buffer and add overlays to links."
  4976. (if (re-search-forward org-angle-link-re limit t)
  4977. (progn
  4978. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4979. (add-text-properties (match-beginning 0) (match-end 0)
  4980. (list 'mouse-face 'highlight
  4981. 'keymap org-mouse-map))
  4982. (org-rear-nonsticky-at (match-end 0))
  4983. t)))
  4984. (defun org-activate-footnote-links (limit)
  4985. "Run through the buffer and add overlays to footnotes."
  4986. (let ((fn (org-footnote-next-reference-or-definition limit)))
  4987. (when fn
  4988. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  4989. (org-remove-flyspell-overlays-in beg end)
  4990. (add-text-properties beg end
  4991. (list 'mouse-face 'highlight
  4992. 'keymap org-mouse-map
  4993. 'help-echo
  4994. (if (= (point-at-bol) beg)
  4995. "Footnote definition"
  4996. "Footnote reference")
  4997. 'font-lock-fontified t
  4998. 'font-lock-multiline t
  4999. 'face 'org-footnote))))))
  5000. (defun org-activate-bracket-links (limit)
  5001. "Run through the buffer and add overlays to bracketed links."
  5002. (if (re-search-forward org-bracket-link-regexp limit t)
  5003. (let* ((hl (org-match-string-no-properties 1))
  5004. (help (concat "LINK: " hl))
  5005. ;; FIXME: Above we should remove the escapes. But that
  5006. ;; requires another match, protecting match data, a lot
  5007. ;; of overhead for font-lock.
  5008. (ip (org-maybe-intangible
  5009. (list 'invisible 'org-link
  5010. 'keymap org-mouse-map 'mouse-face 'highlight
  5011. 'font-lock-multiline t 'help-echo help
  5012. 'htmlize-link `(:uri ,hl))))
  5013. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  5014. 'font-lock-multiline t 'help-echo help
  5015. 'htmlize-link `(:uri ,hl))))
  5016. ;; We need to remove the invisible property here. Table narrowing
  5017. ;; may have made some of this invisible.
  5018. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5019. (remove-text-properties (match-beginning 0) (match-end 0)
  5020. '(invisible nil))
  5021. (if (match-end 3)
  5022. (progn
  5023. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  5024. (org-rear-nonsticky-at (match-beginning 3))
  5025. (add-text-properties (match-beginning 3) (match-end 3) vp)
  5026. (org-rear-nonsticky-at (match-end 3))
  5027. (add-text-properties (match-end 3) (match-end 0) ip)
  5028. (org-rear-nonsticky-at (match-end 0)))
  5029. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  5030. (org-rear-nonsticky-at (match-beginning 1))
  5031. (add-text-properties (match-beginning 1) (match-end 1) vp)
  5032. (org-rear-nonsticky-at (match-end 1))
  5033. (add-text-properties (match-end 1) (match-end 0) ip)
  5034. (org-rear-nonsticky-at (match-end 0)))
  5035. t)))
  5036. (defun org-activate-dates (limit)
  5037. "Run through the buffer and add overlays to dates."
  5038. (if (re-search-forward org-tsr-regexp-both limit t)
  5039. (progn
  5040. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5041. (add-text-properties (match-beginning 0) (match-end 0)
  5042. (list 'mouse-face 'highlight
  5043. 'keymap org-mouse-map))
  5044. (org-rear-nonsticky-at (match-end 0))
  5045. (when org-display-custom-times
  5046. (if (match-end 3)
  5047. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5048. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5049. t)))
  5050. (defvar org-target-link-regexp nil
  5051. "Regular expression matching radio targets in plain text.")
  5052. (make-variable-buffer-local 'org-target-link-regexp)
  5053. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  5054. "Regular expression matching a link target.")
  5055. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  5056. "Regular expression matching a radio target.")
  5057. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  5058. "Regular expression matching any target.")
  5059. (defun org-activate-target-links (limit)
  5060. "Run through the buffer and add overlays to target matches."
  5061. (when org-target-link-regexp
  5062. (let ((case-fold-search t))
  5063. (if (re-search-forward org-target-link-regexp limit t)
  5064. (progn
  5065. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5066. (add-text-properties (match-beginning 0) (match-end 0)
  5067. (list 'mouse-face 'highlight
  5068. 'keymap org-mouse-map
  5069. 'help-echo "Radio target link"
  5070. 'org-linked-text t))
  5071. (org-rear-nonsticky-at (match-end 0))
  5072. t)))))
  5073. (defun org-update-radio-target-regexp ()
  5074. "Find all radio targets in this file and update the regular expression."
  5075. (interactive)
  5076. (when (memq 'radio org-activate-links)
  5077. (setq org-target-link-regexp
  5078. (org-make-target-link-regexp (org-all-targets 'radio)))
  5079. (org-restart-font-lock)))
  5080. (defun org-hide-wide-columns (limit)
  5081. (let (s e)
  5082. (setq s (text-property-any (point) (or limit (point-max))
  5083. 'org-cwidth t))
  5084. (when s
  5085. (setq e (next-single-property-change s 'org-cwidth))
  5086. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5087. (goto-char e)
  5088. t)))
  5089. (defvar org-latex-and-specials-regexp nil
  5090. "Regular expression for highlighting export special stuff.")
  5091. (defvar org-match-substring-regexp)
  5092. (defvar org-match-substring-with-braces-regexp)
  5093. ;; This should be with the exporter code, but we also use if for font-locking
  5094. (defconst org-export-html-special-string-regexps
  5095. '(("\\\\-" . "&shy;")
  5096. ("---\\([^-]\\)" . "&mdash;\\1")
  5097. ("--\\([^-]\\)" . "&ndash;\\1")
  5098. ("\\.\\.\\." . "&hellip;"))
  5099. "Regular expressions for special string conversion.")
  5100. (defun org-compute-latex-and-specials-regexp ()
  5101. "Compute regular expression for stuff treated specially by exporters."
  5102. (if (not org-highlight-latex-fragments-and-specials)
  5103. (org-set-local 'org-latex-and-specials-regexp nil)
  5104. (require 'org-exp)
  5105. (let*
  5106. ((matchers (plist-get org-format-latex-options :matchers))
  5107. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  5108. org-latex-regexps)))
  5109. (org-export-allow-BIND nil)
  5110. (options (org-combine-plists (org-default-export-plist)
  5111. (org-infile-export-plist)))
  5112. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  5113. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  5114. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  5115. (org-export-html-expand (plist-get options :expand-quoted-html))
  5116. (org-export-with-special-strings (plist-get options :special-strings))
  5117. (re-sub
  5118. (cond
  5119. ((equal org-export-with-sub-superscripts '{})
  5120. (list org-match-substring-with-braces-regexp))
  5121. (org-export-with-sub-superscripts
  5122. (list org-match-substring-regexp))))
  5123. (re-latex
  5124. (if org-export-with-LaTeX-fragments
  5125. (mapcar (lambda (x) (nth 1 x)) latexs)))
  5126. (re-macros
  5127. (if org-export-with-TeX-macros
  5128. (list (concat "\\\\"
  5129. (regexp-opt
  5130. (append
  5131. (delq nil
  5132. (mapcar 'car-safe
  5133. (append org-entities-user
  5134. org-entities)))
  5135. (if (boundp 'org-latex-entities)
  5136. (mapcar (lambda (x)
  5137. (or (car-safe x) x))
  5138. org-latex-entities)
  5139. nil))
  5140. 'words))) ; FIXME
  5141. ))
  5142. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  5143. (re-special (if org-export-with-special-strings
  5144. (mapcar (lambda (x) (car x))
  5145. org-export-html-special-string-regexps)))
  5146. (re-rest
  5147. (delq nil
  5148. (list
  5149. (if org-export-html-expand "@<[^>\n]+>")
  5150. ))))
  5151. (org-set-local
  5152. 'org-latex-and-specials-regexp
  5153. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  5154. re-rest) "\\|")))))
  5155. (defun org-do-latex-and-special-faces (limit)
  5156. "Run through the buffer and add overlays to links."
  5157. (when org-latex-and-specials-regexp
  5158. (let (rtn d)
  5159. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  5160. limit t))
  5161. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5162. 'face))
  5163. '(org-code org-verbatim underline)))
  5164. (progn
  5165. (setq rtn t
  5166. d (cond ((member (char-after (1+ (match-beginning 0)))
  5167. '(?_ ?^)) 1)
  5168. (t 0)))
  5169. (font-lock-prepend-text-property
  5170. (+ d (match-beginning 0)) (match-end 0)
  5171. 'face 'org-latex-and-export-specials)
  5172. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  5173. '(font-lock-multiline t)))))
  5174. rtn)))
  5175. (defun org-restart-font-lock ()
  5176. "Restart `font-lock-mode', to force refontification."
  5177. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5178. (font-lock-mode -1)
  5179. (font-lock-mode 1)))
  5180. (defun org-all-targets (&optional radio)
  5181. "Return a list of all targets in this file.
  5182. With optional argument RADIO, only find radio targets."
  5183. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  5184. rtn)
  5185. (save-excursion
  5186. (goto-char (point-min))
  5187. (while (re-search-forward re nil t)
  5188. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  5189. rtn)))
  5190. (defun org-make-target-link-regexp (targets)
  5191. "Make regular expression matching all strings in TARGETS.
  5192. The regular expression finds the targets also if there is a line break
  5193. between words."
  5194. (and targets
  5195. (concat
  5196. "\\<\\("
  5197. (mapconcat
  5198. (lambda (x)
  5199. (setq x (regexp-quote x))
  5200. (while (string-match " +" x)
  5201. (setq x (replace-match "\\s-+" t t x)))
  5202. x)
  5203. targets
  5204. "\\|")
  5205. "\\)\\>")))
  5206. (defun org-activate-tags (limit)
  5207. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5208. (progn
  5209. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5210. (add-text-properties (match-beginning 1) (match-end 1)
  5211. (list 'mouse-face 'highlight
  5212. 'keymap org-mouse-map))
  5213. (org-rear-nonsticky-at (match-end 1))
  5214. t)))
  5215. (defun org-outline-level ()
  5216. "Compute the outline level of the heading at point.
  5217. If this is called at a normal headline, the level is the number of stars.
  5218. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5219. (save-excursion
  5220. (if (not (condition-case nil
  5221. (org-back-to-heading t)
  5222. (error nil)))
  5223. 0
  5224. (looking-at org-outline-regexp)
  5225. (1- (- (match-end 0) (match-beginning 0))))))
  5226. (defvar org-font-lock-keywords nil)
  5227. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  5228. "Regular expression matching a property line.")
  5229. (defvar org-font-lock-hook nil
  5230. "Functions to be called for special font lock stuff.")
  5231. (defvar org-font-lock-set-keywords-hook nil
  5232. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5233. This is called after `org-font-lock-extra-keywords' is defined, but before
  5234. it is installed to be used by font lock. This can be useful if something
  5235. needs to be inserted at a specific position in the font-lock sequence.")
  5236. (defun org-font-lock-hook (limit)
  5237. "Run `org-font-lock-hook' within LIMIT."
  5238. (run-hook-with-args 'org-font-lock-hook limit))
  5239. (defun org-set-font-lock-defaults ()
  5240. "Set font lock defaults for the current buffer."
  5241. (let* ((em org-fontify-emphasized-text)
  5242. (lk org-activate-links)
  5243. (org-font-lock-extra-keywords
  5244. (list
  5245. ;; Call the hook
  5246. '(org-font-lock-hook)
  5247. ;; Headlines
  5248. `(,(if org-fontify-whole-heading-line
  5249. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5250. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5251. (1 (org-get-level-face 1))
  5252. (2 (org-get-level-face 2))
  5253. (3 (org-get-level-face 3)))
  5254. ;; Table lines
  5255. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5256. (1 'org-table t))
  5257. ;; Table internals
  5258. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5259. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5260. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5261. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5262. ;; Drawers
  5263. (list org-drawer-regexp '(0 'org-special-keyword t))
  5264. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5265. ;; Properties
  5266. (list org-property-re
  5267. '(1 'org-special-keyword t)
  5268. '(3 'org-property-value t))
  5269. ;; Links
  5270. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5271. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5272. (if (memq 'plain lk) '(org-activate-plain-links))
  5273. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5274. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5275. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5276. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5277. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5278. '(org-hide-wide-columns (0 nil append))
  5279. ;; TODO keyword
  5280. (list (format org-heading-keyword-regexp-format
  5281. org-todo-regexp)
  5282. '(2 (org-get-todo-face 2) t))
  5283. ;; DONE
  5284. (if org-fontify-done-headline
  5285. (list (format org-heading-keyword-regexp-format
  5286. (concat
  5287. "\\(?:"
  5288. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5289. "\\)"))
  5290. '(2 'org-headline-done t))
  5291. nil)
  5292. ;; Priorities
  5293. '(org-font-lock-add-priority-faces)
  5294. ;; Tags
  5295. '(org-font-lock-add-tag-faces)
  5296. ;; Special keywords
  5297. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5298. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5299. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5300. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5301. ;; Emphasis
  5302. (if em
  5303. (if (featurep 'xemacs)
  5304. '(org-do-emphasis-faces (0 nil append))
  5305. '(org-do-emphasis-faces)))
  5306. ;; Checkboxes
  5307. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5308. 1 'org-checkbox prepend)
  5309. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5310. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5311. (0 (org-get-checkbox-statistics-face) t)))
  5312. ;; Description list items
  5313. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5314. 1 'org-list-dt prepend)
  5315. ;; ARCHIVEd headings
  5316. (list (concat
  5317. org-outline-regexp-bol
  5318. "\\(.*:" org-archive-tag ":.*\\)")
  5319. '(1 'org-archived prepend))
  5320. ;; Specials
  5321. '(org-do-latex-and-special-faces)
  5322. '(org-fontify-entities)
  5323. '(org-raise-scripts)
  5324. ;; Code
  5325. '(org-activate-code (1 'org-code t))
  5326. ;; COMMENT
  5327. (list (format org-heading-keyword-regexp-format
  5328. (concat "\\("
  5329. org-comment-string "\\|" org-quote-string
  5330. "\\)"))
  5331. '(2 'org-special-keyword t))
  5332. ;; Blocks and meta lines
  5333. '(org-fontify-meta-lines-and-blocks)
  5334. )))
  5335. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5336. (run-hooks 'org-font-lock-set-keywords-hook)
  5337. ;; Now set the full font-lock-keywords
  5338. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5339. (org-set-local 'font-lock-defaults
  5340. '(org-font-lock-keywords t nil nil backward-paragraph))
  5341. (kill-local-variable 'font-lock-keywords) nil))
  5342. (defun org-toggle-pretty-entities ()
  5343. "Toggle the composition display of entities as UTF8 characters."
  5344. (interactive)
  5345. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5346. (org-restart-font-lock)
  5347. (if org-pretty-entities
  5348. (message "Entities are displayed as UTF8 characters")
  5349. (save-restriction
  5350. (widen)
  5351. (org-decompose-region (point-min) (point-max))
  5352. (message "Entities are displayed plain"))))
  5353. (defvar org-custom-properties-overlays nil
  5354. "List of overlays used for custom properties.")
  5355. (make-variable-buffer-local 'org-custom-properties-overlays)
  5356. (defun org-toggle-custom-properties-visibility ()
  5357. "Display or hide properties in `org-custom-properties'."
  5358. (interactive)
  5359. (if org-custom-properties-overlays
  5360. (progn (mapc 'delete-overlay org-custom-properties-overlays)
  5361. (setq org-custom-properties-overlays nil))
  5362. (unless (not org-custom-properties)
  5363. (save-excursion
  5364. (save-restriction
  5365. (widen)
  5366. (goto-char (point-min))
  5367. (while (re-search-forward org-property-re nil t)
  5368. (mapc (lambda(p)
  5369. (when (equal p (substring (match-string 1) 1 -1))
  5370. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5371. (overlay-put o 'invisible t)
  5372. (overlay-put o 'org-custom-property t)
  5373. (push o org-custom-properties-overlays))))
  5374. org-custom-properties)))))))
  5375. (defun org-fontify-entities (limit)
  5376. "Find an entity to fontify."
  5377. (let (ee)
  5378. (when org-pretty-entities
  5379. (catch 'match
  5380. (while (re-search-forward
  5381. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5382. limit t)
  5383. (if (and (not (org-in-indented-comment-line))
  5384. (setq ee (org-entity-get (match-string 1)))
  5385. (= (length (nth 6 ee)) 1))
  5386. (let*
  5387. ((end (if (equal (match-string 2) "{}")
  5388. (match-end 2)
  5389. (match-end 1))))
  5390. (add-text-properties
  5391. (match-beginning 0) end
  5392. (list 'font-lock-fontified t))
  5393. (compose-region (match-beginning 0) end
  5394. (nth 6 ee) nil)
  5395. (backward-char 1)
  5396. (throw 'match t))))
  5397. nil))))
  5398. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5399. "Fontify string S like in Org-mode."
  5400. (with-temp-buffer
  5401. (insert s)
  5402. (let ((org-odd-levels-only odd-levels))
  5403. (org-mode)
  5404. (font-lock-fontify-buffer)
  5405. (buffer-string))))
  5406. (defvar org-m nil)
  5407. (defvar org-l nil)
  5408. (defvar org-f nil)
  5409. (defun org-get-level-face (n)
  5410. "Get the right face for match N in font-lock matching of headlines."
  5411. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5412. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5413. (if org-cycle-level-faces
  5414. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5415. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5416. (cond
  5417. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5418. ((eq n 2) org-f)
  5419. (t (if org-level-color-stars-only nil org-f))))
  5420. (defun org-get-todo-face (kwd)
  5421. "Get the right face for a TODO keyword KWD.
  5422. If KWD is a number, get the corresponding match group."
  5423. (if (numberp kwd) (setq kwd (match-string kwd)))
  5424. (or (org-face-from-face-or-color
  5425. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5426. (and (member kwd org-done-keywords) 'org-done)
  5427. 'org-todo))
  5428. (defun org-face-from-face-or-color (context inherit face-or-color)
  5429. "Create a face list that inherits INHERIT, but sets the foreground color.
  5430. When FACE-OR-COLOR is not a string, just return it."
  5431. (if (stringp face-or-color)
  5432. (list :inherit inherit
  5433. (cdr (assoc context org-faces-easy-properties))
  5434. face-or-color)
  5435. face-or-color))
  5436. (defun org-font-lock-add-tag-faces (limit)
  5437. "Add the special tag faces."
  5438. (when (and org-tag-faces org-tags-special-faces-re)
  5439. (while (re-search-forward org-tags-special-faces-re limit t)
  5440. (add-text-properties (match-beginning 1) (match-end 1)
  5441. (list 'face (org-get-tag-face 1)
  5442. 'font-lock-fontified t))
  5443. (backward-char 1))))
  5444. (defun org-font-lock-add-priority-faces (limit)
  5445. "Add the special priority faces."
  5446. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5447. (when (save-match-data (org-at-heading-p))
  5448. (add-text-properties
  5449. (match-beginning 0) (match-end 0)
  5450. (list 'face (or (org-face-from-face-or-color
  5451. 'priority 'org-special-keyword
  5452. (cdr (assoc (char-after (match-beginning 1))
  5453. org-priority-faces)))
  5454. 'org-special-keyword)
  5455. 'font-lock-fontified t)))))
  5456. (defun org-get-tag-face (kwd)
  5457. "Get the right face for a TODO keyword KWD.
  5458. If KWD is a number, get the corresponding match group."
  5459. (if (numberp kwd) (setq kwd (match-string kwd)))
  5460. (or (org-face-from-face-or-color
  5461. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5462. 'org-tag))
  5463. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5464. "Remove fontification and activation overlays from links."
  5465. (font-lock-default-unfontify-region beg end)
  5466. (let* ((buffer-undo-list t)
  5467. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5468. (inhibit-modification-hooks t)
  5469. deactivate-mark buffer-file-name buffer-file-truename)
  5470. (org-decompose-region beg end)
  5471. (remove-text-properties beg end
  5472. '(mouse-face t keymap t org-linked-text t
  5473. invisible t intangible t
  5474. org-no-flyspell t org-emphasis t))
  5475. (org-remove-font-lock-display-properties beg end)))
  5476. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5477. ((raise 0.3) (height 0.7))
  5478. ((raise -0.5))
  5479. ((raise 0.5)))
  5480. "Display properties for showing superscripts and subscripts.")
  5481. (defun org-remove-font-lock-display-properties (beg end)
  5482. "Remove specific display properties that have been added by font lock.
  5483. The will remove the raise properties that are used to show superscripts
  5484. and subscripts."
  5485. (let (next prop)
  5486. (while (< beg end)
  5487. (setq next (next-single-property-change beg 'display nil end)
  5488. prop (get-text-property beg 'display))
  5489. (if (member prop org-script-display)
  5490. (put-text-property beg next 'display nil))
  5491. (setq beg next))))
  5492. (defun org-raise-scripts (limit)
  5493. "Add raise properties to sub/superscripts."
  5494. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5495. (if (re-search-forward
  5496. (if (eq org-use-sub-superscripts t)
  5497. org-match-substring-regexp
  5498. org-match-substring-with-braces-regexp)
  5499. limit t)
  5500. (let* ((pos (point)) table-p comment-p
  5501. (mpos (match-beginning 3))
  5502. (emph-p (get-text-property mpos 'org-emphasis))
  5503. (link-p (get-text-property mpos 'mouse-face))
  5504. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5505. (goto-char (point-at-bol))
  5506. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5507. comment-p (org-looking-at-p "[ \t]*#"))
  5508. (goto-char pos)
  5509. ;; FIXME: Should we go back one character here, for a_b^c
  5510. ;; (goto-char (1- pos)) ;????????????????????
  5511. (if (or comment-p emph-p link-p keyw-p)
  5512. t
  5513. (put-text-property (match-beginning 3) (match-end 0)
  5514. 'display
  5515. (if (equal (char-after (match-beginning 2)) ?^)
  5516. (nth (if table-p 3 1) org-script-display)
  5517. (nth (if table-p 2 0) org-script-display)))
  5518. (add-text-properties (match-beginning 2) (match-end 2)
  5519. (list 'invisible t
  5520. 'org-dwidth t 'org-dwidth-n 1))
  5521. (if (and (eq (char-after (match-beginning 3)) ?{)
  5522. (eq (char-before (match-end 3)) ?}))
  5523. (progn
  5524. (add-text-properties
  5525. (match-beginning 3) (1+ (match-beginning 3))
  5526. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5527. (add-text-properties
  5528. (1- (match-end 3)) (match-end 3)
  5529. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5530. t)))))
  5531. ;;;; Visibility cycling, including org-goto and indirect buffer
  5532. ;;; Cycling
  5533. (defvar org-cycle-global-status nil)
  5534. (make-variable-buffer-local 'org-cycle-global-status)
  5535. (defvar org-cycle-subtree-status nil)
  5536. (make-variable-buffer-local 'org-cycle-subtree-status)
  5537. ;;;###autoload
  5538. (defvar org-inlinetask-min-level)
  5539. (defun org-cycle (&optional arg)
  5540. "TAB-action and visibility cycling for Org-mode.
  5541. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5542. is outline visibility cycling, but it also invokes other actions
  5543. in special contexts.
  5544. - When this function is called with a prefix argument, rotate the entire
  5545. buffer through 3 states (global cycling)
  5546. 1. OVERVIEW: Show only top-level headlines.
  5547. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5548. 3. SHOW ALL: Show everything.
  5549. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5550. determined by the variable `org-startup-folded', and by any VISIBILITY
  5551. properties in the buffer.
  5552. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5553. including any drawers.
  5554. - When inside a table, re-align the table and move to the next field.
  5555. - When point is at the beginning of a headline, rotate the subtree started
  5556. by this line through 3 different states (local cycling)
  5557. 1. FOLDED: Only the main headline is shown.
  5558. 2. CHILDREN: The main headline and the direct children are shown.
  5559. From this state, you can move to one of the children
  5560. and zoom in further.
  5561. 3. SUBTREE: Show the entire subtree, including body text.
  5562. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5563. - When point is at the beginning of an empty headline and the variable
  5564. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5565. of the headline by demoting and promoting it to likely levels. This
  5566. speeds up creation document structure by pressing TAB once or several
  5567. times right after creating a new headline.
  5568. - When there is a numeric prefix, go up to a heading with level ARG, do
  5569. a `show-subtree' and return to the previous cursor position. If ARG
  5570. is negative, go up that many levels.
  5571. - When point is not at the beginning of a headline, execute the global
  5572. binding for TAB, which is re-indenting the line. See the option
  5573. `org-cycle-emulate-tab' for details.
  5574. - Special case: if point is at the beginning of the buffer and there is
  5575. no headline in line 1, this function will act as if called with prefix arg
  5576. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5577. But only if also the variable `org-cycle-global-at-bob' is t."
  5578. (interactive "P")
  5579. (org-load-modules-maybe)
  5580. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5581. (and org-cycle-level-after-item/entry-creation
  5582. (or (org-cycle-level)
  5583. (org-cycle-item-indentation))))
  5584. (let* ((limit-level
  5585. (or org-cycle-max-level
  5586. (and (boundp 'org-inlinetask-min-level)
  5587. org-inlinetask-min-level
  5588. (1- org-inlinetask-min-level))))
  5589. (nstars (and limit-level
  5590. (if org-odd-levels-only
  5591. (and limit-level (1- (* limit-level 2)))
  5592. limit-level)))
  5593. (org-outline-regexp
  5594. (if (not (derived-mode-p 'org-mode))
  5595. outline-regexp
  5596. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5597. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5598. (not (looking-at org-outline-regexp))))
  5599. (org-cycle-hook
  5600. (if bob-special
  5601. (delq 'org-optimize-window-after-visibility-change
  5602. (copy-sequence org-cycle-hook))
  5603. org-cycle-hook))
  5604. (pos (point)))
  5605. (if (or bob-special (equal arg '(4)))
  5606. ;; special case: use global cycling
  5607. (setq arg t))
  5608. (cond
  5609. ((equal arg '(16))
  5610. (setq last-command 'dummy)
  5611. (org-set-startup-visibility)
  5612. (message "Startup visibility, plus VISIBILITY properties"))
  5613. ((equal arg '(64))
  5614. (show-all)
  5615. (message "Entire buffer visible, including drawers"))
  5616. ;; Table: enter it or move to the next field.
  5617. ((org-at-table-p 'any)
  5618. (if (org-at-table.el-p)
  5619. (message "Use C-c ' to edit table.el tables")
  5620. (if arg (org-table-edit-field t)
  5621. (org-table-justify-field-maybe)
  5622. (call-interactively 'org-table-next-field))))
  5623. ((run-hook-with-args-until-success
  5624. 'org-tab-after-check-for-table-hook))
  5625. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5626. ((eq arg t) (org-cycle-internal-global))
  5627. ;; Drawers: delegate to `org-flag-drawer'.
  5628. ((and org-drawers org-drawer-regexp
  5629. (save-excursion
  5630. (beginning-of-line 1)
  5631. (looking-at org-drawer-regexp)))
  5632. (org-flag-drawer ; toggle block visibility
  5633. (not (get-char-property (match-end 0) 'invisible))))
  5634. ;; Show-subtree, ARG levels up from here.
  5635. ((integerp arg)
  5636. (save-excursion
  5637. (org-back-to-heading)
  5638. (outline-up-heading (if (< arg 0) (- arg)
  5639. (- (funcall outline-level) arg)))
  5640. (org-show-subtree)))
  5641. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5642. ((and (featurep 'org-inlinetask)
  5643. (org-inlinetask-at-task-p)
  5644. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5645. (org-inlinetask-toggle-visibility))
  5646. ((org-try-cdlatex-tab))
  5647. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5648. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5649. (save-excursion (beginning-of-line 1)
  5650. (looking-at org-outline-regexp)))
  5651. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5652. (org-cycle-internal-local))
  5653. ;; From there: TAB emulation and template completion.
  5654. (buffer-read-only (org-back-to-heading))
  5655. ((run-hook-with-args-until-success
  5656. 'org-tab-after-check-for-cycling-hook))
  5657. ((org-try-structure-completion))
  5658. ((run-hook-with-args-until-success
  5659. 'org-tab-before-tab-emulation-hook))
  5660. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5661. (or (not (bolp))
  5662. (not (looking-at org-outline-regexp))))
  5663. (call-interactively (global-key-binding "\t")))
  5664. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5665. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5666. (or (and (eq org-cycle-emulate-tab 'white)
  5667. (= (match-end 0) (point-at-eol)))
  5668. (and (eq org-cycle-emulate-tab 'whitestart)
  5669. (>= (match-end 0) pos))))
  5670. t
  5671. (eq org-cycle-emulate-tab t))
  5672. (call-interactively (global-key-binding "\t")))
  5673. (t (save-excursion
  5674. (org-back-to-heading)
  5675. (org-cycle)))))))
  5676. (defun org-cycle-internal-global ()
  5677. "Do the global cycling action."
  5678. ;; Hack to avoid display of messages for .org attachments in Gnus
  5679. (let ((ga (string-match "\\*fontification" (buffer-name))))
  5680. (cond
  5681. ((and (eq last-command this-command)
  5682. (eq org-cycle-global-status 'overview))
  5683. ;; We just created the overview - now do table of contents
  5684. ;; This can be slow in very large buffers, so indicate action
  5685. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5686. (unless ga (message "CONTENTS..."))
  5687. (org-content)
  5688. (unless ga (message "CONTENTS...done"))
  5689. (setq org-cycle-global-status 'contents)
  5690. (run-hook-with-args 'org-cycle-hook 'contents))
  5691. ((and (eq last-command this-command)
  5692. (eq org-cycle-global-status 'contents))
  5693. ;; We just showed the table of contents - now show everything
  5694. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5695. (show-all)
  5696. (unless ga (message "SHOW ALL"))
  5697. (setq org-cycle-global-status 'all)
  5698. (run-hook-with-args 'org-cycle-hook 'all))
  5699. (t
  5700. ;; Default action: go to overview
  5701. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5702. (org-overview)
  5703. (unless ga (message "OVERVIEW"))
  5704. (setq org-cycle-global-status 'overview)
  5705. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5706. (defun org-cycle-internal-local ()
  5707. "Do the local cycling action."
  5708. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5709. ;; First, determine end of headline (EOH), end of subtree or item
  5710. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5711. (save-excursion
  5712. (if (org-at-item-p)
  5713. (progn
  5714. (beginning-of-line)
  5715. (setq struct (org-list-struct))
  5716. (setq eoh (point-at-eol))
  5717. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5718. (setq has-children (org-list-has-child-p (point) struct)))
  5719. (org-back-to-heading)
  5720. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5721. (setq eos (save-excursion
  5722. (org-end-of-subtree t)
  5723. (unless (eobp)
  5724. (skip-chars-forward " \t\n"))
  5725. (if (eobp) (point) (1- (point)))))
  5726. (setq has-children
  5727. (or (save-excursion
  5728. (let ((level (funcall outline-level)))
  5729. (outline-next-heading)
  5730. (and (org-at-heading-p t)
  5731. (> (funcall outline-level) level))))
  5732. (save-excursion
  5733. (org-list-search-forward (org-item-beginning-re) eos t)))))
  5734. ;; Determine end invisible part of buffer (EOL)
  5735. (beginning-of-line 2)
  5736. ;; XEmacs doesn't have `next-single-char-property-change'
  5737. (if (featurep 'xemacs)
  5738. (while (and (not (eobp)) ;; this is like `next-line'
  5739. (get-char-property (1- (point)) 'invisible))
  5740. (beginning-of-line 2))
  5741. (while (and (not (eobp)) ;; this is like `next-line'
  5742. (get-char-property (1- (point)) 'invisible))
  5743. (goto-char (next-single-char-property-change (point) 'invisible))
  5744. (and (eolp) (beginning-of-line 2))))
  5745. (setq eol (point)))
  5746. ;; Find out what to do next and set `this-command'
  5747. (cond
  5748. ((= eos eoh)
  5749. ;; Nothing is hidden behind this heading
  5750. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5751. (message "EMPTY ENTRY")
  5752. (setq org-cycle-subtree-status nil)
  5753. (save-excursion
  5754. (goto-char eos)
  5755. (outline-next-heading)
  5756. (if (outline-invisible-p) (org-flag-heading nil))))
  5757. ((and (or (>= eol eos)
  5758. (not (string-match "\\S-" (buffer-substring eol eos))))
  5759. (or has-children
  5760. (not (setq children-skipped
  5761. org-cycle-skip-children-state-if-no-children))))
  5762. ;; Entire subtree is hidden in one line: children view
  5763. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5764. (if (org-at-item-p)
  5765. (org-list-set-item-visibility (point-at-bol) struct 'children)
  5766. (org-show-entry)
  5767. (org-with-limited-levels (show-children))
  5768. ;; FIXME: This slows down the func way too much.
  5769. ;; How keep drawers hidden in subtree anyway?
  5770. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  5771. ;; (org-cycle-hide-drawers 'subtree))
  5772. ;; Fold every list in subtree to top-level items.
  5773. (when (eq org-cycle-include-plain-lists 'integrate)
  5774. (save-excursion
  5775. (org-back-to-heading)
  5776. (while (org-list-search-forward (org-item-beginning-re) eos t)
  5777. (beginning-of-line 1)
  5778. (let* ((struct (org-list-struct))
  5779. (prevs (org-list-prevs-alist struct))
  5780. (end (org-list-get-bottom-point struct)))
  5781. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  5782. (org-list-get-all-items (point) struct prevs))
  5783. (goto-char end))))))
  5784. (message "CHILDREN")
  5785. (save-excursion
  5786. (goto-char eos)
  5787. (outline-next-heading)
  5788. (if (outline-invisible-p) (org-flag-heading nil)))
  5789. (setq org-cycle-subtree-status 'children)
  5790. (run-hook-with-args 'org-cycle-hook 'children))
  5791. ((or children-skipped
  5792. (and (eq last-command this-command)
  5793. (eq org-cycle-subtree-status 'children)))
  5794. ;; We just showed the children, or no children are there,
  5795. ;; now show everything.
  5796. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5797. (outline-flag-region eoh eos nil)
  5798. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5799. (setq org-cycle-subtree-status 'subtree)
  5800. (run-hook-with-args 'org-cycle-hook 'subtree))
  5801. (t
  5802. ;; Default action: hide the subtree.
  5803. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5804. (outline-flag-region eoh eos t)
  5805. (message "FOLDED")
  5806. (setq org-cycle-subtree-status 'folded)
  5807. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5808. ;;;###autoload
  5809. (defun org-global-cycle (&optional arg)
  5810. "Cycle the global visibility. For details see `org-cycle'.
  5811. With \\[universal-argument] prefix arg, switch to startup visibility.
  5812. With a numeric prefix, show all headlines up to that level."
  5813. (interactive "P")
  5814. (let ((org-cycle-include-plain-lists
  5815. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  5816. (cond
  5817. ((integerp arg)
  5818. (show-all)
  5819. (hide-sublevels arg)
  5820. (setq org-cycle-global-status 'contents))
  5821. ((equal arg '(4))
  5822. (org-set-startup-visibility)
  5823. (message "Startup visibility, plus VISIBILITY properties."))
  5824. (t
  5825. (org-cycle '(4))))))
  5826. (defun org-set-startup-visibility ()
  5827. "Set the visibility required by startup options and properties."
  5828. (cond
  5829. ((eq org-startup-folded t)
  5830. (org-cycle '(4)))
  5831. ((eq org-startup-folded 'content)
  5832. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5833. (org-cycle '(4)) (org-cycle '(4)))))
  5834. (unless (eq org-startup-folded 'showeverything)
  5835. (if org-hide-block-startup (org-hide-block-all))
  5836. (org-set-visibility-according-to-property 'no-cleanup)
  5837. (org-cycle-hide-archived-subtrees 'all)
  5838. (org-cycle-hide-drawers 'all)
  5839. (org-cycle-show-empty-lines t)))
  5840. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5841. "Switch subtree visibilities according to :VISIBILITY: property."
  5842. (interactive)
  5843. (let (org-show-entry-below state)
  5844. (save-excursion
  5845. (goto-char (point-min))
  5846. (while (re-search-forward
  5847. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5848. nil t)
  5849. (setq state (match-string 1))
  5850. (save-excursion
  5851. (org-back-to-heading t)
  5852. (hide-subtree)
  5853. (org-reveal)
  5854. (cond
  5855. ((equal state '("fold" "folded"))
  5856. (hide-subtree))
  5857. ((equal state "children")
  5858. (org-show-hidden-entry)
  5859. (show-children))
  5860. ((equal state "content")
  5861. (save-excursion
  5862. (save-restriction
  5863. (org-narrow-to-subtree)
  5864. (org-content))))
  5865. ((member state '("all" "showall"))
  5866. (show-subtree)))))
  5867. (unless no-cleanup
  5868. (org-cycle-hide-archived-subtrees 'all)
  5869. (org-cycle-hide-drawers 'all)
  5870. (org-cycle-show-empty-lines 'all)))))
  5871. ;; This function uses outline-regexp instead of the more fundamental
  5872. ;; org-outline-regexp so that org-cycle-global works outside of Org
  5873. ;; buffers, where outline-regexp is needed.
  5874. (defun org-overview ()
  5875. "Switch to overview mode, showing only top-level headlines.
  5876. Really, this shows all headlines with level equal or greater than the level
  5877. of the first headline in the buffer. This is important, because if the
  5878. first headline is not level one, then (hide-sublevels 1) gives confusing
  5879. results."
  5880. (interactive)
  5881. (let ((level (save-excursion
  5882. (goto-char (point-min))
  5883. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5884. (progn
  5885. (goto-char (match-beginning 0))
  5886. (funcall outline-level))))))
  5887. (and level (hide-sublevels level))))
  5888. (defun org-content (&optional arg)
  5889. "Show all headlines in the buffer, like a table of contents.
  5890. With numerical argument N, show content up to level N."
  5891. (interactive "P")
  5892. (save-excursion
  5893. ;; Visit all headings and show their offspring
  5894. (and (integerp arg) (org-overview))
  5895. (goto-char (point-max))
  5896. (catch 'exit
  5897. (while (and (progn (condition-case nil
  5898. (outline-previous-visible-heading 1)
  5899. (error (goto-char (point-min))))
  5900. t)
  5901. (looking-at org-outline-regexp))
  5902. (if (integerp arg)
  5903. (show-children (1- arg))
  5904. (show-branches))
  5905. (if (bobp) (throw 'exit nil))))))
  5906. (defun org-optimize-window-after-visibility-change (state)
  5907. "Adjust the window after a change in outline visibility.
  5908. This function is the default value of the hook `org-cycle-hook'."
  5909. (when (get-buffer-window (current-buffer))
  5910. (cond
  5911. ((eq state 'content) nil)
  5912. ((eq state 'all) nil)
  5913. ((eq state 'folded) nil)
  5914. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5915. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5916. (defun org-remove-empty-overlays-at (pos)
  5917. "Remove outline overlays that do not contain non-white stuff."
  5918. (mapc
  5919. (lambda (o)
  5920. (and (eq 'outline (overlay-get o 'invisible))
  5921. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5922. (overlay-end o))))
  5923. (delete-overlay o)))
  5924. (overlays-at pos)))
  5925. (defun org-clean-visibility-after-subtree-move ()
  5926. "Fix visibility issues after moving a subtree."
  5927. ;; First, find a reasonable region to look at:
  5928. ;; Start two siblings above, end three below
  5929. (let* ((beg (save-excursion
  5930. (and (org-get-last-sibling)
  5931. (org-get-last-sibling))
  5932. (point)))
  5933. (end (save-excursion
  5934. (and (org-get-next-sibling)
  5935. (org-get-next-sibling)
  5936. (org-get-next-sibling))
  5937. (if (org-at-heading-p)
  5938. (point-at-eol)
  5939. (point))))
  5940. (level (looking-at "\\*+"))
  5941. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5942. (save-excursion
  5943. (save-restriction
  5944. (narrow-to-region beg end)
  5945. (when re
  5946. ;; Properly fold already folded siblings
  5947. (goto-char (point-min))
  5948. (while (re-search-forward re nil t)
  5949. (if (and (not (outline-invisible-p))
  5950. (save-excursion
  5951. (goto-char (point-at-eol)) (outline-invisible-p)))
  5952. (hide-entry))))
  5953. (org-cycle-show-empty-lines 'overview)
  5954. (org-cycle-hide-drawers 'overview)))))
  5955. (defun org-cycle-show-empty-lines (state)
  5956. "Show empty lines above all visible headlines.
  5957. The region to be covered depends on STATE when called through
  5958. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5959. entire buffer covered. Note that an empty line is only shown if there
  5960. are at least `org-cycle-separator-lines' empty lines before the headline."
  5961. (when (not (= org-cycle-separator-lines 0))
  5962. (save-excursion
  5963. (let* ((n (abs org-cycle-separator-lines))
  5964. (re (cond
  5965. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5966. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5967. (t (let ((ns (number-to-string (- n 2))))
  5968. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5969. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5970. beg end b e)
  5971. (cond
  5972. ((memq state '(overview contents t))
  5973. (setq beg (point-min) end (point-max)))
  5974. ((memq state '(children folded))
  5975. (setq beg (point) end (progn (org-end-of-subtree t t)
  5976. (beginning-of-line 2)
  5977. (point)))))
  5978. (when beg
  5979. (goto-char beg)
  5980. (while (re-search-forward re end t)
  5981. (unless (get-char-property (match-end 1) 'invisible)
  5982. (setq e (match-end 1))
  5983. (if (< org-cycle-separator-lines 0)
  5984. (setq b (save-excursion
  5985. (goto-char (match-beginning 0))
  5986. (org-back-over-empty-lines)
  5987. (if (save-excursion
  5988. (goto-char (max (point-min) (1- (point))))
  5989. (org-at-heading-p))
  5990. (1- (point))
  5991. (point))))
  5992. (setq b (match-beginning 1)))
  5993. (outline-flag-region b e nil)))))))
  5994. ;; Never hide empty lines at the end of the file.
  5995. (save-excursion
  5996. (goto-char (point-max))
  5997. (outline-previous-heading)
  5998. (outline-end-of-heading)
  5999. (if (and (looking-at "[ \t\n]+")
  6000. (= (match-end 0) (point-max)))
  6001. (outline-flag-region (point) (match-end 0) nil))))
  6002. (defun org-show-empty-lines-in-parent ()
  6003. "Move to the parent and re-show empty lines before visible headlines."
  6004. (save-excursion
  6005. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  6006. (org-cycle-show-empty-lines context))))
  6007. (defun org-files-list ()
  6008. "Return `org-agenda-files' list, plus all open org-mode files.
  6009. This is useful for operations that need to scan all of a user's
  6010. open and agenda-wise Org files."
  6011. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  6012. (dolist (buf (buffer-list))
  6013. (with-current-buffer buf
  6014. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  6015. (let ((file (expand-file-name (buffer-file-name))))
  6016. (unless (member file files)
  6017. (push file files))))))
  6018. files))
  6019. (defsubst org-entry-beginning-position ()
  6020. "Return the beginning position of the current entry."
  6021. (save-excursion (outline-back-to-heading t) (point)))
  6022. (defsubst org-entry-end-position ()
  6023. "Return the end position of the current entry."
  6024. (save-excursion (outline-next-heading) (point)))
  6025. (defun org-cycle-hide-drawers (state)
  6026. "Re-hide all drawers after a visibility state change."
  6027. (when (and (derived-mode-p 'org-mode)
  6028. (not (memq state '(overview folded contents))))
  6029. (save-excursion
  6030. (let* ((globalp (memq state '(contents all)))
  6031. (beg (if globalp (point-min) (point)))
  6032. (end (if globalp (point-max)
  6033. (if (eq state 'children)
  6034. (save-excursion (outline-next-heading) (point))
  6035. (org-end-of-subtree t)))))
  6036. (goto-char beg)
  6037. (while (re-search-forward org-drawer-regexp end t)
  6038. (org-flag-drawer t))))))
  6039. (defun org-cycle-hide-inline-tasks (state)
  6040. "Re-hide inline task when switching to 'contents visibility state."
  6041. (when (and (eq state 'contents)
  6042. (boundp 'org-inlinetask-min-level)
  6043. org-inlinetask-min-level)
  6044. (hide-sublevels (1- org-inlinetask-min-level))))
  6045. (defun org-flag-drawer (flag)
  6046. "When FLAG is non-nil, hide the drawer we are within.
  6047. Otherwise make it visible."
  6048. (save-excursion
  6049. (beginning-of-line 1)
  6050. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  6051. (let ((b (match-end 0)))
  6052. (if (re-search-forward
  6053. "^[ \t]*:END:"
  6054. (save-excursion (outline-next-heading) (point)) t)
  6055. (outline-flag-region b (point-at-eol) flag)
  6056. (error ":END: line missing at position %s" b))))))
  6057. (defun org-subtree-end-visible-p ()
  6058. "Is the end of the current subtree visible?"
  6059. (pos-visible-in-window-p
  6060. (save-excursion (org-end-of-subtree t) (point))))
  6061. (defun org-first-headline-recenter (&optional N)
  6062. "Move cursor to the first headline and recenter the headline.
  6063. Optional argument N means put the headline into the Nth line of the window."
  6064. (goto-char (point-min))
  6065. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6066. (beginning-of-line)
  6067. (recenter (prefix-numeric-value N))))
  6068. ;;; Saving and restoring visibility
  6069. (defun org-outline-overlay-data (&optional use-markers)
  6070. "Return a list of the locations of all outline overlays.
  6071. These are overlays with the `invisible' property value `outline'.
  6072. The return value is a list of cons cells, with start and stop
  6073. positions for each overlay.
  6074. If USE-MARKERS is set, return the positions as markers."
  6075. (let (beg end)
  6076. (save-excursion
  6077. (save-restriction
  6078. (widen)
  6079. (delq nil
  6080. (mapcar (lambda (o)
  6081. (when (eq (overlay-get o 'invisible) 'outline)
  6082. (setq beg (overlay-start o)
  6083. end (overlay-end o))
  6084. (and beg end (> end beg)
  6085. (if use-markers
  6086. (cons (move-marker (make-marker) beg)
  6087. (move-marker (make-marker) end))
  6088. (cons beg end)))))
  6089. (overlays-in (point-min) (point-max))))))))
  6090. (defun org-set-outline-overlay-data (data)
  6091. "Create visibility overlays for all positions in DATA.
  6092. DATA should have been made by `org-outline-overlay-data'."
  6093. (let (o)
  6094. (save-excursion
  6095. (save-restriction
  6096. (widen)
  6097. (show-all)
  6098. (mapc (lambda (c)
  6099. (outline-flag-region (car c) (cdr c) t))
  6100. data)))))
  6101. ;;; Folding of blocks
  6102. (defvar org-hide-block-overlays nil
  6103. "Overlays hiding blocks.")
  6104. (make-variable-buffer-local 'org-hide-block-overlays)
  6105. (defun org-block-map (function &optional start end)
  6106. "Call FUNCTION at the head of all source blocks in the current buffer.
  6107. Optional arguments START and END can be used to limit the range."
  6108. (let ((start (or start (point-min)))
  6109. (end (or end (point-max))))
  6110. (save-excursion
  6111. (goto-char start)
  6112. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6113. (save-excursion
  6114. (save-match-data
  6115. (goto-char (match-beginning 0))
  6116. (funcall function)))))))
  6117. (defun org-hide-block-toggle-all ()
  6118. "Toggle the visibility of all blocks in the current buffer."
  6119. (org-block-map #'org-hide-block-toggle))
  6120. (defun org-hide-block-all ()
  6121. "Fold all blocks in the current buffer."
  6122. (interactive)
  6123. (org-show-block-all)
  6124. (org-block-map #'org-hide-block-toggle-maybe))
  6125. (defun org-show-block-all ()
  6126. "Unfold all blocks in the current buffer."
  6127. (interactive)
  6128. (mapc 'delete-overlay org-hide-block-overlays)
  6129. (setq org-hide-block-overlays nil))
  6130. (defun org-hide-block-toggle-maybe ()
  6131. "Toggle visibility of block at point."
  6132. (interactive)
  6133. (let ((case-fold-search t))
  6134. (if (save-excursion
  6135. (beginning-of-line 1)
  6136. (looking-at org-block-regexp))
  6137. (progn (org-hide-block-toggle)
  6138. t) ;; to signal that we took action
  6139. nil))) ;; to signal that we did not
  6140. (defun org-hide-block-toggle (&optional force)
  6141. "Toggle the visibility of the current block."
  6142. (interactive)
  6143. (save-excursion
  6144. (beginning-of-line)
  6145. (if (re-search-forward org-block-regexp nil t)
  6146. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6147. (end (match-end 0)) ;; end of entire body
  6148. ov)
  6149. (if (memq t (mapcar (lambda (overlay)
  6150. (eq (overlay-get overlay 'invisible)
  6151. 'org-hide-block))
  6152. (overlays-at start)))
  6153. (if (or (not force) (eq force 'off))
  6154. (mapc (lambda (ov)
  6155. (when (member ov org-hide-block-overlays)
  6156. (setq org-hide-block-overlays
  6157. (delq ov org-hide-block-overlays)))
  6158. (when (eq (overlay-get ov 'invisible)
  6159. 'org-hide-block)
  6160. (delete-overlay ov)))
  6161. (overlays-at start)))
  6162. (setq ov (make-overlay start end))
  6163. (overlay-put ov 'invisible 'org-hide-block)
  6164. ;; make the block accessible to isearch
  6165. (overlay-put
  6166. ov 'isearch-open-invisible
  6167. (lambda (ov)
  6168. (when (member ov org-hide-block-overlays)
  6169. (setq org-hide-block-overlays
  6170. (delq ov org-hide-block-overlays)))
  6171. (when (eq (overlay-get ov 'invisible)
  6172. 'org-hide-block)
  6173. (delete-overlay ov))))
  6174. (push ov org-hide-block-overlays)))
  6175. (error "Not looking at a source block"))))
  6176. ;; org-tab-after-check-for-cycling-hook
  6177. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6178. ;; Remove overlays when changing major mode
  6179. (add-hook 'org-mode-hook
  6180. (lambda () (org-add-hook 'change-major-mode-hook
  6181. 'org-show-block-all 'append 'local)))
  6182. ;;; Org-goto
  6183. (defvar org-goto-window-configuration nil)
  6184. (defvar org-goto-marker nil)
  6185. (defvar org-goto-map
  6186. (let ((map (make-sparse-keymap)))
  6187. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  6188. (while (setq cmd (pop cmds))
  6189. (substitute-key-definition cmd cmd map global-map)))
  6190. (suppress-keymap map)
  6191. (org-defkey map "\C-m" 'org-goto-ret)
  6192. (org-defkey map [(return)] 'org-goto-ret)
  6193. (org-defkey map [(left)] 'org-goto-left)
  6194. (org-defkey map [(right)] 'org-goto-right)
  6195. (org-defkey map [(control ?g)] 'org-goto-quit)
  6196. (org-defkey map "\C-i" 'org-cycle)
  6197. (org-defkey map [(tab)] 'org-cycle)
  6198. (org-defkey map [(down)] 'outline-next-visible-heading)
  6199. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6200. (if org-goto-auto-isearch
  6201. (if (fboundp 'define-key-after)
  6202. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6203. nil)
  6204. (org-defkey map "q" 'org-goto-quit)
  6205. (org-defkey map "n" 'outline-next-visible-heading)
  6206. (org-defkey map "p" 'outline-previous-visible-heading)
  6207. (org-defkey map "f" 'outline-forward-same-level)
  6208. (org-defkey map "b" 'outline-backward-same-level)
  6209. (org-defkey map "u" 'outline-up-heading))
  6210. (org-defkey map "/" 'org-occur)
  6211. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6212. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6213. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6214. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6215. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6216. map))
  6217. (defconst org-goto-help
  6218. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  6219. RET=jump to location [Q]uit and return to previous location
  6220. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6221. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6222. ;; FIXME: Docstring does not mention both interfaces
  6223. (defun org-goto (&optional alternative-interface)
  6224. "Look up a different location in the current file, keeping current visibility.
  6225. When you want look-up or go to a different location in a
  6226. document, the fastest way is often to fold the entire buffer and
  6227. then dive into the tree. This method has the disadvantage, that
  6228. the previous location will be folded, which may not be what you
  6229. want.
  6230. This command works around this by showing a copy of the current
  6231. buffer in an indirect buffer, in overview mode. You can dive
  6232. into the tree in that copy, use org-occur and incremental search
  6233. to find a location. When pressing RET or `Q', the command
  6234. returns to the original buffer in which the visibility is still
  6235. unchanged. After RET it will also jump to the location selected
  6236. in the indirect buffer and expose the headline hierarchy above.
  6237. With a prefix argument, use the alternative interface: e.g. if
  6238. `org-goto-interface' is 'outline use 'outline-path-completion."
  6239. (interactive "P")
  6240. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6241. (org-refile-use-outline-path t)
  6242. (org-refile-target-verify-function nil)
  6243. (interface
  6244. (if (not alternative-interface)
  6245. org-goto-interface
  6246. (if (eq org-goto-interface 'outline)
  6247. 'outline-path-completion
  6248. 'outline)))
  6249. (org-goto-start-pos (point))
  6250. (selected-point
  6251. (if (eq interface 'outline)
  6252. (car (org-get-location (current-buffer) org-goto-help))
  6253. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6254. (org-refile-check-position pa)
  6255. (nth 3 pa)))))
  6256. (if selected-point
  6257. (progn
  6258. (org-mark-ring-push org-goto-start-pos)
  6259. (goto-char selected-point)
  6260. (if (or (outline-invisible-p) (org-invisible-p2))
  6261. (org-show-context 'org-goto)))
  6262. (message "Quit"))))
  6263. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6264. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6265. (defvar org-goto-local-auto-isearch-map) ; defined below
  6266. (defun org-get-location (buf help)
  6267. "Let the user select a location in the Org-mode buffer BUF.
  6268. This function uses a recursive edit. It returns the selected position
  6269. or nil."
  6270. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6271. (isearch-hide-immediately nil)
  6272. (isearch-search-fun-function
  6273. (lambda () 'org-goto-local-search-headings))
  6274. (org-goto-selected-point org-goto-exit-command)
  6275. (pop-up-frames nil)
  6276. (special-display-buffer-names nil)
  6277. (special-display-regexps nil)
  6278. (special-display-function nil))
  6279. (save-excursion
  6280. (save-window-excursion
  6281. (delete-other-windows)
  6282. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6283. (org-pop-to-buffer-same-window
  6284. (condition-case nil
  6285. (make-indirect-buffer (current-buffer) "*org-goto*")
  6286. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6287. (with-output-to-temp-buffer "*Help*"
  6288. (princ help))
  6289. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  6290. (setq buffer-read-only nil)
  6291. (let ((org-startup-truncated t)
  6292. (org-startup-folded nil)
  6293. (org-startup-align-all-tables nil))
  6294. (org-mode)
  6295. (org-overview))
  6296. (setq buffer-read-only t)
  6297. (if (and (boundp 'org-goto-start-pos)
  6298. (integer-or-marker-p org-goto-start-pos))
  6299. (let ((org-show-hierarchy-above t)
  6300. (org-show-siblings t)
  6301. (org-show-following-heading t))
  6302. (goto-char org-goto-start-pos)
  6303. (and (outline-invisible-p) (org-show-context)))
  6304. (goto-char (point-min)))
  6305. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6306. (message "Select location and press RET")
  6307. (use-local-map org-goto-map)
  6308. (recursive-edit)
  6309. ))
  6310. (kill-buffer "*org-goto*")
  6311. (cons org-goto-selected-point org-goto-exit-command)))
  6312. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6313. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6314. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6315. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6316. (defun org-goto-local-search-headings (string bound noerror)
  6317. "Search and make sure that any matches are in headlines."
  6318. (catch 'return
  6319. (while (if isearch-forward
  6320. (search-forward string bound noerror)
  6321. (search-backward string bound noerror))
  6322. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6323. (and (member :headline context)
  6324. (not (member :tags context))))
  6325. (throw 'return (point))))))
  6326. (defun org-goto-local-auto-isearch ()
  6327. "Start isearch."
  6328. (interactive)
  6329. (goto-char (point-min))
  6330. (let ((keys (this-command-keys)))
  6331. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6332. (isearch-mode t)
  6333. (isearch-process-search-char (string-to-char keys)))))
  6334. (defun org-goto-ret (&optional arg)
  6335. "Finish `org-goto' by going to the new location."
  6336. (interactive "P")
  6337. (setq org-goto-selected-point (point)
  6338. org-goto-exit-command 'return)
  6339. (throw 'exit nil))
  6340. (defun org-goto-left ()
  6341. "Finish `org-goto' by going to the new location."
  6342. (interactive)
  6343. (if (org-at-heading-p)
  6344. (progn
  6345. (beginning-of-line 1)
  6346. (setq org-goto-selected-point (point)
  6347. org-goto-exit-command 'left)
  6348. (throw 'exit nil))
  6349. (error "Not on a heading")))
  6350. (defun org-goto-right ()
  6351. "Finish `org-goto' by going to the new location."
  6352. (interactive)
  6353. (if (org-at-heading-p)
  6354. (progn
  6355. (setq org-goto-selected-point (point)
  6356. org-goto-exit-command 'right)
  6357. (throw 'exit nil))
  6358. (error "Not on a heading")))
  6359. (defun org-goto-quit ()
  6360. "Finish `org-goto' without cursor motion."
  6361. (interactive)
  6362. (setq org-goto-selected-point nil)
  6363. (setq org-goto-exit-command 'quit)
  6364. (throw 'exit nil))
  6365. ;;; Indirect buffer display of subtrees
  6366. (defvar org-indirect-dedicated-frame nil
  6367. "This is the frame being used for indirect tree display.")
  6368. (defvar org-last-indirect-buffer nil)
  6369. (defun org-tree-to-indirect-buffer (&optional arg)
  6370. "Create indirect buffer and narrow it to current subtree.
  6371. With a numerical prefix ARG, go up to this level and then take that tree.
  6372. If ARG is negative, go up that many levels.
  6373. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6374. indirect buffer previously made with this command, to avoid proliferation of
  6375. indirect buffers. However, when you call the command with a \
  6376. \\[universal-argument] prefix, or
  6377. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6378. is kept so that you can work with several indirect buffers at the same time.
  6379. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6380. \\[universal-argument] prefix also
  6381. requests that a new frame be made for the new buffer, so that the dedicated
  6382. frame is not changed."
  6383. (interactive "P")
  6384. (let ((cbuf (current-buffer))
  6385. (cwin (selected-window))
  6386. (pos (point))
  6387. beg end level heading ibuf)
  6388. (save-excursion
  6389. (org-back-to-heading t)
  6390. (when (numberp arg)
  6391. (setq level (org-outline-level))
  6392. (if (< arg 0) (setq arg (+ level arg)))
  6393. (while (> (setq level (org-outline-level)) arg)
  6394. (org-up-heading-safe)))
  6395. (setq beg (point)
  6396. heading (org-get-heading))
  6397. (org-end-of-subtree t t)
  6398. (if (org-at-heading-p) (backward-char 1))
  6399. (setq end (point)))
  6400. (if (and (buffer-live-p org-last-indirect-buffer)
  6401. (not (eq org-indirect-buffer-display 'new-frame))
  6402. (not arg))
  6403. (kill-buffer org-last-indirect-buffer))
  6404. (setq ibuf (org-get-indirect-buffer cbuf)
  6405. org-last-indirect-buffer ibuf)
  6406. (cond
  6407. ((or (eq org-indirect-buffer-display 'new-frame)
  6408. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6409. (select-frame (make-frame))
  6410. (delete-other-windows)
  6411. (org-pop-to-buffer-same-window ibuf)
  6412. (org-set-frame-title heading))
  6413. ((eq org-indirect-buffer-display 'dedicated-frame)
  6414. (raise-frame
  6415. (select-frame (or (and org-indirect-dedicated-frame
  6416. (frame-live-p org-indirect-dedicated-frame)
  6417. org-indirect-dedicated-frame)
  6418. (setq org-indirect-dedicated-frame (make-frame)))))
  6419. (delete-other-windows)
  6420. (org-pop-to-buffer-same-window ibuf)
  6421. (org-set-frame-title (concat "Indirect: " heading)))
  6422. ((eq org-indirect-buffer-display 'current-window)
  6423. (org-pop-to-buffer-same-window ibuf))
  6424. ((eq org-indirect-buffer-display 'other-window)
  6425. (pop-to-buffer ibuf))
  6426. (t (error "Invalid value")))
  6427. (if (featurep 'xemacs)
  6428. (save-excursion (org-mode) (turn-on-font-lock)))
  6429. (narrow-to-region beg end)
  6430. (show-all)
  6431. (goto-char pos)
  6432. (run-hook-with-args 'org-cycle-hook 'all)
  6433. (and (window-live-p cwin) (select-window cwin))))
  6434. (defun org-get-indirect-buffer (&optional buffer)
  6435. (setq buffer (or buffer (current-buffer)))
  6436. (let ((n 1) (base (buffer-name buffer)) bname)
  6437. (while (buffer-live-p
  6438. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6439. (setq n (1+ n)))
  6440. (condition-case nil
  6441. (make-indirect-buffer buffer bname 'clone)
  6442. (error (make-indirect-buffer buffer bname)))))
  6443. (defun org-set-frame-title (title)
  6444. "Set the title of the current frame to the string TITLE."
  6445. ;; FIXME: how to name a single frame in XEmacs???
  6446. (unless (featurep 'xemacs)
  6447. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6448. ;;;; Structure editing
  6449. ;;; Inserting headlines
  6450. (defun org-previous-line-empty-p ()
  6451. (save-excursion
  6452. (and (not (bobp))
  6453. (or (beginning-of-line 0) t)
  6454. (save-match-data
  6455. (looking-at "[ \t]*$")))))
  6456. (defun org-insert-heading (&optional force-heading invisible-ok)
  6457. "Insert a new heading or item with same depth at point.
  6458. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  6459. If point is at the beginning of a headline, insert a sibling before the
  6460. current headline. If point is not at the beginning, split the line,
  6461. create the new headline with the text in the current line after point
  6462. \(but see also the variable `org-M-RET-may-split-line').
  6463. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6464. This is important for non-interactive uses of the command."
  6465. (interactive "P")
  6466. (if (or (= (buffer-size) 0)
  6467. (and (not (save-excursion
  6468. (and (ignore-errors (org-back-to-heading invisible-ok))
  6469. (org-at-heading-p))))
  6470. (or force-heading (not (org-in-item-p)))))
  6471. (progn
  6472. (insert "\n* ")
  6473. (run-hooks 'org-insert-heading-hook))
  6474. (when (or force-heading (not (org-insert-item)))
  6475. (let* ((empty-line-p nil)
  6476. (level nil)
  6477. (on-heading (org-at-heading-p))
  6478. (head (save-excursion
  6479. (condition-case nil
  6480. (progn
  6481. (org-back-to-heading invisible-ok)
  6482. (when (and (not on-heading)
  6483. (featurep 'org-inlinetask)
  6484. (integerp org-inlinetask-min-level)
  6485. (>= (length (match-string 0))
  6486. org-inlinetask-min-level))
  6487. ;; Find a heading level before the inline task
  6488. (while (and (setq level (org-up-heading-safe))
  6489. (>= level org-inlinetask-min-level)))
  6490. (if (org-at-heading-p)
  6491. (org-back-to-heading invisible-ok)
  6492. (error "This should not happen")))
  6493. (setq empty-line-p (org-previous-line-empty-p))
  6494. (match-string 0))
  6495. (error "*"))))
  6496. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6497. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6498. pos hide-previous previous-pos)
  6499. (cond
  6500. ((and (org-at-heading-p) (bolp)
  6501. (or (bobp)
  6502. (save-excursion (backward-char 1) (not (outline-invisible-p)))))
  6503. ;; insert before the current line
  6504. (open-line (if blank 2 1)))
  6505. ((and (bolp)
  6506. (not org-insert-heading-respect-content)
  6507. (or (bobp)
  6508. (save-excursion
  6509. (backward-char 1) (not (outline-invisible-p)))))
  6510. ;; insert right here
  6511. nil)
  6512. (t
  6513. ;; somewhere in the line
  6514. (save-excursion
  6515. (setq previous-pos (point-at-bol))
  6516. (end-of-line)
  6517. (setq hide-previous (outline-invisible-p)))
  6518. (and org-insert-heading-respect-content (org-show-subtree))
  6519. (let ((split
  6520. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  6521. (save-excursion
  6522. (let ((p (point)))
  6523. (goto-char (point-at-bol))
  6524. (and (looking-at org-complex-heading-regexp)
  6525. (match-beginning 4)
  6526. (> p (match-beginning 4)))))))
  6527. tags pos)
  6528. (cond
  6529. (org-insert-heading-respect-content
  6530. (org-end-of-subtree nil t)
  6531. (when (featurep 'org-inlinetask)
  6532. (while (and (not (eobp))
  6533. (looking-at "\\(\\*+\\)[ \t]+")
  6534. (>= (length (match-string 1))
  6535. org-inlinetask-min-level))
  6536. (org-end-of-subtree nil t)))
  6537. (or (bolp) (newline))
  6538. (or (org-previous-line-empty-p)
  6539. (and blank (newline)))
  6540. (open-line 1))
  6541. ((org-at-heading-p)
  6542. (when hide-previous
  6543. (show-children)
  6544. (org-show-entry))
  6545. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  6546. (setq tags (and (match-end 2) (match-string 2)))
  6547. (and (match-end 1)
  6548. (delete-region (match-beginning 1) (match-end 1)))
  6549. (setq pos (point-at-bol))
  6550. (or split (end-of-line 1))
  6551. (delete-horizontal-space)
  6552. (if (string-match "\\`\\*+\\'"
  6553. (buffer-substring (point-at-bol) (point)))
  6554. (insert " "))
  6555. (newline (if blank 2 1))
  6556. (when tags
  6557. (save-excursion
  6558. (goto-char pos)
  6559. (end-of-line 1)
  6560. (insert " " tags)
  6561. (org-set-tags nil 'align))))
  6562. (t
  6563. (or split (end-of-line 1))
  6564. (newline (if blank 2 1)))))))
  6565. (insert head) (just-one-space)
  6566. (setq pos (point))
  6567. (end-of-line 1)
  6568. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  6569. (when (and org-insert-heading-respect-content hide-previous)
  6570. (save-excursion
  6571. (goto-char previous-pos)
  6572. (hide-subtree)))
  6573. (run-hooks 'org-insert-heading-hook)))))
  6574. (defun org-get-heading (&optional no-tags no-todo)
  6575. "Return the heading of the current entry, without the stars.
  6576. When NO-TAGS is non-nil, don't include tags.
  6577. When NO-TODO is non-nil, don't include TODO keywords."
  6578. (save-excursion
  6579. (org-back-to-heading t)
  6580. (cond
  6581. ((and no-tags no-todo)
  6582. (looking-at org-complex-heading-regexp)
  6583. (match-string 4))
  6584. (no-tags
  6585. (looking-at (concat org-outline-regexp
  6586. "\\(.*?\\)"
  6587. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6588. (match-string 1))
  6589. (no-todo
  6590. (looking-at org-todo-line-regexp)
  6591. (match-string 3))
  6592. (t (looking-at org-heading-regexp)
  6593. (match-string 2)))))
  6594. (defun org-heading-components ()
  6595. "Return the components of the current heading.
  6596. This is a list with the following elements:
  6597. - the level as an integer
  6598. - the reduced level, different if `org-odd-levels-only' is set.
  6599. - the TODO keyword, or nil
  6600. - the priority character, like ?A, or nil if no priority is given
  6601. - the headline text itself, or the tags string if no headline text
  6602. - the tags string, or nil."
  6603. (save-excursion
  6604. (org-back-to-heading t)
  6605. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  6606. (list (length (match-string 1))
  6607. (org-reduced-level (length (match-string 1)))
  6608. (org-match-string-no-properties 2)
  6609. (and (match-end 3) (aref (match-string 3) 2))
  6610. (org-match-string-no-properties 4)
  6611. (org-match-string-no-properties 5)))))
  6612. (defun org-get-entry ()
  6613. "Get the entry text, after heading, entire subtree."
  6614. (save-excursion
  6615. (org-back-to-heading t)
  6616. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6617. (defun org-insert-heading-after-current ()
  6618. "Insert a new heading with same level as current, after current subtree."
  6619. (interactive)
  6620. (org-back-to-heading)
  6621. (org-insert-heading)
  6622. (org-move-subtree-down)
  6623. (end-of-line 1))
  6624. (defun org-insert-heading-respect-content ()
  6625. (interactive)
  6626. (let ((org-insert-heading-respect-content t))
  6627. (org-insert-heading t)))
  6628. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6629. (interactive "P")
  6630. (let ((org-insert-heading-respect-content t))
  6631. (org-insert-todo-heading force-state t)))
  6632. (defun org-insert-todo-heading (arg &optional force-heading)
  6633. "Insert a new heading with the same level and TODO state as current heading.
  6634. If the heading has no TODO state, or if the state is DONE, use the first
  6635. state (TODO by default). Also with prefix arg, force first state."
  6636. (interactive "P")
  6637. (when (or force-heading (not (org-insert-item 'checkbox)))
  6638. (org-insert-heading force-heading)
  6639. (save-excursion
  6640. (org-back-to-heading)
  6641. (outline-previous-heading)
  6642. (looking-at org-todo-line-regexp))
  6643. (let*
  6644. ((new-mark-x
  6645. (if (or arg
  6646. (not (match-beginning 2))
  6647. (member (match-string 2) org-done-keywords))
  6648. (car org-todo-keywords-1)
  6649. (match-string 2)))
  6650. (new-mark
  6651. (or
  6652. (run-hook-with-args-until-success
  6653. 'org-todo-get-default-hook new-mark-x nil)
  6654. new-mark-x)))
  6655. (beginning-of-line 1)
  6656. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6657. (if org-treat-insert-todo-heading-as-state-change
  6658. (org-todo new-mark)
  6659. (insert new-mark " "))))
  6660. (when org-provide-todo-statistics
  6661. (org-update-parent-todo-statistics))))
  6662. (defun org-insert-subheading (arg)
  6663. "Insert a new subheading and demote it.
  6664. Works for outline headings and for plain lists alike."
  6665. (interactive "P")
  6666. (org-insert-heading arg)
  6667. (cond
  6668. ((org-at-heading-p) (org-do-demote))
  6669. ((org-at-item-p) (org-indent-item))))
  6670. (defun org-insert-todo-subheading (arg)
  6671. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6672. Works for outline headings and for plain lists alike."
  6673. (interactive "P")
  6674. (org-insert-todo-heading arg)
  6675. (cond
  6676. ((org-at-heading-p) (org-do-demote))
  6677. ((org-at-item-p) (org-indent-item))))
  6678. ;;; Promotion and Demotion
  6679. (defvar org-after-demote-entry-hook nil
  6680. "Hook run after an entry has been demoted.
  6681. The cursor will be at the beginning of the entry.
  6682. When a subtree is being demoted, the hook will be called for each node.")
  6683. (defvar org-after-promote-entry-hook nil
  6684. "Hook run after an entry has been promoted.
  6685. The cursor will be at the beginning of the entry.
  6686. When a subtree is being promoted, the hook will be called for each node.")
  6687. (defun org-promote-subtree ()
  6688. "Promote the entire subtree.
  6689. See also `org-promote'."
  6690. (interactive)
  6691. (save-excursion
  6692. (org-with-limited-levels (org-map-tree 'org-promote)))
  6693. (org-fix-position-after-promote))
  6694. (defun org-demote-subtree ()
  6695. "Demote the entire subtree. See `org-demote'.
  6696. See also `org-promote'."
  6697. (interactive)
  6698. (save-excursion
  6699. (org-with-limited-levels (org-map-tree 'org-demote)))
  6700. (org-fix-position-after-promote))
  6701. (defun org-do-promote ()
  6702. "Promote the current heading higher up the tree.
  6703. If the region is active in `transient-mark-mode', promote all headings
  6704. in the region."
  6705. (interactive)
  6706. (save-excursion
  6707. (if (org-region-active-p)
  6708. (org-map-region 'org-promote (region-beginning) (region-end))
  6709. (org-promote)))
  6710. (org-fix-position-after-promote))
  6711. (defun org-do-demote ()
  6712. "Demote the current heading lower down the tree.
  6713. If the region is active in `transient-mark-mode', demote all headings
  6714. in the region."
  6715. (interactive)
  6716. (save-excursion
  6717. (if (org-region-active-p)
  6718. (org-map-region 'org-demote (region-beginning) (region-end))
  6719. (org-demote)))
  6720. (org-fix-position-after-promote))
  6721. (defun org-fix-position-after-promote ()
  6722. "Make sure that after pro/demotion cursor position is right."
  6723. (let ((pos (point)))
  6724. (when (save-excursion
  6725. (beginning-of-line 1)
  6726. (looking-at org-todo-line-regexp)
  6727. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6728. (cond ((eobp) (insert " "))
  6729. ((eolp) (insert " "))
  6730. ((equal (char-after) ?\ ) (forward-char 1))))))
  6731. (defun org-current-level ()
  6732. "Return the level of the current entry, or nil if before the first headline.
  6733. The level is the number of stars at the beginning of the headline."
  6734. (save-excursion
  6735. (org-with-limited-levels
  6736. (if (ignore-errors (org-back-to-heading t))
  6737. (funcall outline-level)))))
  6738. (defun org-get-previous-line-level ()
  6739. "Return the outline depth of the last headline before the current line.
  6740. Returns 0 for the first headline in the buffer, and nil if before the
  6741. first headline."
  6742. (let ((current-level (org-current-level))
  6743. (prev-level (when (> (line-number-at-pos) 1)
  6744. (save-excursion
  6745. (beginning-of-line 0)
  6746. (org-current-level)))))
  6747. (cond ((null current-level) nil) ; Before first headline
  6748. ((null prev-level) 0) ; At first headline
  6749. (prev-level))))
  6750. (defun org-reduced-level (l)
  6751. "Compute the effective level of a heading.
  6752. This takes into account the setting of `org-odd-levels-only'."
  6753. (cond
  6754. ((zerop l) 0)
  6755. (org-odd-levels-only (1+ (floor (/ l 2))))
  6756. (t l)))
  6757. (defun org-level-increment ()
  6758. "Return the number of stars that will be added or removed at a
  6759. time to headlines when structure editing, based on the value of
  6760. `org-odd-levels-only'."
  6761. (if org-odd-levels-only 2 1))
  6762. (defun org-get-valid-level (level &optional change)
  6763. "Rectify a level change under the influence of `org-odd-levels-only'
  6764. LEVEL is a current level, CHANGE is by how much the level should be
  6765. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6766. even level numbers will become the next higher odd number."
  6767. (if org-odd-levels-only
  6768. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6769. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6770. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6771. (max 1 (+ level (or change 0)))))
  6772. (if (boundp 'define-obsolete-function-alias)
  6773. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6774. (define-obsolete-function-alias 'org-get-legal-level
  6775. 'org-get-valid-level)
  6776. (define-obsolete-function-alias 'org-get-legal-level
  6777. 'org-get-valid-level "23.1")))
  6778. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  6779. ;; ̀org-with-limited-levels'
  6780. (defun org-promote ()
  6781. "Promote the current heading higher up the tree.
  6782. If the region is active in `transient-mark-mode', promote all headings
  6783. in the region."
  6784. (org-back-to-heading t)
  6785. (let* ((level (save-match-data (funcall outline-level)))
  6786. (after-change-functions (remove 'flyspell-after-change-function
  6787. after-change-functions))
  6788. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6789. (diff (abs (- level (length up-head) -1))))
  6790. (cond ((and (= level 1) org-called-with-limited-levels
  6791. org-allow-promoting-top-level-subtree)
  6792. (replace-match "# " nil t))
  6793. ((= level 1)
  6794. (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6795. (t (replace-match up-head nil t)))
  6796. ;; Fixup tag positioning
  6797. (unless (= level 1)
  6798. (and org-auto-align-tags (org-set-tags nil t))
  6799. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  6800. (run-hooks 'org-after-promote-entry-hook)))
  6801. (defun org-demote ()
  6802. "Demote the current heading lower down the tree.
  6803. If the region is active in `transient-mark-mode', demote all headings
  6804. in the region."
  6805. (org-back-to-heading t)
  6806. (let* ((level (save-match-data (funcall outline-level)))
  6807. (after-change-functions (remove 'flyspell-after-change-function
  6808. after-change-functions))
  6809. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6810. (diff (abs (- level (length down-head) -1))))
  6811. (replace-match down-head nil t)
  6812. ;; Fixup tag positioning
  6813. (and org-auto-align-tags (org-set-tags nil t))
  6814. (if org-adapt-indentation (org-fixup-indentation diff))
  6815. (run-hooks 'org-after-demote-entry-hook)))
  6816. (defun org-cycle-level ()
  6817. "Cycle the level of an empty headline through possible states.
  6818. This goes first to child, then to parent, level, then up the hierarchy.
  6819. After top level, it switches back to sibling level."
  6820. (interactive)
  6821. (let ((org-adapt-indentation nil))
  6822. (when (org-point-at-end-of-empty-headline)
  6823. (setq this-command 'org-cycle-level) ; Only needed for caching
  6824. (let ((cur-level (org-current-level))
  6825. (prev-level (org-get-previous-line-level)))
  6826. (cond
  6827. ;; If first headline in file, promote to top-level.
  6828. ((= prev-level 0)
  6829. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6830. do (org-do-promote)))
  6831. ;; If same level as prev, demote one.
  6832. ((= prev-level cur-level)
  6833. (org-do-demote))
  6834. ;; If parent is top-level, promote to top level if not already.
  6835. ((= prev-level 1)
  6836. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6837. do (org-do-promote)))
  6838. ;; If top-level, return to prev-level.
  6839. ((= cur-level 1)
  6840. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6841. do (org-do-demote)))
  6842. ;; If less than prev-level, promote one.
  6843. ((< cur-level prev-level)
  6844. (org-do-promote))
  6845. ;; If deeper than prev-level, promote until higher than
  6846. ;; prev-level.
  6847. ((> cur-level prev-level)
  6848. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6849. do (org-do-promote))))
  6850. t))))
  6851. (defun org-map-tree (fun)
  6852. "Call FUN for every heading underneath the current one."
  6853. (org-back-to-heading)
  6854. (let ((level (funcall outline-level)))
  6855. (save-excursion
  6856. (funcall fun)
  6857. (while (and (progn
  6858. (outline-next-heading)
  6859. (> (funcall outline-level) level))
  6860. (not (eobp)))
  6861. (funcall fun)))))
  6862. (defun org-map-region (fun beg end)
  6863. "Call FUN for every heading between BEG and END."
  6864. (let ((org-ignore-region t))
  6865. (save-excursion
  6866. (setq end (copy-marker end))
  6867. (goto-char beg)
  6868. (if (and (re-search-forward org-outline-regexp-bol nil t)
  6869. (< (point) end))
  6870. (funcall fun))
  6871. (while (and (progn
  6872. (outline-next-heading)
  6873. (< (point) end))
  6874. (not (eobp)))
  6875. (funcall fun)))))
  6876. (defvar org-property-end-re) ; silence byte-compiler
  6877. (defun org-fixup-indentation (diff)
  6878. "Change the indentation in the current entry by DIFF.
  6879. However, if any line in the current entry has no indentation, or if it
  6880. would end up with no indentation after the change, nothing at all is done."
  6881. (save-excursion
  6882. (let ((end (save-excursion (outline-next-heading)
  6883. (point-marker)))
  6884. (prohibit (if (> diff 0)
  6885. "^\\S-"
  6886. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6887. col)
  6888. (unless (save-excursion (end-of-line 1)
  6889. (re-search-forward prohibit end t))
  6890. (while (and (< (point) end)
  6891. (re-search-forward "^[ \t]+" end t))
  6892. (goto-char (match-end 0))
  6893. (setq col (current-column))
  6894. (if (< diff 0) (replace-match ""))
  6895. (org-indent-to-column (+ diff col))))
  6896. (move-marker end nil))))
  6897. (defun org-convert-to-odd-levels ()
  6898. "Convert an org-mode file with all levels allowed to one with odd levels.
  6899. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6900. level 5 etc."
  6901. (interactive)
  6902. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6903. (let ((outline-level 'org-outline-level)
  6904. (org-odd-levels-only nil) n)
  6905. (save-excursion
  6906. (goto-char (point-min))
  6907. (while (re-search-forward "^\\*\\*+ " nil t)
  6908. (setq n (- (length (match-string 0)) 2))
  6909. (while (>= (setq n (1- n)) 0)
  6910. (org-demote))
  6911. (end-of-line 1))))))
  6912. (defun org-convert-to-oddeven-levels ()
  6913. "Convert an org-mode file with only odd levels to one with odd/even levels.
  6914. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6915. file contains a section with an even level, conversion would
  6916. destroy the structure of the file. An error is signaled in this
  6917. case."
  6918. (interactive)
  6919. (goto-char (point-min))
  6920. ;; First check if there are no even levels
  6921. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6922. (org-show-context t)
  6923. (error "Not all levels are odd in this file. Conversion not possible"))
  6924. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6925. (let ((outline-regexp org-outline-regexp)
  6926. (outline-level 'org-outline-level)
  6927. (org-odd-levels-only nil) n)
  6928. (save-excursion
  6929. (goto-char (point-min))
  6930. (while (re-search-forward "^\\*\\*+ " nil t)
  6931. (setq n (/ (1- (length (match-string 0))) 2))
  6932. (while (>= (setq n (1- n)) 0)
  6933. (org-promote))
  6934. (end-of-line 1))))))
  6935. (defun org-tr-level (n)
  6936. "Make N odd if required."
  6937. (if org-odd-levels-only (1+ (/ n 2)) n))
  6938. ;;; Vertical tree motion, cutting and pasting of subtrees
  6939. (defun org-move-subtree-up (&optional arg)
  6940. "Move the current subtree up past ARG headlines of the same level."
  6941. (interactive "p")
  6942. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6943. (defun org-move-subtree-down (&optional arg)
  6944. "Move the current subtree down past ARG headlines of the same level."
  6945. (interactive "p")
  6946. (setq arg (prefix-numeric-value arg))
  6947. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6948. 'org-get-last-sibling))
  6949. (ins-point (make-marker))
  6950. (cnt (abs arg))
  6951. (col (current-column))
  6952. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6953. ;; Select the tree
  6954. (org-back-to-heading)
  6955. (setq beg0 (point))
  6956. (save-excursion
  6957. (setq ne-beg (org-back-over-empty-lines))
  6958. (setq beg (point)))
  6959. (save-match-data
  6960. (save-excursion (outline-end-of-heading)
  6961. (setq folded (outline-invisible-p)))
  6962. (outline-end-of-subtree))
  6963. (outline-next-heading)
  6964. (setq ne-end (org-back-over-empty-lines))
  6965. (setq end (point))
  6966. (goto-char beg0)
  6967. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6968. ;; include less whitespace
  6969. (save-excursion
  6970. (goto-char beg)
  6971. (forward-line (- ne-beg ne-end))
  6972. (setq beg (point))))
  6973. ;; Find insertion point, with error handling
  6974. (while (> cnt 0)
  6975. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  6976. (progn (goto-char beg0)
  6977. (error "Cannot move past superior level or buffer limit")))
  6978. (setq cnt (1- cnt)))
  6979. (if (> arg 0)
  6980. ;; Moving forward - still need to move over subtree
  6981. (progn (org-end-of-subtree t t)
  6982. (save-excursion
  6983. (org-back-over-empty-lines)
  6984. (or (bolp) (newline)))))
  6985. (setq ne-ins (org-back-over-empty-lines))
  6986. (move-marker ins-point (point))
  6987. (setq txt (buffer-substring beg end))
  6988. (org-save-markers-in-region beg end)
  6989. (delete-region beg end)
  6990. (org-remove-empty-overlays-at beg)
  6991. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6992. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6993. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6994. (let ((bbb (point)))
  6995. (insert-before-markers txt)
  6996. (org-reinstall-markers-in-region bbb)
  6997. (move-marker ins-point bbb))
  6998. (or (bolp) (insert "\n"))
  6999. (setq ins-end (point))
  7000. (goto-char ins-point)
  7001. (org-skip-whitespace)
  7002. (when (and (< arg 0)
  7003. (org-first-sibling-p)
  7004. (> ne-ins ne-beg))
  7005. ;; Move whitespace back to beginning
  7006. (save-excursion
  7007. (goto-char ins-end)
  7008. (let ((kill-whole-line t))
  7009. (kill-line (- ne-ins ne-beg)) (point)))
  7010. (insert (make-string (- ne-ins ne-beg) ?\n)))
  7011. (move-marker ins-point nil)
  7012. (if folded
  7013. (hide-subtree)
  7014. (org-show-entry)
  7015. (show-children)
  7016. (org-cycle-hide-drawers 'children))
  7017. (org-clean-visibility-after-subtree-move)
  7018. ;; move back to the initial column we were at
  7019. (move-to-column col)))
  7020. (defvar org-subtree-clip ""
  7021. "Clipboard for cut and paste of subtrees.
  7022. This is actually only a copy of the kill, because we use the normal kill
  7023. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  7024. (defvar org-subtree-clip-folded nil
  7025. "Was the last copied subtree folded?
  7026. This is used to fold the tree back after pasting.")
  7027. (defun org-cut-subtree (&optional n)
  7028. "Cut the current subtree into the clipboard.
  7029. With prefix arg N, cut this many sequential subtrees.
  7030. This is a short-hand for marking the subtree and then cutting it."
  7031. (interactive "p")
  7032. (org-copy-subtree n 'cut))
  7033. (defun org-copy-subtree (&optional n cut force-store-markers)
  7034. "Cut the current subtree into the clipboard.
  7035. With prefix arg N, cut this many sequential subtrees.
  7036. This is a short-hand for marking the subtree and then copying it.
  7037. If CUT is non-nil, actually cut the subtree.
  7038. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  7039. of some markers in the region, even if CUT is non-nil. This is
  7040. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  7041. (interactive "p")
  7042. (let (beg end folded (beg0 (point)))
  7043. (if (org-called-interactively-p 'any)
  7044. (org-back-to-heading nil) ; take what looks like a subtree
  7045. (org-back-to-heading t)) ; take what is really there
  7046. (org-back-over-empty-lines)
  7047. (setq beg (point))
  7048. (skip-chars-forward " \t\r\n")
  7049. (save-match-data
  7050. (save-excursion (outline-end-of-heading)
  7051. (setq folded (outline-invisible-p)))
  7052. (condition-case nil
  7053. (org-forward-heading-same-level (1- n) t)
  7054. (error nil))
  7055. (org-end-of-subtree t t))
  7056. (org-back-over-empty-lines)
  7057. (setq end (point))
  7058. (goto-char beg0)
  7059. (when (> end beg)
  7060. (setq org-subtree-clip-folded folded)
  7061. (when (or cut force-store-markers)
  7062. (org-save-markers-in-region beg end))
  7063. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7064. (setq org-subtree-clip (current-kill 0))
  7065. (message "%s: Subtree(s) with %d characters"
  7066. (if cut "Cut" "Copied")
  7067. (length org-subtree-clip)))))
  7068. (defun org-paste-subtree (&optional level tree for-yank)
  7069. "Paste the clipboard as a subtree, with modification of headline level.
  7070. The entire subtree is promoted or demoted in order to match a new headline
  7071. level.
  7072. If the cursor is at the beginning of a headline, the same level as
  7073. that headline is used to paste the tree
  7074. If not, the new level is derived from the *visible* headings
  7075. before and after the insertion point, and taken to be the inferior headline
  7076. level of the two. So if the previous visible heading is level 3 and the
  7077. next is level 4 (or vice versa), level 4 will be used for insertion.
  7078. This makes sure that the subtree remains an independent subtree and does
  7079. not swallow low level entries.
  7080. You can also force a different level, either by using a numeric prefix
  7081. argument, or by inserting the heading marker by hand. For example, if the
  7082. cursor is after \"*****\", then the tree will be shifted to level 5.
  7083. If optional TREE is given, use this text instead of the kill ring.
  7084. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7085. move back over whitespace before inserting, and move point to the end of
  7086. the inserted text when done."
  7087. (interactive "P")
  7088. (setq tree (or tree (and kill-ring (current-kill 0))))
  7089. (unless (org-kill-is-subtree-p tree)
  7090. (error "%s"
  7091. (substitute-command-keys
  7092. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7093. (org-with-limited-levels
  7094. (let* ((visp (not (outline-invisible-p)))
  7095. (txt tree)
  7096. (^re_ "\\(\\*+\\)[ \t]*")
  7097. (old-level (if (string-match org-outline-regexp-bol txt)
  7098. (- (match-end 0) (match-beginning 0) 1)
  7099. -1))
  7100. (force-level (cond (level (prefix-numeric-value level))
  7101. ((and (looking-at "[ \t]*$")
  7102. (string-match
  7103. "^\\*+$" (buffer-substring
  7104. (point-at-bol) (point))))
  7105. (- (match-end 1) (match-beginning 1)))
  7106. ((and (bolp)
  7107. (looking-at org-outline-regexp))
  7108. (- (match-end 0) (point) 1))))
  7109. (previous-level (save-excursion
  7110. (condition-case nil
  7111. (progn
  7112. (outline-previous-visible-heading 1)
  7113. (if (looking-at ^re_)
  7114. (- (match-end 0) (match-beginning 0) 1)
  7115. 1))
  7116. (error 1))))
  7117. (next-level (save-excursion
  7118. (condition-case nil
  7119. (progn
  7120. (or (looking-at org-outline-regexp)
  7121. (outline-next-visible-heading 1))
  7122. (if (looking-at ^re_)
  7123. (- (match-end 0) (match-beginning 0) 1)
  7124. 1))
  7125. (error 1))))
  7126. (new-level (or force-level (max previous-level next-level)))
  7127. (shift (if (or (= old-level -1)
  7128. (= new-level -1)
  7129. (= old-level new-level))
  7130. 0
  7131. (- new-level old-level)))
  7132. (delta (if (> shift 0) -1 1))
  7133. (func (if (> shift 0) 'org-demote 'org-promote))
  7134. (org-odd-levels-only nil)
  7135. beg end newend)
  7136. ;; Remove the forced level indicator
  7137. (if force-level
  7138. (delete-region (point-at-bol) (point)))
  7139. ;; Paste
  7140. (beginning-of-line (if (bolp) 1 2))
  7141. (unless for-yank (org-back-over-empty-lines))
  7142. (setq beg (point))
  7143. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7144. (insert-before-markers txt)
  7145. (unless (string-match "\n\\'" txt) (insert "\n"))
  7146. (setq newend (point))
  7147. (org-reinstall-markers-in-region beg)
  7148. (setq end (point))
  7149. (goto-char beg)
  7150. (skip-chars-forward " \t\n\r")
  7151. (setq beg (point))
  7152. (if (and (outline-invisible-p) visp)
  7153. (save-excursion (outline-show-heading)))
  7154. ;; Shift if necessary
  7155. (unless (= shift 0)
  7156. (save-restriction
  7157. (narrow-to-region beg end)
  7158. (while (not (= shift 0))
  7159. (org-map-region func (point-min) (point-max))
  7160. (setq shift (+ delta shift)))
  7161. (goto-char (point-min))
  7162. (setq newend (point-max))))
  7163. (when (or (org-called-interactively-p 'interactive) for-yank)
  7164. (message "Clipboard pasted as level %d subtree" new-level))
  7165. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7166. kill-ring
  7167. (eq org-subtree-clip (current-kill 0))
  7168. org-subtree-clip-folded)
  7169. ;; The tree was folded before it was killed/copied
  7170. (hide-subtree))
  7171. (and for-yank (goto-char newend)))))
  7172. (defun org-kill-is-subtree-p (&optional txt)
  7173. "Check if the current kill is an outline subtree, or a set of trees.
  7174. Returns nil if kill does not start with a headline, or if the first
  7175. headline level is not the largest headline level in the tree.
  7176. So this will actually accept several entries of equal levels as well,
  7177. which is OK for `org-paste-subtree'.
  7178. If optional TXT is given, check this string instead of the current kill."
  7179. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7180. (re (org-get-limited-outline-regexp))
  7181. (^re (concat "^" re))
  7182. (start-level (and kill
  7183. (string-match
  7184. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7185. kill)
  7186. (- (match-end 2) (match-beginning 2) 1)))
  7187. (start (1+ (or (match-beginning 2) -1))))
  7188. (if (not start-level)
  7189. (progn
  7190. nil) ;; does not even start with a heading
  7191. (catch 'exit
  7192. (while (setq start (string-match ^re kill (1+ start)))
  7193. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7194. (throw 'exit nil)))
  7195. t))))
  7196. (defvar org-markers-to-move nil
  7197. "Markers that should be moved with a cut-and-paste operation.
  7198. Those markers are stored together with their positions relative to
  7199. the start of the region.")
  7200. (defun org-save-markers-in-region (beg end)
  7201. "Check markers in region.
  7202. If these markers are between BEG and END, record their position relative
  7203. to BEG, so that after moving the block of text, we can put the markers back
  7204. into place.
  7205. This function gets called just before an entry or tree gets cut from the
  7206. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7207. called immediately, to move the markers with the entries."
  7208. (setq org-markers-to-move nil)
  7209. (when (featurep 'org-clock)
  7210. (org-clock-save-markers-for-cut-and-paste beg end))
  7211. (when (featurep 'org-agenda)
  7212. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7213. (defun org-check-and-save-marker (marker beg end)
  7214. "Check if MARKER is between BEG and END.
  7215. If yes, remember the marker and the distance to BEG."
  7216. (when (and (marker-buffer marker)
  7217. (equal (marker-buffer marker) (current-buffer)))
  7218. (if (and (>= marker beg) (< marker end))
  7219. (push (cons marker (- marker beg)) org-markers-to-move))))
  7220. (defun org-reinstall-markers-in-region (beg)
  7221. "Move all remembered markers to their position relative to BEG."
  7222. (mapc (lambda (x)
  7223. (move-marker (car x) (+ beg (cdr x))))
  7224. org-markers-to-move)
  7225. (setq org-markers-to-move nil))
  7226. (defun org-narrow-to-subtree ()
  7227. "Narrow buffer to the current subtree."
  7228. (interactive)
  7229. (save-excursion
  7230. (save-match-data
  7231. (org-with-limited-levels
  7232. (narrow-to-region
  7233. (progn (org-back-to-heading t) (point))
  7234. (progn (org-end-of-subtree t t)
  7235. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7236. (point)))))))
  7237. (defun org-narrow-to-block ()
  7238. "Narrow buffer to the current block."
  7239. (interactive)
  7240. (let* ((case-fold-search t)
  7241. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7242. "^[ \t]*#\\+end_.*")))
  7243. (if blockp
  7244. (narrow-to-region (car blockp) (cdr blockp))
  7245. (error "Not in a block"))))
  7246. (eval-when-compile
  7247. (defvar org-property-drawer-re))
  7248. (defvar org-property-start-re) ;; defined below
  7249. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7250. "Clone the task (subtree) at point N times.
  7251. The clones will be inserted as siblings.
  7252. In interactive use, the user will be prompted for the number of
  7253. clones to be produced, and for a time SHIFT, which may be a
  7254. repeater as used in time stamps, for example `+3d'.
  7255. When a valid repeater is given and the entry contains any time
  7256. stamps, the clones will become a sequence in time, with time
  7257. stamps in the subtree shifted for each clone produced. If SHIFT
  7258. is nil or the empty string, time stamps will be left alone. The
  7259. ID property of the original subtree is removed.
  7260. If the original subtree did contain time stamps with a repeater,
  7261. the following will happen:
  7262. - the repeater will be removed in each clone
  7263. - an additional clone will be produced, with the current, unshifted
  7264. date(s) in the entry.
  7265. - the original entry will be placed *after* all the clones, with
  7266. repeater intact.
  7267. - the start days in the repeater in the original entry will be shifted
  7268. to past the last clone.
  7269. In this way you can spell out a number of instances of a repeating task,
  7270. and still retain the repeater to cover future instances of the task."
  7271. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  7272. (let (beg end template task idprop
  7273. shift-n shift-what doshift nmin nmax (n-no-remove -1)
  7274. (drawer-re org-drawer-regexp))
  7275. (if (not (and (integerp n) (> n 0)))
  7276. (error "Invalid number of replications %s" n))
  7277. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7278. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7279. shift)))
  7280. (error "Invalid shift specification %s" shift))
  7281. (when doshift
  7282. (setq shift-n (string-to-number (match-string 1 shift))
  7283. shift-what (cdr (assoc (match-string 2 shift)
  7284. '(("d" . day) ("w" . week)
  7285. ("m" . month) ("y" . year))))))
  7286. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7287. (setq nmin 1 nmax n)
  7288. (org-back-to-heading t)
  7289. (setq beg (point))
  7290. (setq idprop (org-entry-get nil "ID"))
  7291. (org-end-of-subtree t t)
  7292. (or (bolp) (insert "\n"))
  7293. (setq end (point))
  7294. (setq template (buffer-substring beg end))
  7295. (when (and doshift
  7296. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7297. (delete-region beg end)
  7298. (setq end beg)
  7299. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7300. (goto-char end)
  7301. (loop for n from nmin to nmax do
  7302. ;; prepare clone
  7303. (with-temp-buffer
  7304. (insert template)
  7305. (org-mode)
  7306. (goto-char (point-min))
  7307. (org-show-subtree)
  7308. (and idprop (if org-clone-delete-id
  7309. (org-entry-delete nil "ID")
  7310. (org-id-get-create t)))
  7311. (unless (= n 0)
  7312. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7313. (kill-whole-line))
  7314. (goto-char (point-min))
  7315. (while (re-search-forward drawer-re nil t)
  7316. (mapc (lambda (d)
  7317. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7318. (goto-char (point-min))
  7319. (when doshift
  7320. (while (re-search-forward org-ts-regexp-both nil t)
  7321. (org-timestamp-change (* n shift-n) shift-what))
  7322. (unless (= n n-no-remove)
  7323. (goto-char (point-min))
  7324. (while (re-search-forward org-ts-regexp nil t)
  7325. (save-excursion
  7326. (goto-char (match-beginning 0))
  7327. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7328. (delete-region (match-beginning 1) (match-end 1)))))))
  7329. (setq task (buffer-string)))
  7330. (insert task))
  7331. (goto-char beg)))
  7332. ;;; Outline Sorting
  7333. (defun org-sort (with-case)
  7334. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7335. Optional argument WITH-CASE means sort case-sensitively."
  7336. (interactive "P")
  7337. (cond
  7338. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7339. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7340. (t
  7341. (org-call-with-arg 'org-sort-entries with-case))))
  7342. (defun org-sort-remove-invisible (s)
  7343. (remove-text-properties 0 (length s) org-rm-props s)
  7344. (while (string-match org-bracket-link-regexp s)
  7345. (setq s (replace-match (if (match-end 2)
  7346. (match-string 3 s)
  7347. (match-string 1 s)) t t s)))
  7348. s)
  7349. (defvar org-priority-regexp) ; defined later in the file
  7350. (defvar org-after-sorting-entries-or-items-hook nil
  7351. "Hook that is run after a bunch of entries or items have been sorted.
  7352. When children are sorted, the cursor is in the parent line when this
  7353. hook gets called. When a region or a plain list is sorted, the cursor
  7354. will be in the first entry of the sorted region/list.")
  7355. (defun org-sort-entries
  7356. (&optional with-case sorting-type getkey-func compare-func property)
  7357. "Sort entries on a certain level of an outline tree.
  7358. If there is an active region, the entries in the region are sorted.
  7359. Else, if the cursor is before the first entry, sort the top-level items.
  7360. Else, the children of the entry at point are sorted.
  7361. Sorting can be alphabetically, numerically, by date/time as given by
  7362. a time stamp, by a property or by priority.
  7363. The command prompts for the sorting type unless it has been given to the
  7364. function through the SORTING-TYPE argument, which needs to be a character,
  7365. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  7366. precise meaning of each character:
  7367. n Numerically, by converting the beginning of the entry/item to a number.
  7368. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7369. t By date/time, either the first active time stamp in the entry, or, if
  7370. none exist, by the first inactive one.
  7371. s By the scheduled date/time.
  7372. d By deadline date/time.
  7373. c By creation time, which is assumed to be the first inactive time stamp
  7374. at the beginning of a line.
  7375. p By priority according to the cookie.
  7376. r By the value of a property.
  7377. Capital letters will reverse the sort order.
  7378. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7379. called with point at the beginning of the record. It must return either
  7380. a string or a number that should serve as the sorting key for that record.
  7381. Comparing entries ignores case by default. However, with an optional argument
  7382. WITH-CASE, the sorting considers case as well."
  7383. (interactive "P")
  7384. (let ((case-func (if with-case 'identity 'downcase))
  7385. start beg end stars re re2
  7386. txt what tmp)
  7387. ;; Find beginning and end of region to sort
  7388. (cond
  7389. ((org-region-active-p)
  7390. ;; we will sort the region
  7391. (setq end (region-end)
  7392. what "region")
  7393. (goto-char (region-beginning))
  7394. (if (not (org-at-heading-p)) (outline-next-heading))
  7395. (setq start (point)))
  7396. ((or (org-at-heading-p)
  7397. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7398. ;; we will sort the children of the current headline
  7399. (org-back-to-heading)
  7400. (setq start (point)
  7401. end (progn (org-end-of-subtree t t)
  7402. (or (bolp) (insert "\n"))
  7403. (org-back-over-empty-lines)
  7404. (point))
  7405. what "children")
  7406. (goto-char start)
  7407. (show-subtree)
  7408. (outline-next-heading))
  7409. (t
  7410. ;; we will sort the top-level entries in this file
  7411. (goto-char (point-min))
  7412. (or (org-at-heading-p) (outline-next-heading))
  7413. (setq start (point))
  7414. (goto-char (point-max))
  7415. (beginning-of-line 1)
  7416. (when (looking-at ".*?\\S-")
  7417. ;; File ends in a non-white line
  7418. (end-of-line 1)
  7419. (insert "\n"))
  7420. (setq end (point-max))
  7421. (setq what "top-level")
  7422. (goto-char start)
  7423. (show-all)))
  7424. (setq beg (point))
  7425. (if (>= beg end) (error "Nothing to sort"))
  7426. (looking-at "\\(\\*+\\)")
  7427. (setq stars (match-string 1)
  7428. re (concat "^" (regexp-quote stars) " +")
  7429. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7430. txt (buffer-substring beg end))
  7431. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7432. (if (and (not (equal stars "*")) (string-match re2 txt))
  7433. (error "Region to sort contains a level above the first entry"))
  7434. (unless sorting-type
  7435. (message
  7436. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7437. [t]ime [s]cheduled [d]eadline [c]reated
  7438. A/N/T/S/D/C/P/O/F means reversed:"
  7439. what)
  7440. (setq sorting-type (read-char-exclusive))
  7441. (and (= (downcase sorting-type) ?f)
  7442. (setq getkey-func
  7443. (org-icompleting-read "Sort using function: "
  7444. obarray 'fboundp t nil nil))
  7445. (setq getkey-func (intern getkey-func)))
  7446. (and (= (downcase sorting-type) ?r)
  7447. (setq property
  7448. (org-icompleting-read "Property: "
  7449. (mapcar 'list (org-buffer-property-keys t))
  7450. nil t))))
  7451. (message "Sorting entries...")
  7452. (save-restriction
  7453. (narrow-to-region start end)
  7454. (let ((dcst (downcase sorting-type))
  7455. (case-fold-search nil)
  7456. (now (current-time)))
  7457. (sort-subr
  7458. (/= dcst sorting-type)
  7459. ;; This function moves to the beginning character of the "record" to
  7460. ;; be sorted.
  7461. (lambda nil
  7462. (if (re-search-forward re nil t)
  7463. (goto-char (match-beginning 0))
  7464. (goto-char (point-max))))
  7465. ;; This function moves to the last character of the "record" being
  7466. ;; sorted.
  7467. (lambda nil
  7468. (save-match-data
  7469. (condition-case nil
  7470. (outline-forward-same-level 1)
  7471. (error
  7472. (goto-char (point-max))))))
  7473. ;; This function returns the value that gets sorted against.
  7474. (lambda nil
  7475. (cond
  7476. ((= dcst ?n)
  7477. (if (looking-at org-complex-heading-regexp)
  7478. (string-to-number (match-string 4))
  7479. nil))
  7480. ((= dcst ?a)
  7481. (if (looking-at org-complex-heading-regexp)
  7482. (funcall case-func (match-string 4))
  7483. nil))
  7484. ((= dcst ?t)
  7485. (let ((end (save-excursion (outline-next-heading) (point))))
  7486. (if (or (re-search-forward org-ts-regexp end t)
  7487. (re-search-forward org-ts-regexp-both end t))
  7488. (org-time-string-to-seconds (match-string 0))
  7489. (org-float-time now))))
  7490. ((= dcst ?c)
  7491. (let ((end (save-excursion (outline-next-heading) (point))))
  7492. (if (re-search-forward
  7493. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7494. end t)
  7495. (org-time-string-to-seconds (match-string 0))
  7496. (org-float-time now))))
  7497. ((= dcst ?s)
  7498. (let ((end (save-excursion (outline-next-heading) (point))))
  7499. (if (re-search-forward org-scheduled-time-regexp end t)
  7500. (org-time-string-to-seconds (match-string 1))
  7501. (org-float-time now))))
  7502. ((= dcst ?d)
  7503. (let ((end (save-excursion (outline-next-heading) (point))))
  7504. (if (re-search-forward org-deadline-time-regexp end t)
  7505. (org-time-string-to-seconds (match-string 1))
  7506. (org-float-time now))))
  7507. ((= dcst ?p)
  7508. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7509. (string-to-char (match-string 2))
  7510. org-default-priority))
  7511. ((= dcst ?r)
  7512. (or (org-entry-get nil property) ""))
  7513. ((= dcst ?o)
  7514. (if (looking-at org-complex-heading-regexp)
  7515. (- 9999 (length (member (match-string 2)
  7516. org-todo-keywords-1)))))
  7517. ((= dcst ?f)
  7518. (if getkey-func
  7519. (progn
  7520. (setq tmp (funcall getkey-func))
  7521. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7522. tmp)
  7523. (error "Invalid key function `%s'" getkey-func)))
  7524. (t (error "Invalid sorting type `%c'" sorting-type))))
  7525. nil
  7526. (cond
  7527. ((= dcst ?a) 'string<)
  7528. ((= dcst ?f) compare-func)
  7529. ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
  7530. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7531. (message "Sorting entries...done")))
  7532. (defun org-do-sort (table what &optional with-case sorting-type)
  7533. "Sort TABLE of WHAT according to SORTING-TYPE.
  7534. The user will be prompted for the SORTING-TYPE if the call to this
  7535. function does not specify it. WHAT is only for the prompt, to indicate
  7536. what is being sorted. The sorting key will be extracted from
  7537. the car of the elements of the table.
  7538. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7539. (unless sorting-type
  7540. (message
  7541. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  7542. what)
  7543. (setq sorting-type (read-char-exclusive)))
  7544. (let ((dcst (downcase sorting-type))
  7545. extractfun comparefun)
  7546. ;; Define the appropriate functions
  7547. (cond
  7548. ((= dcst ?n)
  7549. (setq extractfun 'string-to-number
  7550. comparefun (if (= dcst sorting-type) '< '>)))
  7551. ((= dcst ?a)
  7552. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7553. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7554. comparefun (if (= dcst sorting-type)
  7555. 'string<
  7556. (lambda (a b) (and (not (string< a b))
  7557. (not (string= a b)))))))
  7558. ((= dcst ?t)
  7559. (setq extractfun
  7560. (lambda (x)
  7561. (if (or (string-match org-ts-regexp x)
  7562. (string-match org-ts-regexp-both x))
  7563. (org-float-time
  7564. (org-time-string-to-time (match-string 0 x)))
  7565. 0))
  7566. comparefun (if (= dcst sorting-type) '< '>)))
  7567. (t (error "Invalid sorting type `%c'" sorting-type)))
  7568. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7569. table)
  7570. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7571. ;;; The orgstruct minor mode
  7572. ;; Define a minor mode which can be used in other modes in order to
  7573. ;; integrate the org-mode structure editing commands.
  7574. ;; This is really a hack, because the org-mode structure commands use
  7575. ;; keys which normally belong to the major mode. Here is how it
  7576. ;; works: The minor mode defines all the keys necessary to operate the
  7577. ;; structure commands, but wraps the commands into a function which
  7578. ;; tests if the cursor is currently at a headline or a plain list
  7579. ;; item. If that is the case, the structure command is used,
  7580. ;; temporarily setting many Org-mode variables like regular
  7581. ;; expressions for filling etc. However, when any of those keys is
  7582. ;; used at a different location, function uses `key-binding' to look
  7583. ;; up if the key has an associated command in another currently active
  7584. ;; keymap (minor modes, major mode, global), and executes that
  7585. ;; command. There might be problems if any of the keys is otherwise
  7586. ;; used as a prefix key.
  7587. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  7588. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  7589. ;; addresses this by checking explicitly for both bindings.
  7590. (defvar orgstruct-mode-map (make-sparse-keymap)
  7591. "Keymap for the minor `orgstruct-mode'.")
  7592. (defvar org-local-vars nil
  7593. "List of local variables, for use by `orgstruct-mode'.")
  7594. ;;;###autoload
  7595. (define-minor-mode orgstruct-mode
  7596. "Toggle the minor mode `orgstruct-mode'.
  7597. This mode is for using Org-mode structure commands in other
  7598. modes. The following keys behave as if Org-mode were active, if
  7599. the cursor is on a headline, or on a plain list item (both as
  7600. defined by Org-mode).
  7601. M-up Move entry/item up
  7602. M-down Move entry/item down
  7603. M-left Promote
  7604. M-right Demote
  7605. M-S-up Move entry/item up
  7606. M-S-down Move entry/item down
  7607. M-S-left Promote subtree
  7608. M-S-right Demote subtree
  7609. M-q Fill paragraph and items like in Org-mode
  7610. C-c ^ Sort entries
  7611. C-c - Cycle list bullet
  7612. TAB Cycle item visibility
  7613. M-RET Insert new heading/item
  7614. S-M-RET Insert new TODO heading / Checkbox item
  7615. C-c C-c Set tags / toggle checkbox"
  7616. nil " OrgStruct" nil
  7617. (org-load-modules-maybe)
  7618. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7619. ;;;###autoload
  7620. (defun turn-on-orgstruct ()
  7621. "Unconditionally turn on `orgstruct-mode'."
  7622. (orgstruct-mode 1))
  7623. (defvar org-fb-vars nil)
  7624. (make-variable-buffer-local 'org-fb-vars)
  7625. (defun orgstruct++-mode (&optional arg)
  7626. "Toggle `orgstruct-mode', the enhanced version of it.
  7627. In addition to setting orgstruct-mode, this also exports all
  7628. indentation and autofilling variables from org-mode into the
  7629. buffer. It will also recognize item context in multiline items."
  7630. (interactive "P")
  7631. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7632. (if (< arg 1)
  7633. (progn (orgstruct-mode -1)
  7634. (mapc (lambda(v)
  7635. (org-set-local (car v)
  7636. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  7637. org-fb-vars))
  7638. (orgstruct-mode 1)
  7639. (setq org-fb-vars nil)
  7640. (let (var val)
  7641. (mapc
  7642. (lambda (x)
  7643. (when (string-match
  7644. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
  7645. (symbol-name (car x)))
  7646. (setq var (car x) val (nth 1 x))
  7647. (push (list var `(quote ,(eval var))) org-fb-vars)
  7648. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7649. org-local-vars)
  7650. (org-set-local 'orgstruct-is-++ t))))
  7651. (defvar orgstruct-is-++ nil
  7652. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  7653. (make-variable-buffer-local 'orgstruct-is-++)
  7654. ;;;###autoload
  7655. (defun turn-on-orgstruct++ ()
  7656. "Unconditionally turn on `orgstruct++-mode'."
  7657. (orgstruct++-mode 1))
  7658. (defun orgstruct-error ()
  7659. "Error when there is no default binding for a structure key."
  7660. (interactive)
  7661. (error "This key has no function outside structure elements"))
  7662. (defun orgstruct-setup ()
  7663. "Setup orgstruct keymaps."
  7664. (let ((nfunc 0)
  7665. (bindings
  7666. (list
  7667. '([(meta up)] org-metaup)
  7668. '([(meta down)] org-metadown)
  7669. '([(meta left)] org-metaleft)
  7670. '([(meta right)] org-metaright)
  7671. '([(meta shift up)] org-shiftmetaup)
  7672. '([(meta shift down)] org-shiftmetadown)
  7673. '([(meta shift left)] org-shiftmetaleft)
  7674. '([(meta shift right)] org-shiftmetaright)
  7675. '([?\e (up)] org-metaup)
  7676. '([?\e (down)] org-metadown)
  7677. '([?\e (left)] org-metaleft)
  7678. '([?\e (right)] org-metaright)
  7679. '([?\e (shift up)] org-shiftmetaup)
  7680. '([?\e (shift down)] org-shiftmetadown)
  7681. '([?\e (shift left)] org-shiftmetaleft)
  7682. '([?\e (shift right)] org-shiftmetaright)
  7683. '([(shift up)] org-shiftup)
  7684. '([(shift down)] org-shiftdown)
  7685. '([(shift left)] org-shiftleft)
  7686. '([(shift right)] org-shiftright)
  7687. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7688. '("\M-q" fill-paragraph)
  7689. '("\C-c^" org-sort)
  7690. '("\C-c-" org-cycle-list-bullet)))
  7691. elt key fun cmd)
  7692. (while (setq elt (pop bindings))
  7693. (setq nfunc (1+ nfunc))
  7694. (setq key (org-key (car elt))
  7695. fun (nth 1 elt)
  7696. cmd (orgstruct-make-binding fun nfunc key))
  7697. (org-defkey orgstruct-mode-map key cmd))
  7698. ;; Prevent an error for users who forgot to make autoloads
  7699. (require 'org-element)
  7700. ;; Special treatment needed for TAB and RET
  7701. (org-defkey orgstruct-mode-map [(tab)]
  7702. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7703. (org-defkey orgstruct-mode-map "\C-i"
  7704. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7705. (org-defkey orgstruct-mode-map "\M-\C-m"
  7706. (orgstruct-make-binding 'org-insert-heading 105
  7707. "\M-\C-m" [(meta return)]))
  7708. (org-defkey orgstruct-mode-map [(meta return)]
  7709. (orgstruct-make-binding 'org-insert-heading 106
  7710. [(meta return)] "\M-\C-m"))
  7711. (org-defkey orgstruct-mode-map [(shift meta return)]
  7712. (orgstruct-make-binding 'org-insert-todo-heading 107
  7713. [(meta return)] "\M-\C-m"))
  7714. (org-defkey orgstruct-mode-map "\e\C-m"
  7715. (orgstruct-make-binding 'org-insert-heading 108
  7716. "\e\C-m" [?\e (return)]))
  7717. (org-defkey orgstruct-mode-map [?\e (return)]
  7718. (orgstruct-make-binding 'org-insert-heading 109
  7719. [?\e (return)] "\e\C-m"))
  7720. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7721. (orgstruct-make-binding 'org-insert-todo-heading 110
  7722. [?\e (return)] "\e\C-m"))
  7723. (unless org-local-vars
  7724. (setq org-local-vars (org-get-local-variables)))
  7725. t))
  7726. (defun orgstruct-make-binding (fun n &rest keys)
  7727. "Create a function for binding in the structure minor mode.
  7728. FUN is the command to call inside a table. N is used to create a unique
  7729. command name. KEYS are keys that should be checked in for a command
  7730. to execute outside of tables."
  7731. (eval
  7732. (list 'defun
  7733. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7734. '(arg)
  7735. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7736. "Outside of structure, run the binding of `"
  7737. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7738. "'.")
  7739. '(interactive "p")
  7740. (list 'if
  7741. `(org-context-p 'headline 'item
  7742. (and orgstruct-is-++
  7743. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7744. 'item-body))
  7745. (list 'org-run-like-in-org-mode (list 'quote fun))
  7746. (list 'let '(orgstruct-mode)
  7747. (list 'call-interactively
  7748. (append '(or)
  7749. (mapcar (lambda (k)
  7750. (list 'key-binding k))
  7751. keys)
  7752. '('orgstruct-error))))))))
  7753. (defun org-contextualize-keys (alist contexts)
  7754. "Return valid elements in ALIST depending on CONTEXTS.
  7755. `org-agenda-custom-commands' or `org-capture-templates' are the
  7756. values used for ALIST, and `org-agenda-custom-commands-contexts'
  7757. or `org-capture-templates-contexts' are the associated contexts
  7758. definitions."
  7759. (let ((contexts
  7760. ;; normalize contexts
  7761. (mapcar
  7762. (lambda(c) (cond ((listp (cadr c))
  7763. (list (car c) (car c) (cadr c)))
  7764. ((string= "" (cadr c))
  7765. (list (car c) (car c) (caddr c)))
  7766. (t c))) contexts))
  7767. (a alist) c r s)
  7768. ;; loop over all commands or templates
  7769. (while (setq c (pop a))
  7770. (let (vrules repl)
  7771. (cond
  7772. ((not (assoc (car c) contexts))
  7773. (push c r))
  7774. ((and (assoc (car c) contexts)
  7775. (setq vrules (org-contextualize-validate-key
  7776. (car c) contexts)))
  7777. (mapc (lambda (vr)
  7778. (when (not (equal (car vr) (cadr vr)))
  7779. (setq repl vr))) vrules)
  7780. (if (not repl) (push c r)
  7781. (push (cadr repl) s)
  7782. (push
  7783. (cons (car c)
  7784. (cdr (or (assoc (cadr repl) alist)
  7785. (error "Undefined key `%s' as contextual replacement for `%s'"
  7786. (cadr repl) (car c)))))
  7787. r))))))
  7788. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  7789. (delq
  7790. nil
  7791. (delete-dups
  7792. (mapcar (lambda (x)
  7793. (let ((tpl (car x)))
  7794. (when (not (delq
  7795. nil
  7796. (mapcar (lambda(y)
  7797. (equal y tpl)) s))) x)))
  7798. (reverse r))))))
  7799. (defun org-contextualize-validate-key (key contexts)
  7800. "Check CONTEXTS for agenda or capture KEY."
  7801. (let (r rr res)
  7802. (while (setq r (pop contexts))
  7803. (mapc
  7804. (lambda (rr)
  7805. (when
  7806. (and (equal key (car r))
  7807. (if (functionp rr) (funcall rr)
  7808. (or (and (eq (car rr) 'in-file)
  7809. (buffer-file-name)
  7810. (string-match (cdr rr) (buffer-file-name)))
  7811. (and (eq (car rr) 'in-mode)
  7812. (string-match (cdr rr) (symbol-name major-mode)))
  7813. (when (and (eq (car rr) 'not-in-file)
  7814. (buffer-file-name))
  7815. (not (string-match (cdr rr) (buffer-file-name))))
  7816. (when (eq (car rr) 'not-in-mode)
  7817. (not (string-match (cdr rr) (symbol-name major-mode)))))))
  7818. (push r res)))
  7819. (car (last r))))
  7820. (delete-dups (delq nil res))))
  7821. (defun org-context-p (&rest contexts)
  7822. "Check if local context is any of CONTEXTS.
  7823. Possible values in the list of contexts are `table', `headline', and `item'."
  7824. (let ((pos (point)))
  7825. (goto-char (point-at-bol))
  7826. (prog1 (or (and (memq 'table contexts)
  7827. (looking-at "[ \t]*|"))
  7828. (and (memq 'headline contexts)
  7829. (looking-at org-outline-regexp))
  7830. (and (memq 'item contexts)
  7831. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7832. (and (memq 'item-body contexts)
  7833. (org-in-item-p)))
  7834. (goto-char pos))))
  7835. (defun org-get-local-variables ()
  7836. "Return a list of all local variables in an Org mode buffer."
  7837. (let (varlist)
  7838. (with-current-buffer (get-buffer-create "*Org tmp*")
  7839. (erase-buffer)
  7840. (org-mode)
  7841. (setq varlist (buffer-local-variables)))
  7842. (kill-buffer "*Org tmp*")
  7843. (delq nil
  7844. (mapcar
  7845. (lambda (x)
  7846. (setq x
  7847. (if (symbolp x)
  7848. (list x)
  7849. (list (car x) (list 'quote (cdr x)))))
  7850. (if (string-match
  7851. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  7852. (symbol-name (car x)))
  7853. x nil))
  7854. varlist))))
  7855. (defun org-clone-local-variables (from-buffer &optional regexp)
  7856. "Clone local variables from FROM-BUFFER.
  7857. Optional argument REGEXP selects variables to clone."
  7858. (mapc
  7859. (lambda (pair)
  7860. (and (symbolp (car pair))
  7861. (or (null regexp)
  7862. (string-match regexp (symbol-name (car pair))))
  7863. (set (make-local-variable (car pair))
  7864. (cdr pair))))
  7865. (buffer-local-variables from-buffer)))
  7866. ;;;###autoload
  7867. (defun org-run-like-in-org-mode (cmd)
  7868. "Run a command, pretending that the current buffer is in Org-mode.
  7869. This will temporarily bind local variables that are typically bound in
  7870. Org-mode to the values they have in Org-mode, and then interactively
  7871. call CMD."
  7872. (org-load-modules-maybe)
  7873. (unless org-local-vars
  7874. (setq org-local-vars (org-get-local-variables)))
  7875. (eval (list 'let org-local-vars
  7876. (list 'call-interactively (list 'quote cmd)))))
  7877. ;;;; Archiving
  7878. (defun org-get-category (&optional pos force-refresh)
  7879. "Get the category applying to position POS."
  7880. (save-match-data
  7881. (if force-refresh (org-refresh-category-properties))
  7882. (let ((pos (or pos (point))))
  7883. (or (get-text-property pos 'org-category)
  7884. (progn (org-refresh-category-properties)
  7885. (get-text-property pos 'org-category))))))
  7886. (defun org-refresh-category-properties ()
  7887. "Refresh category text properties in the buffer."
  7888. (let ((case-fold-search t)
  7889. (inhibit-read-only t)
  7890. (def-cat (cond
  7891. ((null org-category)
  7892. (if buffer-file-name
  7893. (file-name-sans-extension
  7894. (file-name-nondirectory buffer-file-name))
  7895. "???"))
  7896. ((symbolp org-category) (symbol-name org-category))
  7897. (t org-category)))
  7898. beg end cat pos optionp)
  7899. (org-unmodified
  7900. (save-excursion
  7901. (save-restriction
  7902. (widen)
  7903. (goto-char (point-min))
  7904. (put-text-property (point) (point-max) 'org-category def-cat)
  7905. (while (re-search-forward
  7906. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7907. (setq pos (match-end 0)
  7908. optionp (equal (char-after (match-beginning 0)) ?#)
  7909. cat (org-trim (match-string 2)))
  7910. (if optionp
  7911. (setq beg (point-at-bol) end (point-max))
  7912. (org-back-to-heading t)
  7913. (setq beg (point) end (org-end-of-subtree t t)))
  7914. (put-text-property beg end 'org-category cat)
  7915. (put-text-property beg end 'org-category-position beg)
  7916. (goto-char pos)))))))
  7917. ;;;; Link Stuff
  7918. ;;; Link abbreviations
  7919. (defun org-link-expand-abbrev (link)
  7920. "Apply replacements as defined in `org-link-abbrev-alist'."
  7921. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  7922. (let* ((key (match-string 1 link))
  7923. (as (or (assoc key org-link-abbrev-alist-local)
  7924. (assoc key org-link-abbrev-alist)))
  7925. (tag (and (match-end 2) (match-string 3 link)))
  7926. rpl)
  7927. (if (not as)
  7928. link
  7929. (setq rpl (cdr as))
  7930. (cond
  7931. ((symbolp rpl) (funcall rpl tag))
  7932. ((string-match "%(\\([^)]+\\))" rpl)
  7933. (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
  7934. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7935. ((string-match "%h" rpl)
  7936. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7937. (t (concat rpl tag)))))
  7938. link))
  7939. ;;; Storing and inserting links
  7940. (defvar org-insert-link-history nil
  7941. "Minibuffer history for links inserted with `org-insert-link'.")
  7942. (defvar org-stored-links nil
  7943. "Contains the links stored with `org-store-link'.")
  7944. (defvar org-store-link-plist nil
  7945. "Plist with info about the most recently link created with `org-store-link'.")
  7946. (defvar org-link-protocols nil
  7947. "Link protocols added to Org-mode using `org-add-link-type'.")
  7948. (defvar org-store-link-functions nil
  7949. "List of functions that are called to create and store a link.
  7950. Each function will be called in turn until one returns a non-nil
  7951. value. Each function should check if it is responsible for creating
  7952. this link (for example by looking at the major mode).
  7953. If not, it must exit and return nil.
  7954. If yes, it should return a non-nil value after a calling
  7955. `org-store-link-props' with a list of properties and values.
  7956. Special properties are:
  7957. :type The link prefix, like \"http\". This must be given.
  7958. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7959. This is obligatory as well.
  7960. :description Optional default description for the second pair
  7961. of brackets in an Org-mode link. The user can still change
  7962. this when inserting this link into an Org-mode buffer.
  7963. In addition to these, any additional properties can be specified
  7964. and then used in capture templates.")
  7965. (defun org-add-link-type (type &optional follow export)
  7966. "Add TYPE to the list of `org-link-types'.
  7967. Re-compute all regular expressions depending on `org-link-types'
  7968. FOLLOW and EXPORT are two functions.
  7969. FOLLOW should take the link path as the single argument and do whatever
  7970. is necessary to follow the link, for example find a file or display
  7971. a mail message.
  7972. EXPORT should format the link path for export to one of the export formats.
  7973. It should be a function accepting three arguments:
  7974. path the path of the link, the text after the prefix (like \"http:\")
  7975. desc the description of the link, if any, or a description added by
  7976. org-export-normalize-links if there is none
  7977. format the export format, a symbol like `html' or `latex' or `ascii'..
  7978. The function may use the FORMAT information to return different values
  7979. depending on the format. The return value will be put literally into
  7980. the exported file. If the return value is nil, this means Org should
  7981. do what it normally does with links which do not have EXPORT defined.
  7982. Org-mode has a built-in default for exporting links. If you are happy with
  7983. this default, there is no need to define an export function for the link
  7984. type. For a simple example of an export function, see `org-bbdb.el'."
  7985. (add-to-list 'org-link-types type t)
  7986. (org-make-link-regexps)
  7987. (if (assoc type org-link-protocols)
  7988. (setcdr (assoc type org-link-protocols) (list follow export))
  7989. (push (list type follow export) org-link-protocols)))
  7990. (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
  7991. (defvar org-link-to-org-use-id) ; Defined in org-id.el
  7992. ;;;###autoload
  7993. (defun org-store-link (arg)
  7994. "\\<org-mode-map>Store an org-link to the current location.
  7995. This link is added to `org-stored-links' and can later be inserted
  7996. into an org-buffer with \\[org-insert-link].
  7997. For some link types, a prefix arg is interpreted:
  7998. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  7999. For file links, arg negates `org-context-in-file-links'."
  8000. (interactive "P")
  8001. (org-load-modules-maybe)
  8002. (setq org-store-link-plist nil) ; reset
  8003. (org-with-limited-levels
  8004. (let (link cpltxt desc description search txt custom-id agenda-link)
  8005. (cond
  8006. ((run-hook-with-args-until-success 'org-store-link-functions)
  8007. (setq link (plist-get org-store-link-plist :link)
  8008. desc (or (plist-get org-store-link-plist :description) link)))
  8009. ((org-src-edit-buffer-p)
  8010. (let (label gc)
  8011. (while (or (not label)
  8012. (save-excursion
  8013. (save-restriction
  8014. (widen)
  8015. (goto-char (point-min))
  8016. (re-search-forward
  8017. (regexp-quote (format org-coderef-label-format label))
  8018. nil t))))
  8019. (when label (message "Label exists already") (sit-for 2))
  8020. (setq label (read-string "Code line label: " label)))
  8021. (end-of-line 1)
  8022. (setq link (format org-coderef-label-format label))
  8023. (setq gc (- 79 (length link)))
  8024. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  8025. (insert link)
  8026. (setq link (concat "(" label ")") desc nil)))
  8027. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  8028. ;; We are in the agenda, link to referenced location
  8029. (let ((m (or (get-text-property (point) 'org-hd-marker)
  8030. (get-text-property (point) 'org-marker))))
  8031. (when m
  8032. (org-with-point-at m
  8033. (setq agenda-link
  8034. (if (org-called-interactively-p 'any)
  8035. (call-interactively 'org-store-link)
  8036. (org-store-link nil)))))))
  8037. ((eq major-mode 'calendar-mode)
  8038. (let ((cd (calendar-cursor-to-date)))
  8039. (setq link
  8040. (format-time-string
  8041. (car org-time-stamp-formats)
  8042. (apply 'encode-time
  8043. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  8044. nil nil nil))))
  8045. (org-store-link-props :type "calendar" :date cd)))
  8046. ((eq major-mode 'help-mode)
  8047. (setq link (concat "help:" (save-excursion
  8048. (goto-char (point-min))
  8049. (looking-at "^[^ ]+")
  8050. (match-string 0))))
  8051. (org-store-link-props :type "help"))
  8052. ((eq major-mode 'w3-mode)
  8053. (setq cpltxt (if (and (buffer-name)
  8054. (not (string-match "Untitled" (buffer-name))))
  8055. (buffer-name)
  8056. (url-view-url t))
  8057. link (url-view-url t))
  8058. (org-store-link-props :type "w3" :url (url-view-url t)))
  8059. ((eq major-mode 'w3m-mode)
  8060. (setq cpltxt (or w3m-current-title w3m-current-url)
  8061. link w3m-current-url)
  8062. (org-store-link-props :type "w3m" :url (url-view-url t)))
  8063. ((setq search (run-hook-with-args-until-success
  8064. 'org-create-file-search-functions))
  8065. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  8066. "::" search))
  8067. (setq cpltxt (or description link)))
  8068. ((eq major-mode 'image-mode)
  8069. (setq cpltxt (concat "file:"
  8070. (abbreviate-file-name buffer-file-name))
  8071. link cpltxt)
  8072. (org-store-link-props :type "image" :file buffer-file-name))
  8073. ((eq major-mode 'dired-mode)
  8074. ;; link to the file in the current line
  8075. (let ((file (dired-get-filename nil t)))
  8076. (setq file (if file
  8077. (abbreviate-file-name
  8078. (expand-file-name (dired-get-filename nil t)))
  8079. ;; otherwise, no file so use current directory.
  8080. default-directory))
  8081. (setq cpltxt (concat "file:" file)
  8082. link cpltxt)))
  8083. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  8084. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  8085. (cond
  8086. ((org-in-regexp "<<\\(.*?\\)>>")
  8087. (setq cpltxt
  8088. (concat "file:"
  8089. (abbreviate-file-name
  8090. (buffer-file-name (buffer-base-buffer)))
  8091. "::" (match-string 1))
  8092. link cpltxt))
  8093. ((and (featurep 'org-id)
  8094. (or (eq org-link-to-org-use-id t)
  8095. (and (org-called-interactively-p 'any)
  8096. (or (eq org-link-to-org-use-id 'create-if-interactive)
  8097. (and (eq org-link-to-org-use-id
  8098. 'create-if-interactive-and-no-custom-id)
  8099. (not custom-id))))
  8100. (and org-link-to-org-use-id (org-entry-get nil "ID"))))
  8101. ;; We can make a link using the ID.
  8102. (setq link (condition-case nil
  8103. (prog1 (org-id-store-link)
  8104. (setq desc (plist-get org-store-link-plist :description)))
  8105. (error
  8106. ;; probably before first headline, link to file only
  8107. (concat "file:"
  8108. (abbreviate-file-name
  8109. (buffer-file-name (buffer-base-buffer))))))))
  8110. (t
  8111. ;; Just link to current headline
  8112. (setq cpltxt (concat "file:"
  8113. (abbreviate-file-name
  8114. (buffer-file-name (buffer-base-buffer)))))
  8115. ;; Add a context search string
  8116. (when (org-xor org-context-in-file-links arg)
  8117. (setq txt (cond
  8118. ((org-at-heading-p) nil)
  8119. ((org-region-active-p)
  8120. (buffer-substring (region-beginning) (region-end)))))
  8121. (when (or (null txt) (string-match "\\S-" txt))
  8122. (setq cpltxt
  8123. (concat cpltxt "::"
  8124. (condition-case nil
  8125. (org-make-org-heading-search-string txt)
  8126. (error "")))
  8127. desc (or (nth 4 (ignore-errors
  8128. (org-heading-components))) "NONE"))))
  8129. (if (string-match "::\\'" cpltxt)
  8130. (setq cpltxt (substring cpltxt 0 -2)))
  8131. (setq link cpltxt))))
  8132. ((buffer-file-name (buffer-base-buffer))
  8133. ;; Just link to this file here.
  8134. (setq cpltxt (concat "file:"
  8135. (abbreviate-file-name
  8136. (buffer-file-name (buffer-base-buffer)))))
  8137. ;; Add a context string
  8138. (when (org-xor org-context-in-file-links arg)
  8139. (setq txt (if (org-region-active-p)
  8140. (buffer-substring (region-beginning) (region-end))
  8141. (buffer-substring (point-at-bol) (point-at-eol))))
  8142. ;; Only use search option if there is some text.
  8143. (when (string-match "\\S-" txt)
  8144. (setq cpltxt
  8145. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8146. desc "NONE")))
  8147. (setq link cpltxt))
  8148. ((org-called-interactively-p 'interactive)
  8149. (error "Cannot link to a buffer which is not visiting a file"))
  8150. (t (setq link nil)))
  8151. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8152. (setq link (or link cpltxt)
  8153. desc (or desc cpltxt))
  8154. (if (equal desc "NONE") (setq desc nil))
  8155. (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
  8156. (progn
  8157. (setq org-stored-links
  8158. (cons (list link desc) org-stored-links))
  8159. (message "Stored: %s" (or desc link))
  8160. (when custom-id
  8161. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  8162. "::#" custom-id))
  8163. (setq org-stored-links
  8164. (cons (list link desc) org-stored-links))))
  8165. (or agenda-link (and link (org-make-link-string link desc)))))))
  8166. (defun org-store-link-props (&rest plist)
  8167. "Store link properties, extract names and addresses."
  8168. (let (x adr)
  8169. (when (setq x (plist-get plist :from))
  8170. (setq adr (mail-extract-address-components x))
  8171. (setq plist (plist-put plist :fromname (car adr)))
  8172. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8173. (when (setq x (plist-get plist :to))
  8174. (setq adr (mail-extract-address-components x))
  8175. (setq plist (plist-put plist :toname (car adr)))
  8176. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8177. (let ((from (plist-get plist :from))
  8178. (to (plist-get plist :to)))
  8179. (when (and from to org-from-is-user-regexp)
  8180. (setq plist
  8181. (plist-put plist :fromto
  8182. (if (string-match org-from-is-user-regexp from)
  8183. (concat "to %t")
  8184. (concat "from %f"))))))
  8185. (setq org-store-link-plist plist))
  8186. (defun org-add-link-props (&rest plist)
  8187. "Add these properties to the link property list."
  8188. (let (key value)
  8189. (while plist
  8190. (setq key (pop plist) value (pop plist))
  8191. (setq org-store-link-plist
  8192. (plist-put org-store-link-plist key value)))))
  8193. (defun org-email-link-description (&optional fmt)
  8194. "Return the description part of an email link.
  8195. This takes information from `org-store-link-plist' and formats it
  8196. according to FMT (default from `org-email-link-description-format')."
  8197. (setq fmt (or fmt org-email-link-description-format))
  8198. (let* ((p org-store-link-plist)
  8199. (to (plist-get p :toaddress))
  8200. (from (plist-get p :fromaddress))
  8201. (table
  8202. (list
  8203. (cons "%c" (plist-get p :fromto))
  8204. (cons "%F" (plist-get p :from))
  8205. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8206. (cons "%T" (plist-get p :to))
  8207. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8208. (cons "%s" (plist-get p :subject))
  8209. (cons "%d" (plist-get p :date))
  8210. (cons "%m" (plist-get p :message-id)))))
  8211. (when (string-match "%c" fmt)
  8212. ;; Check if the user wrote this message
  8213. (if (and org-from-is-user-regexp from to
  8214. (save-match-data (string-match org-from-is-user-regexp from)))
  8215. (setq fmt (replace-match "to %t" t t fmt))
  8216. (setq fmt (replace-match "from %f" t t fmt))))
  8217. (org-replace-escapes fmt table)))
  8218. (defun org-make-org-heading-search-string (&optional string heading)
  8219. "Make search string for STRING or current headline."
  8220. (interactive)
  8221. (let ((s (or string (org-get-heading)))
  8222. (lines org-context-in-file-links))
  8223. (unless (and string (not heading))
  8224. ;; We are using a headline, clean up garbage in there.
  8225. (if (string-match org-todo-regexp s)
  8226. (setq s (replace-match "" t t s)))
  8227. (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
  8228. (setq s (replace-match "" t t s)))
  8229. (setq s (org-trim s))
  8230. (if (string-match (concat "^\\(" org-quote-string "\\|"
  8231. org-comment-string "\\)") s)
  8232. (setq s (replace-match "" t t s)))
  8233. (while (string-match org-ts-regexp s)
  8234. (setq s (replace-match "" t t s))))
  8235. (or string (setq s (concat "*" s))) ; Add * for headlines
  8236. (when (and string (integerp lines) (> lines 0))
  8237. (let ((slines (org-split-string s "\n")))
  8238. (when (< lines (length slines))
  8239. (setq s (mapconcat
  8240. 'identity
  8241. (reverse (nthcdr (- (length slines) lines)
  8242. (reverse slines))) "\n")))))
  8243. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8244. (defun org-make-link-string (link &optional description)
  8245. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8246. (unless (string-match "\\S-" link)
  8247. (error "Empty link"))
  8248. (when (and description
  8249. (stringp description)
  8250. (not (string-match "\\S-" description)))
  8251. (setq description nil))
  8252. (when (stringp description)
  8253. ;; Remove brackets from the description, they are fatal.
  8254. (while (string-match "\\[" description)
  8255. (setq description (replace-match "{" t t description)))
  8256. (while (string-match "\\]" description)
  8257. (setq description (replace-match "}" t t description))))
  8258. (when (equal link description)
  8259. ;; No description needed, it is identical
  8260. (setq description nil))
  8261. (when (and (not description)
  8262. (not (string-match (org-image-file-name-regexp) link))
  8263. (not (equal link (org-link-escape link))))
  8264. (setq description (org-extract-attributes link)))
  8265. (setq link
  8266. (cond ((string-match (org-image-file-name-regexp) link) link)
  8267. ((string-match org-link-types-re link)
  8268. (concat (match-string 1 link)
  8269. (org-link-escape (substring link (match-end 1)))))
  8270. (t (org-link-escape link))))
  8271. (concat "[[" link "]"
  8272. (if description (concat "[" description "]") "")
  8273. "]"))
  8274. (defconst org-link-escape-chars
  8275. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  8276. "List of characters that should be escaped in link.
  8277. This is the list that is used for internal purposes.")
  8278. (defconst org-link-escape-chars-browser
  8279. '(?\ )
  8280. "List of escapes for characters that are problematic in links.
  8281. This is the list that is used before handing over to the browser.")
  8282. (defun org-link-escape (text &optional table merge)
  8283. "Return percent escaped representation of TEXT.
  8284. TEXT is a string with the text to escape.
  8285. Optional argument TABLE is a list with characters that should be
  8286. escaped. When nil, `org-link-escape-chars' is used.
  8287. If optional argument MERGE is set, merge TABLE into
  8288. `org-link-escape-chars'."
  8289. (cond
  8290. ((and table merge)
  8291. (mapc (lambda (defchr)
  8292. (unless (member defchr table)
  8293. (setq table (cons defchr table)))) org-link-escape-chars))
  8294. ((null table)
  8295. (setq table org-link-escape-chars)))
  8296. (mapconcat
  8297. (lambda (char)
  8298. (if (or (member char table)
  8299. (and (or (< char 32) (= char 37) (> char 126))
  8300. org-url-hexify-p))
  8301. (mapconcat (lambda (sequence-element)
  8302. (format "%%%.2X" sequence-element))
  8303. (or (encode-coding-char char 'utf-8)
  8304. (error "Unable to percent escape character: %s"
  8305. (char-to-string char))) "")
  8306. (char-to-string char))) text ""))
  8307. (defun org-link-unescape (str)
  8308. "Unhex hexified Unicode strings as returned from the JavaScript function
  8309. encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
  8310. (unless (and (null str) (string= "" str))
  8311. (let ((pos 0) (case-fold-search t) unhexed)
  8312. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8313. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8314. (setq str (replace-match unhexed t t str))
  8315. (setq pos (+ pos (length unhexed))))))
  8316. str)
  8317. (defun org-link-unescape-compound (hex)
  8318. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
  8319. Note: this function also decodes single byte encodings like
  8320. `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
  8321. (save-match-data
  8322. (let* ((bytes (cdr (split-string hex "%")))
  8323. (ret "")
  8324. (eat 0)
  8325. (sum 0))
  8326. (while bytes
  8327. (let* ((val (string-to-number (pop bytes) 16))
  8328. (shift-xor
  8329. (if (= 0 eat)
  8330. (cond
  8331. ((>= val 252) (cons 6 252))
  8332. ((>= val 248) (cons 5 248))
  8333. ((>= val 240) (cons 4 240))
  8334. ((>= val 224) (cons 3 224))
  8335. ((>= val 192) (cons 2 192))
  8336. (t (cons 0 0)))
  8337. (cons 6 128))))
  8338. (if (>= val 192) (setq eat (car shift-xor)))
  8339. (setq val (logxor val (cdr shift-xor)))
  8340. (setq sum (+ (lsh sum (car shift-xor)) val))
  8341. (if (> eat 0) (setq eat (- eat 1)))
  8342. (cond
  8343. ((= 0 eat) ;multi byte
  8344. (setq ret (concat ret (org-char-to-string sum)))
  8345. (setq sum 0))
  8346. ((not bytes) ; single byte(s)
  8347. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8348. )) ;; end (while bytes
  8349. ret )))
  8350. (defun org-link-unescape-single-byte-sequence (hex)
  8351. "Unhexify hex-encoded single byte character sequences."
  8352. (mapconcat (lambda (byte)
  8353. (char-to-string (string-to-number byte 16)))
  8354. (cdr (split-string hex "%")) ""))
  8355. (defun org-xor (a b)
  8356. "Exclusive or."
  8357. (if a (not b) b))
  8358. (defun org-fixup-message-id-for-http (s)
  8359. "Replace special characters in a message id, so it can be used in an http query."
  8360. (when (string-match "%" s)
  8361. (setq s (mapconcat (lambda (c)
  8362. (if (eq c ?%)
  8363. "%25"
  8364. (char-to-string c)))
  8365. s "")))
  8366. (while (string-match "<" s)
  8367. (setq s (replace-match "%3C" t t s)))
  8368. (while (string-match ">" s)
  8369. (setq s (replace-match "%3E" t t s)))
  8370. (while (string-match "@" s)
  8371. (setq s (replace-match "%40" t t s)))
  8372. s)
  8373. (defun org-link-prettify (link)
  8374. "Return a human-readable representation of LINK.
  8375. The car of LINK must be a raw link the cdr of LINK must be either
  8376. a link description or nil."
  8377. (let ((desc (or (cadr link) "<no description>")))
  8378. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8379. "<" (car link) ">")))
  8380. ;;;###autoload
  8381. (defun org-insert-link-global ()
  8382. "Insert a link like Org-mode does.
  8383. This command can be called in any mode to insert a link in Org-mode syntax."
  8384. (interactive)
  8385. (org-load-modules-maybe)
  8386. (org-run-like-in-org-mode 'org-insert-link))
  8387. (defun org-insert-all-links (&optional keep)
  8388. "Insert all links in `org-stored-links'."
  8389. (interactive "P")
  8390. (let ((links (copy-sequence org-stored-links)) l)
  8391. (while (setq l (if keep (pop links) (pop org-stored-links)))
  8392. (insert "- ")
  8393. (org-insert-link nil (car l) (cadr l))
  8394. (insert "\n"))))
  8395. (defun org-link-fontify-links-to-this-file ()
  8396. "Fontify links to the current file in `org-stored-links'."
  8397. (let ((f (buffer-file-name)) a b)
  8398. (setq a (mapcar (lambda(l)
  8399. (let ((ll (car l)))
  8400. (when (and (string-match "^file:\\(.+\\)::" ll)
  8401. (equal f (expand-file-name (match-string 1 ll))))
  8402. ll)))
  8403. org-stored-links))
  8404. (when (featurep 'org-id)
  8405. (setq b (mapcar (lambda(l)
  8406. (let ((ll (car l)))
  8407. (when (and (string-match "^id:\\(.+\\)$" ll)
  8408. (equal f (expand-file-name
  8409. (or (org-id-find-id-file
  8410. (match-string 1 ll)) ""))))
  8411. ll)))
  8412. org-stored-links)))
  8413. (mapcar (lambda(l)
  8414. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  8415. (delq nil (append a b)))))
  8416. (defvar org-link-links-in-this-file nil)
  8417. (defun org-insert-link (&optional complete-file link-location default-description)
  8418. "Insert a link. At the prompt, enter the link.
  8419. Completion can be used to insert any of the link protocol prefixes like
  8420. http or ftp in use.
  8421. The history can be used to select a link previously stored with
  8422. `org-store-link'. When the empty string is entered (i.e. if you just
  8423. press RET at the prompt), the link defaults to the most recently
  8424. stored link. As SPC triggers completion in the minibuffer, you need to
  8425. use M-SPC or C-q SPC to force the insertion of a space character.
  8426. You will also be prompted for a description, and if one is given, it will
  8427. be displayed in the buffer instead of the link.
  8428. If there is already a link at point, this command will allow you to edit link
  8429. and description parts.
  8430. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8431. be selected using completion. The path to the file will be relative to the
  8432. current directory if the file is in the current directory or a subdirectory.
  8433. Otherwise, the link will be the absolute path as completed in the minibuffer
  8434. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8435. option `org-link-file-path-type'.
  8436. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8437. the current directory or below.
  8438. With three \\[universal-argument] prefixes, negate the meaning of
  8439. `org-keep-stored-link-after-insertion'.
  8440. If `org-make-link-description-function' is non-nil, this function will be
  8441. called with the link target, and the result will be the default
  8442. link description.
  8443. If the LINK-LOCATION parameter is non-nil, this value will be
  8444. used as the link location instead of reading one interactively.
  8445. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8446. be used as the default description."
  8447. (interactive "P")
  8448. (let* ((wcf (current-window-configuration))
  8449. (origbuf (current-buffer))
  8450. (region (if (org-region-active-p)
  8451. (buffer-substring (region-beginning) (region-end))))
  8452. (remove (and region (list (region-beginning) (region-end))))
  8453. (desc region)
  8454. tmphist ; byte-compile incorrectly complains about this
  8455. (link link-location)
  8456. (abbrevs org-link-abbrev-alist-local)
  8457. entry file all-prefixes auto-desc)
  8458. (cond
  8459. (link-location) ; specified by arg, just use it.
  8460. ((org-in-regexp org-bracket-link-regexp 1)
  8461. ;; We do have a link at point, and we are going to edit it.
  8462. (setq remove (list (match-beginning 0) (match-end 0)))
  8463. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8464. (setq link (read-string "Link: "
  8465. (org-link-unescape
  8466. (org-match-string-no-properties 1)))))
  8467. ((or (org-in-regexp org-angle-link-re)
  8468. (org-in-regexp org-plain-link-re))
  8469. ;; Convert to bracket link
  8470. (setq remove (list (match-beginning 0) (match-end 0))
  8471. link (read-string "Link: "
  8472. (org-remove-angle-brackets (match-string 0)))))
  8473. ((member complete-file '((4) (16)))
  8474. ;; Completing read for file names.
  8475. (setq link (org-file-complete-link complete-file)))
  8476. (t
  8477. ;; Read link, with completion for stored links.
  8478. (org-link-fontify-links-to-this-file)
  8479. (org-switch-to-buffer-other-window "*Org Links*")
  8480. (with-current-buffer "*Org Links*"
  8481. (erase-buffer)
  8482. (insert "Insert a link.
  8483. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  8484. (when org-stored-links
  8485. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  8486. (insert (mapconcat 'org-link-prettify
  8487. (reverse org-stored-links) "\n")))
  8488. (goto-char (point-min)))
  8489. (let ((cw (selected-window)))
  8490. (select-window (get-buffer-window "*Org Links*" 'visible))
  8491. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  8492. (unless (pos-visible-in-window-p (point-max))
  8493. (org-fit-window-to-buffer))
  8494. (and (window-live-p cw) (select-window cw)))
  8495. ;; Fake a link history, containing the stored links.
  8496. (setq tmphist (append (mapcar 'car org-stored-links)
  8497. org-insert-link-history))
  8498. (setq all-prefixes (append (mapcar 'car abbrevs)
  8499. (mapcar 'car org-link-abbrev-alist)
  8500. org-link-types))
  8501. (unwind-protect
  8502. (progn
  8503. (setq link
  8504. (let ((org-completion-use-ido nil)
  8505. (org-completion-use-iswitchb nil))
  8506. (org-completing-read
  8507. "Link: "
  8508. (append
  8509. (mapcar (lambda (x) (list (concat x ":")))
  8510. all-prefixes)
  8511. (mapcar 'car org-stored-links)
  8512. (mapcar 'cadr org-stored-links))
  8513. nil nil nil
  8514. 'tmphist
  8515. (caar org-stored-links))))
  8516. (if (not (string-match "\\S-" link))
  8517. (error "No link selected"))
  8518. (mapc (lambda(l)
  8519. (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
  8520. org-stored-links)
  8521. (if (or (member link all-prefixes)
  8522. (and (equal ":" (substring link -1))
  8523. (member (substring link 0 -1) all-prefixes)
  8524. (setq link (substring link 0 -1))))
  8525. (setq link (with-current-buffer origbuf
  8526. (org-link-try-special-completion link)))))
  8527. (set-window-configuration wcf)
  8528. (kill-buffer "*Org Links*"))
  8529. (setq entry (assoc link org-stored-links))
  8530. (or entry (push link org-insert-link-history))
  8531. (setq desc (or desc (nth 1 entry)))))
  8532. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  8533. (not org-keep-stored-link-after-insertion))
  8534. (setq org-stored-links (delq (assoc link org-stored-links)
  8535. org-stored-links)))
  8536. (if (string-match org-plain-link-re link)
  8537. ;; URL-like link, normalize the use of angular brackets.
  8538. (setq link (org-remove-angle-brackets link)))
  8539. ;; Check if we are linking to the current file with a search option
  8540. ;; If yes, simplify the link by using only the search option.
  8541. (when (and buffer-file-name
  8542. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  8543. (let* ((path (match-string 1 link))
  8544. (case-fold-search nil)
  8545. (search (match-string 2 link)))
  8546. (save-match-data
  8547. (if (equal (file-truename buffer-file-name) (file-truename path))
  8548. ;; We are linking to this same file, with a search option
  8549. (setq link search)))))
  8550. ;; Check if we can/should use a relative path. If yes, simplify the link
  8551. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  8552. (let* ((type (match-string 1 link))
  8553. (path (match-string 2 link))
  8554. (origpath path)
  8555. (case-fold-search nil))
  8556. (cond
  8557. ((or (eq org-link-file-path-type 'absolute)
  8558. (equal complete-file '(16)))
  8559. (setq path (abbreviate-file-name (expand-file-name path))))
  8560. ((eq org-link-file-path-type 'noabbrev)
  8561. (setq path (expand-file-name path)))
  8562. ((eq org-link-file-path-type 'relative)
  8563. (setq path (file-relative-name path)))
  8564. (t
  8565. (save-match-data
  8566. (if (string-match (concat "^" (regexp-quote
  8567. (expand-file-name
  8568. (file-name-as-directory
  8569. default-directory))))
  8570. (expand-file-name path))
  8571. ;; We are linking a file with relative path name.
  8572. (setq path (substring (expand-file-name path)
  8573. (match-end 0)))
  8574. (setq path (abbreviate-file-name (expand-file-name path)))))))
  8575. (setq link (concat type path))
  8576. (if (equal desc origpath)
  8577. (setq desc path))))
  8578. (if org-make-link-description-function
  8579. (setq desc (funcall org-make-link-description-function link desc))
  8580. (if default-description (setq desc default-description)
  8581. (setq desc (or (and auto-desc desc)
  8582. (read-string "Description: " desc)))))
  8583. (unless (string-match "\\S-" desc) (setq desc nil))
  8584. (if remove (apply 'delete-region remove))
  8585. (insert (org-make-link-string link desc))))
  8586. (defun org-link-try-special-completion (type)
  8587. "If there is completion support for link type TYPE, offer it."
  8588. (let ((fun (intern (concat "org-" type "-complete-link"))))
  8589. (if (functionp fun)
  8590. (funcall fun)
  8591. (read-string "Link (no completion support): " (concat type ":")))))
  8592. (defun org-file-complete-link (&optional arg)
  8593. "Create a file link using completion."
  8594. (let (file link)
  8595. (setq file (read-file-name "File: "))
  8596. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  8597. (pwd1 (file-name-as-directory (abbreviate-file-name
  8598. (expand-file-name ".")))))
  8599. (cond
  8600. ((equal arg '(16))
  8601. (setq link (concat
  8602. "file:"
  8603. (abbreviate-file-name (expand-file-name file)))))
  8604. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  8605. (setq link (concat "file:" (match-string 1 file))))
  8606. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  8607. (expand-file-name file))
  8608. (setq link (concat
  8609. "file:" (match-string 1 (expand-file-name file)))))
  8610. (t (setq link (concat "file:" file)))))
  8611. link))
  8612. (defun org-completing-read (&rest args)
  8613. "Completing-read with SPACE being a normal character."
  8614. (let ((enable-recursive-minibuffers t)
  8615. (minibuffer-local-completion-map
  8616. (copy-keymap minibuffer-local-completion-map)))
  8617. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  8618. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  8619. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  8620. (apply 'org-icompleting-read args)))
  8621. (defun org-completing-read-no-i (&rest args)
  8622. (let (org-completion-use-ido org-completion-use-iswitchb)
  8623. (apply 'org-completing-read args)))
  8624. (defun org-iswitchb-completing-read (prompt choices &rest args)
  8625. "Use iswitch as a completing-read replacement to choose from choices.
  8626. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  8627. from."
  8628. (let* ((iswitchb-use-virtual-buffers nil)
  8629. (iswitchb-make-buflist-hook
  8630. (lambda ()
  8631. (setq iswitchb-temp-buflist choices))))
  8632. (iswitchb-read-buffer prompt)))
  8633. (defun org-icompleting-read (&rest args)
  8634. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  8635. (org-without-partial-completion
  8636. (if (and org-completion-use-ido
  8637. (fboundp 'ido-completing-read)
  8638. (boundp 'ido-mode) ido-mode
  8639. (listp (second args)))
  8640. (let ((ido-enter-matching-directory nil))
  8641. (apply 'ido-completing-read (concat (car args))
  8642. (if (consp (car (nth 1 args)))
  8643. (mapcar 'car (nth 1 args))
  8644. (nth 1 args))
  8645. (cddr args)))
  8646. (if (and org-completion-use-iswitchb
  8647. (boundp 'iswitchb-mode) iswitchb-mode
  8648. (listp (second args)))
  8649. (apply 'org-iswitchb-completing-read (concat (car args))
  8650. (if (consp (car (nth 1 args)))
  8651. (mapcar 'car (nth 1 args))
  8652. (nth 1 args))
  8653. (cddr args))
  8654. (apply 'completing-read args)))))
  8655. (defun org-extract-attributes (s)
  8656. "Extract the attributes cookie from a string and set as text property."
  8657. (let (a attr (start 0) key value)
  8658. (save-match-data
  8659. (when (string-match "{{\\([^}]+\\)}}$" s)
  8660. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  8661. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  8662. (setq key (match-string 1 a) value (match-string 2 a)
  8663. start (match-end 0)
  8664. attr (plist-put attr (intern key) value))))
  8665. (org-add-props s nil 'org-attr attr))
  8666. s))
  8667. (defun org-extract-attributes-from-string (tag)
  8668. (let (key value attr)
  8669. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  8670. (setq key (match-string 1 tag) value (match-string 2 tag)
  8671. tag (replace-match "" t t tag)
  8672. attr (plist-put attr (intern key) value)))
  8673. (cons tag attr)))
  8674. (defun org-attributes-to-string (plist)
  8675. "Format a property list into an HTML attribute list."
  8676. (let ((s "") key value)
  8677. (while plist
  8678. (setq key (pop plist) value (pop plist))
  8679. (and value
  8680. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  8681. s))
  8682. ;;; Opening/following a link
  8683. (defvar org-link-search-failed nil)
  8684. (defvar org-open-link-functions nil
  8685. "Hook for functions finding a plain text link.
  8686. These functions must take a single argument, the link content.
  8687. They will be called for links that look like [[link text][description]]
  8688. when LINK TEXT does not have a protocol like \"http:\" and does not look
  8689. like a filename (e.g. \"./blue.png\").
  8690. These functions will be called *before* Org attempts to resolve the
  8691. link by doing text searches in the current buffer - so if you want a
  8692. link \"[[target]]\" to still find \"<<target>>\", your function should
  8693. handle this as a special case.
  8694. When the function does handle the link, it must return a non-nil value.
  8695. If it decides that it is not responsible for this link, it must return
  8696. nil to indicate that that Org-mode can continue with other options
  8697. like exact and fuzzy text search.")
  8698. (defun org-next-link ()
  8699. "Move forward to the next link.
  8700. If the link is in hidden text, expose it."
  8701. (interactive)
  8702. (when (and org-link-search-failed (eq this-command last-command))
  8703. (goto-char (point-min))
  8704. (message "Link search wrapped back to beginning of buffer"))
  8705. (setq org-link-search-failed nil)
  8706. (let* ((pos (point))
  8707. (ct (org-context))
  8708. (a (assoc :link ct)))
  8709. (if a (goto-char (nth 2 a)))
  8710. (if (re-search-forward org-any-link-re nil t)
  8711. (progn
  8712. (goto-char (match-beginning 0))
  8713. (if (outline-invisible-p) (org-show-context)))
  8714. (goto-char pos)
  8715. (setq org-link-search-failed t)
  8716. (error "No further link found"))))
  8717. (defun org-previous-link ()
  8718. "Move backward to the previous link.
  8719. If the link is in hidden text, expose it."
  8720. (interactive)
  8721. (when (and org-link-search-failed (eq this-command last-command))
  8722. (goto-char (point-max))
  8723. (message "Link search wrapped back to end of buffer"))
  8724. (setq org-link-search-failed nil)
  8725. (let* ((pos (point))
  8726. (ct (org-context))
  8727. (a (assoc :link ct)))
  8728. (if a (goto-char (nth 1 a)))
  8729. (if (re-search-backward org-any-link-re nil t)
  8730. (progn
  8731. (goto-char (match-beginning 0))
  8732. (if (outline-invisible-p) (org-show-context)))
  8733. (goto-char pos)
  8734. (setq org-link-search-failed t)
  8735. (error "No further link found"))))
  8736. (defun org-translate-link (s)
  8737. "Translate a link string if a translation function has been defined."
  8738. (if (and org-link-translation-function
  8739. (fboundp org-link-translation-function)
  8740. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  8741. (progn
  8742. (setq s (funcall org-link-translation-function
  8743. (match-string 1 s) (match-string 2 s)))
  8744. (concat (car s) ":" (cdr s)))
  8745. s))
  8746. (defun org-translate-link-from-planner (type path)
  8747. "Translate a link from Emacs Planner syntax so that Org can follow it.
  8748. This is still an experimental function, your mileage may vary."
  8749. (cond
  8750. ((member type '("http" "https" "news" "ftp"))
  8751. ;; standard Internet links are the same.
  8752. nil)
  8753. ((and (equal type "irc") (string-match "^//" path))
  8754. ;; Planner has two / at the beginning of an irc link, we have 1.
  8755. ;; We should have zero, actually....
  8756. (setq path (substring path 1)))
  8757. ((and (equal type "lisp") (string-match "^/" path))
  8758. ;; Planner has a slash, we do not.
  8759. (setq type "elisp" path (substring path 1)))
  8760. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  8761. ;; A typical message link. Planner has the id after the final slash,
  8762. ;; we separate it with a hash mark
  8763. (setq path (concat (match-string 1 path) "#"
  8764. (org-remove-angle-brackets (match-string 2 path)))))
  8765. )
  8766. (cons type path))
  8767. (defun org-find-file-at-mouse (ev)
  8768. "Open file link or URL at mouse."
  8769. (interactive "e")
  8770. (mouse-set-point ev)
  8771. (org-open-at-point 'in-emacs))
  8772. (defun org-open-at-mouse (ev)
  8773. "Open file link or URL at mouse.
  8774. See the docstring of `org-open-file' for details."
  8775. (interactive "e")
  8776. (mouse-set-point ev)
  8777. (if (eq major-mode 'org-agenda-mode)
  8778. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  8779. (org-open-at-point))
  8780. (defvar org-window-config-before-follow-link nil
  8781. "The window configuration before following a link.
  8782. This is saved in case the need arises to restore it.")
  8783. (defvar org-open-link-marker (make-marker)
  8784. "Marker pointing to the location where `org-open-at-point; was called.")
  8785. ;;;###autoload
  8786. (defun org-open-at-point-global ()
  8787. "Follow a link like Org-mode does.
  8788. This command can be called in any mode to follow a link that has
  8789. Org-mode syntax."
  8790. (interactive)
  8791. (org-run-like-in-org-mode 'org-open-at-point))
  8792. ;;;###autoload
  8793. (defun org-open-link-from-string (s &optional arg reference-buffer)
  8794. "Open a link in the string S, as if it was in Org-mode."
  8795. (interactive "sLink: \nP")
  8796. (let ((reference-buffer (or reference-buffer (current-buffer))))
  8797. (with-temp-buffer
  8798. (let ((org-inhibit-startup (not reference-buffer)))
  8799. (org-mode)
  8800. (insert s)
  8801. (goto-char (point-min))
  8802. (when reference-buffer
  8803. (setq org-link-abbrev-alist-local
  8804. (with-current-buffer reference-buffer
  8805. org-link-abbrev-alist-local)))
  8806. (org-open-at-point arg reference-buffer)))))
  8807. (defvar org-open-at-point-functions nil
  8808. "Hook that is run when following a link at point.
  8809. Functions in this hook must return t if they identify and follow
  8810. a link at point. If they don't find anything interesting at point,
  8811. they must return nil.")
  8812. (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
  8813. (defun org-open-at-point (&optional arg reference-buffer)
  8814. "Open link at or after point.
  8815. If there is no link at point, this function will search forward up to
  8816. the end of the current line.
  8817. Normally, files will be opened by an appropriate application. If the
  8818. optional prefix argument ARG is non-nil, Emacs will visit the file.
  8819. With a double prefix argument, try to open outside of Emacs, in the
  8820. application the system uses for this file type."
  8821. (interactive "P")
  8822. ;; if in a code block, then open the block's results
  8823. (unless (call-interactively #'org-babel-open-src-block-result)
  8824. (org-load-modules-maybe)
  8825. (move-marker org-open-link-marker (point))
  8826. (setq org-window-config-before-follow-link (current-window-configuration))
  8827. (org-remove-occur-highlights nil nil t)
  8828. (cond
  8829. ((and (org-at-heading-p)
  8830. (not (org-at-timestamp-p t))
  8831. (not (org-in-regexp
  8832. (concat org-plain-link-re "\\|"
  8833. org-bracket-link-regexp "\\|"
  8834. org-angle-link-re "\\|"
  8835. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8836. (not (get-text-property (point) 'org-linked-text)))
  8837. (or (org-offer-links-in-entry arg)
  8838. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8839. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  8840. ((and (org-at-timestamp-p t)
  8841. (not (org-in-regexp org-bracket-link-regexp)))
  8842. (org-follow-timestamp-link))
  8843. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8844. (not (org-in-regexp org-bracket-link-regexp)))
  8845. (org-footnote-action))
  8846. (t
  8847. (let (type path link line search (pos (point)))
  8848. (catch 'match
  8849. (save-excursion
  8850. (skip-chars-forward "^]\n\r")
  8851. (when (org-in-regexp org-bracket-link-regexp 1)
  8852. (setq link (org-extract-attributes
  8853. (org-link-unescape (org-match-string-no-properties 1))))
  8854. (while (string-match " *\n *" link)
  8855. (setq link (replace-match " " t t link)))
  8856. (setq link (org-link-expand-abbrev link))
  8857. (cond
  8858. ((or (file-name-absolute-p link)
  8859. (string-match "^\\.\\.?/" link))
  8860. (setq type "file" path link))
  8861. ((string-match org-link-re-with-space3 link)
  8862. (setq type (match-string 1 link) path (match-string 2 link)))
  8863. ((string-match "^help:+\\(.+\\)" link)
  8864. (setq type "help" path (match-string 1 link)))
  8865. (t (setq type "thisfile" path link)))
  8866. (throw 'match t)))
  8867. (when (get-text-property (point) 'org-linked-text)
  8868. (setq type "thisfile"
  8869. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8870. (1+ (point)) (point))
  8871. path (buffer-substring
  8872. (or (previous-single-property-change pos 'org-linked-text)
  8873. (point-min))
  8874. (or (next-single-property-change pos 'org-linked-text)
  8875. (point-max))))
  8876. (throw 'match t))
  8877. (save-excursion
  8878. (when (or (org-in-regexp org-angle-link-re)
  8879. (and (goto-char (car (org-in-regexp org-plain-link-re)))
  8880. (save-match-data (not (looking-back "\\[\\[")))))
  8881. (setq type (match-string 1)
  8882. path (org-link-unescape (match-string 2)))
  8883. (throw 'match t)))
  8884. (save-excursion
  8885. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  8886. (setq type "tags"
  8887. path (match-string 1))
  8888. (while (string-match ":" path)
  8889. (setq path (replace-match "+" t t path)))
  8890. (throw 'match t)))
  8891. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8892. (setq type "tree-match"
  8893. path (match-string 1))
  8894. (throw 'match t)))
  8895. (unless path
  8896. (error "No link found"))
  8897. ;; switch back to reference buffer
  8898. ;; needed when if called in a temporary buffer through
  8899. ;; org-open-link-from-string
  8900. (with-current-buffer (or reference-buffer (current-buffer))
  8901. ;; Remove any trailing spaces in path
  8902. (if (string-match " +\\'" path)
  8903. (setq path (replace-match "" t t path)))
  8904. (if (and org-link-translation-function
  8905. (fboundp org-link-translation-function))
  8906. ;; Check if we need to translate the link
  8907. (let ((tmp (funcall org-link-translation-function type path)))
  8908. (setq type (car tmp) path (cdr tmp))))
  8909. (cond
  8910. ((assoc type org-link-protocols)
  8911. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8912. ((equal type "help")
  8913. (let ((f-or-v (intern path)))
  8914. (cond ((fboundp f-or-v)
  8915. (describe-function f-or-v))
  8916. ((boundp f-or-v)
  8917. (describe-variable f-or-v))
  8918. (t (error "Not a known function or variable")))))
  8919. ((equal type "mailto")
  8920. (let ((cmd (car org-link-mailto-program))
  8921. (args (cdr org-link-mailto-program)) args1
  8922. (address path) (subject "") a)
  8923. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8924. (setq address (match-string 1 path)
  8925. subject (org-link-escape (match-string 2 path))))
  8926. (while args
  8927. (cond
  8928. ((not (stringp (car args))) (push (pop args) args1))
  8929. (t (setq a (pop args))
  8930. (if (string-match "%a" a)
  8931. (setq a (replace-match address t t a)))
  8932. (if (string-match "%s" a)
  8933. (setq a (replace-match subject t t a)))
  8934. (push a args1))))
  8935. (apply cmd (nreverse args1))))
  8936. ((member type '("http" "https" "ftp" "news"))
  8937. (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
  8938. (org-link-escape
  8939. path org-link-escape-chars-browser)
  8940. path))))
  8941. ((string= type "doi")
  8942. (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
  8943. (org-link-escape
  8944. path org-link-escape-chars-browser)
  8945. path))))
  8946. ((member type '("message"))
  8947. (browse-url (concat type ":" path)))
  8948. ((string= type "tags")
  8949. (org-tags-view arg path))
  8950. ((string= type "tree-match")
  8951. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8952. ((string= type "file")
  8953. (if (string-match "::\\([0-9]+\\)\\'" path)
  8954. (setq line (string-to-number (match-string 1 path))
  8955. path (substring path 0 (match-beginning 0)))
  8956. (if (string-match "::\\(.+\\)\\'" path)
  8957. (setq search (match-string 1 path)
  8958. path (substring path 0 (match-beginning 0)))))
  8959. (if (string-match "[*?{]" (file-name-nondirectory path))
  8960. (dired path)
  8961. (org-open-file path arg line search)))
  8962. ((string= type "shell")
  8963. (let ((buf (generate-new-buffer "*Org Shell Output"))
  8964. (cmd path))
  8965. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  8966. (string-match org-confirm-shell-link-not-regexp cmd))
  8967. (not org-confirm-shell-link-function)
  8968. (funcall org-confirm-shell-link-function
  8969. (format "Execute \"%s\" in shell? "
  8970. (org-add-props cmd nil
  8971. 'face 'org-warning))))
  8972. (progn
  8973. (message "Executing %s" cmd)
  8974. (shell-command cmd buf)
  8975. (if (featurep 'midnight)
  8976. (setq clean-buffer-list-kill-buffer-names
  8977. (cons buf clean-buffer-list-kill-buffer-names))))
  8978. (error "Abort"))))
  8979. ((string= type "elisp")
  8980. (let ((cmd path))
  8981. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  8982. (string-match org-confirm-elisp-link-not-regexp cmd))
  8983. (not org-confirm-elisp-link-function)
  8984. (funcall org-confirm-elisp-link-function
  8985. (format "Execute \"%s\" as elisp? "
  8986. (org-add-props cmd nil
  8987. 'face 'org-warning))))
  8988. (message "%s => %s" cmd
  8989. (if (equal (string-to-char cmd) ?\()
  8990. (eval (read cmd))
  8991. (call-interactively (read cmd))))
  8992. (error "Abort"))))
  8993. ((and (string= type "thisfile")
  8994. (run-hook-with-args-until-success
  8995. 'org-open-link-functions path)))
  8996. ((string= type "thisfile")
  8997. (if arg
  8998. (switch-to-buffer-other-window
  8999. (org-get-buffer-for-internal-link (current-buffer)))
  9000. (org-mark-ring-push))
  9001. (let ((cmd `(org-link-search
  9002. ,path
  9003. ,(cond ((equal arg '(4)) ''occur)
  9004. ((equal arg '(16)) ''org-occur))
  9005. ,pos)))
  9006. (condition-case nil (let ((org-link-search-inhibit-query t))
  9007. (eval cmd))
  9008. (error (progn (widen) (eval cmd))))))
  9009. (t (browse-url-at-point)))))))
  9010. (move-marker org-open-link-marker nil)
  9011. (run-hook-with-args 'org-follow-link-hook)))
  9012. (defun org-offer-links-in-entry (&optional nth zero)
  9013. "Offer links in the current entry and follow the selected link.
  9014. If there is only one link, follow it immediately as well.
  9015. If NTH is an integer, immediately pick the NTH link found.
  9016. If ZERO is a string, check also this string for a link, and if
  9017. there is one, offer it as link number zero."
  9018. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  9019. "\\(" org-angle-link-re "\\)\\|"
  9020. "\\(" org-plain-link-re "\\)"))
  9021. (cnt ?0)
  9022. (in-emacs (if (integerp nth) nil nth))
  9023. have-zero end links link c)
  9024. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  9025. (push (match-string 0 zero) links)
  9026. (setq cnt (1- cnt) have-zero t))
  9027. (save-excursion
  9028. (org-back-to-heading t)
  9029. (setq end (save-excursion (outline-next-heading) (point)))
  9030. (while (re-search-forward re end t)
  9031. (push (match-string 0) links))
  9032. (setq links (org-uniquify (reverse links))))
  9033. (cond
  9034. ((null links)
  9035. (message "No links"))
  9036. ((equal (length links) 1)
  9037. (setq link (list (car links))))
  9038. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  9039. (setq link (list (nth (if have-zero nth (1- nth)) links))))
  9040. (t ; we have to select a link
  9041. (save-excursion
  9042. (save-window-excursion
  9043. (delete-other-windows)
  9044. (with-output-to-temp-buffer "*Select Link*"
  9045. (mapc (lambda (l)
  9046. (if (not (string-match org-bracket-link-regexp l))
  9047. (princ (format "[%c] %s\n" (incf cnt)
  9048. (org-remove-angle-brackets l)))
  9049. (if (match-end 3)
  9050. (princ (format "[%c] %s (%s)\n" (incf cnt)
  9051. (match-string 3 l) (match-string 1 l)))
  9052. (princ (format "[%c] %s\n" (incf cnt)
  9053. (match-string 1 l))))))
  9054. links))
  9055. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  9056. (message "Select link to open, RET to open all:")
  9057. (setq c (read-char-exclusive))
  9058. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  9059. (when (equal c ?q) (error "Abort"))
  9060. (if (equal c ?\C-m)
  9061. (setq link links)
  9062. (setq nth (- c ?0))
  9063. (if have-zero (setq nth (1+ nth)))
  9064. (unless (and (integerp nth) (>= (length links) nth))
  9065. (error "Invalid link selection"))
  9066. (setq link (list (nth (1- nth) links))))))
  9067. (if link
  9068. (let ((buf (current-buffer)))
  9069. (dolist (l link)
  9070. (org-open-link-from-string l in-emacs buf))
  9071. t)
  9072. nil)))
  9073. ;; Add special file links that specify the way of opening
  9074. (org-add-link-type "file+sys" 'org-open-file-with-system)
  9075. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  9076. (defun org-open-file-with-system (path)
  9077. "Open file at PATH using the system way of opening it."
  9078. (org-open-file path 'system))
  9079. (defun org-open-file-with-emacs (path)
  9080. "Open file at PATH in Emacs."
  9081. (org-open-file path 'emacs))
  9082. (defun org-remove-file-link-modifiers ()
  9083. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  9084. (goto-char (point-min))
  9085. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  9086. (org-if-unprotected
  9087. (replace-match "file:" t t))))
  9088. (eval-after-load "org-exp"
  9089. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  9090. 'org-remove-file-link-modifiers))
  9091. ;;;; Time estimates
  9092. (defun org-get-effort (&optional pom)
  9093. "Get the effort estimate for the current entry."
  9094. (org-entry-get pom org-effort-property))
  9095. ;;; File search
  9096. (defvar org-create-file-search-functions nil
  9097. "List of functions to construct the right search string for a file link.
  9098. These functions are called in turn with point at the location to
  9099. which the link should point.
  9100. A function in the hook should first test if it would like to
  9101. handle this file type, for example by checking the `major-mode'
  9102. or the file extension. If it decides not to handle this file, it
  9103. should just return nil to give other functions a chance. If it
  9104. does handle the file, it must return the search string to be used
  9105. when following the link. The search string will be part of the
  9106. file link, given after a double colon, and `org-open-at-point'
  9107. will automatically search for it. If special measures must be
  9108. taken to make the search successful, another function should be
  9109. added to the companion hook `org-execute-file-search-functions',
  9110. which see.
  9111. A function in this hook may also use `setq' to set the variable
  9112. `description' to provide a suggestion for the descriptive text to
  9113. be used for this link when it gets inserted into an Org-mode
  9114. buffer with \\[org-insert-link].")
  9115. (defvar org-execute-file-search-functions nil
  9116. "List of functions to execute a file search triggered by a link.
  9117. Functions added to this hook must accept a single argument, the
  9118. search string that was part of the file link, the part after the
  9119. double colon. The function must first check if it would like to
  9120. handle this search, for example by checking the `major-mode' or
  9121. the file extension. If it decides not to handle this search, it
  9122. should just return nil to give other functions a chance. If it
  9123. does handle the search, it must return a non-nil value to keep
  9124. other functions from trying.
  9125. Each function can access the current prefix argument through the
  9126. variable `current-prefix-argument'. Note that a single prefix is
  9127. used to force opening a link in Emacs, so it may be good to only
  9128. use a numeric or double prefix to guide the search function.
  9129. In case this is needed, a function in this hook can also restore
  9130. the window configuration before `org-open-at-point' was called using:
  9131. (set-window-configuration org-window-config-before-follow-link)")
  9132. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  9133. (defun org-link-search (s &optional type avoid-pos stealth)
  9134. "Search for a link search option.
  9135. If S is surrounded by forward slashes, it is interpreted as a
  9136. regular expression. In org-mode files, this will create an `org-occur'
  9137. sparse tree. In ordinary files, `occur' will be used to list matches.
  9138. If the current buffer is in `dired-mode', grep will be used to search
  9139. in all files. If AVOID-POS is given, ignore matches near that position.
  9140. When optional argument STEALTH is non-nil, do not modify
  9141. visibility around point, thus ignoring
  9142. `org-show-hierarchy-above', `org-show-following-heading' and
  9143. `org-show-siblings' variables."
  9144. (let ((case-fold-search t)
  9145. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  9146. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  9147. (append '(("") (" ") ("\t") ("\n"))
  9148. org-emphasis-alist)
  9149. "\\|") "\\)"))
  9150. (pos (point))
  9151. (pre nil) (post nil)
  9152. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  9153. (cond
  9154. ;; First check if there are any special search functions
  9155. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9156. ;; Now try the builtin stuff
  9157. ((and (equal (string-to-char s0) ?#)
  9158. (> (length s0) 1)
  9159. (save-excursion
  9160. (goto-char (point-min))
  9161. (and
  9162. (re-search-forward
  9163. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  9164. (setq type 'dedicated
  9165. pos (match-beginning 0))))
  9166. ;; There is an exact target for this
  9167. (goto-char pos)
  9168. (org-back-to-heading t)))
  9169. ((save-excursion
  9170. (goto-char (point-min))
  9171. (and
  9172. (re-search-forward
  9173. (concat "<<" (regexp-quote s0) ">>") nil t)
  9174. (setq type 'dedicated
  9175. pos (match-beginning 0))))
  9176. ;; There is an exact target for this
  9177. (goto-char pos))
  9178. ((save-excursion
  9179. (goto-char (point-min))
  9180. (and
  9181. (re-search-forward
  9182. (format "^[ \t]*#\\+TARGET: %s" (regexp-quote s0)) nil t)
  9183. (setq type 'dedicated pos (match-beginning 0))))
  9184. ;; Found an invisible target.
  9185. (goto-char pos))
  9186. ((save-excursion
  9187. (goto-char (point-min))
  9188. (and
  9189. (re-search-forward
  9190. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9191. (setq type 'dedicated pos (match-beginning 0))))
  9192. ;; Found an element with a matching #+name affiliated keyword.
  9193. (goto-char pos))
  9194. ((and (string-match "^(\\(.*\\))$" s0)
  9195. (save-excursion
  9196. (goto-char (point-min))
  9197. (and
  9198. (re-search-forward
  9199. (concat "[^[]" (regexp-quote
  9200. (format org-coderef-label-format
  9201. (match-string 1 s0))))
  9202. nil t)
  9203. (setq type 'dedicated
  9204. pos (1+ (match-beginning 0))))))
  9205. ;; There is a coderef target for this
  9206. (goto-char pos))
  9207. ((string-match "^/\\(.*\\)/$" s)
  9208. ;; A regular expression
  9209. (cond
  9210. ((derived-mode-p 'org-mode)
  9211. (org-occur (match-string 1 s)))
  9212. ;;((eq major-mode 'dired-mode)
  9213. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  9214. (t (org-do-occur (match-string 1 s)))))
  9215. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9216. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9217. (goto-char (point-min))
  9218. (cond
  9219. ((let (case-fold-search)
  9220. (re-search-forward (format org-complex-heading-regexp-format
  9221. (regexp-quote s))
  9222. nil t))
  9223. ;; OK, found a match
  9224. (setq type 'dedicated)
  9225. (goto-char (match-beginning 0)))
  9226. ((and (not org-link-search-inhibit-query)
  9227. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9228. (y-or-n-p "No match - create this as a new heading? "))
  9229. (goto-char (point-max))
  9230. (or (bolp) (newline))
  9231. (insert "* " s "\n")
  9232. (beginning-of-line 0))
  9233. (t
  9234. (goto-char pos)
  9235. (error "No match"))))
  9236. (t
  9237. ;; A normal search string
  9238. (when (equal (string-to-char s) ?*)
  9239. ;; Anchor on headlines, post may include tags.
  9240. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9241. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9242. s (substring s 1)))
  9243. (remove-text-properties
  9244. 0 (length s)
  9245. '(face nil mouse-face nil keymap nil fontified nil) s)
  9246. ;; Make a series of regular expressions to find a match
  9247. (setq words (org-split-string s "[ \n\r\t]+")
  9248. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9249. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9250. "\\)" markers)
  9251. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  9252. re2a (concat "[ \t\r\n]" re2a_)
  9253. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9254. re4 (concat "[^a-zA-Z_]" re4_)
  9255. re1 (concat pre re2 post)
  9256. re3 (concat pre (if pre re4_ re4) post)
  9257. re5 (concat pre ".*" re4)
  9258. re2 (concat pre re2)
  9259. re2a (concat pre (if pre re2a_ re2a))
  9260. re4 (concat pre (if pre re4_ re4))
  9261. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9262. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9263. re5 "\\)"
  9264. ))
  9265. (cond
  9266. ((eq type 'org-occur) (org-occur reall))
  9267. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9268. (t (goto-char (point-min))
  9269. (setq type 'fuzzy)
  9270. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  9271. (org-search-not-self 1 re1 nil t)
  9272. (org-search-not-self 1 re2 nil t)
  9273. (org-search-not-self 1 re2a nil t)
  9274. (org-search-not-self 1 re3 nil t)
  9275. (org-search-not-self 1 re4 nil t)
  9276. (org-search-not-self 1 re5 nil t)
  9277. )
  9278. (goto-char (match-beginning 1))
  9279. (goto-char pos)
  9280. (error "No match"))))))
  9281. (and (derived-mode-p 'org-mode)
  9282. (not stealth)
  9283. (org-show-context 'link-search))
  9284. type))
  9285. (defun org-search-not-self (group &rest args)
  9286. "Execute `re-search-forward', but only accept matches that do not
  9287. enclose the position of `org-open-link-marker'."
  9288. (let ((m org-open-link-marker))
  9289. (catch 'exit
  9290. (while (apply 're-search-forward args)
  9291. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9292. (goto-char (match-end group))
  9293. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9294. (> (match-beginning 0) (marker-position m))
  9295. (< (match-end 0) (marker-position m)))
  9296. (save-match-data
  9297. (or (not (org-in-regexp
  9298. org-bracket-link-analytic-regexp 1))
  9299. (not (match-end 4)) ; no description
  9300. (and (<= (match-beginning 4) (point))
  9301. (>= (match-end 4) (point))))))
  9302. (throw 'exit (point))))))))
  9303. (defun org-get-buffer-for-internal-link (buffer)
  9304. "Return a buffer to be used for displaying the link target of internal links."
  9305. (cond
  9306. ((not org-display-internal-link-with-indirect-buffer)
  9307. buffer)
  9308. ((string-match "(Clone)$" (buffer-name buffer))
  9309. (message "Buffer is already a clone, not making another one")
  9310. ;; we also do not modify visibility in this case
  9311. buffer)
  9312. (t ; make a new indirect buffer for displaying the link
  9313. (let* ((bn (buffer-name buffer))
  9314. (ibn (concat bn "(Clone)"))
  9315. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9316. (with-current-buffer ib (org-overview))
  9317. ib))))
  9318. (defun org-do-occur (regexp &optional cleanup)
  9319. "Call the Emacs command `occur'.
  9320. If CLEANUP is non-nil, remove the printout of the regular expression
  9321. in the *Occur* buffer. This is useful if the regex is long and not useful
  9322. to read."
  9323. (occur regexp)
  9324. (when cleanup
  9325. (let ((cwin (selected-window)) win beg end)
  9326. (when (setq win (get-buffer-window "*Occur*"))
  9327. (select-window win))
  9328. (goto-char (point-min))
  9329. (when (re-search-forward "match[a-z]+" nil t)
  9330. (setq beg (match-end 0))
  9331. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9332. (setq end (1- (match-beginning 0)))))
  9333. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9334. (goto-char (point-min))
  9335. (select-window cwin))))
  9336. ;;; The mark ring for links jumps
  9337. (defvar org-mark-ring nil
  9338. "Mark ring for positions before jumps in Org-mode.")
  9339. (defvar org-mark-ring-last-goto nil
  9340. "Last position in the mark ring used to go back.")
  9341. ;; Fill and close the ring
  9342. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9343. (loop for i from 1 to org-mark-ring-length do
  9344. (push (make-marker) org-mark-ring))
  9345. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9346. org-mark-ring)
  9347. (defun org-mark-ring-push (&optional pos buffer)
  9348. "Put the current position or POS into the mark ring and rotate it."
  9349. (interactive)
  9350. (setq pos (or pos (point)))
  9351. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9352. (move-marker (car org-mark-ring)
  9353. (or pos (point))
  9354. (or buffer (current-buffer)))
  9355. (message "%s"
  9356. (substitute-command-keys
  9357. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9358. (defun org-mark-ring-goto (&optional n)
  9359. "Jump to the previous position in the mark ring.
  9360. With prefix arg N, jump back that many stored positions. When
  9361. called several times in succession, walk through the entire ring.
  9362. Org-mode commands jumping to a different position in the current file,
  9363. or to another Org-mode file, automatically push the old position
  9364. onto the ring."
  9365. (interactive "p")
  9366. (let (p m)
  9367. (if (eq last-command this-command)
  9368. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9369. (setq p org-mark-ring))
  9370. (setq org-mark-ring-last-goto p)
  9371. (setq m (car p))
  9372. (org-pop-to-buffer-same-window (marker-buffer m))
  9373. (goto-char m)
  9374. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9375. (defun org-remove-angle-brackets (s)
  9376. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9377. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9378. s)
  9379. (defun org-add-angle-brackets (s)
  9380. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9381. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9382. s)
  9383. (defun org-remove-double-quotes (s)
  9384. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9385. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9386. s)
  9387. ;;; Following specific links
  9388. (defun org-follow-timestamp-link ()
  9389. "Open an agenda view for the time-stamp date/range at point."
  9390. (cond
  9391. ((org-at-date-range-p t)
  9392. (let ((org-agenda-start-on-weekday)
  9393. (t1 (match-string 1))
  9394. (t2 (match-string 2)) tt1 tt2)
  9395. (setq tt1 (time-to-days (org-time-string-to-time t1))
  9396. tt2 (time-to-days (org-time-string-to-time t2)))
  9397. (let ((org-agenda-buffer-tmp-name
  9398. (format "*Org Agenda(a:%s)"
  9399. (concat (substring t1 0 10) "--" (substring t2 0 10)))))
  9400. (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
  9401. ((org-at-timestamp-p t)
  9402. (let ((org-agenda-buffer-tmp-name
  9403. (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
  9404. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9405. (substring (match-string 1) 0 10)))
  9406. 1)))
  9407. (t (error "This should not happen"))))
  9408. ;;; Following file links
  9409. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9410. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9411. (declare-function mailcap-mime-info
  9412. "mailcap" (string &optional request no-decode))
  9413. (defvar org-wait nil)
  9414. (defun org-open-file (path &optional in-emacs line search)
  9415. "Open the file at PATH.
  9416. First, this expands any special file name abbreviations. Then the
  9417. configuration variable `org-file-apps' is checked if it contains an
  9418. entry for this file type, and if yes, the corresponding command is launched.
  9419. If no application is found, Emacs simply visits the file.
  9420. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9421. With a double \\[universal-argument] \\[universal-argument] \
  9422. prefix arg, Org tries to avoid opening in Emacs
  9423. and to use an external application to visit the file.
  9424. Optional LINE specifies a line to go to, optional SEARCH a string
  9425. to search for. If LINE or SEARCH is given, the file will be
  9426. opened in Emacs, unless an entry from org-file-apps that makes
  9427. use of groups in a regexp matches.
  9428. If you want to change the way frames are used when following a
  9429. link, please customize `org-link-frame-setup'.
  9430. If the file does not exist, an error is thrown."
  9431. (let* ((file (if (equal path "")
  9432. buffer-file-name
  9433. (substitute-in-file-name (expand-file-name path))))
  9434. (file-apps (append org-file-apps (org-default-apps)))
  9435. (apps (org-remove-if
  9436. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9437. (apps-dlink (org-remove-if-not
  9438. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9439. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9440. (dirp (if remp nil (file-directory-p file)))
  9441. (file (if (and dirp org-open-directory-means-index-dot-org)
  9442. (concat (file-name-as-directory file) "index.org")
  9443. file))
  9444. (a-m-a-p (assq 'auto-mode apps))
  9445. (dfile (downcase file))
  9446. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9447. (link (cond ((and (eq line nil)
  9448. (eq search nil))
  9449. file)
  9450. (line
  9451. (concat file "::" (number-to-string line)))
  9452. (search
  9453. (concat file "::" search))))
  9454. (dlink (downcase link))
  9455. (old-buffer (current-buffer))
  9456. (old-pos (point))
  9457. (old-mode major-mode)
  9458. ext cmd link-match-data)
  9459. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9460. (setq ext (match-string 1 dfile))
  9461. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9462. (setq ext (match-string 1 dfile))))
  9463. (cond
  9464. ((member in-emacs '((16) system))
  9465. (setq cmd (cdr (assoc 'system apps))))
  9466. (in-emacs (setq cmd 'emacs))
  9467. (t
  9468. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9469. (and dirp (cdr (assoc 'directory apps)))
  9470. ; first, try matching against apps-dlink
  9471. ; if we get a match here, store the match data for later
  9472. (let ((match (assoc-default dlink apps-dlink
  9473. 'string-match)))
  9474. (if match
  9475. (progn (setq link-match-data (match-data))
  9476. match)
  9477. (progn (setq in-emacs (or in-emacs line search))
  9478. nil))) ; if we have no match in apps-dlink,
  9479. ; always open the file in emacs if line or search
  9480. ; is given (for backwards compatibility)
  9481. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9482. 'string-match)
  9483. (cdr (assoc ext apps))
  9484. (cdr (assoc t apps))))))
  9485. (when (eq cmd 'system)
  9486. (setq cmd (cdr (assoc 'system apps))))
  9487. (when (eq cmd 'default)
  9488. (setq cmd (cdr (assoc t apps))))
  9489. (when (eq cmd 'mailcap)
  9490. (require 'mailcap)
  9491. (mailcap-parse-mailcaps)
  9492. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9493. (command (mailcap-mime-info mime-type)))
  9494. (if (stringp command)
  9495. (setq cmd command)
  9496. (setq cmd 'emacs))))
  9497. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  9498. (not (file-exists-p file))
  9499. (not org-open-non-existing-files))
  9500. (error "No such file: %s" file))
  9501. (cond
  9502. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  9503. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  9504. (while (string-match "['\"]%s['\"]" cmd)
  9505. (setq cmd (replace-match "%s" t t cmd)))
  9506. (while (string-match "%s" cmd)
  9507. (setq cmd (replace-match
  9508. (save-match-data
  9509. (shell-quote-argument
  9510. (convert-standard-filename file)))
  9511. t t cmd)))
  9512. ;; Replace "%1", "%2" etc. in command with group matches from regex
  9513. (save-match-data
  9514. (let ((match-index 1)
  9515. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  9516. (set-match-data link-match-data)
  9517. (while (<= match-index number-of-groups)
  9518. (let ((regex (concat "%" (number-to-string match-index)))
  9519. (replace-with (match-string match-index dlink)))
  9520. (while (string-match regex cmd)
  9521. (setq cmd (replace-match replace-with t t cmd))))
  9522. (setq match-index (+ match-index 1)))))
  9523. (save-window-excursion
  9524. (message "Running %s...done" cmd)
  9525. (start-process-shell-command cmd nil cmd)
  9526. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  9527. ((or (stringp cmd)
  9528. (eq cmd 'emacs))
  9529. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  9530. (widen)
  9531. (if line (org-goto-line line)
  9532. (if search (org-link-search search))))
  9533. ((consp cmd)
  9534. (let ((file (convert-standard-filename file)))
  9535. (save-match-data
  9536. (set-match-data link-match-data)
  9537. (eval cmd))))
  9538. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  9539. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  9540. (or (not (equal old-buffer (current-buffer)))
  9541. (not (equal old-pos (point))))
  9542. (org-mark-ring-push old-pos old-buffer))))
  9543. (defun org-file-apps-entry-match-against-dlink-p (entry)
  9544. "This function returns non-nil if `entry' uses a regular
  9545. expression which should be matched against the whole link by
  9546. org-open-file.
  9547. It assumes that is the case when the entry uses a regular
  9548. expression which has at least one grouping construct and the
  9549. action is either a lisp form or a command string containing
  9550. '%1', i.e. using at least one subexpression match as a
  9551. parameter."
  9552. (let ((selector (car entry))
  9553. (action (cdr entry)))
  9554. (if (stringp selector)
  9555. (and (> (regexp-opt-depth selector) 0)
  9556. (or (and (stringp action)
  9557. (string-match "%[0-9]" action))
  9558. (consp action)))
  9559. nil)))
  9560. (defun org-default-apps ()
  9561. "Return the default applications for this operating system."
  9562. (cond
  9563. ((eq system-type 'darwin)
  9564. org-file-apps-defaults-macosx)
  9565. ((eq system-type 'windows-nt)
  9566. org-file-apps-defaults-windowsnt)
  9567. (t org-file-apps-defaults-gnu)))
  9568. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  9569. "Convert extensions to regular expressions in the cars of LIST.
  9570. Also, weed out any non-string entries, because the return value is used
  9571. only for regexp matching.
  9572. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  9573. point to the symbol `emacs', indicating that the file should
  9574. be opened in Emacs."
  9575. (append
  9576. (delq nil
  9577. (mapcar (lambda (x)
  9578. (if (not (stringp (car x)))
  9579. nil
  9580. (if (string-match "\\W" (car x))
  9581. x
  9582. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  9583. list))
  9584. (if add-auto-mode
  9585. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  9586. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  9587. (defun org-file-remote-p (file)
  9588. "Test whether FILE specifies a location on a remote system.
  9589. Return non-nil if the location is indeed remote.
  9590. For example, the filename \"/user@host:/foo\" specifies a location
  9591. on the system \"/user@host:\"."
  9592. (cond ((fboundp 'file-remote-p)
  9593. (file-remote-p file))
  9594. ((fboundp 'tramp-handle-file-remote-p)
  9595. (tramp-handle-file-remote-p file))
  9596. ((and (boundp 'ange-ftp-name-format)
  9597. (string-match (car ange-ftp-name-format) file))
  9598. t)))
  9599. ;;;; Refiling
  9600. (defun org-get-org-file ()
  9601. "Read a filename, with default directory `org-directory'."
  9602. (let ((default (or org-default-notes-file remember-data-file)))
  9603. (read-file-name (format "File name [%s]: " default)
  9604. (file-name-as-directory org-directory)
  9605. default)))
  9606. (defun org-notes-order-reversed-p ()
  9607. "Check if the current file should receive notes in reversed order."
  9608. (cond
  9609. ((not org-reverse-note-order) nil)
  9610. ((eq t org-reverse-note-order) t)
  9611. ((not (listp org-reverse-note-order)) nil)
  9612. (t (catch 'exit
  9613. (let ((all org-reverse-note-order)
  9614. entry)
  9615. (while (setq entry (pop all))
  9616. (if (string-match (car entry) buffer-file-name)
  9617. (throw 'exit (cdr entry))))
  9618. nil)))))
  9619. (defvar org-refile-target-table nil
  9620. "The list of refile targets, created by `org-refile'.")
  9621. (defvar org-agenda-new-buffers nil
  9622. "Buffers created to visit agenda files.")
  9623. (defvar org-refile-cache nil
  9624. "Cache for refile targets.")
  9625. (defvar org-refile-markers nil
  9626. "All the markers used for caching refile locations.")
  9627. (defun org-refile-marker (pos)
  9628. "Get a new refile marker, but only if caching is in use."
  9629. (if (not org-refile-use-cache)
  9630. pos
  9631. (let ((m (make-marker)))
  9632. (move-marker m pos)
  9633. (push m org-refile-markers)
  9634. m)))
  9635. (defun org-refile-cache-clear ()
  9636. "Clear the refile cache and disable all the markers."
  9637. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  9638. (setq org-refile-markers nil)
  9639. (setq org-refile-cache nil)
  9640. (message "Refile cache has been cleared"))
  9641. (defun org-refile-cache-check-set (set)
  9642. "Check if all the markers in the cache still have live buffers."
  9643. (let (marker)
  9644. (catch 'exit
  9645. (while (and set (setq marker (nth 3 (pop set))))
  9646. ;; if org-refile-use-outline-path is 'file, marker may be nil
  9647. (when (and marker (null (marker-buffer marker)))
  9648. (message "not found") (sit-for 3)
  9649. (throw 'exit nil)))
  9650. t)))
  9651. (defun org-refile-cache-put (set &rest identifiers)
  9652. "Push the refile targets SET into the cache, under IDENTIFIERS."
  9653. (let* ((key (sha1 (prin1-to-string identifiers)))
  9654. (entry (assoc key org-refile-cache)))
  9655. (if entry
  9656. (setcdr entry set)
  9657. (push (cons key set) org-refile-cache))))
  9658. (defun org-refile-cache-get (&rest identifiers)
  9659. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  9660. (cond
  9661. ((not org-refile-cache) nil)
  9662. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  9663. (t
  9664. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  9665. org-refile-cache))))
  9666. (and set (org-refile-cache-check-set set) set)))))
  9667. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  9668. "Produce a table with refile targets."
  9669. (let ((case-fold-search nil)
  9670. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  9671. (entries (or org-refile-targets '((nil . (:level . 1)))))
  9672. targets tgs txt re files f desc descre fast-path-p level pos0)
  9673. (message "Getting targets...")
  9674. (with-current-buffer (or default-buffer (current-buffer))
  9675. (while (setq entry (pop entries))
  9676. (setq files (car entry) desc (cdr entry))
  9677. (setq fast-path-p nil)
  9678. (cond
  9679. ((null files) (setq files (list (current-buffer))))
  9680. ((eq files 'org-agenda-files)
  9681. (setq files (org-agenda-files 'unrestricted)))
  9682. ((and (symbolp files) (fboundp files))
  9683. (setq files (funcall files)))
  9684. ((and (symbolp files) (boundp files))
  9685. (setq files (symbol-value files))))
  9686. (if (stringp files) (setq files (list files)))
  9687. (cond
  9688. ((eq (car desc) :tag)
  9689. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  9690. ((eq (car desc) :todo)
  9691. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  9692. ((eq (car desc) :regexp)
  9693. (setq descre (cdr desc)))
  9694. ((eq (car desc) :level)
  9695. (setq descre (concat "^\\*\\{" (number-to-string
  9696. (if org-odd-levels-only
  9697. (1- (* 2 (cdr desc)))
  9698. (cdr desc)))
  9699. "\\}[ \t]")))
  9700. ((eq (car desc) :maxlevel)
  9701. (setq fast-path-p t)
  9702. (setq descre (concat "^\\*\\{1," (number-to-string
  9703. (if org-odd-levels-only
  9704. (1- (* 2 (cdr desc)))
  9705. (cdr desc)))
  9706. "\\}[ \t]")))
  9707. (t (error "Bad refiling target description %s" desc)))
  9708. (while (setq f (pop files))
  9709. (with-current-buffer
  9710. (if (bufferp f) f (org-get-agenda-file-buffer f))
  9711. (or
  9712. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  9713. (progn
  9714. (if (bufferp f) (setq f (buffer-file-name
  9715. (buffer-base-buffer f))))
  9716. (setq f (and f (expand-file-name f)))
  9717. (if (eq org-refile-use-outline-path 'file)
  9718. (push (list (file-name-nondirectory f) f nil nil) tgs))
  9719. (save-excursion
  9720. (save-restriction
  9721. (widen)
  9722. (goto-char (point-min))
  9723. (while (re-search-forward descre nil t)
  9724. (goto-char (setq pos0 (point-at-bol)))
  9725. (catch 'next
  9726. (when org-refile-target-verify-function
  9727. (save-match-data
  9728. (or (funcall org-refile-target-verify-function)
  9729. (throw 'next t))))
  9730. (when (and (looking-at org-complex-heading-regexp)
  9731. (not (member (match-string 4) excluded-entries))
  9732. (match-string 4))
  9733. (setq level (org-reduced-level
  9734. (- (match-end 1) (match-beginning 1)))
  9735. txt (org-link-display-format (match-string 4))
  9736. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  9737. re (format org-complex-heading-regexp-format
  9738. (regexp-quote (match-string 4))))
  9739. (when org-refile-use-outline-path
  9740. (setq txt (mapconcat
  9741. 'org-protect-slash
  9742. (append
  9743. (if (eq org-refile-use-outline-path
  9744. 'file)
  9745. (list (file-name-nondirectory
  9746. (buffer-file-name
  9747. (buffer-base-buffer))))
  9748. (if (eq org-refile-use-outline-path
  9749. 'full-file-path)
  9750. (list (buffer-file-name
  9751. (buffer-base-buffer)))))
  9752. (org-get-outline-path fast-path-p
  9753. level txt)
  9754. (list txt))
  9755. "/")))
  9756. (push (list txt f re (org-refile-marker (point)))
  9757. tgs)))
  9758. (when (= (point) pos0)
  9759. ;; verification function has not moved point
  9760. (goto-char (point-at-eol))))))))
  9761. (when org-refile-use-cache
  9762. (org-refile-cache-put tgs (buffer-file-name) descre))
  9763. (setq targets (append tgs targets))
  9764. ))))
  9765. (message "Getting targets...done")
  9766. (nreverse targets)))
  9767. (defun org-protect-slash (s)
  9768. (while (string-match "/" s)
  9769. (setq s (replace-match "\\" t t s)))
  9770. s)
  9771. (defvar org-olpa (make-vector 20 nil))
  9772. (defun org-get-outline-path (&optional fastp level heading)
  9773. "Return the outline path to the current entry, as a list.
  9774. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  9775. routine which makes outline path derivations for an entire file,
  9776. avoiding backtracing. Refile target collection makes use of that."
  9777. (if fastp
  9778. (progn
  9779. (if (> level 19)
  9780. (error "Outline path failure, more than 19 levels"))
  9781. (loop for i from level upto 19 do
  9782. (aset org-olpa i nil))
  9783. (prog1
  9784. (delq nil (append org-olpa nil))
  9785. (aset org-olpa level heading)))
  9786. (let (rtn case-fold-search)
  9787. (save-excursion
  9788. (save-restriction
  9789. (widen)
  9790. (while (org-up-heading-safe)
  9791. (when (looking-at org-complex-heading-regexp)
  9792. (push (org-match-string-no-properties 4) rtn)))
  9793. rtn)))))
  9794. (defun org-format-outline-path (path &optional width prefix separator)
  9795. "Format the outline path PATH for display.
  9796. WIDTH is the maximum number of characters that is available.
  9797. PREFIX is a prefix to be included in the returned string,
  9798. such as the file name.
  9799. SEPARATOR is inserted between the different parts of the path,
  9800. the default is \"/\"."
  9801. (setq width (or width 79))
  9802. (if prefix (setq width (- width (length prefix))))
  9803. (if (not path)
  9804. (or prefix "")
  9805. (let* ((nsteps (length path))
  9806. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  9807. (maxwidth (if (<= total-width width)
  9808. 10000 ;; everything fits
  9809. ;; we need to shorten the level headings
  9810. (/ (- width nsteps) nsteps)))
  9811. (org-odd-levels-only nil)
  9812. (n 0)
  9813. (total (1+ (length prefix))))
  9814. (setq maxwidth (max maxwidth 10))
  9815. (concat prefix
  9816. (if prefix (or separator "/"))
  9817. (mapconcat
  9818. (lambda (h)
  9819. (setq n (1+ n))
  9820. (if (and (= n nsteps) (< maxwidth 10000))
  9821. (setq maxwidth (- total-width total)))
  9822. (if (< (length h) maxwidth)
  9823. (progn (setq total (+ total (length h) 1)) h)
  9824. (setq h (substring h 0 (- maxwidth 2))
  9825. total (+ total maxwidth 1))
  9826. (if (string-match "[ \t]+\\'" h)
  9827. (setq h (substring h 0 (match-beginning 0))))
  9828. (setq h (concat h "..")))
  9829. (org-add-props h nil 'face
  9830. (nth (% (1- n) org-n-level-faces)
  9831. org-level-faces))
  9832. h)
  9833. path (or separator "/"))))))
  9834. (defun org-display-outline-path (&optional file current separator just-return-string)
  9835. "Display the current outline path in the echo area.
  9836. If FILE is non-nil, prepend the output with the file name.
  9837. If CURRENT is non-nil, append the current heading to the output.
  9838. SEPARATOR is passed through to `org-format-outline-path'. It separates
  9839. the different parts of the path and defaults to \"/\".
  9840. If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
  9841. (interactive "P")
  9842. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  9843. (case-fold-search nil)
  9844. (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
  9845. res)
  9846. (if current (setq path (append path
  9847. (save-excursion
  9848. (org-back-to-heading t)
  9849. (if (looking-at org-complex-heading-regexp)
  9850. (list (match-string 4)))))))
  9851. (setq res
  9852. (org-format-outline-path
  9853. path
  9854. (1- (frame-width))
  9855. (and file bfn (concat (file-name-nondirectory bfn) separator))
  9856. separator))
  9857. (if just-return-string
  9858. (org-no-properties res)
  9859. (message "%s" res))))
  9860. (defvar org-refile-history nil
  9861. "History for refiling operations.")
  9862. (defvar org-after-refile-insert-hook nil
  9863. "Hook run after `org-refile' has inserted its stuff at the new location.
  9864. Note that this is still *before* the stuff will be removed from
  9865. the *old* location.")
  9866. (defvar org-capture-last-stored-marker)
  9867. (defvar org-refile-keep nil
  9868. "Non-nil means `org-refile' will copy instead of refile.")
  9869. (defun org-copy ()
  9870. "Like `org-refile', but copy."
  9871. (interactive)
  9872. (let ((org-refile-keep t))
  9873. (funcall 'org-refile nil nil nil "Copy")))
  9874. (defun org-refile (&optional goto default-buffer rfloc msg)
  9875. "Move the entry or entries at point to another heading.
  9876. The list of target headings is compiled using the information in
  9877. `org-refile-targets', which see.
  9878. At the target location, the entry is filed as a subitem of the target
  9879. heading. Depending on `org-reverse-note-order', the new subitem will
  9880. either be the first or the last subitem.
  9881. If there is an active region, all entries in that region will be moved.
  9882. However, the region must fulfill the requirement that the first heading
  9883. is the first one sets the top-level of the moved text - at most siblings
  9884. below it are allowed.
  9885. With prefix arg GOTO, the command will only visit the target location
  9886. and not actually move anything.
  9887. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  9888. go to the location where the last refiling operation has put the subtree.
  9889. With a prefix argument of `2', refile to the running clock.
  9890. RFLOC can be a refile location obtained in a different way.
  9891. MSG is a string to replace \"Refile\" in the default prompt with
  9892. another verb. E.g. `org-copy' sets this parameter to \"Copy\".
  9893. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  9894. If you are using target caching (see `org-refile-use-cache'),
  9895. you have to clear the target cache in order to find new targets.
  9896. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  9897. prefix argument (`C-u C-u C-u C-c C-w')."
  9898. (interactive "P")
  9899. (if (member goto '(0 (64)))
  9900. (org-refile-cache-clear)
  9901. (let* ((actionmsg (or msg "Refile"))
  9902. (cbuf (current-buffer))
  9903. (regionp (org-region-active-p))
  9904. (region-start (and regionp (region-beginning)))
  9905. (region-end (and regionp (region-end)))
  9906. (region-length (and regionp (- region-end region-start)))
  9907. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9908. pos it nbuf file re level reversed)
  9909. (setq last-command nil)
  9910. (when regionp
  9911. (goto-char region-start)
  9912. (or (bolp) (goto-char (point-at-bol)))
  9913. (setq region-start (point))
  9914. (unless (or (org-kill-is-subtree-p
  9915. (buffer-substring region-start region-end))
  9916. (prog1 org-refile-active-region-within-subtree
  9917. (org-toggle-heading)))
  9918. (error "The region is not a (sequence of) subtree(s)")))
  9919. (if (equal goto '(16))
  9920. (org-refile-goto-last-stored)
  9921. (when (or
  9922. (and (equal goto 2)
  9923. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9924. (prog1
  9925. (setq it (list (or org-clock-heading "running clock")
  9926. (buffer-file-name
  9927. (marker-buffer org-clock-hd-marker))
  9928. ""
  9929. (marker-position org-clock-hd-marker)))
  9930. (setq goto nil)))
  9931. (setq it (or rfloc
  9932. (let (heading-text)
  9933. (save-excursion
  9934. (unless goto
  9935. (org-back-to-heading t)
  9936. (setq heading-text
  9937. (nth 4 (org-heading-components))))
  9938. (org-refile-get-location
  9939. (cond (goto "Goto")
  9940. (regionp (concat actionmsg " region to"))
  9941. (t (concat actionmsg " subtree \""
  9942. heading-text "\" to")))
  9943. default-buffer
  9944. (and (not (equal '(4) goto))
  9945. org-refile-allow-creating-parent-nodes)
  9946. goto))))))
  9947. (setq file (nth 1 it)
  9948. re (nth 2 it)
  9949. pos (nth 3 it))
  9950. (if (and (not goto)
  9951. pos
  9952. (equal (buffer-file-name) file)
  9953. (if regionp
  9954. (and (>= pos region-start)
  9955. (<= pos region-end))
  9956. (and (>= pos (point))
  9957. (< pos (save-excursion
  9958. (org-end-of-subtree t t))))))
  9959. (error "Cannot refile to position inside the tree or region"))
  9960. (setq nbuf (or (find-buffer-visiting file)
  9961. (find-file-noselect file)))
  9962. (if goto
  9963. (progn
  9964. (org-pop-to-buffer-same-window nbuf)
  9965. (goto-char pos)
  9966. (org-show-context 'org-goto))
  9967. (if regionp
  9968. (progn
  9969. (org-kill-new (buffer-substring region-start region-end))
  9970. (org-save-markers-in-region region-start region-end))
  9971. (org-copy-subtree 1 nil t))
  9972. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9973. (find-file-noselect file)))
  9974. (setq reversed (org-notes-order-reversed-p))
  9975. (save-excursion
  9976. (save-restriction
  9977. (widen)
  9978. (if pos
  9979. (progn
  9980. (goto-char pos)
  9981. (looking-at org-outline-regexp)
  9982. (setq level (org-get-valid-level (funcall outline-level) 1))
  9983. (goto-char
  9984. (if reversed
  9985. (or (outline-next-heading) (point-max))
  9986. (or (save-excursion (org-get-next-sibling))
  9987. (org-end-of-subtree t t)
  9988. (point-max)))))
  9989. (setq level 1)
  9990. (if (not reversed)
  9991. (goto-char (point-max))
  9992. (goto-char (point-min))
  9993. (or (outline-next-heading) (goto-char (point-max)))))
  9994. (if (not (bolp)) (newline))
  9995. (org-paste-subtree level)
  9996. (when org-log-refile
  9997. (org-add-log-setup 'refile nil nil 'findpos
  9998. org-log-refile)
  9999. (unless (eq org-log-refile 'note)
  10000. (save-excursion (org-add-log-note))))
  10001. (and org-auto-align-tags
  10002. (let ((org-loop-over-headlines-in-active-region nil))
  10003. (org-set-tags nil t)))
  10004. (bookmark-set "org-refile-last-stored")
  10005. ;; If we are refiling for capture, make sure that the
  10006. ;; last-capture pointers point here
  10007. (when (org-bound-and-true-p org-refile-for-capture)
  10008. (bookmark-set "org-capture-last-stored-marker")
  10009. (move-marker org-capture-last-stored-marker (point)))
  10010. (if (fboundp 'deactivate-mark) (deactivate-mark))
  10011. (run-hooks 'org-after-refile-insert-hook))))
  10012. (unless org-refile-keep
  10013. (if regionp
  10014. (delete-region (point) (+ (point) region-length))
  10015. (org-cut-subtree)))
  10016. (when (featurep 'org-inlinetask)
  10017. (org-inlinetask-remove-END-maybe))
  10018. (setq org-markers-to-move nil)
  10019. (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
  10020. (defun org-refile-goto-last-stored ()
  10021. "Go to the location where the last refile was stored."
  10022. (interactive)
  10023. (bookmark-jump "org-refile-last-stored")
  10024. (message "This is the location of the last refile"))
  10025. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  10026. no-exclude)
  10027. "Prompt the user for a refile location, using PROMPT.
  10028. PROMPT should not be suffixed with a colon and a space, because
  10029. this function appends the default value from
  10030. `org-refile-history' automatically, if that is not empty.
  10031. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  10032. this is used for the GOTO interface."
  10033. (let ((org-refile-targets org-refile-targets)
  10034. (org-refile-use-outline-path org-refile-use-outline-path)
  10035. excluded-entries)
  10036. (when (and (derived-mode-p 'org-mode)
  10037. (not org-refile-use-cache)
  10038. (not no-exclude))
  10039. (org-map-tree
  10040. (lambda()
  10041. (setq excluded-entries
  10042. (append excluded-entries (list (org-get-heading t t)))))))
  10043. (setq org-refile-target-table
  10044. (org-refile-get-targets default-buffer excluded-entries)))
  10045. (unless org-refile-target-table
  10046. (error "No refile targets"))
  10047. (let* ((cbuf (current-buffer))
  10048. (partial-completion-mode nil)
  10049. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  10050. (cfunc (if (and org-refile-use-outline-path
  10051. org-outline-path-complete-in-steps)
  10052. 'org-olpath-completing-read
  10053. 'org-icompleting-read))
  10054. (extra (if org-refile-use-outline-path "/" ""))
  10055. (cbnex (concat (buffer-name) extra))
  10056. (filename (and cfn (expand-file-name cfn)))
  10057. (tbl (mapcar
  10058. (lambda (x)
  10059. (if (and (not (member org-refile-use-outline-path
  10060. '(file full-file-path)))
  10061. (not (equal filename (nth 1 x))))
  10062. (cons (concat (car x) extra " ("
  10063. (file-name-nondirectory (nth 1 x)) ")")
  10064. (cdr x))
  10065. (cons (concat (car x) extra) (cdr x))))
  10066. org-refile-target-table))
  10067. (completion-ignore-case t)
  10068. cdef
  10069. (prompt (concat prompt
  10070. (or (and (car org-refile-history)
  10071. (concat " (default " (car org-refile-history) ")"))
  10072. (and (assoc cbnex tbl) (setq cdef cbnex)
  10073. (concat " (default " cbnex ")"))) ": "))
  10074. pa answ parent-target child parent old-hist)
  10075. (setq old-hist org-refile-history)
  10076. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  10077. nil 'org-refile-history (or cdef (car org-refile-history))))
  10078. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  10079. (org-refile-check-position pa)
  10080. (if pa
  10081. (progn
  10082. (when (or (not org-refile-history)
  10083. (not (eq old-hist org-refile-history))
  10084. (not (equal (car pa) (car org-refile-history))))
  10085. (setq org-refile-history
  10086. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  10087. org-refile-history
  10088. (cdr org-refile-history))))
  10089. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  10090. (pop org-refile-history)))
  10091. pa)
  10092. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  10093. (progn
  10094. (setq parent (match-string 1 answ)
  10095. child (match-string 2 answ))
  10096. (setq parent-target (or (assoc parent tbl)
  10097. (assoc (concat parent "/") tbl)))
  10098. (when (and parent-target
  10099. (or (eq new-nodes t)
  10100. (and (eq new-nodes 'confirm)
  10101. (y-or-n-p (format "Create new node \"%s\"? "
  10102. child)))))
  10103. (org-refile-new-child parent-target child)))
  10104. (error "Invalid target location")))))
  10105. (declare-function org-string-nw-p "org-macs.el" (s))
  10106. (defun org-refile-check-position (refile-pointer)
  10107. "Check if the refile pointer matches the readline to which it points."
  10108. (let* ((file (nth 1 refile-pointer))
  10109. (re (nth 2 refile-pointer))
  10110. (pos (nth 3 refile-pointer))
  10111. buffer)
  10112. (when (org-string-nw-p re)
  10113. (setq buffer (if (markerp pos)
  10114. (marker-buffer pos)
  10115. (or (find-buffer-visiting file)
  10116. (find-file-noselect file))))
  10117. (with-current-buffer buffer
  10118. (save-excursion
  10119. (save-restriction
  10120. (widen)
  10121. (goto-char pos)
  10122. (beginning-of-line 1)
  10123. (unless (org-looking-at-p re)
  10124. (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  10125. (defun org-refile-new-child (parent-target child)
  10126. "Use refile target PARENT-TARGET to add new CHILD below it."
  10127. (unless parent-target
  10128. (error "Cannot find parent for new node"))
  10129. (let ((file (nth 1 parent-target))
  10130. (pos (nth 3 parent-target))
  10131. level)
  10132. (with-current-buffer (or (find-buffer-visiting file)
  10133. (find-file-noselect file))
  10134. (save-excursion
  10135. (save-restriction
  10136. (widen)
  10137. (if pos
  10138. (goto-char pos)
  10139. (goto-char (point-max))
  10140. (if (not (bolp)) (newline)))
  10141. (when (looking-at org-outline-regexp)
  10142. (setq level (funcall outline-level))
  10143. (org-end-of-subtree t t))
  10144. (org-back-over-empty-lines)
  10145. (insert "\n" (make-string
  10146. (if pos (org-get-valid-level level 1) 1) ?*)
  10147. " " child "\n")
  10148. (beginning-of-line 0)
  10149. (list (concat (car parent-target) "/" child) file "" (point)))))))
  10150. (defun org-olpath-completing-read (prompt collection &rest args)
  10151. "Read an outline path like a file name."
  10152. (let ((thetable collection)
  10153. (org-completion-use-ido nil) ; does not work with ido.
  10154. (org-completion-use-iswitchb nil)) ; or iswitchb
  10155. (apply
  10156. 'org-icompleting-read prompt
  10157. (lambda (string predicate &optional flag)
  10158. (let (rtn r f (l (length string)))
  10159. (cond
  10160. ((eq flag nil)
  10161. ;; try completion
  10162. (try-completion string thetable))
  10163. ((eq flag t)
  10164. ;; all-completions
  10165. (setq rtn (all-completions string thetable predicate))
  10166. (mapcar
  10167. (lambda (x)
  10168. (setq r (substring x l))
  10169. (if (string-match " ([^)]*)$" x)
  10170. (setq f (match-string 0 x))
  10171. (setq f ""))
  10172. (if (string-match "/" r)
  10173. (concat string (substring r 0 (match-end 0)) f)
  10174. x))
  10175. rtn))
  10176. ((eq flag 'lambda)
  10177. ;; exact match?
  10178. (assoc string thetable)))))
  10179. args)))
  10180. ;;;; Dynamic blocks
  10181. (defun org-find-dblock (name)
  10182. "Find the first dynamic block with name NAME in the buffer.
  10183. If not found, stay at current position and return nil."
  10184. (let ((case-fold-search t) pos)
  10185. (save-excursion
  10186. (goto-char (point-min))
  10187. (setq pos (and (re-search-forward
  10188. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10189. (match-beginning 0))))
  10190. (if pos (goto-char pos))
  10191. pos))
  10192. (defconst org-dblock-start-re
  10193. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  10194. "Matches the start line of a dynamic block, with parameters.")
  10195. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  10196. "Matches the end of a dynamic block.")
  10197. (defun org-create-dblock (plist)
  10198. "Create a dynamic block section, with parameters taken from PLIST.
  10199. PLIST must contain a :name entry which is used as name of the block."
  10200. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10201. (end-of-line 1)
  10202. (newline))
  10203. (let ((col (current-column))
  10204. (name (plist-get plist :name)))
  10205. (insert "#+BEGIN: " name)
  10206. (while plist
  10207. (if (eq (car plist) :name)
  10208. (setq plist (cddr plist))
  10209. (insert " " (prin1-to-string (pop plist)))))
  10210. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10211. (beginning-of-line -2)))
  10212. (defun org-prepare-dblock ()
  10213. "Prepare dynamic block for refresh.
  10214. This empties the block, puts the cursor at the insert position and returns
  10215. the property list including an extra property :name with the block name."
  10216. (unless (looking-at org-dblock-start-re)
  10217. (error "Not at a dynamic block"))
  10218. (let* ((begdel (1+ (match-end 0)))
  10219. (name (org-no-properties (match-string 1)))
  10220. (params (append (list :name name)
  10221. (read (concat "(" (match-string 3) ")")))))
  10222. (save-excursion
  10223. (beginning-of-line 1)
  10224. (skip-chars-forward " \t")
  10225. (setq params (plist-put params :indentation-column (current-column))))
  10226. (unless (re-search-forward org-dblock-end-re nil t)
  10227. (error "Dynamic block not terminated"))
  10228. (setq params
  10229. (append params
  10230. (list :content (buffer-substring
  10231. begdel (match-beginning 0)))))
  10232. (delete-region begdel (match-beginning 0))
  10233. (goto-char begdel)
  10234. (open-line 1)
  10235. params))
  10236. (defun org-map-dblocks (&optional command)
  10237. "Apply COMMAND to all dynamic blocks in the current buffer.
  10238. If COMMAND is not given, use `org-update-dblock'."
  10239. (let ((cmd (or command 'org-update-dblock)))
  10240. (save-excursion
  10241. (goto-char (point-min))
  10242. (while (re-search-forward org-dblock-start-re nil t)
  10243. (goto-char (match-beginning 0))
  10244. (save-excursion
  10245. (condition-case nil
  10246. (funcall cmd)
  10247. (error (message "Error during update of dynamic block"))))
  10248. (unless (re-search-forward org-dblock-end-re nil t)
  10249. (error "Dynamic block not terminated"))))))
  10250. (defun org-dblock-update (&optional arg)
  10251. "User command for updating dynamic blocks.
  10252. Update the dynamic block at point. With prefix ARG, update all dynamic
  10253. blocks in the buffer."
  10254. (interactive "P")
  10255. (if arg
  10256. (org-update-all-dblocks)
  10257. (or (looking-at org-dblock-start-re)
  10258. (org-beginning-of-dblock))
  10259. (org-update-dblock)))
  10260. (defun org-update-dblock ()
  10261. "Update the dynamic block at point.
  10262. This means to empty the block, parse for parameters and then call
  10263. the correct writing function."
  10264. (interactive)
  10265. (save-window-excursion
  10266. (let* ((pos (point))
  10267. (line (org-current-line))
  10268. (params (org-prepare-dblock))
  10269. (name (plist-get params :name))
  10270. (indent (plist-get params :indentation-column))
  10271. (cmd (intern (concat "org-dblock-write:" name))))
  10272. (message "Updating dynamic block `%s' at line %d..." name line)
  10273. (funcall cmd params)
  10274. (message "Updating dynamic block `%s' at line %d...done" name line)
  10275. (goto-char pos)
  10276. (when (and indent (> indent 0))
  10277. (setq indent (make-string indent ?\ ))
  10278. (save-excursion
  10279. (org-beginning-of-dblock)
  10280. (forward-line 1)
  10281. (while (not (looking-at org-dblock-end-re))
  10282. (insert indent)
  10283. (beginning-of-line 2))
  10284. (when (looking-at org-dblock-end-re)
  10285. (and (looking-at "[ \t]+")
  10286. (replace-match ""))
  10287. (insert indent)))))))
  10288. (defun org-beginning-of-dblock ()
  10289. "Find the beginning of the dynamic block at point.
  10290. Error if there is no such block at point."
  10291. (let ((pos (point))
  10292. beg)
  10293. (end-of-line 1)
  10294. (if (and (re-search-backward org-dblock-start-re nil t)
  10295. (setq beg (match-beginning 0))
  10296. (re-search-forward org-dblock-end-re nil t)
  10297. (> (match-end 0) pos))
  10298. (goto-char beg)
  10299. (goto-char pos)
  10300. (error "Not in a dynamic block"))))
  10301. ;;;###autoload
  10302. (defun org-update-all-dblocks ()
  10303. "Update all dynamic blocks in the buffer.
  10304. This function can be used in a hook."
  10305. (interactive)
  10306. (when (derived-mode-p 'org-mode)
  10307. (org-map-dblocks 'org-update-dblock)))
  10308. ;;;; Completion
  10309. (defconst org-additional-option-like-keywords
  10310. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
  10311. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
  10312. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  10313. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
  10314. "BEGIN:" "END:"
  10315. "ORGTBL" "TBLFM:" "TBLNAME:"
  10316. "BEGIN_EXAMPLE" "END_EXAMPLE"
  10317. "BEGIN_VERBATIM" "END_VERBATIM"
  10318. "BEGIN_QUOTE" "END_QUOTE"
  10319. "BEGIN_VERSE" "END_VERSE"
  10320. "BEGIN_CENTER" "END_CENTER"
  10321. "BEGIN_SRC" "END_SRC"
  10322. "BEGIN_RESULT" "END_RESULT"
  10323. "BEGIN_lstlisting" "END_lstlisting"
  10324. "NAME:" "RESULTS:"
  10325. "HEADER:" "HEADERS:"
  10326. "COLUMNS:" "PROPERTY:"
  10327. "CAPTION:" "LABEL:"
  10328. "SETUPFILE:"
  10329. "INCLUDE:"
  10330. "BIND:"
  10331. "MACRO:"))
  10332. (defconst org-options-keywords
  10333. '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
  10334. "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
  10335. "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
  10336. "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
  10337. "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
  10338. "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:" "STYLE:"
  10339. "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
  10340. (defconst org-additional-option-like-keywords-for-flyspell
  10341. (delete-dups
  10342. (split-string
  10343. (mapconcat (lambda(k)
  10344. (replace-regexp-in-string
  10345. "_\\|:" " "
  10346. (concat k " " (downcase k) " " (upcase k))))
  10347. (append org-options-keywords org-additional-option-like-keywords)
  10348. " ")
  10349. " +" t)))
  10350. (defcustom org-structure-template-alist
  10351. '(
  10352. ("s" "#+BEGIN_SRC ?\n\n#+END_SRC"
  10353. "<src lang=\"?\">\n\n</src>")
  10354. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE"
  10355. "<example>\n?\n</example>")
  10356. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE"
  10357. "<quote>\n?\n</quote>")
  10358. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE"
  10359. "<verse>\n?\n</verse>")
  10360. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER"
  10361. "<center>\n?\n</center>")
  10362. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10363. "<literal style=\"latex\">\n?\n</literal>")
  10364. ("L" "#+LaTeX: "
  10365. "<literal style=\"latex\">?</literal>")
  10366. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10367. "<literal style=\"html\">\n?\n</literal>")
  10368. ("H" "#+HTML: "
  10369. "<literal style=\"html\">?</literal>")
  10370. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
  10371. ("A" "#+ASCII: ")
  10372. ("i" "#+INDEX: ?"
  10373. "#+INDEX: ?")
  10374. ("I" "#+INCLUDE: %file ?"
  10375. "<include file=%file markup=\"?\">")
  10376. )
  10377. "Structure completion elements.
  10378. This is a list of abbreviation keys and values. The value gets inserted
  10379. if you type `<' followed by the key and then press the completion key,
  10380. usually `M-TAB'. %file will be replaced by a file name after prompting
  10381. for the file using completion. The cursor will be placed at the position
  10382. of the `?` in the template.
  10383. There are two templates for each key, the first uses the original Org syntax,
  10384. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10385. the default when the /org-mtags.el/ module has been loaded. See also the
  10386. variable `org-mtags-prefer-muse-templates'."
  10387. :group 'org-completion
  10388. :type '(repeat
  10389. (string :tag "Key")
  10390. (string :tag "Template")
  10391. (string :tag "Muse Template")))
  10392. (defun org-try-structure-completion ()
  10393. "Try to complete a structure template before point.
  10394. This looks for strings like \"<e\" on an otherwise empty line and
  10395. expands them."
  10396. (let ((l (buffer-substring (point-at-bol) (point)))
  10397. a)
  10398. (when (and (looking-at "[ \t]*$")
  10399. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10400. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10401. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10402. (match-beginning 1)) a)
  10403. t)))
  10404. (defun org-complete-expand-structure-template (start cell)
  10405. "Expand a structure template."
  10406. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10407. (rpl (nth (if musep 2 1) cell))
  10408. (ind ""))
  10409. (delete-region start (point))
  10410. (when (string-match "\\`#\\+" rpl)
  10411. (cond
  10412. ((bolp))
  10413. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10414. (setq ind (buffer-substring (point-at-bol) (point))))
  10415. (t (newline))))
  10416. (setq start (point))
  10417. (if (string-match "%file" rpl)
  10418. (setq rpl (replace-match
  10419. (concat
  10420. "\""
  10421. (save-match-data
  10422. (abbreviate-file-name (read-file-name "Include file: ")))
  10423. "\"")
  10424. t t rpl)))
  10425. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10426. (concat "\n" ind)))
  10427. (insert rpl)
  10428. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10429. ;;;; TODO, DEADLINE, Comments
  10430. (defun org-toggle-comment ()
  10431. "Change the COMMENT state of an entry."
  10432. (interactive)
  10433. (save-excursion
  10434. (org-back-to-heading)
  10435. (let (case-fold-search)
  10436. (cond
  10437. ((looking-at (format org-heading-keyword-regexp-format
  10438. org-comment-string))
  10439. (goto-char (match-end 1))
  10440. (looking-at (concat " +" org-comment-string))
  10441. (replace-match "" t t)
  10442. (when (eolp) (insert " ")))
  10443. ((looking-at org-outline-regexp)
  10444. (goto-char (match-end 0))
  10445. (insert org-comment-string " "))))))
  10446. (defvar org-last-todo-state-is-todo nil
  10447. "This is non-nil when the last TODO state change led to a TODO state.
  10448. If the last change removed the TODO tag or switched to DONE, then
  10449. this is nil.")
  10450. (defvar org-setting-tags nil) ; dynamically skipped
  10451. (defvar org-todo-setup-filter-hook nil
  10452. "Hook for functions that pre-filter todo specs.
  10453. Each function takes a todo spec and returns either nil or the spec
  10454. transformed into canonical form." )
  10455. (defvar org-todo-get-default-hook nil
  10456. "Hook for functions that get a default item for todo.
  10457. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10458. nil or a string to be used for the todo mark." )
  10459. (defvar org-agenda-headline-snapshot-before-repeat)
  10460. (defun org-current-effective-time ()
  10461. "Return current time adjusted for `org-extend-today-until' variable."
  10462. (let* ((ct (org-current-time))
  10463. (dct (decode-time ct))
  10464. (ct1
  10465. (cond
  10466. (org-use-last-clock-out-time-as-effective-time
  10467. (or (org-clock-get-last-clock-out-time) ct))
  10468. ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
  10469. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
  10470. (t ct))))
  10471. ct1))
  10472. (defun org-todo-yesterday (&optional arg)
  10473. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10474. (interactive "P")
  10475. (if (eq major-mode 'org-agenda-mode)
  10476. (apply 'org-agenda-todo-yesterday arg)
  10477. (let* ((hour (third (decode-time
  10478. (org-current-time))))
  10479. (org-extend-today-until (1+ hour)))
  10480. (org-todo arg))))
  10481. (defun org-todo (&optional arg)
  10482. "Change the TODO state of an item.
  10483. The state of an item is given by a keyword at the start of the heading,
  10484. like
  10485. *** TODO Write paper
  10486. *** DONE Call mom
  10487. The different keywords are specified in the variable `org-todo-keywords'.
  10488. By default the available states are \"TODO\" and \"DONE\".
  10489. So for this example: when the item starts with TODO, it is changed to DONE.
  10490. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10491. DONE are present, add TODO at the beginning of the heading.
  10492. With \\[universal-argument] prefix arg, use completion to determine the new \
  10493. state.
  10494. With numeric prefix arg, switch to that state.
  10495. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10496. keywords (nextset).
  10497. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10498. With a numeric prefix arg of 0, inhibit note taking for the change.
  10499. For calling through lisp, arg is also interpreted in the following way:
  10500. 'none -> empty state
  10501. \"\"(empty string) -> switch to empty state
  10502. 'done -> switch to DONE
  10503. 'nextset -> switch to the next set of keywords
  10504. 'previousset -> switch to the previous set of keywords
  10505. \"WAITING\" -> switch to the specified keyword, but only if it
  10506. really is a member of `org-todo-keywords'."
  10507. (interactive "P")
  10508. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10509. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10510. 'region-start-level 'region))
  10511. org-loop-over-headlines-in-active-region)
  10512. (org-map-entries
  10513. `(org-todo ,arg)
  10514. org-loop-over-headlines-in-active-region
  10515. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  10516. (if (equal arg '(16)) (setq arg 'nextset))
  10517. (let ((org-blocker-hook org-blocker-hook)
  10518. (case-fold-search nil))
  10519. (when (equal arg '(64))
  10520. (setq arg nil org-blocker-hook nil))
  10521. (when (and org-blocker-hook
  10522. (or org-inhibit-blocking
  10523. (org-entry-get nil "NOBLOCKING")))
  10524. (setq org-blocker-hook nil))
  10525. (save-excursion
  10526. (catch 'exit
  10527. (org-back-to-heading t)
  10528. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  10529. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  10530. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  10531. (let* ((match-data (match-data))
  10532. (startpos (point-at-bol))
  10533. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  10534. (org-log-done org-log-done)
  10535. (org-log-repeat org-log-repeat)
  10536. (org-todo-log-states org-todo-log-states)
  10537. (org-inhibit-logging
  10538. (if (equal arg 0)
  10539. (progn (setq arg nil) 'note) org-inhibit-logging))
  10540. (this (match-string 1))
  10541. (hl-pos (match-beginning 0))
  10542. (head (org-get-todo-sequence-head this))
  10543. (ass (assoc head org-todo-kwd-alist))
  10544. (interpret (nth 1 ass))
  10545. (done-word (nth 3 ass))
  10546. (final-done-word (nth 4 ass))
  10547. (org-last-state (or this ""))
  10548. (completion-ignore-case t)
  10549. (member (member this org-todo-keywords-1))
  10550. (tail (cdr member))
  10551. (org-state (cond
  10552. ((and org-todo-key-trigger
  10553. (or (and (equal arg '(4))
  10554. (eq org-use-fast-todo-selection 'prefix))
  10555. (and (not arg) org-use-fast-todo-selection
  10556. (not (eq org-use-fast-todo-selection
  10557. 'prefix)))))
  10558. ;; Use fast selection
  10559. (org-fast-todo-selection))
  10560. ((and (equal arg '(4))
  10561. (or (not org-use-fast-todo-selection)
  10562. (not org-todo-key-trigger)))
  10563. ;; Read a state with completion
  10564. (org-icompleting-read
  10565. "State: " (mapcar (lambda(x) (list x))
  10566. org-todo-keywords-1)
  10567. nil t))
  10568. ((eq arg 'right)
  10569. (if this
  10570. (if tail (car tail) nil)
  10571. (car org-todo-keywords-1)))
  10572. ((eq arg 'left)
  10573. (if (equal member org-todo-keywords-1)
  10574. nil
  10575. (if this
  10576. (nth (- (length org-todo-keywords-1)
  10577. (length tail) 2)
  10578. org-todo-keywords-1)
  10579. (org-last org-todo-keywords-1))))
  10580. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  10581. (setq arg nil))) ; hack to fall back to cycling
  10582. (arg
  10583. ;; user or caller requests a specific state
  10584. (cond
  10585. ((equal arg "") nil)
  10586. ((eq arg 'none) nil)
  10587. ((eq arg 'done) (or done-word (car org-done-keywords)))
  10588. ((eq arg 'nextset)
  10589. (or (car (cdr (member head org-todo-heads)))
  10590. (car org-todo-heads)))
  10591. ((eq arg 'previousset)
  10592. (let ((org-todo-heads (reverse org-todo-heads)))
  10593. (or (car (cdr (member head org-todo-heads)))
  10594. (car org-todo-heads))))
  10595. ((car (member arg org-todo-keywords-1)))
  10596. ((stringp arg)
  10597. (error "State `%s' not valid in this file" arg))
  10598. ((nth (1- (prefix-numeric-value arg))
  10599. org-todo-keywords-1))))
  10600. ((null member) (or head (car org-todo-keywords-1)))
  10601. ((equal this final-done-word) nil) ;; -> make empty
  10602. ((null tail) nil) ;; -> first entry
  10603. ((memq interpret '(type priority))
  10604. (if (eq this-command last-command)
  10605. (car tail)
  10606. (if (> (length tail) 0)
  10607. (or done-word (car org-done-keywords))
  10608. nil)))
  10609. (t
  10610. (car tail))))
  10611. (org-state (or
  10612. (run-hook-with-args-until-success
  10613. 'org-todo-get-default-hook org-state org-last-state)
  10614. org-state))
  10615. (next (if org-state (concat " " org-state " ") " "))
  10616. (change-plist (list :type 'todo-state-change :from this :to org-state
  10617. :position startpos))
  10618. dolog now-done-p)
  10619. (when org-blocker-hook
  10620. (setq org-last-todo-state-is-todo
  10621. (not (member this org-done-keywords)))
  10622. (unless (save-excursion
  10623. (save-match-data
  10624. (org-with-wide-buffer
  10625. (run-hook-with-args-until-failure
  10626. 'org-blocker-hook change-plist))))
  10627. (if (org-called-interactively-p 'interactive)
  10628. (error "TODO state change from %s to %s blocked" this org-state)
  10629. ;; fail silently
  10630. (message "TODO state change from %s to %s blocked" this org-state)
  10631. (throw 'exit nil))))
  10632. (store-match-data match-data)
  10633. (replace-match next t t)
  10634. (unless (pos-visible-in-window-p hl-pos)
  10635. (message "TODO state changed to %s" (org-trim next)))
  10636. (unless head
  10637. (setq head (org-get-todo-sequence-head org-state)
  10638. ass (assoc head org-todo-kwd-alist)
  10639. interpret (nth 1 ass)
  10640. done-word (nth 3 ass)
  10641. final-done-word (nth 4 ass)))
  10642. (when (memq arg '(nextset previousset))
  10643. (message "Keyword-Set %d/%d: %s"
  10644. (- (length org-todo-sets) -1
  10645. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  10646. (length org-todo-sets)
  10647. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  10648. (setq org-last-todo-state-is-todo
  10649. (not (member org-state org-done-keywords)))
  10650. (setq now-done-p (and (member org-state org-done-keywords)
  10651. (not (member this org-done-keywords))))
  10652. (and logging (org-local-logging logging))
  10653. (when (and (or org-todo-log-states org-log-done)
  10654. (not (eq org-inhibit-logging t))
  10655. (not (memq arg '(nextset previousset))))
  10656. ;; we need to look at recording a time and note
  10657. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  10658. (nth 2 (assoc this org-todo-log-states))))
  10659. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  10660. (setq dolog 'time))
  10661. (when (and org-state
  10662. (member org-state org-not-done-keywords)
  10663. (not (member this org-not-done-keywords)))
  10664. ;; This is now a todo state and was not one before
  10665. ;; If there was a CLOSED time stamp, get rid of it.
  10666. (org-add-planning-info nil nil 'closed))
  10667. (when (and now-done-p org-log-done)
  10668. ;; It is now done, and it was not done before
  10669. (org-add-planning-info 'closed (org-current-effective-time))
  10670. (if (and (not dolog) (eq 'note org-log-done))
  10671. (org-add-log-setup 'done org-state this 'findpos 'note)))
  10672. (when (and org-state dolog)
  10673. ;; This is a non-nil state, and we need to log it
  10674. (org-add-log-setup 'state org-state this 'findpos dolog)))
  10675. ;; Fixup tag positioning
  10676. (org-todo-trigger-tag-changes org-state)
  10677. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  10678. (when org-provide-todo-statistics
  10679. (org-update-parent-todo-statistics))
  10680. (run-hooks 'org-after-todo-state-change-hook)
  10681. (if (and arg (not (member org-state org-done-keywords)))
  10682. (setq head (org-get-todo-sequence-head org-state)))
  10683. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  10684. ;; Do we need to trigger a repeat?
  10685. (when now-done-p
  10686. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  10687. ;; This is for the agenda, take a snapshot of the headline.
  10688. (save-match-data
  10689. (setq org-agenda-headline-snapshot-before-repeat
  10690. (org-get-heading))))
  10691. (org-auto-repeat-maybe org-state))
  10692. ;; Fixup cursor location if close to the keyword
  10693. (if (and (outline-on-heading-p)
  10694. (not (bolp))
  10695. (save-excursion (beginning-of-line 1)
  10696. (looking-at org-todo-line-regexp))
  10697. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  10698. (progn
  10699. (goto-char (or (match-end 2) (match-end 1)))
  10700. (and (looking-at " ") (just-one-space))))
  10701. (when org-trigger-hook
  10702. (save-excursion
  10703. (run-hook-with-args 'org-trigger-hook change-plist)))))))))
  10704. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  10705. "Block turning an entry into a TODO, using the hierarchy.
  10706. This checks whether the current task should be blocked from state
  10707. changes. Such blocking occurs when:
  10708. 1. The task has children which are not all in a completed state.
  10709. 2. A task has a parent with the property :ORDERED:, and there
  10710. are siblings prior to the current task with incomplete
  10711. status.
  10712. 3. The parent of the task is blocked because it has siblings that should
  10713. be done first, or is child of a block grandparent TODO entry."
  10714. (if (not org-enforce-todo-dependencies)
  10715. t ; if locally turned off don't block
  10716. (catch 'dont-block
  10717. ;; If this is not a todo state change, or if this entry is already DONE,
  10718. ;; do not block
  10719. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10720. (member (plist-get change-plist :from)
  10721. (cons 'done org-done-keywords))
  10722. (member (plist-get change-plist :to)
  10723. (cons 'todo org-not-done-keywords))
  10724. (not (plist-get change-plist :to)))
  10725. (throw 'dont-block t))
  10726. ;; If this task has children, and any are undone, it's blocked
  10727. (save-excursion
  10728. (org-back-to-heading t)
  10729. (let ((this-level (funcall outline-level)))
  10730. (outline-next-heading)
  10731. (let ((child-level (funcall outline-level)))
  10732. (while (and (not (eobp))
  10733. (> child-level this-level))
  10734. ;; this todo has children, check whether they are all
  10735. ;; completed
  10736. (if (and (not (org-entry-is-done-p))
  10737. (org-entry-is-todo-p))
  10738. (throw 'dont-block nil))
  10739. (outline-next-heading)
  10740. (setq child-level (funcall outline-level))))))
  10741. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  10742. ;; any previous siblings are undone, it's blocked
  10743. (save-excursion
  10744. (org-back-to-heading t)
  10745. (let* ((pos (point))
  10746. (parent-pos (and (org-up-heading-safe) (point))))
  10747. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10748. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10749. (forward-line 1)
  10750. (re-search-forward org-not-done-heading-regexp pos t))
  10751. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  10752. ;; Search further up the hierarchy, to see if an ancestor is blocked
  10753. (while t
  10754. (goto-char parent-pos)
  10755. (if (not (looking-at org-not-done-heading-regexp))
  10756. (throw 'dont-block t)) ; do not block, parent is not a TODO
  10757. (setq pos (point))
  10758. (setq parent-pos (and (org-up-heading-safe) (point)))
  10759. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10760. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10761. (forward-line 1)
  10762. (re-search-forward org-not-done-heading-regexp pos t))
  10763. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  10764. (defcustom org-track-ordered-property-with-tag nil
  10765. "Should the ORDERED property also be shown as a tag?
  10766. The ORDERED property decides if an entry should require subtasks to be
  10767. completed in sequence. Since a property is not very visible, setting
  10768. this option means that toggling the ORDERED property with the command
  10769. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  10770. not relevant for the behavior, but it makes things more visible.
  10771. Note that toggling the tag with tags commands will not change the property
  10772. and therefore not influence behavior!
  10773. This can be t, meaning the tag ORDERED should be used, It can also be a
  10774. string to select a different tag for this task."
  10775. :group 'org-todo
  10776. :type '(choice
  10777. (const :tag "No tracking" nil)
  10778. (const :tag "Track with ORDERED tag" t)
  10779. (string :tag "Use other tag")))
  10780. (defun org-toggle-ordered-property ()
  10781. "Toggle the ORDERED property of the current entry.
  10782. For better visibility, you can track the value of this property with a tag.
  10783. See variable `org-track-ordered-property-with-tag'."
  10784. (interactive)
  10785. (let* ((t1 org-track-ordered-property-with-tag)
  10786. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  10787. (save-excursion
  10788. (org-back-to-heading)
  10789. (if (org-entry-get nil "ORDERED")
  10790. (progn
  10791. (org-delete-property "ORDERED")
  10792. (and tag (org-toggle-tag tag 'off))
  10793. (message "Subtasks can be completed in arbitrary order"))
  10794. (org-entry-put nil "ORDERED" "t")
  10795. (and tag (org-toggle-tag tag 'on))
  10796. (message "Subtasks must be completed in sequence")))))
  10797. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  10798. (defun org-block-todo-from-checkboxes (change-plist)
  10799. "Block turning an entry into a TODO, using checkboxes.
  10800. This checks whether the current task should be blocked from state
  10801. changes because there are unchecked boxes in this entry."
  10802. (if (not org-enforce-todo-checkbox-dependencies)
  10803. t ; if locally turned off don't block
  10804. (catch 'dont-block
  10805. ;; If this is not a todo state change, or if this entry is already DONE,
  10806. ;; do not block
  10807. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10808. (member (plist-get change-plist :from)
  10809. (cons 'done org-done-keywords))
  10810. (member (plist-get change-plist :to)
  10811. (cons 'todo org-not-done-keywords))
  10812. (not (plist-get change-plist :to)))
  10813. (throw 'dont-block t))
  10814. ;; If this task has checkboxes that are not checked, it's blocked
  10815. (save-excursion
  10816. (org-back-to-heading t)
  10817. (let ((beg (point)) end)
  10818. (outline-next-heading)
  10819. (setq end (point))
  10820. (goto-char beg)
  10821. (if (org-list-search-forward
  10822. (concat (org-item-beginning-re)
  10823. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  10824. "\\[[- ]\\]")
  10825. end t)
  10826. (progn
  10827. (if (boundp 'org-blocked-by-checkboxes)
  10828. (setq org-blocked-by-checkboxes t))
  10829. (throw 'dont-block nil)))))
  10830. t))) ; do not block
  10831. (defun org-entry-blocked-p ()
  10832. "Is the current entry blocked?"
  10833. (if (org-entry-get nil "NOBLOCKING")
  10834. nil ;; Never block this entry
  10835. (not
  10836. (run-hook-with-args-until-failure
  10837. 'org-blocker-hook
  10838. (list :type 'todo-state-change
  10839. :position (point)
  10840. :from 'todo
  10841. :to 'done)))))
  10842. (defun org-update-statistics-cookies (all)
  10843. "Update the statistics cookie, either from TODO or from checkboxes.
  10844. This should be called with the cursor in a line with a statistics cookie."
  10845. (interactive "P")
  10846. (if all
  10847. (progn
  10848. (org-update-checkbox-count 'all)
  10849. (org-map-entries 'org-update-parent-todo-statistics))
  10850. (if (not (org-at-heading-p))
  10851. (org-update-checkbox-count)
  10852. (let ((pos (move-marker (make-marker) (point)))
  10853. end l1 l2)
  10854. (ignore-errors (org-back-to-heading t))
  10855. (if (not (org-at-heading-p))
  10856. (org-update-checkbox-count)
  10857. (setq l1 (org-outline-level))
  10858. (setq end (save-excursion
  10859. (outline-next-heading)
  10860. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  10861. (point)))
  10862. (if (and (save-excursion
  10863. (re-search-forward
  10864. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  10865. (not (save-excursion (re-search-forward
  10866. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  10867. (org-update-checkbox-count)
  10868. (if (and l2 (> l2 l1))
  10869. (progn
  10870. (goto-char end)
  10871. (org-update-parent-todo-statistics))
  10872. (goto-char pos)
  10873. (beginning-of-line 1)
  10874. (while (re-search-forward
  10875. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  10876. (point-at-eol) t)
  10877. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  10878. (goto-char pos)
  10879. (move-marker pos nil)))))
  10880. (defvar org-entry-property-inherited-from) ;; defined below
  10881. (defun org-update-parent-todo-statistics ()
  10882. "Update any statistics cookie in the parent of the current headline.
  10883. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  10884. the entire subtree and this will travel up the hierarchy and update
  10885. statistics everywhere."
  10886. (let* ((prop (save-excursion (org-up-heading-safe)
  10887. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  10888. (recursive (or (not org-hierarchical-todo-statistics)
  10889. (and prop (string-match "\\<recursive\\>" prop))))
  10890. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  10891. 0))
  10892. (first t)
  10893. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10894. level ltoggle l1 new ndel
  10895. (cnt-all 0) (cnt-done 0) is-percent kwd
  10896. checkbox-beg ov ovs ove cookie-present)
  10897. (catch 'exit
  10898. (save-excursion
  10899. (beginning-of-line 1)
  10900. (setq ltoggle (funcall outline-level))
  10901. ;; Three situations are to consider:
  10902. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  10903. ;; to the top-level ancestor on the headline;
  10904. ;; 2. If parent has "recursive" property, repeat up to the
  10905. ;; headline setting that property, taking inheritance into
  10906. ;; account;
  10907. ;; 3. Else, move up to direct parent and proceed only once.
  10908. (while (and (setq level (org-up-heading-safe))
  10909. (or recursive first)
  10910. (>= (point) lim))
  10911. (setq first nil cookie-present nil)
  10912. (unless (and level
  10913. (not (string-match
  10914. "\\<checkbox\\>"
  10915. (downcase (or (org-entry-get nil "COOKIE_DATA")
  10916. "")))))
  10917. (throw 'exit nil))
  10918. (while (re-search-forward box-re (point-at-eol) t)
  10919. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10920. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  10921. (save-match-data
  10922. (unless (outline-next-heading) (throw 'exit nil))
  10923. (while (and (looking-at org-complex-heading-regexp)
  10924. (> (setq l1 (length (match-string 1))) level))
  10925. (setq kwd (and (or recursive (= l1 ltoggle))
  10926. (match-string 2)))
  10927. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10928. (and (listp org-provide-todo-statistics)
  10929. (or (member kwd org-provide-todo-statistics)
  10930. (member kwd org-done-keywords))))
  10931. (setq cnt-all (1+ cnt-all))
  10932. (if (eq org-provide-todo-statistics t)
  10933. (and kwd (setq cnt-all (1+ cnt-all)))))
  10934. (and (member kwd org-done-keywords)
  10935. (setq cnt-done (1+ cnt-done)))
  10936. (outline-next-heading)))
  10937. (setq new
  10938. (if is-percent
  10939. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10940. (format "[%d/%d]" cnt-done cnt-all))
  10941. ndel (- (match-end 0) checkbox-beg))
  10942. ;; handle overlays when updating cookie from column view
  10943. (when (setq ov (car (overlays-at checkbox-beg)))
  10944. (setq ovs (overlay-start ov) ove (overlay-end ov))
  10945. (delete-overlay ov))
  10946. (goto-char checkbox-beg)
  10947. (insert new)
  10948. (delete-region (point) (+ (point) ndel))
  10949. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  10950. (when ov (move-overlay ov ovs ove)))
  10951. (when cookie-present
  10952. (run-hook-with-args 'org-after-todo-statistics-hook
  10953. cnt-done (- cnt-all cnt-done))))))
  10954. (run-hooks 'org-todo-statistics-hook)))
  10955. (defvar org-after-todo-statistics-hook nil
  10956. "Hook that is called after a TODO statistics cookie has been updated.
  10957. Each function is called with two arguments: the number of not-done entries
  10958. and the number of done entries.
  10959. For example, the following function, when added to this hook, will switch
  10960. an entry to DONE when all children are done, and back to TODO when new
  10961. entries are set to a TODO status. Note that this hook is only called
  10962. when there is a statistics cookie in the headline!
  10963. (defun org-summary-todo (n-done n-not-done)
  10964. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10965. (let (org-log-done org-log-states) ; turn off logging
  10966. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10967. ")
  10968. (defvar org-todo-statistics-hook nil
  10969. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10970. This hook runs even if there is no statistics cookie present, in which case
  10971. `org-after-todo-statistics-hook' would not run.")
  10972. (defun org-todo-trigger-tag-changes (state)
  10973. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10974. (let ((l org-todo-state-tags-triggers)
  10975. changes)
  10976. (when (or (not state) (equal state ""))
  10977. (setq changes (append changes (cdr (assoc "" l)))))
  10978. (when (and (stringp state) (> (length state) 0))
  10979. (setq changes (append changes (cdr (assoc state l)))))
  10980. (when (member state org-not-done-keywords)
  10981. (setq changes (append changes (cdr (assoc 'todo l)))))
  10982. (when (member state org-done-keywords)
  10983. (setq changes (append changes (cdr (assoc 'done l)))))
  10984. (dolist (c changes)
  10985. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10986. (defun org-local-logging (value)
  10987. "Get logging settings from a property VALUE."
  10988. (let* (words w a)
  10989. ;; directly set the variables, they are already local.
  10990. (setq org-log-done nil
  10991. org-log-repeat nil
  10992. org-todo-log-states nil)
  10993. (setq words (org-split-string value))
  10994. (while (setq w (pop words))
  10995. (cond
  10996. ((setq a (assoc w org-startup-options))
  10997. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10998. (set (nth 1 a) (nth 2 a))))
  10999. ((setq a (org-extract-log-state-settings w))
  11000. (and (member (car a) org-todo-keywords-1)
  11001. (push a org-todo-log-states)))))))
  11002. (defun org-get-todo-sequence-head (kwd)
  11003. "Return the head of the TODO sequence to which KWD belongs.
  11004. If KWD is not set, check if there is a text property remembering the
  11005. right sequence."
  11006. (let (p)
  11007. (cond
  11008. ((not kwd)
  11009. (or (get-text-property (point-at-bol) 'org-todo-head)
  11010. (progn
  11011. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  11012. nil (point-at-eol)))
  11013. (get-text-property p 'org-todo-head))))
  11014. ((not (member kwd org-todo-keywords-1))
  11015. (car org-todo-keywords-1))
  11016. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  11017. (defun org-fast-todo-selection ()
  11018. "Fast TODO keyword selection with single keys.
  11019. Returns the new TODO keyword, or nil if no state change should occur."
  11020. (let* ((fulltable org-todo-key-alist)
  11021. (done-keywords org-done-keywords) ;; needed for the faces.
  11022. (maxlen (apply 'max (mapcar
  11023. (lambda (x)
  11024. (if (stringp (car x)) (string-width (car x)) 0))
  11025. fulltable)))
  11026. (expert nil)
  11027. (fwidth (+ maxlen 3 1 3))
  11028. (ncol (/ (- (window-width) 4) fwidth))
  11029. tg cnt e c tbl
  11030. groups ingroup)
  11031. (save-excursion
  11032. (save-window-excursion
  11033. (if expert
  11034. (set-buffer (get-buffer-create " *Org todo*"))
  11035. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  11036. (erase-buffer)
  11037. (org-set-local 'org-done-keywords done-keywords)
  11038. (setq tbl fulltable cnt 0)
  11039. (while (setq e (pop tbl))
  11040. (cond
  11041. ((equal e '(:startgroup))
  11042. (push '() groups) (setq ingroup t)
  11043. (when (not (= cnt 0))
  11044. (setq cnt 0)
  11045. (insert "\n"))
  11046. (insert "{ "))
  11047. ((equal e '(:endgroup))
  11048. (setq ingroup nil cnt 0)
  11049. (insert "}\n"))
  11050. ((equal e '(:newline))
  11051. (when (not (= cnt 0))
  11052. (setq cnt 0)
  11053. (insert "\n")
  11054. (setq e (car tbl))
  11055. (while (equal (car tbl) '(:newline))
  11056. (insert "\n")
  11057. (setq tbl (cdr tbl)))))
  11058. (t
  11059. (setq tg (car e) c (cdr e))
  11060. (if ingroup (push tg (car groups)))
  11061. (setq tg (org-add-props tg nil 'face
  11062. (org-get-todo-face tg)))
  11063. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11064. (insert "[" c "] " tg (make-string
  11065. (- fwidth 4 (length tg)) ?\ ))
  11066. (when (= (setq cnt (1+ cnt)) ncol)
  11067. (insert "\n")
  11068. (if ingroup (insert " "))
  11069. (setq cnt 0)))))
  11070. (insert "\n")
  11071. (goto-char (point-min))
  11072. (if (not expert) (org-fit-window-to-buffer))
  11073. (message "[a-z..]:Set [SPC]:clear")
  11074. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11075. (cond
  11076. ((or (= c ?\C-g)
  11077. (and (= c ?q) (not (rassoc c fulltable))))
  11078. (setq quit-flag t))
  11079. ((= c ?\ ) nil)
  11080. ((setq e (rassoc c fulltable) tg (car e))
  11081. tg)
  11082. (t (setq quit-flag t)))))))
  11083. (defun org-entry-is-todo-p ()
  11084. (member (org-get-todo-state) org-not-done-keywords))
  11085. (defun org-entry-is-done-p ()
  11086. (member (org-get-todo-state) org-done-keywords))
  11087. (defun org-get-todo-state ()
  11088. (save-excursion
  11089. (org-back-to-heading t)
  11090. (and (looking-at org-todo-line-regexp)
  11091. (match-end 2)
  11092. (match-string 2))))
  11093. (defun org-at-date-range-p (&optional inactive-ok)
  11094. "Is the cursor inside a date range?"
  11095. (interactive)
  11096. (save-excursion
  11097. (catch 'exit
  11098. (let ((pos (point)))
  11099. (skip-chars-backward "^[<\r\n")
  11100. (skip-chars-backward "<[")
  11101. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11102. (>= (match-end 0) pos)
  11103. (throw 'exit t))
  11104. (skip-chars-backward "^<[\r\n")
  11105. (skip-chars-backward "<[")
  11106. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11107. (>= (match-end 0) pos)
  11108. (throw 'exit t)))
  11109. nil)))
  11110. (defun org-get-repeat (&optional tagline)
  11111. "Check if there is a deadline/schedule with repeater in this entry."
  11112. (save-match-data
  11113. (save-excursion
  11114. (org-back-to-heading t)
  11115. (and (re-search-forward (if tagline
  11116. (concat tagline "\\s-*" org-repeat-re)
  11117. org-repeat-re)
  11118. (org-entry-end-position) t)
  11119. (match-string-no-properties 1)))))
  11120. (defvar org-last-changed-timestamp)
  11121. (defvar org-last-inserted-timestamp)
  11122. (defvar org-log-post-message)
  11123. (defvar org-log-note-purpose)
  11124. (defvar org-log-note-how)
  11125. (defvar org-log-note-extra)
  11126. (defun org-auto-repeat-maybe (done-word)
  11127. "Check if the current headline contains a repeated deadline/schedule.
  11128. If yes, set TODO state back to what it was and change the base date
  11129. of repeating deadline/scheduled time stamps to new date.
  11130. This function is run automatically after each state change to a DONE state."
  11131. ;; last-state is dynamically scoped into this function
  11132. (let* ((repeat (org-get-repeat))
  11133. (aa (assoc org-last-state org-todo-kwd-alist))
  11134. (interpret (nth 1 aa))
  11135. (head (nth 2 aa))
  11136. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11137. (msg "Entry repeats: ")
  11138. (org-log-done nil)
  11139. (org-todo-log-states nil)
  11140. re type n what ts time to-state)
  11141. (when repeat
  11142. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  11143. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  11144. org-todo-repeat-to-state))
  11145. (unless (and to-state (member to-state org-todo-keywords-1))
  11146. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11147. (org-todo to-state)
  11148. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11149. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11150. (org-time-stamp-format t t))))
  11151. (when org-log-repeat
  11152. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11153. (memq 'org-add-log-note post-command-hook))
  11154. ;; OK, we are already setup for some record
  11155. (if (eq org-log-repeat 'note)
  11156. ;; make sure we take a note, not only a time stamp
  11157. (setq org-log-note-how 'note))
  11158. ;; Set up for taking a record
  11159. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  11160. org-last-state
  11161. 'findpos org-log-repeat)))
  11162. (org-back-to-heading t)
  11163. (org-add-planning-info nil nil 'closed)
  11164. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11165. org-deadline-time-regexp "\\)\\|\\("
  11166. org-ts-regexp "\\)"))
  11167. (while (re-search-forward
  11168. re (save-excursion (outline-next-heading) (point)) t)
  11169. (setq type (if (match-end 1) org-scheduled-string
  11170. (if (match-end 3) org-deadline-string "Plain:"))
  11171. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  11172. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  11173. (setq n (string-to-number (match-string 2 ts))
  11174. what (match-string 3 ts))
  11175. (if (equal what "w") (setq n (* n 7) what "d"))
  11176. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  11177. (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  11178. ;; Preparation, see if we need to modify the start date for the change
  11179. (when (match-end 1)
  11180. (setq time (save-match-data (org-time-string-to-time ts)))
  11181. (cond
  11182. ((equal (match-string 1 ts) ".")
  11183. ;; Shift starting date to today
  11184. (org-timestamp-change
  11185. (- (org-today) (time-to-days time))
  11186. 'day))
  11187. ((equal (match-string 1 ts) "+")
  11188. (let ((nshiftmax 10) (nshift 0))
  11189. (while (or (= nshift 0)
  11190. (<= (time-to-days time)
  11191. (time-to-days (current-time))))
  11192. (when (= (incf nshift) nshiftmax)
  11193. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  11194. (error "Abort")))
  11195. (org-timestamp-change n (cdr (assoc what whata)))
  11196. (org-at-timestamp-p t)
  11197. (setq ts (match-string 1))
  11198. (setq time (save-match-data (org-time-string-to-time ts)))))
  11199. (org-timestamp-change (- n) (cdr (assoc what whata)))
  11200. ;; rematch, so that we have everything in place for the real shift
  11201. (org-at-timestamp-p t)
  11202. (setq ts (match-string 1))
  11203. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  11204. (org-timestamp-change n (cdr (assoc what whata)))
  11205. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  11206. (setq org-log-post-message msg)
  11207. (message "%s" msg))))
  11208. (defun org-show-todo-tree (arg)
  11209. "Make a compact tree which shows all headlines marked with TODO.
  11210. The tree will show the lines where the regexp matches, and all higher
  11211. headlines above the match.
  11212. With a \\[universal-argument] prefix, prompt for a regexp to match.
  11213. With a numeric prefix N, construct a sparse tree for the Nth element
  11214. of `org-todo-keywords-1'."
  11215. (interactive "P")
  11216. (let ((case-fold-search nil)
  11217. (kwd-re
  11218. (cond ((null arg) org-not-done-regexp)
  11219. ((equal arg '(4))
  11220. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  11221. (mapcar 'list org-todo-keywords-1))))
  11222. (concat "\\("
  11223. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  11224. "\\)\\>")))
  11225. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  11226. (regexp-quote (nth (1- (prefix-numeric-value arg))
  11227. org-todo-keywords-1)))
  11228. (t (error "Invalid prefix argument: %s" arg)))))
  11229. (message "%d TODO entries found"
  11230. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  11231. (defun org-deadline (&optional remove time)
  11232. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  11233. With argument REMOVE, remove any deadline from the item.
  11234. With argument TIME, set the deadline at the corresponding date. TIME
  11235. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11236. (interactive "P")
  11237. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11238. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11239. 'region-start-level 'region))
  11240. org-loop-over-headlines-in-active-region)
  11241. (org-map-entries
  11242. `(org-deadline ',remove ,time)
  11243. org-loop-over-headlines-in-active-region
  11244. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11245. (let* ((old-date (org-entry-get nil "DEADLINE"))
  11246. (repeater (and old-date
  11247. (string-match
  11248. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11249. old-date)
  11250. (match-string 1 old-date))))
  11251. (if remove
  11252. (progn
  11253. (when (and old-date org-log-redeadline)
  11254. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11255. org-log-redeadline))
  11256. (org-remove-timestamp-with-keyword org-deadline-string)
  11257. (message "Item no longer has a deadline."))
  11258. (org-add-planning-info 'deadline time 'closed)
  11259. (when (and old-date org-log-redeadline
  11260. (not (equal old-date
  11261. (substring org-last-inserted-timestamp 1 -1))))
  11262. (org-add-log-setup 'redeadline nil old-date 'findpos
  11263. org-log-redeadline))
  11264. (when repeater
  11265. (save-excursion
  11266. (org-back-to-heading t)
  11267. (when (re-search-forward (concat org-deadline-string " "
  11268. org-last-inserted-timestamp)
  11269. (save-excursion
  11270. (outline-next-heading) (point)) t)
  11271. (goto-char (1- (match-end 0)))
  11272. (insert " " repeater)
  11273. (setq org-last-inserted-timestamp
  11274. (concat (substring org-last-inserted-timestamp 0 -1)
  11275. " " repeater
  11276. (substring org-last-inserted-timestamp -1))))))
  11277. (message "Deadline on %s" org-last-inserted-timestamp)))))
  11278. (defun org-schedule (&optional remove time)
  11279. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11280. With argument REMOVE, remove any scheduling date from the item.
  11281. With argument TIME, scheduled at the corresponding date. TIME can
  11282. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11283. (interactive "P")
  11284. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11285. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11286. 'region-start-level 'region))
  11287. org-loop-over-headlines-in-active-region)
  11288. (org-map-entries
  11289. `(org-schedule ',remove ,time)
  11290. org-loop-over-headlines-in-active-region
  11291. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11292. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11293. (repeater (and old-date
  11294. (string-match
  11295. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11296. old-date)
  11297. (match-string 1 old-date))))
  11298. (if remove
  11299. (progn
  11300. (when (and old-date org-log-reschedule)
  11301. (org-add-log-setup 'delschedule nil old-date 'findpos
  11302. org-log-reschedule))
  11303. (org-remove-timestamp-with-keyword org-scheduled-string)
  11304. (message "Item is no longer scheduled."))
  11305. (org-add-planning-info 'scheduled time 'closed)
  11306. (when (and old-date org-log-reschedule
  11307. (not (equal old-date
  11308. (substring org-last-inserted-timestamp 1 -1))))
  11309. (org-add-log-setup 'reschedule nil old-date 'findpos
  11310. org-log-reschedule))
  11311. (when repeater
  11312. (save-excursion
  11313. (org-back-to-heading t)
  11314. (when (re-search-forward (concat org-scheduled-string " "
  11315. org-last-inserted-timestamp)
  11316. (save-excursion
  11317. (outline-next-heading) (point)) t)
  11318. (goto-char (1- (match-end 0)))
  11319. (insert " " repeater)
  11320. (setq org-last-inserted-timestamp
  11321. (concat (substring org-last-inserted-timestamp 0 -1)
  11322. " " repeater
  11323. (substring org-last-inserted-timestamp -1))))))
  11324. (message "Scheduled to %s" org-last-inserted-timestamp)))))
  11325. (defun org-get-scheduled-time (pom &optional inherit)
  11326. "Get the scheduled time as a time tuple, of a format suitable
  11327. for calling org-schedule with, or if there is no scheduling,
  11328. returns nil."
  11329. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11330. (when time
  11331. (apply 'encode-time (org-parse-time-string time)))))
  11332. (defun org-get-deadline-time (pom &optional inherit)
  11333. "Get the deadline as a time tuple, of a format suitable for
  11334. calling org-deadline with, or if there is no scheduling, returns
  11335. nil."
  11336. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11337. (when time
  11338. (apply 'encode-time (org-parse-time-string time)))))
  11339. (defun org-remove-timestamp-with-keyword (keyword)
  11340. "Remove all time stamps with KEYWORD in the current entry."
  11341. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11342. beg)
  11343. (save-excursion
  11344. (org-back-to-heading t)
  11345. (setq beg (point))
  11346. (outline-next-heading)
  11347. (while (re-search-backward re beg t)
  11348. (replace-match "")
  11349. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11350. (equal (char-before) ?\ ))
  11351. (backward-delete-char 1)
  11352. (if (string-match "^[ \t]*$" (buffer-substring
  11353. (point-at-bol) (point-at-eol)))
  11354. (delete-region (point-at-bol)
  11355. (min (point-max) (1+ (point-at-eol))))))))))
  11356. (defun org-add-planning-info (what &optional time &rest remove)
  11357. "Insert new timestamp with keyword in the line directly after the headline.
  11358. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11359. If non is given, the user is prompted for a date.
  11360. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11361. be removed."
  11362. (interactive)
  11363. (let (org-time-was-given org-end-time-was-given ts
  11364. end default-time default-input)
  11365. (catch 'exit
  11366. (when (and (memq what '(scheduled deadline))
  11367. (or (not time)
  11368. (and (stringp time)
  11369. (string-match "^[-+]+[0-9]" time))))
  11370. ;; Try to get a default date/time from existing timestamp
  11371. (save-excursion
  11372. (org-back-to-heading t)
  11373. (setq end (save-excursion (outline-next-heading) (point)))
  11374. (when (re-search-forward (if (eq what 'scheduled)
  11375. org-scheduled-time-regexp
  11376. org-deadline-time-regexp)
  11377. end t)
  11378. (setq ts (match-string 1)
  11379. default-time
  11380. (apply 'encode-time (org-parse-time-string ts))
  11381. default-input (and ts (org-get-compact-tod ts))))))
  11382. (when what
  11383. (setq time
  11384. (if (stringp time)
  11385. ;; This is a string (relative or absolute), set proper date
  11386. (apply 'encode-time
  11387. (org-read-date-analyze
  11388. time default-time (decode-time default-time)))
  11389. ;; If necessary, get the time from the user
  11390. (or time (org-read-date nil 'to-time nil nil
  11391. default-time default-input)))))
  11392. (when (and org-insert-labeled-timestamps-at-point
  11393. (member what '(scheduled deadline)))
  11394. (insert
  11395. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11396. (org-insert-time-stamp time org-time-was-given
  11397. nil nil nil (list org-end-time-was-given))
  11398. (setq what nil))
  11399. (save-excursion
  11400. (save-restriction
  11401. (let (col list elt ts buffer-invisibility-spec)
  11402. (org-back-to-heading t)
  11403. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11404. (goto-char (match-end 1))
  11405. (setq col (current-column))
  11406. (goto-char (match-end 0))
  11407. (if (eobp) (insert "\n") (forward-char 1))
  11408. (when (and (not what)
  11409. (not (looking-at
  11410. (concat "[ \t]*"
  11411. org-keyword-time-not-clock-regexp))))
  11412. ;; Nothing to add, nothing to remove...... :-)
  11413. (throw 'exit nil))
  11414. (if (and (not (looking-at org-outline-regexp))
  11415. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11416. "[^\r\n]*"))
  11417. (not (equal (match-string 1) org-clock-string)))
  11418. (narrow-to-region (match-beginning 0) (match-end 0))
  11419. (insert-before-markers "\n")
  11420. (backward-char 1)
  11421. (narrow-to-region (point) (point))
  11422. (and org-adapt-indentation (org-indent-to-column col)))
  11423. ;; Check if we have to remove something.
  11424. (setq list (cons what remove))
  11425. (while list
  11426. (setq elt (pop list))
  11427. (when (or (and (eq elt 'scheduled)
  11428. (re-search-forward org-scheduled-time-regexp nil t))
  11429. (and (eq elt 'deadline)
  11430. (re-search-forward org-deadline-time-regexp nil t))
  11431. (and (eq elt 'closed)
  11432. (re-search-forward org-closed-time-regexp nil t)))
  11433. (replace-match "")
  11434. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11435. (and (looking-at "[ \t]+") (replace-match ""))
  11436. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11437. (when what
  11438. (insert
  11439. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11440. (cond ((eq what 'scheduled) org-scheduled-string)
  11441. ((eq what 'deadline) org-deadline-string)
  11442. ((eq what 'closed) org-closed-string))
  11443. " ")
  11444. (setq ts (org-insert-time-stamp
  11445. time
  11446. (or org-time-was-given
  11447. (and (eq what 'closed) org-log-done-with-time))
  11448. (eq what 'closed)
  11449. nil nil (list org-end-time-was-given)))
  11450. (insert
  11451. (if (not (or (bolp) (eq (char-before) ?\ )
  11452. (memq (char-after) '(32 10))
  11453. (eobp))) " " ""))
  11454. (end-of-line 1))
  11455. (goto-char (point-min))
  11456. (widen)
  11457. (if (and (looking-at "[ \t]*\n")
  11458. (equal (char-before) ?\n))
  11459. (delete-region (1- (point)) (point-at-eol)))
  11460. ts))))))
  11461. (defvar org-log-note-marker (make-marker))
  11462. (defvar org-log-note-purpose nil)
  11463. (defvar org-log-note-state nil)
  11464. (defvar org-log-note-previous-state nil)
  11465. (defvar org-log-note-how nil)
  11466. (defvar org-log-note-extra nil)
  11467. (defvar org-log-note-window-configuration nil)
  11468. (defvar org-log-note-return-to (make-marker))
  11469. (defvar org-log-note-effective-time nil
  11470. "Remembered current time so that dynamically scoped
  11471. `org-extend-today-until' affects tha timestamps in state change
  11472. log")
  11473. (defvar org-log-post-message nil
  11474. "Message to be displayed after a log note has been stored.
  11475. The auto-repeater uses this.")
  11476. (defun org-add-note ()
  11477. "Add a note to the current entry.
  11478. This is done in the same way as adding a state change note."
  11479. (interactive)
  11480. (org-add-log-setup 'note nil nil 'findpos nil))
  11481. (defvar org-property-end-re)
  11482. (defun org-add-log-setup (&optional purpose state prev-state
  11483. findpos how extra)
  11484. "Set up the post command hook to take a note.
  11485. If this is about to TODO state change, the new state is expected in STATE.
  11486. When FINDPOS is non-nil, find the correct position for the note in
  11487. the current entry. If not, assume that it can be inserted at point.
  11488. HOW is an indicator what kind of note should be created.
  11489. EXTRA is additional text that will be inserted into the notes buffer."
  11490. (let* ((org-log-into-drawer (org-log-into-drawer))
  11491. (drawer (cond ((stringp org-log-into-drawer)
  11492. org-log-into-drawer)
  11493. (org-log-into-drawer "LOGBOOK"))))
  11494. (save-restriction
  11495. (save-excursion
  11496. (when findpos
  11497. (org-back-to-heading t)
  11498. (narrow-to-region (point) (save-excursion
  11499. (outline-next-heading) (point)))
  11500. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  11501. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  11502. "[^\r\n]*\\)?"))
  11503. (goto-char (match-end 0))
  11504. (cond
  11505. (drawer
  11506. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  11507. nil t)
  11508. (progn
  11509. (goto-char (match-end 0))
  11510. (or org-log-states-order-reversed
  11511. (and (re-search-forward org-property-end-re nil t)
  11512. (goto-char (1- (match-beginning 0))))))
  11513. (insert "\n:" drawer ":\n:END:")
  11514. (beginning-of-line 0)
  11515. (org-indent-line)
  11516. (beginning-of-line 2)
  11517. (org-indent-line)
  11518. (end-of-line 0)))
  11519. ((and org-log-state-notes-insert-after-drawers
  11520. (save-excursion
  11521. (forward-line) (looking-at org-drawer-regexp)))
  11522. (forward-line)
  11523. (while (looking-at org-drawer-regexp)
  11524. (goto-char (match-end 0))
  11525. (re-search-forward org-property-end-re (point-max) t)
  11526. (forward-line))
  11527. (forward-line -1)))
  11528. (unless org-log-states-order-reversed
  11529. (and (= (char-after) ?\n) (forward-char 1))
  11530. (org-skip-over-state-notes)
  11531. (skip-chars-backward " \t\n\r")))
  11532. (move-marker org-log-note-marker (point))
  11533. (setq org-log-note-purpose purpose
  11534. org-log-note-state state
  11535. org-log-note-previous-state prev-state
  11536. org-log-note-how how
  11537. org-log-note-extra extra
  11538. org-log-note-effective-time (org-current-effective-time))
  11539. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  11540. (defun org-skip-over-state-notes ()
  11541. "Skip past the list of State notes in an entry."
  11542. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  11543. (when (ignore-errors (goto-char (org-in-item-p)))
  11544. (let* ((struct (org-list-struct))
  11545. (prevs (org-list-prevs-alist struct)))
  11546. (while (looking-at "[ \t]*- State")
  11547. (goto-char (or (org-list-get-next-item (point) struct prevs)
  11548. (org-list-get-item-end (point) struct)))))))
  11549. (defun org-add-log-note (&optional purpose)
  11550. "Pop up a window for taking a note, and add this note later at point."
  11551. (remove-hook 'post-command-hook 'org-add-log-note)
  11552. (setq org-log-note-window-configuration (current-window-configuration))
  11553. (delete-other-windows)
  11554. (move-marker org-log-note-return-to (point))
  11555. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  11556. (goto-char org-log-note-marker)
  11557. (org-switch-to-buffer-other-window "*Org Note*")
  11558. (erase-buffer)
  11559. (if (memq org-log-note-how '(time state))
  11560. (let (current-prefix-arg) (org-store-log-note))
  11561. (let ((org-inhibit-startup t)) (org-mode))
  11562. (insert (format "# Insert note for %s.
  11563. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  11564. (cond
  11565. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  11566. ((eq org-log-note-purpose 'done) "closed todo item")
  11567. ((eq org-log-note-purpose 'state)
  11568. (format "state change from \"%s\" to \"%s\""
  11569. (or org-log-note-previous-state "")
  11570. (or org-log-note-state "")))
  11571. ((eq org-log-note-purpose 'reschedule)
  11572. "rescheduling")
  11573. ((eq org-log-note-purpose 'delschedule)
  11574. "no longer scheduled")
  11575. ((eq org-log-note-purpose 'redeadline)
  11576. "changing deadline")
  11577. ((eq org-log-note-purpose 'deldeadline)
  11578. "removing deadline")
  11579. ((eq org-log-note-purpose 'refile)
  11580. "refiling")
  11581. ((eq org-log-note-purpose 'note)
  11582. "this entry")
  11583. (t (error "This should not happen")))))
  11584. (if org-log-note-extra (insert org-log-note-extra))
  11585. (org-set-local 'org-finish-function 'org-store-log-note)
  11586. (run-hooks 'org-log-buffer-setup-hook)))
  11587. (defvar org-note-abort nil) ; dynamically scoped
  11588. (defun org-store-log-note ()
  11589. "Finish taking a log note, and insert it to where it belongs."
  11590. (let ((txt (buffer-string))
  11591. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  11592. lines ind bul)
  11593. (kill-buffer (current-buffer))
  11594. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  11595. (setq txt (replace-match "" t t txt)))
  11596. (if (string-match "\\s-+\\'" txt)
  11597. (setq txt (replace-match "" t t txt)))
  11598. (setq lines (org-split-string txt "\n"))
  11599. (when (and note (string-match "\\S-" note))
  11600. (setq note
  11601. (org-replace-escapes
  11602. note
  11603. (list (cons "%u" (user-login-name))
  11604. (cons "%U" user-full-name)
  11605. (cons "%t" (format-time-string
  11606. (org-time-stamp-format 'long 'inactive)
  11607. org-log-note-effective-time))
  11608. (cons "%T" (format-time-string
  11609. (org-time-stamp-format 'long nil)
  11610. org-log-note-effective-time))
  11611. (cons "%d" (format-time-string
  11612. (org-time-stamp-format nil 'inactive)
  11613. org-log-note-effective-time))
  11614. (cons "%D" (format-time-string
  11615. (org-time-stamp-format nil nil)
  11616. org-log-note-effective-time))
  11617. (cons "%s" (if org-log-note-state
  11618. (concat "\"" org-log-note-state "\"")
  11619. ""))
  11620. (cons "%S" (if org-log-note-previous-state
  11621. (concat "\"" org-log-note-previous-state "\"")
  11622. "\"\"")))))
  11623. (if lines (setq note (concat note " \\\\")))
  11624. (push note lines))
  11625. (when (or current-prefix-arg org-note-abort)
  11626. (when org-log-into-drawer
  11627. (org-remove-empty-drawer-at
  11628. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  11629. org-log-note-marker))
  11630. (setq lines nil))
  11631. (when lines
  11632. (with-current-buffer (marker-buffer org-log-note-marker)
  11633. (save-excursion
  11634. (goto-char org-log-note-marker)
  11635. (move-marker org-log-note-marker nil)
  11636. (end-of-line 1)
  11637. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  11638. (setq ind (save-excursion
  11639. (if (ignore-errors (goto-char (org-in-item-p)))
  11640. (let ((struct (org-list-struct)))
  11641. (org-list-get-ind
  11642. (org-list-get-top-point struct) struct))
  11643. (skip-chars-backward " \r\t\n")
  11644. (cond
  11645. ((and (org-at-heading-p)
  11646. org-adapt-indentation)
  11647. (1+ (org-current-level)))
  11648. ((org-at-heading-p) 0)
  11649. (t (org-get-indentation))))))
  11650. (setq bul (org-list-bullet-string "-"))
  11651. (org-indent-line-to ind)
  11652. (insert bul (pop lines))
  11653. (let ((ind-body (+ (length bul) ind)))
  11654. (while lines
  11655. (insert "\n")
  11656. (org-indent-line-to ind-body)
  11657. (insert (pop lines))))
  11658. (message "Note stored")
  11659. (org-back-to-heading t)
  11660. (org-cycle-hide-drawers 'children)))))
  11661. (set-window-configuration org-log-note-window-configuration)
  11662. (with-current-buffer (marker-buffer org-log-note-return-to)
  11663. (goto-char org-log-note-return-to))
  11664. (move-marker org-log-note-return-to nil)
  11665. (and org-log-post-message (message "%s" org-log-post-message)))
  11666. (defun org-remove-empty-drawer-at (drawer pos)
  11667. "Remove an empty drawer DRAWER at position POS.
  11668. POS may also be a marker."
  11669. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  11670. (save-excursion
  11671. (save-restriction
  11672. (widen)
  11673. (goto-char pos)
  11674. (if (org-in-regexp
  11675. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  11676. (replace-match ""))))))
  11677. (defvar org-ts-type nil)
  11678. (defun org-sparse-tree (&optional arg type)
  11679. "Create a sparse tree, prompt for the details.
  11680. This command can create sparse trees. You first need to select the type
  11681. of match used to create the tree:
  11682. t Show all TODO entries.
  11683. T Show entries with a specific TODO keyword.
  11684. m Show entries selected by a tags/property match.
  11685. p Enter a property name and its value (both with completion on existing
  11686. names/values) and show entries with that property.
  11687. r Show entries matching a regular expression (`/' can be used as well).
  11688. b Show deadlines and scheduled items before a date.
  11689. a Show deadlines and scheduled items after a date.
  11690. d Show deadlines due within `org-deadline-warning-days'.
  11691. D Show deadlines and scheduled items between a date range."
  11692. (interactive "P")
  11693. (let (ans kwd value ts-type)
  11694. (setq type (or type org-sparse-tree-default-date-type))
  11695. (setq org-ts-type type)
  11696. (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"
  11697. (cond ((eq type 'all) "all timestamps")
  11698. ((eq type 'scheduled) "only scheduled")
  11699. ((eq type 'deadline) "only deadline")
  11700. ((eq type 'active) "only active timestamps")
  11701. ((eq type 'inactive) "only inactive timestamps")
  11702. ((eq type 'scheduled-or-deadline) "scheduled/deadline")
  11703. (t "scheduled/deadline")))
  11704. (setq ans (read-char-exclusive))
  11705. (cond
  11706. ((equal ans ?c)
  11707. (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
  11708. ((equal ans ?d)
  11709. (call-interactively 'org-check-deadlines))
  11710. ((equal ans ?b)
  11711. (call-interactively 'org-check-before-date))
  11712. ((equal ans ?a)
  11713. (call-interactively 'org-check-after-date))
  11714. ((equal ans ?D)
  11715. (call-interactively 'org-check-dates-range))
  11716. ((equal ans ?t)
  11717. (org-show-todo-tree nil))
  11718. ((equal ans ?T)
  11719. (org-show-todo-tree '(4)))
  11720. ((member ans '(?T ?m))
  11721. (call-interactively 'org-match-sparse-tree))
  11722. ((member ans '(?p ?P))
  11723. (setq kwd (org-icompleting-read "Property: "
  11724. (mapcar 'list (org-buffer-property-keys))))
  11725. (setq value (org-icompleting-read "Value: "
  11726. (mapcar 'list (org-property-values kwd))))
  11727. (unless (string-match "\\`{.*}\\'" value)
  11728. (setq value (concat "\"" value "\"")))
  11729. (org-match-sparse-tree arg (concat kwd "=" value)))
  11730. ((member ans '(?r ?R ?/))
  11731. (call-interactively 'org-occur))
  11732. (t (error "No such sparse tree command \"%c\"" ans)))))
  11733. (defvar org-occur-highlights nil
  11734. "List of overlays used for occur matches.")
  11735. (make-variable-buffer-local 'org-occur-highlights)
  11736. (defvar org-occur-parameters nil
  11737. "Parameters of the active org-occur calls.
  11738. This is a list, each call to org-occur pushes as cons cell,
  11739. containing the regular expression and the callback, onto the list.
  11740. The list can contain several entries if `org-occur' has been called
  11741. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  11742. will only contain one set of parameters. When the highlights are
  11743. removed (for example with `C-c C-c', or with the next edit (depending
  11744. on `org-remove-highlights-with-change'), this variable is emptied
  11745. as well.")
  11746. (make-variable-buffer-local 'org-occur-parameters)
  11747. (defun org-occur (regexp &optional keep-previous callback)
  11748. "Make a compact tree which shows all matches of REGEXP.
  11749. The tree will show the lines where the regexp matches, and all higher
  11750. headlines above the match. It will also show the heading after the match,
  11751. to make sure editing the matching entry is easy.
  11752. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  11753. call to `org-occur' will be kept, to allow stacking of calls to this
  11754. command.
  11755. If CALLBACK is non-nil, it is a function which is called to confirm
  11756. that the match should indeed be shown."
  11757. (interactive "sRegexp: \nP")
  11758. (when (equal regexp "")
  11759. (error "Regexp cannot be empty"))
  11760. (unless keep-previous
  11761. (org-remove-occur-highlights nil nil t))
  11762. (push (cons regexp callback) org-occur-parameters)
  11763. (let ((cnt 0))
  11764. (save-excursion
  11765. (goto-char (point-min))
  11766. (if (or (not keep-previous) ; do not want to keep
  11767. (not org-occur-highlights)) ; no previous matches
  11768. ;; hide everything
  11769. (org-overview))
  11770. (while (re-search-forward regexp nil t)
  11771. (when (or (not callback)
  11772. (save-match-data (funcall callback)))
  11773. (setq cnt (1+ cnt))
  11774. (when org-highlight-sparse-tree-matches
  11775. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  11776. (org-show-context 'occur-tree))))
  11777. (when org-remove-highlights-with-change
  11778. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  11779. nil 'local))
  11780. (unless org-sparse-tree-open-archived-trees
  11781. (org-hide-archived-subtrees (point-min) (point-max)))
  11782. (run-hooks 'org-occur-hook)
  11783. (if (org-called-interactively-p 'interactive)
  11784. (message "%d match(es) for regexp %s" cnt regexp))
  11785. cnt))
  11786. (defun org-occur-next-match (&optional n reset)
  11787. "Function for `next-error-function' to find sparse tree matches.
  11788. N is the number of matches to move, when negative move backwards.
  11789. RESET is entirely ignored - this function always goes back to the
  11790. starting point when no match is found."
  11791. (let* ((limit (if (< n 0) (point-min) (point-max)))
  11792. (search-func (if (< n 0)
  11793. 'previous-single-char-property-change
  11794. 'next-single-char-property-change))
  11795. (n (abs n))
  11796. (pos (point))
  11797. p1)
  11798. (catch 'exit
  11799. (while (setq p1 (funcall search-func (point) 'org-type))
  11800. (when (equal p1 limit)
  11801. (goto-char pos)
  11802. (error "No more matches"))
  11803. (when (equal (get-char-property p1 'org-type) 'org-occur)
  11804. (setq n (1- n))
  11805. (when (= n 0)
  11806. (goto-char p1)
  11807. (throw 'exit (point))))
  11808. (goto-char p1))
  11809. (goto-char p1)
  11810. (error "No more matches"))))
  11811. (defun org-show-context (&optional key)
  11812. "Make sure point and context are visible.
  11813. How much context is shown depends upon the variables
  11814. `org-show-hierarchy-above', `org-show-following-heading',
  11815. `org-show-entry-below' and `org-show-siblings'."
  11816. (let ((heading-p (org-at-heading-p t))
  11817. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  11818. (following-p (org-get-alist-option org-show-following-heading key))
  11819. (entry-p (org-get-alist-option org-show-entry-below key))
  11820. (siblings-p (org-get-alist-option org-show-siblings key)))
  11821. (catch 'exit
  11822. ;; Show heading or entry text
  11823. (if (and heading-p (not entry-p))
  11824. (org-flag-heading nil) ; only show the heading
  11825. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  11826. (org-show-hidden-entry))) ; show entire entry
  11827. (when following-p
  11828. ;; Show next sibling, or heading below text
  11829. (save-excursion
  11830. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  11831. (org-flag-heading nil))))
  11832. (when siblings-p (org-show-siblings))
  11833. (when hierarchy-p
  11834. ;; show all higher headings, possibly with siblings
  11835. (save-excursion
  11836. (while (and (condition-case nil
  11837. (progn (org-up-heading-all 1) t)
  11838. (error nil))
  11839. (not (bobp)))
  11840. (org-flag-heading nil)
  11841. (when siblings-p (org-show-siblings))))))))
  11842. (defvar org-reveal-start-hook nil
  11843. "Hook run before revealing a location.")
  11844. (defun org-reveal (&optional siblings)
  11845. "Show current entry, hierarchy above it, and the following headline.
  11846. This can be used to show a consistent set of context around locations
  11847. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  11848. not t for the search context.
  11849. With optional argument SIBLINGS, on each level of the hierarchy all
  11850. siblings are shown. This repairs the tree structure to what it would
  11851. look like when opened with hierarchical calls to `org-cycle'.
  11852. With double optional argument \\[universal-argument] \\[universal-argument], \
  11853. go to the parent and show the
  11854. entire tree."
  11855. (interactive "P")
  11856. (run-hooks 'org-reveal-start-hook)
  11857. (let ((org-show-hierarchy-above t)
  11858. (org-show-following-heading t)
  11859. (org-show-siblings (if siblings t org-show-siblings)))
  11860. (org-show-context nil))
  11861. (when (equal siblings '(16))
  11862. (save-excursion
  11863. (when (org-up-heading-safe)
  11864. (org-show-subtree)
  11865. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  11866. (defun org-highlight-new-match (beg end)
  11867. "Highlight from BEG to END and mark the highlight is an occur headline."
  11868. (let ((ov (make-overlay beg end)))
  11869. (overlay-put ov 'face 'secondary-selection)
  11870. (overlay-put ov 'org-type 'org-occur)
  11871. (push ov org-occur-highlights)))
  11872. (defun org-remove-occur-highlights (&optional beg end noremove)
  11873. "Remove the occur highlights from the buffer.
  11874. BEG and END are ignored. If NOREMOVE is nil, remove this function
  11875. from the `before-change-functions' in the current buffer."
  11876. (interactive)
  11877. (unless org-inhibit-highlight-removal
  11878. (mapc 'delete-overlay org-occur-highlights)
  11879. (setq org-occur-highlights nil)
  11880. (setq org-occur-parameters nil)
  11881. (unless noremove
  11882. (remove-hook 'before-change-functions
  11883. 'org-remove-occur-highlights 'local))))
  11884. ;;;; Priorities
  11885. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  11886. "Regular expression matching the priority indicator.")
  11887. (defvar org-remove-priority-next-time nil)
  11888. (defun org-priority-up ()
  11889. "Increase the priority of the current item."
  11890. (interactive)
  11891. (org-priority 'up))
  11892. (defun org-priority-down ()
  11893. "Decrease the priority of the current item."
  11894. (interactive)
  11895. (org-priority 'down))
  11896. (defun org-priority (&optional action show)
  11897. "Change the priority of an item.
  11898. ACTION can be `set', `up', `down', or a character."
  11899. (interactive "P")
  11900. (if (equal action '(4))
  11901. (org-show-priority)
  11902. (unless org-enable-priority-commands
  11903. (error "Priority commands are disabled"))
  11904. (setq action (or action 'set))
  11905. (let (current new news have remove)
  11906. (save-excursion
  11907. (org-back-to-heading t)
  11908. (if (looking-at org-priority-regexp)
  11909. (setq current (string-to-char (match-string 2))
  11910. have t))
  11911. (cond
  11912. ((eq action 'remove)
  11913. (setq remove t new ?\ ))
  11914. ((or (eq action 'set)
  11915. (if (featurep 'xemacs) (characterp action) (integerp action)))
  11916. (if (not (eq action 'set))
  11917. (setq new action)
  11918. (message "Priority %c-%c, SPC to remove: "
  11919. org-highest-priority org-lowest-priority)
  11920. (save-match-data
  11921. (setq new (read-char-exclusive))))
  11922. (if (and (= (upcase org-highest-priority) org-highest-priority)
  11923. (= (upcase org-lowest-priority) org-lowest-priority))
  11924. (setq new (upcase new)))
  11925. (cond ((equal new ?\ ) (setq remove t))
  11926. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  11927. (error "Priority must be between `%c' and `%c'"
  11928. org-highest-priority org-lowest-priority))))
  11929. ((eq action 'up)
  11930. (setq new (if have
  11931. (1- current) ; normal cycling
  11932. ;; last priority was empty
  11933. (if (eq last-command this-command)
  11934. org-lowest-priority ; wrap around empty to lowest
  11935. ;; default
  11936. (if org-priority-start-cycle-with-default
  11937. org-default-priority
  11938. (1- org-default-priority))))))
  11939. ((eq action 'down)
  11940. (setq new (if have
  11941. (1+ current) ; normal cycling
  11942. ;; last priority was empty
  11943. (if (eq last-command this-command)
  11944. org-highest-priority ; wrap around empty to highest
  11945. ;; default
  11946. (if org-priority-start-cycle-with-default
  11947. org-default-priority
  11948. (1+ org-default-priority))))))
  11949. (t (error "Invalid action")))
  11950. (if (or (< (upcase new) org-highest-priority)
  11951. (> (upcase new) org-lowest-priority))
  11952. (if (and (memq action '(up down))
  11953. (not have) (not (eq last-command this-command)))
  11954. ;; `new' is from default priority
  11955. (error
  11956. "The default can not be set, see `org-default-priority' why")
  11957. ;; normal cycling: `new' is beyond highest/lowest priority
  11958. ;; and is wrapped around to the empty priority
  11959. (setq remove t)))
  11960. (setq news (format "%c" new))
  11961. (if have
  11962. (if remove
  11963. (replace-match "" t t nil 1)
  11964. (replace-match news t t nil 2))
  11965. (if remove
  11966. (error "No priority cookie found in line")
  11967. (let ((case-fold-search nil))
  11968. (looking-at org-todo-line-regexp))
  11969. (if (match-end 2)
  11970. (progn
  11971. (goto-char (match-end 2))
  11972. (insert " [#" news "]"))
  11973. (goto-char (match-beginning 3))
  11974. (insert "[#" news "] "))))
  11975. (org-preserve-lc (org-set-tags nil 'align)))
  11976. (if remove
  11977. (message "Priority removed")
  11978. (message "Priority of current item set to %s" news)))))
  11979. (defun org-show-priority ()
  11980. "Show the priority of the current item.
  11981. This priority is composed of the main priority given with the [#A] cookies,
  11982. and by additional input from the age of a schedules or deadline entry."
  11983. (interactive)
  11984. (let ((pri (if (eq major-mode 'org-agenda-mode)
  11985. (org-get-at-bol 'priority)
  11986. (save-excursion
  11987. (save-match-data
  11988. (beginning-of-line)
  11989. (and (looking-at org-heading-regexp)
  11990. (org-get-priority (match-string 0))))))))
  11991. (message "Priority is %d" (if pri pri -1000))))
  11992. (defun org-get-priority (s)
  11993. "Find priority cookie and return priority."
  11994. (if (functionp org-get-priority-function)
  11995. (funcall org-get-priority-function)
  11996. (save-match-data
  11997. (if (not (string-match org-priority-regexp s))
  11998. (* 1000 (- org-lowest-priority org-default-priority))
  11999. (* 1000 (- org-lowest-priority
  12000. (string-to-char (match-string 2 s))))))))
  12001. ;;;; Tags
  12002. (defvar org-agenda-archives-mode)
  12003. (defvar org-map-continue-from nil
  12004. "Position from where mapping should continue.
  12005. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  12006. (defvar org-scanner-tags nil
  12007. "The current tag list while the tags scanner is running.")
  12008. (defvar org-trust-scanner-tags nil
  12009. "Should `org-get-tags-at' use the tags for the scanner.
  12010. This is for internal dynamical scoping only.
  12011. When this is non-nil, the function `org-get-tags-at' will return the value
  12012. of `org-scanner-tags' instead of building the list by itself. This
  12013. can lead to large speed-ups when the tags scanner is used in a file with
  12014. many entries, and when the list of tags is retrieved, for example to
  12015. obtain a list of properties. Building the tags list for each entry in such
  12016. a file becomes an N^2 operation - but with this variable set, it scales
  12017. as N.")
  12018. (defun org-scan-tags (action matcher todo-only &optional start-level)
  12019. "Scan headline tags with inheritance and produce output ACTION.
  12020. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  12021. or `agenda' to produce an entry list for an agenda view. It can also be
  12022. a Lisp form or a function that should be called at each matched headline, in
  12023. this case the return value is a list of all return values from these calls.
  12024. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  12025. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  12026. only lines with a not-done TODO keyword are included in the output.
  12027. This should be the same variable that was scoped into
  12028. and set by `org-make-tags-matcher' when it constructed MATCHER.
  12029. START-LEVEL can be a string with asterisks, reducing the scope to
  12030. headlines matching this string."
  12031. (require 'org-agenda)
  12032. (let* ((re (concat "^"
  12033. (if start-level
  12034. ;; Get the correct level to match
  12035. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  12036. org-outline-regexp)
  12037. " *\\(\\<\\("
  12038. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  12039. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  12040. (props (list 'face 'default
  12041. 'done-face 'org-agenda-done
  12042. 'undone-face 'default
  12043. 'mouse-face 'highlight
  12044. 'org-not-done-regexp org-not-done-regexp
  12045. 'org-todo-regexp org-todo-regexp
  12046. 'org-complex-heading-regexp org-complex-heading-regexp
  12047. 'help-echo
  12048. (format "mouse-2 or RET jump to org file %s"
  12049. (abbreviate-file-name
  12050. (or (buffer-file-name (buffer-base-buffer))
  12051. (buffer-name (buffer-base-buffer)))))))
  12052. (case-fold-search nil)
  12053. (org-map-continue-from nil)
  12054. lspos tags tags-list
  12055. (tags-alist (list (cons 0 org-file-tags)))
  12056. (llast 0) rtn rtn1 level category i txt
  12057. todo marker entry priority)
  12058. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  12059. (setq action (list 'lambda nil action)))
  12060. (save-excursion
  12061. (goto-char (point-min))
  12062. (when (eq action 'sparse-tree)
  12063. (org-overview)
  12064. (org-remove-occur-highlights))
  12065. (while (re-search-forward re nil t)
  12066. (setq org-map-continue-from nil)
  12067. (catch :skip
  12068. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  12069. tags (if (match-end 4) (org-match-string-no-properties 4)))
  12070. (goto-char (setq lspos (match-beginning 0)))
  12071. (setq level (org-reduced-level (org-outline-level))
  12072. category (org-get-category))
  12073. (setq i llast llast level)
  12074. ;; remove tag lists from same and sublevels
  12075. (while (>= i level)
  12076. (when (setq entry (assoc i tags-alist))
  12077. (setq tags-alist (delete entry tags-alist)))
  12078. (setq i (1- i)))
  12079. ;; add the next tags
  12080. (when tags
  12081. (setq tags (org-split-string tags ":")
  12082. tags-alist
  12083. (cons (cons level tags) tags-alist)))
  12084. ;; compile tags for current headline
  12085. (setq tags-list
  12086. (if org-use-tag-inheritance
  12087. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  12088. tags)
  12089. org-scanner-tags tags-list)
  12090. (when org-use-tag-inheritance
  12091. (setcdr (car tags-alist)
  12092. (mapcar (lambda (x)
  12093. (setq x (copy-sequence x))
  12094. (org-add-prop-inherited x))
  12095. (cdar tags-alist))))
  12096. (when (and tags org-use-tag-inheritance
  12097. (or (not (eq t org-use-tag-inheritance))
  12098. org-tags-exclude-from-inheritance))
  12099. ;; selective inheritance, remove uninherited ones
  12100. (setcdr (car tags-alist)
  12101. (org-remove-uninherited-tags (cdar tags-alist))))
  12102. (when (and
  12103. ;; eval matcher only when the todo condition is OK
  12104. (and (or (not todo-only) (member todo org-not-done-keywords))
  12105. (let ((case-fold-search t) (org-trust-scanner-tags t))
  12106. (eval matcher)))
  12107. ;; Call the skipper, but return t if it does not skip,
  12108. ;; so that the `and' form continues evaluating
  12109. (progn
  12110. (unless (eq action 'sparse-tree) (org-agenda-skip))
  12111. t)
  12112. ;; Check if timestamps are deselecting this entry
  12113. (or (not todo-only)
  12114. (and (member todo org-not-done-keywords)
  12115. (or (not org-agenda-tags-todo-honor-ignore-options)
  12116. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  12117. ;; Extra check for the archive tag
  12118. ;; FIXME: Does the skipper already do this????
  12119. (or
  12120. (not (member org-archive-tag tags-list))
  12121. ;; we have an archive tag, should we use this anyway?
  12122. (or (not org-agenda-skip-archived-trees)
  12123. (and (eq action 'agenda) org-agenda-archives-mode))))
  12124. ;; select this headline
  12125. (cond
  12126. ((eq action 'sparse-tree)
  12127. (and org-highlight-sparse-tree-matches
  12128. (org-get-heading) (match-end 0)
  12129. (org-highlight-new-match
  12130. (match-beginning 1) (match-end 1)))
  12131. (org-show-context 'tags-tree))
  12132. ((eq action 'agenda)
  12133. (setq txt (org-agenda-format-item
  12134. ""
  12135. (concat
  12136. (if (eq org-tags-match-list-sublevels 'indented)
  12137. (make-string (1- level) ?.) "")
  12138. (org-get-heading))
  12139. level category
  12140. tags-list)
  12141. priority (org-get-priority txt))
  12142. (goto-char lspos)
  12143. (setq marker (org-agenda-new-marker))
  12144. (org-add-props txt props
  12145. 'org-marker marker 'org-hd-marker marker 'org-category category
  12146. 'todo-state todo
  12147. 'priority priority 'type "tagsmatch")
  12148. (push txt rtn))
  12149. ((functionp action)
  12150. (setq org-map-continue-from nil)
  12151. (save-excursion
  12152. (setq rtn1 (funcall action))
  12153. (push rtn1 rtn)))
  12154. (t (error "Invalid action")))
  12155. ;; if we are to skip sublevels, jump to end of subtree
  12156. (unless org-tags-match-list-sublevels
  12157. (org-end-of-subtree t)
  12158. (backward-char 1))))
  12159. ;; Get the correct position from where to continue
  12160. (if org-map-continue-from
  12161. (goto-char org-map-continue-from)
  12162. (and (= (point) lspos) (end-of-line 1)))))
  12163. (when (and (eq action 'sparse-tree)
  12164. (not org-sparse-tree-open-archived-trees))
  12165. (org-hide-archived-subtrees (point-min) (point-max)))
  12166. (nreverse rtn)))
  12167. (defun org-remove-uninherited-tags (tags)
  12168. "Remove all tags that are not inherited from the list TAGS."
  12169. (cond
  12170. ((eq org-use-tag-inheritance t)
  12171. (if org-tags-exclude-from-inheritance
  12172. (org-delete-all org-tags-exclude-from-inheritance tags)
  12173. tags))
  12174. ((not org-use-tag-inheritance) nil)
  12175. ((stringp org-use-tag-inheritance)
  12176. (delq nil (mapcar
  12177. (lambda (x)
  12178. (if (and (string-match org-use-tag-inheritance x)
  12179. (not (member x org-tags-exclude-from-inheritance)))
  12180. x nil))
  12181. tags)))
  12182. ((listp org-use-tag-inheritance)
  12183. (delq nil (mapcar
  12184. (lambda (x)
  12185. (if (member x org-use-tag-inheritance) x nil))
  12186. tags)))))
  12187. (defun org-match-sparse-tree (&optional todo-only match)
  12188. "Create a sparse tree according to tags string MATCH.
  12189. MATCH can contain positive and negative selection of tags, like
  12190. \"+WORK+URGENT-WITHBOSS\".
  12191. If optional argument TODO-ONLY is non-nil, only select lines that are
  12192. also TODO lines."
  12193. (interactive "P")
  12194. (org-agenda-prepare-buffers (list (current-buffer)))
  12195. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  12196. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  12197. (defvar org-cached-props nil)
  12198. (defun org-cached-entry-get (pom property)
  12199. (if (or (eq t org-use-property-inheritance)
  12200. (and (stringp org-use-property-inheritance)
  12201. (string-match org-use-property-inheritance property))
  12202. (and (listp org-use-property-inheritance)
  12203. (member property org-use-property-inheritance)))
  12204. ;; Caching is not possible, check it directly
  12205. (org-entry-get pom property 'inherit)
  12206. ;; Get all properties, so that we can do complicated checks easily
  12207. (cdr (assoc property (or org-cached-props
  12208. (setq org-cached-props
  12209. (org-entry-properties pom)))))))
  12210. (defun org-global-tags-completion-table (&optional files)
  12211. "Return the list of all tags in all agenda buffer/files.
  12212. Optional FILES argument is a list of files which can be used
  12213. instead of the agenda files."
  12214. (save-excursion
  12215. (org-uniquify
  12216. (delq nil
  12217. (apply 'append
  12218. (mapcar
  12219. (lambda (file)
  12220. (set-buffer (find-file-noselect file))
  12221. (append (org-get-buffer-tags)
  12222. (mapcar (lambda (x) (if (stringp (car-safe x))
  12223. (list (car-safe x)) nil))
  12224. org-tag-alist)))
  12225. (if (and files (car files))
  12226. files
  12227. (org-agenda-files))))))))
  12228. (defun org-make-tags-matcher (match)
  12229. "Create the TAGS/TODO matcher form for the selection string MATCH.
  12230. The variable `todo-only' is scoped dynamically into this function.
  12231. It will be set to t if the matcher restricts matching to TODO entries,
  12232. otherwise will not be touched.
  12233. Returns a cons of the selection string MATCH and the constructed
  12234. lisp form implementing the matcher. The matcher is to be evaluated
  12235. at an Org entry, with point on the headline, and returns t if the
  12236. entry matches the selection string MATCH. The returned lisp form
  12237. references two variables with information about the entry, which
  12238. must be bound around the form's evaluation: todo, the TODO keyword
  12239. at the entry (or nil of none); and tags-list, the list of all tags
  12240. at the entry including inherited ones. Additionally, the category
  12241. of the entry (if any) must be specified as the text property
  12242. 'org-category on the headline.
  12243. See also `org-scan-tags'.
  12244. "
  12245. (declare (special todo-only))
  12246. (unless (boundp 'todo-only)
  12247. (error "org-make-tags-matcher expects todo-only to be scoped in"))
  12248. (unless match
  12249. ;; Get a new match request, with completion
  12250. (let ((org-last-tags-completion-table
  12251. (org-global-tags-completion-table)))
  12252. (setq match (org-completing-read-no-i
  12253. "Match: " 'org-tags-completion-function nil nil nil
  12254. 'org-tags-history))))
  12255. ;; Parse the string and create a lisp form
  12256. (let ((match0 match)
  12257. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  12258. minus tag mm
  12259. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  12260. orterms term orlist re-p str-p level-p level-op time-p
  12261. prop-p pn pv po gv rest)
  12262. (if (string-match "/+" match)
  12263. ;; match contains also a todo-matching request
  12264. (progn
  12265. (setq tagsmatch (substring match 0 (match-beginning 0))
  12266. todomatch (substring match (match-end 0)))
  12267. (if (string-match "^!" todomatch)
  12268. (setq todo-only t todomatch (substring todomatch 1)))
  12269. (if (string-match "^\\s-*$" todomatch)
  12270. (setq todomatch nil)))
  12271. ;; only matching tags
  12272. (setq tagsmatch match todomatch nil))
  12273. ;; Make the tags matcher
  12274. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12275. (setq tagsmatcher t)
  12276. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12277. (while (setq term (pop orterms))
  12278. (while (and (equal (substring term -1) "\\") orterms)
  12279. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12280. (while (string-match re term)
  12281. (setq rest (substring term (match-end 0))
  12282. minus (and (match-end 1)
  12283. (equal (match-string 1 term) "-"))
  12284. tag (save-match-data (replace-regexp-in-string
  12285. "\\\\-" "-"
  12286. (match-string 2 term)))
  12287. re-p (equal (string-to-char tag) ?{)
  12288. level-p (match-end 4)
  12289. prop-p (match-end 5)
  12290. mm (cond
  12291. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12292. (level-p
  12293. (setq level-op (org-op-to-function (match-string 3 term)))
  12294. `(,level-op level ,(string-to-number
  12295. (match-string 4 term))))
  12296. (prop-p
  12297. (setq pn (match-string 5 term)
  12298. po (match-string 6 term)
  12299. pv (match-string 7 term)
  12300. re-p (equal (string-to-char pv) ?{)
  12301. str-p (equal (string-to-char pv) ?\")
  12302. time-p (save-match-data
  12303. (string-match "^\"[[<].*[]>]\"$" pv))
  12304. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12305. (if time-p (setq pv (org-matcher-time pv)))
  12306. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12307. (cond
  12308. ((equal pn "CATEGORY")
  12309. (setq gv '(get-text-property (point) 'org-category)))
  12310. ((equal pn "TODO")
  12311. (setq gv 'todo))
  12312. (t
  12313. (setq gv `(org-cached-entry-get nil ,pn))))
  12314. (if re-p
  12315. (if (eq po 'org<>)
  12316. `(not (string-match ,pv (or ,gv "")))
  12317. `(string-match ,pv (or ,gv "")))
  12318. (if str-p
  12319. `(,po (or ,gv "") ,pv)
  12320. `(,po (string-to-number (or ,gv ""))
  12321. ,(string-to-number pv) ))))
  12322. (t `(member ,tag tags-list)))
  12323. mm (if minus (list 'not mm) mm)
  12324. term rest)
  12325. (push mm tagsmatcher))
  12326. (push (if (> (length tagsmatcher) 1)
  12327. (cons 'and tagsmatcher)
  12328. (car tagsmatcher))
  12329. orlist)
  12330. (setq tagsmatcher nil))
  12331. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12332. (setq tagsmatcher
  12333. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12334. ;; Make the todo matcher
  12335. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12336. (setq todomatcher t)
  12337. (setq orterms (org-split-string todomatch "|") orlist nil)
  12338. (while (setq term (pop orterms))
  12339. (while (string-match re term)
  12340. (setq minus (and (match-end 1)
  12341. (equal (match-string 1 term) "-"))
  12342. kwd (match-string 2 term)
  12343. re-p (equal (string-to-char kwd) ?{)
  12344. term (substring term (match-end 0))
  12345. mm (if re-p
  12346. `(string-match ,(substring kwd 1 -1) todo)
  12347. (list 'equal 'todo kwd))
  12348. mm (if minus (list 'not mm) mm))
  12349. (push mm todomatcher))
  12350. (push (if (> (length todomatcher) 1)
  12351. (cons 'and todomatcher)
  12352. (car todomatcher))
  12353. orlist)
  12354. (setq todomatcher nil))
  12355. (setq todomatcher (if (> (length orlist) 1)
  12356. (cons 'or orlist) (car orlist))))
  12357. ;; Return the string and lisp forms of the matcher
  12358. (setq matcher (if todomatcher
  12359. (list 'and tagsmatcher todomatcher)
  12360. tagsmatcher))
  12361. (when todo-only
  12362. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12363. matcher)))
  12364. (cons match0 matcher)))
  12365. (defun org-op-to-function (op &optional stringp)
  12366. "Turn an operator into the appropriate function."
  12367. (setq op
  12368. (cond
  12369. ((equal op "<" ) '(< string< org-time<))
  12370. ((equal op ">" ) '(> org-string> org-time>))
  12371. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12372. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12373. ((member op '("=" "==")) '(= string= org-time=))
  12374. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12375. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12376. (defun org<> (a b) (not (= a b)))
  12377. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12378. (defun org-string>= (a b) (not (string< a b)))
  12379. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12380. (defun org-string<> (a b) (not (string= a b)))
  12381. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  12382. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  12383. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  12384. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  12385. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  12386. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  12387. (defun org-2ft (s)
  12388. "Convert S to a floating point time.
  12389. If S is already a number, just return it. If it is a string, parse
  12390. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  12391. (cond
  12392. ((numberp s) s)
  12393. ((stringp s)
  12394. (condition-case nil
  12395. (float-time (apply 'encode-time (org-parse-time-string s)))
  12396. (error 0.)))
  12397. (t 0.)))
  12398. (defun org-time-today ()
  12399. "Time in seconds today at 0:00.
  12400. Returns the float number of seconds since the beginning of the
  12401. epoch to the beginning of today (00:00)."
  12402. (float-time (apply 'encode-time
  12403. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  12404. (defun org-matcher-time (s)
  12405. "Interpret a time comparison value."
  12406. (save-match-data
  12407. (cond
  12408. ((string= s "<now>") (float-time))
  12409. ((string= s "<today>") (org-time-today))
  12410. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  12411. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  12412. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  12413. (+ (org-time-today)
  12414. (* (string-to-number (match-string 1 s))
  12415. (cdr (assoc (match-string 2 s)
  12416. '(("d" . 86400.0) ("w" . 604800.0)
  12417. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  12418. (t (org-2ft s)))))
  12419. (defun org-match-any-p (re list)
  12420. "Does re match any element of list?"
  12421. (setq list (mapcar (lambda (x) (string-match re x)) list))
  12422. (delq nil list))
  12423. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  12424. (defvar org-tags-overlay (make-overlay 1 1))
  12425. (org-detach-overlay org-tags-overlay)
  12426. (defun org-get-local-tags-at (&optional pos)
  12427. "Get a list of tags defined in the current headline."
  12428. (org-get-tags-at pos 'local))
  12429. (defun org-get-local-tags ()
  12430. "Get a list of tags defined in the current headline."
  12431. (org-get-tags-at nil 'local))
  12432. (defun org-get-tags-at (&optional pos local)
  12433. "Get a list of all headline tags applicable at POS.
  12434. POS defaults to point. If tags are inherited, the list contains
  12435. the targets in the same sequence as the headlines appear, i.e.
  12436. the tags of the current headline come last.
  12437. When LOCAL is non-nil, only return tags from the current headline,
  12438. ignore inherited ones."
  12439. (interactive)
  12440. (if (and org-trust-scanner-tags
  12441. (or (not pos) (equal pos (point)))
  12442. (not local))
  12443. org-scanner-tags
  12444. (let (tags ltags lastpos parent)
  12445. (save-excursion
  12446. (save-restriction
  12447. (widen)
  12448. (goto-char (or pos (point)))
  12449. (save-match-data
  12450. (catch 'done
  12451. (condition-case nil
  12452. (progn
  12453. (org-back-to-heading t)
  12454. (while (not (equal lastpos (point)))
  12455. (setq lastpos (point))
  12456. (when (looking-at
  12457. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  12458. (setq ltags (org-split-string
  12459. (org-match-string-no-properties 1) ":"))
  12460. (when parent
  12461. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  12462. (setq tags (append
  12463. (if parent
  12464. (org-remove-uninherited-tags ltags)
  12465. ltags)
  12466. tags)))
  12467. (or org-use-tag-inheritance (throw 'done t))
  12468. (if local (throw 'done t))
  12469. (or (org-up-heading-safe) (error nil))
  12470. (setq parent t)))
  12471. (error nil)))))
  12472. (if local
  12473. tags
  12474. (append (org-remove-uninherited-tags org-file-tags) tags))))))
  12475. (defun org-add-prop-inherited (s)
  12476. (add-text-properties 0 (length s) '(inherited t) s)
  12477. s)
  12478. (defun org-toggle-tag (tag &optional onoff)
  12479. "Toggle the tag TAG for the current line.
  12480. If ONOFF is `on' or `off', don't toggle but set to this state."
  12481. (let (res current)
  12482. (save-excursion
  12483. (org-back-to-heading t)
  12484. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  12485. (point-at-eol) t)
  12486. (progn
  12487. (setq current (match-string 1))
  12488. (replace-match ""))
  12489. (setq current ""))
  12490. (setq current (nreverse (org-split-string current ":")))
  12491. (cond
  12492. ((eq onoff 'on)
  12493. (setq res t)
  12494. (or (member tag current) (push tag current)))
  12495. ((eq onoff 'off)
  12496. (or (not (member tag current)) (setq current (delete tag current))))
  12497. (t (if (member tag current)
  12498. (setq current (delete tag current))
  12499. (setq res t)
  12500. (push tag current))))
  12501. (end-of-line 1)
  12502. (if current
  12503. (progn
  12504. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  12505. (org-set-tags nil t))
  12506. (delete-horizontal-space))
  12507. (run-hooks 'org-after-tags-change-hook))
  12508. res))
  12509. (defun org-align-tags-here (to-col)
  12510. ;; Assumes that this is a headline
  12511. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  12512. (beginning-of-line 1)
  12513. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12514. (< pos (match-beginning 2)))
  12515. (progn
  12516. (setq tags-l (- (match-end 2) (match-beginning 2)))
  12517. (goto-char (match-beginning 1))
  12518. (insert " ")
  12519. (delete-region (point) (1+ (match-beginning 2)))
  12520. (setq ncol (max (current-column)
  12521. (1+ col)
  12522. (if (> to-col 0)
  12523. to-col
  12524. (- (abs to-col) tags-l))))
  12525. (setq p (point))
  12526. (insert (make-string (- ncol (current-column)) ?\ ))
  12527. (setq ncol (current-column))
  12528. (when indent-tabs-mode (tabify p (point-at-eol)))
  12529. (org-move-to-column (min ncol col) t))
  12530. (goto-char pos))))
  12531. (defun org-set-tags-command (&optional arg just-align)
  12532. "Call the set-tags command for the current entry."
  12533. (interactive "P")
  12534. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  12535. (org-set-tags arg just-align)
  12536. (save-excursion
  12537. (org-back-to-heading t)
  12538. (org-set-tags arg just-align))))
  12539. (defun org-set-tags-to (data)
  12540. "Set the tags of the current entry to DATA, replacing the current tags.
  12541. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  12542. If DATA is nil or the empty string, any tags will be removed."
  12543. (interactive "sTags: ")
  12544. (setq data
  12545. (cond
  12546. ((eq data nil) "")
  12547. ((equal data "") "")
  12548. ((stringp data)
  12549. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  12550. ":"))
  12551. ((listp data)
  12552. (concat ":" (mapconcat 'identity data ":") ":"))))
  12553. (when data
  12554. (save-excursion
  12555. (org-back-to-heading t)
  12556. (when (looking-at org-complex-heading-regexp)
  12557. (if (match-end 5)
  12558. (progn
  12559. (goto-char (match-beginning 5))
  12560. (insert data)
  12561. (delete-region (point) (point-at-eol))
  12562. (org-set-tags nil 'align))
  12563. (goto-char (point-at-eol))
  12564. (insert " " data)
  12565. (org-set-tags nil 'align)))
  12566. (beginning-of-line 1)
  12567. (if (looking-at ".*?\\([ \t]+\\)$")
  12568. (delete-region (match-beginning 1) (match-end 1))))))
  12569. (defun org-align-all-tags ()
  12570. "Align the tags i all headings."
  12571. (interactive)
  12572. (save-excursion
  12573. (or (ignore-errors (org-back-to-heading t))
  12574. (outline-next-heading))
  12575. (if (org-at-heading-p)
  12576. (org-set-tags t)
  12577. (message "No headings"))))
  12578. (defvar org-indent-indentation-per-level)
  12579. (defun org-set-tags (&optional arg just-align)
  12580. "Set the tags for the current headline.
  12581. With prefix ARG, realign all tags in headings in the current buffer."
  12582. (interactive "P")
  12583. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12584. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12585. 'region-start-level 'region))
  12586. org-loop-over-headlines-in-active-region)
  12587. (org-map-entries
  12588. ;; We don't use ARG and JUST-ALIGN here these args are not
  12589. ;; useful when looping over headlines
  12590. `(org-set-tags)
  12591. org-loop-over-headlines-in-active-region
  12592. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12593. (let* ((re org-outline-regexp-bol)
  12594. (current (unless arg (org-get-tags-string)))
  12595. (col (current-column))
  12596. (org-setting-tags t)
  12597. table current-tags inherited-tags ; computed below when needed
  12598. tags p0 c0 c1 rpl di tc level)
  12599. (if arg
  12600. (save-excursion
  12601. (goto-char (point-min))
  12602. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  12603. (while (re-search-forward re nil t)
  12604. (org-set-tags nil t)
  12605. (end-of-line 1)))
  12606. (message "All tags realigned to column %d" org-tags-column))
  12607. (if just-align
  12608. (setq tags current)
  12609. ;; Get a new set of tags from the user
  12610. (save-excursion
  12611. (setq table (append org-tag-persistent-alist
  12612. (or org-tag-alist (org-get-buffer-tags))
  12613. (and
  12614. org-complete-tags-always-offer-all-agenda-tags
  12615. (org-global-tags-completion-table
  12616. (org-agenda-files))))
  12617. org-last-tags-completion-table table
  12618. current-tags (org-split-string current ":")
  12619. inherited-tags (nreverse
  12620. (nthcdr (length current-tags)
  12621. (nreverse (org-get-tags-at))))
  12622. tags
  12623. (if (or (eq t org-use-fast-tag-selection)
  12624. (and org-use-fast-tag-selection
  12625. (delq nil (mapcar 'cdr table))))
  12626. (org-fast-tag-selection
  12627. current-tags inherited-tags table
  12628. (if org-fast-tag-selection-include-todo
  12629. org-todo-key-alist))
  12630. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  12631. (org-trim
  12632. (org-icompleting-read "Tags: "
  12633. 'org-tags-completion-function
  12634. nil nil current 'org-tags-history))))))
  12635. (while (string-match "[-+&]+" tags)
  12636. ;; No boolean logic, just a list
  12637. (setq tags (replace-match ":" t t tags))))
  12638. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  12639. (if org-tags-sort-function
  12640. (setq tags (mapconcat 'identity
  12641. (sort (org-split-string
  12642. tags (org-re "[^[:alnum:]_@#%]+"))
  12643. org-tags-sort-function) ":")))
  12644. (if (string-match "\\`[\t ]*\\'" tags)
  12645. (setq tags "")
  12646. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  12647. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  12648. ;; Insert new tags at the correct column
  12649. (beginning-of-line 1)
  12650. (setq level (or (and (looking-at org-outline-regexp)
  12651. (- (match-end 0) (point) 1))
  12652. 1))
  12653. (cond
  12654. ((and (equal current "") (equal tags "")))
  12655. ((re-search-forward
  12656. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  12657. (point-at-eol) t)
  12658. (if (equal tags "")
  12659. (setq rpl "")
  12660. (goto-char (match-beginning 0))
  12661. (setq c0 (current-column)
  12662. ;; compute offset for the case of org-indent-mode active
  12663. di (if org-indent-mode
  12664. (* (1- org-indent-indentation-per-level) (1- level))
  12665. 0)
  12666. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  12667. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  12668. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  12669. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  12670. (replace-match rpl t t)
  12671. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  12672. tags)
  12673. (t (error "Tags alignment failed")))
  12674. (org-move-to-column col)
  12675. (unless just-align
  12676. (run-hooks 'org-after-tags-change-hook))))))
  12677. (defun org-change-tag-in-region (beg end tag off)
  12678. "Add or remove TAG for each entry in the region.
  12679. This works in the agenda, and also in an org-mode buffer."
  12680. (interactive
  12681. (list (region-beginning) (region-end)
  12682. (let ((org-last-tags-completion-table
  12683. (if (derived-mode-p 'org-mode)
  12684. (org-get-buffer-tags)
  12685. (org-global-tags-completion-table))))
  12686. (org-icompleting-read
  12687. "Tag: " 'org-tags-completion-function nil nil nil
  12688. 'org-tags-history))
  12689. (progn
  12690. (message "[s]et or [r]emove? ")
  12691. (equal (read-char-exclusive) ?r))))
  12692. (if (fboundp 'deactivate-mark) (deactivate-mark))
  12693. (let ((agendap (equal major-mode 'org-agenda-mode))
  12694. l1 l2 m buf pos newhead (cnt 0))
  12695. (goto-char end)
  12696. (setq l2 (1- (org-current-line)))
  12697. (goto-char beg)
  12698. (setq l1 (org-current-line))
  12699. (loop for l from l1 to l2 do
  12700. (org-goto-line l)
  12701. (setq m (get-text-property (point) 'org-hd-marker))
  12702. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  12703. (and agendap m))
  12704. (setq buf (if agendap (marker-buffer m) (current-buffer))
  12705. pos (if agendap m (point)))
  12706. (with-current-buffer buf
  12707. (save-excursion
  12708. (save-restriction
  12709. (goto-char pos)
  12710. (setq cnt (1+ cnt))
  12711. (org-toggle-tag tag (if off 'off 'on))
  12712. (setq newhead (org-get-heading)))))
  12713. (and agendap (org-agenda-change-all-lines newhead m))))
  12714. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  12715. (defun org-tags-completion-function (string predicate &optional flag)
  12716. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  12717. (confirm (lambda (x) (stringp (car x)))))
  12718. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  12719. (setq s1 (match-string 1 string)
  12720. s2 (match-string 2 string))
  12721. (setq s1 "" s2 string))
  12722. (cond
  12723. ((eq flag nil)
  12724. ;; try completion
  12725. (setq rtn (try-completion s2 ctable confirm))
  12726. (if (stringp rtn)
  12727. (setq rtn
  12728. (concat s1 s2 (substring rtn (length s2))
  12729. (if (and org-add-colon-after-tag-completion
  12730. (assoc rtn ctable))
  12731. ":" ""))))
  12732. rtn)
  12733. ((eq flag t)
  12734. ;; all-completions
  12735. (all-completions s2 ctable confirm)
  12736. )
  12737. ((eq flag 'lambda)
  12738. ;; exact match?
  12739. (assoc s2 ctable)))
  12740. ))
  12741. (defun org-fast-tag-insert (kwd tags face &optional end)
  12742. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  12743. (insert (format "%-12s" (concat kwd ":"))
  12744. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  12745. (or end "")))
  12746. (defun org-fast-tag-show-exit (flag)
  12747. (save-excursion
  12748. (org-goto-line 3)
  12749. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  12750. (replace-match ""))
  12751. (when flag
  12752. (end-of-line 1)
  12753. (org-move-to-column (- (window-width) 19) t)
  12754. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  12755. (defun org-set-current-tags-overlay (current prefix)
  12756. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  12757. (if (featurep 'xemacs)
  12758. (org-overlay-display org-tags-overlay (concat prefix s)
  12759. 'secondary-selection)
  12760. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  12761. (org-overlay-display org-tags-overlay (concat prefix s)))))
  12762. (defvar org-last-tag-selection-key nil)
  12763. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  12764. "Fast tag selection with single keys.
  12765. CURRENT is the current list of tags in the headline, INHERITED is the
  12766. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  12767. possibly with grouping information. TODO-TABLE is a similar table with
  12768. TODO keywords, should these have keys assigned to them.
  12769. If the keys are nil, a-z are automatically assigned.
  12770. Returns the new tags string, or nil to not change the current settings."
  12771. (let* ((fulltable (append table todo-table))
  12772. (maxlen (apply 'max (mapcar
  12773. (lambda (x)
  12774. (if (stringp (car x)) (string-width (car x)) 0))
  12775. fulltable)))
  12776. (buf (current-buffer))
  12777. (expert (eq org-fast-tag-selection-single-key 'expert))
  12778. (buffer-tags nil)
  12779. (fwidth (+ maxlen 3 1 3))
  12780. (ncol (/ (- (window-width) 4) fwidth))
  12781. (i-face 'org-done)
  12782. (c-face 'org-todo)
  12783. tg cnt e c char c1 c2 ntable tbl rtn
  12784. ov-start ov-end ov-prefix
  12785. (exit-after-next org-fast-tag-selection-single-key)
  12786. (done-keywords org-done-keywords)
  12787. groups ingroup)
  12788. (save-excursion
  12789. (beginning-of-line 1)
  12790. (if (looking-at
  12791. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12792. (setq ov-start (match-beginning 1)
  12793. ov-end (match-end 1)
  12794. ov-prefix "")
  12795. (setq ov-start (1- (point-at-eol))
  12796. ov-end (1+ ov-start))
  12797. (skip-chars-forward "^\n\r")
  12798. (setq ov-prefix
  12799. (concat
  12800. (buffer-substring (1- (point)) (point))
  12801. (if (> (current-column) org-tags-column)
  12802. " "
  12803. (make-string (- org-tags-column (current-column)) ?\ ))))))
  12804. (move-overlay org-tags-overlay ov-start ov-end)
  12805. (save-window-excursion
  12806. (if expert
  12807. (set-buffer (get-buffer-create " *Org tags*"))
  12808. (delete-other-windows)
  12809. (split-window-vertically)
  12810. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  12811. (erase-buffer)
  12812. (org-set-local 'org-done-keywords done-keywords)
  12813. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  12814. (org-fast-tag-insert "Current" current c-face "\n\n")
  12815. (org-fast-tag-show-exit exit-after-next)
  12816. (org-set-current-tags-overlay current ov-prefix)
  12817. (setq tbl fulltable char ?a cnt 0)
  12818. (while (setq e (pop tbl))
  12819. (cond
  12820. ((equal (car e) :startgroup)
  12821. (push '() groups) (setq ingroup t)
  12822. (when (not (= cnt 0))
  12823. (setq cnt 0)
  12824. (insert "\n"))
  12825. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  12826. ((equal (car e) :endgroup)
  12827. (setq ingroup nil cnt 0)
  12828. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  12829. ((equal e '(:newline))
  12830. (when (not (= cnt 0))
  12831. (setq cnt 0)
  12832. (insert "\n")
  12833. (setq e (car tbl))
  12834. (while (equal (car tbl) '(:newline))
  12835. (insert "\n")
  12836. (setq tbl (cdr tbl)))))
  12837. (t
  12838. (setq tg (copy-sequence (car e)) c2 nil)
  12839. (if (cdr e)
  12840. (setq c (cdr e))
  12841. ;; automatically assign a character.
  12842. (setq c1 (string-to-char
  12843. (downcase (substring
  12844. tg (if (= (string-to-char tg) ?@) 1 0)))))
  12845. (if (or (rassoc c1 ntable) (rassoc c1 table))
  12846. (while (or (rassoc char ntable) (rassoc char table))
  12847. (setq char (1+ char)))
  12848. (setq c2 c1))
  12849. (setq c (or c2 char)))
  12850. (if ingroup (push tg (car groups)))
  12851. (setq tg (org-add-props tg nil 'face
  12852. (cond
  12853. ((not (assoc tg table))
  12854. (org-get-todo-face tg))
  12855. ((member tg current) c-face)
  12856. ((member tg inherited) i-face))))
  12857. (if (and (= cnt 0) (not ingroup)) (insert " "))
  12858. (insert "[" c "] " tg (make-string
  12859. (- fwidth 4 (length tg)) ?\ ))
  12860. (push (cons tg c) ntable)
  12861. (when (= (setq cnt (1+ cnt)) ncol)
  12862. (insert "\n")
  12863. (if ingroup (insert " "))
  12864. (setq cnt 0)))))
  12865. (setq ntable (nreverse ntable))
  12866. (insert "\n")
  12867. (goto-char (point-min))
  12868. (if (not expert) (org-fit-window-to-buffer))
  12869. (setq rtn
  12870. (catch 'exit
  12871. (while t
  12872. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  12873. (if (not groups) "no " "")
  12874. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  12875. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  12876. (setq org-last-tag-selection-key c)
  12877. (cond
  12878. ((= c ?\r) (throw 'exit t))
  12879. ((= c ?!)
  12880. (setq groups (not groups))
  12881. (goto-char (point-min))
  12882. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  12883. ((= c ?\C-c)
  12884. (if (not expert)
  12885. (org-fast-tag-show-exit
  12886. (setq exit-after-next (not exit-after-next)))
  12887. (setq expert nil)
  12888. (delete-other-windows)
  12889. (set-window-buffer (split-window-vertically) " *Org tags*")
  12890. (org-switch-to-buffer-other-window " *Org tags*")
  12891. (org-fit-window-to-buffer)))
  12892. ((or (= c ?\C-g)
  12893. (and (= c ?q) (not (rassoc c ntable))))
  12894. (org-detach-overlay org-tags-overlay)
  12895. (setq quit-flag t))
  12896. ((= c ?\ )
  12897. (setq current nil)
  12898. (if exit-after-next (setq exit-after-next 'now)))
  12899. ((= c ?\t)
  12900. (condition-case nil
  12901. (setq tg (org-icompleting-read
  12902. "Tag: "
  12903. (or buffer-tags
  12904. (with-current-buffer buf
  12905. (org-get-buffer-tags)))))
  12906. (quit (setq tg "")))
  12907. (when (string-match "\\S-" tg)
  12908. (add-to-list 'buffer-tags (list tg))
  12909. (if (member tg current)
  12910. (setq current (delete tg current))
  12911. (push tg current)))
  12912. (if exit-after-next (setq exit-after-next 'now)))
  12913. ((setq e (rassoc c todo-table) tg (car e))
  12914. (with-current-buffer buf
  12915. (save-excursion (org-todo tg)))
  12916. (if exit-after-next (setq exit-after-next 'now)))
  12917. ((setq e (rassoc c ntable) tg (car e))
  12918. (if (member tg current)
  12919. (setq current (delete tg current))
  12920. (loop for g in groups do
  12921. (if (member tg g)
  12922. (mapc (lambda (x)
  12923. (setq current (delete x current)))
  12924. g)))
  12925. (push tg current))
  12926. (if exit-after-next (setq exit-after-next 'now))))
  12927. ;; Create a sorted list
  12928. (setq current
  12929. (sort current
  12930. (lambda (a b)
  12931. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  12932. (if (eq exit-after-next 'now) (throw 'exit t))
  12933. (goto-char (point-min))
  12934. (beginning-of-line 2)
  12935. (delete-region (point) (point-at-eol))
  12936. (org-fast-tag-insert "Current" current c-face)
  12937. (org-set-current-tags-overlay current ov-prefix)
  12938. (while (re-search-forward
  12939. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  12940. (setq tg (match-string 1))
  12941. (add-text-properties
  12942. (match-beginning 1) (match-end 1)
  12943. (list 'face
  12944. (cond
  12945. ((member tg current) c-face)
  12946. ((member tg inherited) i-face)
  12947. (t (get-text-property (match-beginning 1) 'face))))))
  12948. (goto-char (point-min)))))
  12949. (org-detach-overlay org-tags-overlay)
  12950. (if rtn
  12951. (mapconcat 'identity current ":")
  12952. nil))))
  12953. (defun org-get-tags-string ()
  12954. "Get the TAGS string in the current headline."
  12955. (unless (org-at-heading-p t)
  12956. (error "Not on a heading"))
  12957. (save-excursion
  12958. (beginning-of-line 1)
  12959. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12960. (org-match-string-no-properties 1)
  12961. "")))
  12962. (defun org-get-tags ()
  12963. "Get the list of tags specified in the current headline."
  12964. (org-split-string (org-get-tags-string) ":"))
  12965. (defun org-get-buffer-tags ()
  12966. "Get a table of all tags used in the buffer, for completion."
  12967. (let (tags)
  12968. (save-excursion
  12969. (goto-char (point-min))
  12970. (while (re-search-forward
  12971. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  12972. (when (equal (char-after (point-at-bol 0)) ?*)
  12973. (mapc (lambda (x) (add-to-list 'tags x))
  12974. (org-split-string (org-match-string-no-properties 1) ":")))))
  12975. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  12976. (mapcar 'list tags)))
  12977. ;;;; The mapping API
  12978. ;;;###autoload
  12979. (defun org-map-entries (func &optional match scope &rest skip)
  12980. "Call FUNC at each headline selected by MATCH in SCOPE.
  12981. FUNC is a function or a lisp form. The function will be called without
  12982. arguments, with the cursor positioned at the beginning of the headline.
  12983. The return values of all calls to the function will be collected and
  12984. returned as a list.
  12985. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  12986. does not need to preserve point. After evaluation, the cursor will be
  12987. moved to the end of the line (presumably of the headline of the
  12988. processed entry) and search continues from there. Under some
  12989. circumstances, this may not produce the wanted results. For example,
  12990. if you have removed (e.g. archived) the current (sub)tree it could
  12991. mean that the next entry will be skipped entirely. In such cases, you
  12992. can specify the position from where search should continue by making
  12993. FUNC set the variable `org-map-continue-from' to the desired buffer
  12994. position.
  12995. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  12996. Only headlines that are matched by this query will be considered during
  12997. the iteration. When MATCH is nil or t, all headlines will be
  12998. visited by the iteration.
  12999. SCOPE determines the scope of this command. It can be any of:
  13000. nil The current buffer, respecting the restriction if any
  13001. tree The subtree started with the entry at point
  13002. region The entries within the active region, if any
  13003. region-start-level
  13004. The entries within the active region, but only those at
  13005. the same level than the first one.
  13006. file The current buffer, without restriction
  13007. file-with-archives
  13008. The current buffer, and any archives associated with it
  13009. agenda All agenda files
  13010. agenda-with-archives
  13011. All agenda files with any archive files associated with them
  13012. \(file1 file2 ...)
  13013. If this is a list, all files in the list will be scanned
  13014. The remaining args are treated as settings for the skipping facilities of
  13015. the scanner. The following items can be given here:
  13016. archive skip trees with the archive tag.
  13017. comment skip trees with the COMMENT keyword
  13018. function or Emacs Lisp form:
  13019. will be used as value for `org-agenda-skip-function', so whenever
  13020. the function returns t, FUNC will not be called for that
  13021. entry and search will continue from the point where the
  13022. function leaves it.
  13023. If your function needs to retrieve the tags including inherited tags
  13024. at the *current* entry, you can use the value of the variable
  13025. `org-scanner-tags' which will be much faster than getting the value
  13026. with `org-get-tags-at'. If your function gets properties with
  13027. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  13028. to t around the call to `org-entry-properties' to get the same speedup.
  13029. Note that if your function moves around to retrieve tags and properties at
  13030. a *different* entry, you cannot use these techniques."
  13031. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  13032. (not (org-region-active-p)))
  13033. (let* ((org-agenda-archives-mode nil) ; just to make sure
  13034. (org-agenda-skip-archived-trees (memq 'archive skip))
  13035. (org-agenda-skip-comment-trees (memq 'comment skip))
  13036. (org-agenda-skip-function
  13037. (car (org-delete-all '(comment archive) skip)))
  13038. (org-tags-match-list-sublevels t)
  13039. (start-level (eq scope 'region-start-level))
  13040. matcher file res
  13041. org-todo-keywords-for-agenda
  13042. org-done-keywords-for-agenda
  13043. org-todo-keyword-alist-for-agenda
  13044. org-drawers-for-agenda
  13045. org-tag-alist-for-agenda
  13046. todo-only)
  13047. (cond
  13048. ((eq match t) (setq matcher t))
  13049. ((eq match nil) (setq matcher t))
  13050. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  13051. (save-excursion
  13052. (save-restriction
  13053. (cond ((eq scope 'tree)
  13054. (org-back-to-heading t)
  13055. (org-narrow-to-subtree)
  13056. (setq scope nil))
  13057. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  13058. (org-region-active-p))
  13059. ;; If needed, set start-level to a string like "2"
  13060. (when start-level
  13061. (save-excursion
  13062. (goto-char (region-beginning))
  13063. (unless (org-at-heading-p) (outline-next-heading))
  13064. (setq start-level (org-current-level))))
  13065. (narrow-to-region (region-beginning)
  13066. (save-excursion
  13067. (goto-char (region-end))
  13068. (unless (and (bolp) (org-at-heading-p))
  13069. (outline-next-heading))
  13070. (point)))
  13071. (setq scope nil)))
  13072. (if (not scope)
  13073. (progn
  13074. (org-agenda-prepare-buffers
  13075. (list (buffer-file-name (current-buffer))))
  13076. (setq res (org-scan-tags func matcher todo-only start-level)))
  13077. ;; Get the right scope
  13078. (cond
  13079. ((and scope (listp scope) (symbolp (car scope)))
  13080. (setq scope (eval scope)))
  13081. ((eq scope 'agenda)
  13082. (setq scope (org-agenda-files t)))
  13083. ((eq scope 'agenda-with-archives)
  13084. (setq scope (org-agenda-files t))
  13085. (setq scope (org-add-archive-files scope)))
  13086. ((eq scope 'file)
  13087. (setq scope (list (buffer-file-name))))
  13088. ((eq scope 'file-with-archives)
  13089. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  13090. (org-agenda-prepare-buffers scope)
  13091. (while (setq file (pop scope))
  13092. (with-current-buffer (org-find-base-buffer-visiting file)
  13093. (save-excursion
  13094. (save-restriction
  13095. (widen)
  13096. (goto-char (point-min))
  13097. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  13098. res)))
  13099. ;;;; Properties
  13100. ;;; Setting and retrieving properties
  13101. (defconst org-special-properties
  13102. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  13103. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
  13104. "The special properties valid in Org-mode.
  13105. These are properties that are not defined in the property drawer,
  13106. but in some other way.")
  13107. (defconst org-default-properties
  13108. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  13109. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  13110. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  13111. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  13112. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  13113. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  13114. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  13115. "Some properties that are used by Org-mode for various purposes.
  13116. Being in this list makes sure that they are offered for completion.")
  13117. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  13118. "Regular expression matching the first line of a property drawer.")
  13119. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  13120. "Regular expression matching the last line of a property drawer.")
  13121. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  13122. "Regular expression matching the first line of a property drawer.")
  13123. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  13124. "Regular expression matching the first line of a property drawer.")
  13125. (defconst org-property-drawer-re
  13126. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  13127. org-property-end-re "\\)\n?")
  13128. "Matches an entire property drawer.")
  13129. (defconst org-clock-drawer-re
  13130. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  13131. org-property-end-re "\\)\n?")
  13132. "Matches an entire clock drawer.")
  13133. (defsubst org-re-property (property)
  13134. "Return a regexp matching a PROPERTY line.
  13135. Match group 1 will be set to the value."
  13136. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
  13137. (defsubst org-re-property-keyword (property)
  13138. "Return a regexp matching a PROPERTY line, possibly with no
  13139. value for the property."
  13140. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)?"))
  13141. (defun org-property-action ()
  13142. "Do an action on properties."
  13143. (interactive)
  13144. (let (c)
  13145. (org-at-property-p)
  13146. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  13147. (setq c (read-char-exclusive))
  13148. (cond
  13149. ((equal c ?s)
  13150. (call-interactively 'org-set-property))
  13151. ((equal c ?d)
  13152. (call-interactively 'org-delete-property))
  13153. ((equal c ?D)
  13154. (call-interactively 'org-delete-property-globally))
  13155. ((equal c ?c)
  13156. (call-interactively 'org-compute-property-at-point))
  13157. (t (error "No such property action %c" c)))))
  13158. (defun org-inc-effort ()
  13159. "Increment the value of the effort property in the current entry."
  13160. (interactive)
  13161. (org-set-effort nil t))
  13162. (defun org-set-effort (&optional value increment)
  13163. "Set the effort property of the current entry.
  13164. With numerical prefix arg, use the nth allowed value, 0 stands for the
  13165. 10th allowed value.
  13166. When INCREMENT is non-nil, set the property to the next allowed value."
  13167. (interactive "P")
  13168. (if (equal value 0) (setq value 10))
  13169. (let* ((completion-ignore-case t)
  13170. (prop org-effort-property)
  13171. (cur (org-entry-get nil prop))
  13172. (allowed (org-property-get-allowed-values nil prop 'table))
  13173. (existing (mapcar 'list (org-property-values prop)))
  13174. rpl
  13175. (val (cond
  13176. ((stringp value) value)
  13177. ((and allowed (integerp value))
  13178. (or (car (nth (1- value) allowed))
  13179. (car (org-last allowed))))
  13180. ((and allowed increment)
  13181. (or (caadr (member (list cur) allowed))
  13182. (error "Allowed effort values are not set")))
  13183. (allowed
  13184. (message "Select 1-9,0, [RET%s]: %s"
  13185. (if cur (concat "=" cur) "")
  13186. (mapconcat 'car allowed " "))
  13187. (setq rpl (read-char-exclusive))
  13188. (if (equal rpl ?\r)
  13189. cur
  13190. (setq rpl (- rpl ?0))
  13191. (if (equal rpl 0) (setq rpl 10))
  13192. (if (and (> rpl 0) (<= rpl (length allowed)))
  13193. (car (nth (1- rpl) allowed))
  13194. (org-completing-read "Effort: " allowed nil))))
  13195. (t
  13196. (let (org-completion-use-ido org-completion-use-iswitchb)
  13197. (org-completing-read
  13198. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  13199. (concat "[" cur "]") "")
  13200. ": ")
  13201. existing nil nil "" nil cur))))))
  13202. (unless (equal (org-entry-get nil prop) val)
  13203. (org-entry-put nil prop val))
  13204. (message "%s is now %s" prop val)))
  13205. (defun org-at-property-p ()
  13206. "Is cursor inside a property drawer?"
  13207. (save-excursion
  13208. (beginning-of-line 1)
  13209. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  13210. (save-match-data ;; Used by calling procedures
  13211. (let ((p (point))
  13212. (range (unless (org-before-first-heading-p)
  13213. (org-get-property-block))))
  13214. (and range (<= (car range) p) (< p (cdr range))))))))
  13215. (defun org-get-property-block (&optional beg end force)
  13216. "Return the (beg . end) range of the body of the property drawer.
  13217. BEG and END are the beginning and end of the current subtree, or of
  13218. the part before the first headline. If they are not given, they will
  13219. be found. If the drawer does not exist and FORCE is non-nil, create
  13220. the drawer."
  13221. (catch 'exit
  13222. (save-excursion
  13223. (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
  13224. (progn (org-back-to-heading t) (point))))
  13225. (end (or end (and (not (outline-next-heading)) (point-max))
  13226. (point))))
  13227. (goto-char beg)
  13228. (if (re-search-forward org-property-start-re end t)
  13229. (setq beg (1+ (match-end 0)))
  13230. (if force
  13231. (save-excursion
  13232. (org-insert-property-drawer)
  13233. (setq end (progn (outline-next-heading) (point))))
  13234. (throw 'exit nil))
  13235. (goto-char beg)
  13236. (if (re-search-forward org-property-start-re end t)
  13237. (setq beg (1+ (match-end 0)))))
  13238. (if (re-search-forward org-property-end-re end t)
  13239. (setq end (match-beginning 0))
  13240. (or force (throw 'exit nil))
  13241. (goto-char beg)
  13242. (setq end beg)
  13243. (org-indent-line)
  13244. (insert ":END:\n"))
  13245. (cons beg end)))))
  13246. (defun org-entry-properties (&optional pom which specific)
  13247. "Get all properties of the entry at point-or-marker POM.
  13248. This includes the TODO keyword, the tags, time strings for deadline,
  13249. scheduled, and clocking, and any additional properties defined in the
  13250. entry. The return value is an alist, keys may occur multiple times
  13251. if the property key was used several times.
  13252. POM may also be nil, in which case the current entry is used.
  13253. If WHICH is nil or `all', get all properties. If WHICH is
  13254. `special' or `standard', only get that subclass. If WHICH
  13255. is a string only get exactly this property. SPECIFIC can be a string, the
  13256. specific property we are interested in. Specifying it can speed
  13257. things up because then unnecessary parsing is avoided."
  13258. (setq which (or which 'all))
  13259. (org-with-point-at pom
  13260. (let ((clockstr (substring org-clock-string 0 -1))
  13261. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  13262. (case-fold-search nil)
  13263. beg end range props sum-props key key1 value string clocksum clocksumt)
  13264. (save-excursion
  13265. (when (condition-case nil
  13266. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  13267. (error nil))
  13268. (setq beg (point))
  13269. (setq sum-props (get-text-property (point) 'org-summaries))
  13270. (setq clocksum (get-text-property (point) :org-clock-minutes)
  13271. clocksumt (get-text-property (point) :org-clock-minutes-today))
  13272. (outline-next-heading)
  13273. (setq end (point))
  13274. (when (memq which '(all special))
  13275. ;; Get the special properties, like TODO and tags
  13276. (goto-char beg)
  13277. (when (and (or (not specific) (string= specific "TODO"))
  13278. (looking-at org-todo-line-regexp) (match-end 2))
  13279. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  13280. (when (and (or (not specific) (string= specific "PRIORITY"))
  13281. (looking-at org-priority-regexp))
  13282. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  13283. (when (or (not specific) (string= specific "FILE"))
  13284. (push (cons "FILE" buffer-file-name) props))
  13285. (when (and (or (not specific) (string= specific "TAGS"))
  13286. (setq value (org-get-tags-string))
  13287. (string-match "\\S-" value))
  13288. (push (cons "TAGS" value) props))
  13289. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13290. (setq value (org-get-tags-at)))
  13291. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13292. ":"))
  13293. props))
  13294. (when (or (not specific) (string= specific "BLOCKED"))
  13295. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13296. (when (or (not specific)
  13297. (member specific
  13298. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13299. "TIMESTAMP" "TIMESTAMP_IA")))
  13300. (catch 'match
  13301. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13302. (setq key (if (match-end 1)
  13303. (substring (org-match-string-no-properties 1)
  13304. 0 -1))
  13305. string (if (equal key clockstr)
  13306. (org-trim
  13307. (buffer-substring-no-properties
  13308. (match-beginning 3) (goto-char
  13309. (point-at-eol))))
  13310. (substring (org-match-string-no-properties 3)
  13311. 1 -1)))
  13312. ;; Get the correct property name from the key. This is
  13313. ;; necessary if the user has configured time keywords.
  13314. (setq key1 (concat key ":"))
  13315. (cond
  13316. ((not key)
  13317. (setq key
  13318. (if (= (char-after (match-beginning 3)) ?\[)
  13319. "TIMESTAMP_IA" "TIMESTAMP")))
  13320. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13321. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13322. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13323. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13324. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13325. (progn
  13326. (push (cons key string) props)
  13327. ;; no need to search further if match is found
  13328. (throw 'match t))
  13329. (when (or (equal key "CLOCK") (not (assoc key props)))
  13330. (push (cons key string) props)))))))
  13331. (when (memq which '(all standard))
  13332. ;; Get the standard properties, like :PROP: ...
  13333. (setq range (org-get-property-block beg end))
  13334. (when range
  13335. (goto-char (car range))
  13336. (while (re-search-forward
  13337. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  13338. (cdr range) t)
  13339. (setq key (org-match-string-no-properties 1)
  13340. value (org-trim (or (org-match-string-no-properties 2) "")))
  13341. (unless (member key excluded)
  13342. (push (cons key (or value "")) props)))))
  13343. (if clocksum
  13344. (push (cons "CLOCKSUM"
  13345. (org-columns-number-to-string (/ (float clocksum) 60.)
  13346. 'add_times))
  13347. props))
  13348. (if clocksumt
  13349. (push (cons "CLOCKSUM_T"
  13350. (org-columns-number-to-string (/ (float clocksumt) 60.)
  13351. 'add_times))
  13352. props))
  13353. (unless (assoc "CATEGORY" props)
  13354. (push (cons "CATEGORY" (org-get-category)) props))
  13355. (append sum-props (nreverse props)))))))
  13356. (defun org-entry-get (pom property &optional inherit literal-nil)
  13357. "Get value of PROPERTY for entry or content at point-or-marker POM.
  13358. If INHERIT is non-nil and the entry does not have the property,
  13359. then also check higher levels of the hierarchy.
  13360. If INHERIT is the symbol `selective', use inheritance only if the setting
  13361. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13362. If the property is present but empty, the return value is the empty string.
  13363. If the property is not present at all, nil is returned.
  13364. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13365. do not interpret it as the list atom nil. This is used for inheritance
  13366. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13367. (org-with-point-at pom
  13368. (if (and inherit (if (eq inherit 'selective)
  13369. (org-property-inherit-p property)
  13370. t))
  13371. (org-entry-get-with-inheritance property literal-nil)
  13372. (if (member property org-special-properties)
  13373. ;; We need a special property. Use `org-entry-properties' to
  13374. ;; retrieve it, but specify the wanted property
  13375. (cdr (assoc property (org-entry-properties nil 'special property)))
  13376. (let* ((range (org-get-property-block))
  13377. (props (list (or (assoc property org-file-properties)
  13378. (assoc property org-global-properties)
  13379. (assoc property org-global-properties-fixed))))
  13380. (ap (lambda (key)
  13381. (when (re-search-forward
  13382. (org-re-property key) (cdr range) t)
  13383. (setq props
  13384. (org-update-property-plist
  13385. key
  13386. (if (match-end 1)
  13387. (org-match-string-no-properties 1) "")
  13388. props)))))
  13389. val)
  13390. (when (and range (goto-char (car range)))
  13391. (funcall ap property)
  13392. (goto-char (car range))
  13393. (while (funcall ap (concat property "+")))
  13394. (setq val (cdr (assoc property props)))
  13395. (when val (if literal-nil val (org-not-nil val)))))))))
  13396. (defun org-property-or-variable-value (var &optional inherit)
  13397. "Check if there is a property fixing the value of VAR.
  13398. If yes, return this value. If not, return the current value of the variable."
  13399. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  13400. (if (and prop (stringp prop) (string-match "\\S-" prop))
  13401. (read prop)
  13402. (symbol-value var))))
  13403. (defun org-entry-delete (pom property)
  13404. "Delete the property PROPERTY from entry at point-or-marker POM."
  13405. (org-with-point-at pom
  13406. (if (member property org-special-properties)
  13407. nil ; cannot delete these properties.
  13408. (let ((range (org-get-property-block)))
  13409. (if (and range
  13410. (goto-char (car range))
  13411. (re-search-forward
  13412. (org-re-property property)
  13413. (cdr range) t))
  13414. (progn
  13415. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  13416. t)
  13417. nil)))))
  13418. ;; Multi-values properties are properties that contain multiple values
  13419. ;; These values are assumed to be single words, separated by whitespace.
  13420. (defun org-entry-add-to-multivalued-property (pom property value)
  13421. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  13422. (let* ((old (org-entry-get pom property))
  13423. (values (and old (org-split-string old "[ \t]"))))
  13424. (setq value (org-entry-protect-space value))
  13425. (unless (member value values)
  13426. (setq values (cons value values))
  13427. (org-entry-put pom property
  13428. (mapconcat 'identity values " ")))))
  13429. (defun org-entry-remove-from-multivalued-property (pom property value)
  13430. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  13431. (let* ((old (org-entry-get pom property))
  13432. (values (and old (org-split-string old "[ \t]"))))
  13433. (setq value (org-entry-protect-space value))
  13434. (when (member value values)
  13435. (setq values (delete value values))
  13436. (org-entry-put pom property
  13437. (mapconcat 'identity values " ")))))
  13438. (defun org-entry-member-in-multivalued-property (pom property value)
  13439. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  13440. (let* ((old (org-entry-get pom property))
  13441. (values (and old (org-split-string old "[ \t]"))))
  13442. (setq value (org-entry-protect-space value))
  13443. (member value values)))
  13444. (defun org-entry-get-multivalued-property (pom property)
  13445. "Return a list of values in a multivalued property."
  13446. (let* ((value (org-entry-get pom property))
  13447. (values (and value (org-split-string value "[ \t]"))))
  13448. (mapcar 'org-entry-restore-space values)))
  13449. (defun org-entry-put-multivalued-property (pom property &rest values)
  13450. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  13451. VALUES should be a list of strings. Spaces will be protected."
  13452. (org-entry-put pom property
  13453. (mapconcat 'org-entry-protect-space values " "))
  13454. (let* ((value (org-entry-get pom property))
  13455. (values (and value (org-split-string value "[ \t]"))))
  13456. (mapcar 'org-entry-restore-space values)))
  13457. (defun org-entry-protect-space (s)
  13458. "Protect spaces and newline in string S."
  13459. (while (string-match " " s)
  13460. (setq s (replace-match "%20" t t s)))
  13461. (while (string-match "\n" s)
  13462. (setq s (replace-match "%0A" t t s)))
  13463. s)
  13464. (defun org-entry-restore-space (s)
  13465. "Restore spaces and newline in string S."
  13466. (while (string-match "%20" s)
  13467. (setq s (replace-match " " t t s)))
  13468. (while (string-match "%0A" s)
  13469. (setq s (replace-match "\n" t t s)))
  13470. s)
  13471. (defvar org-entry-property-inherited-from (make-marker)
  13472. "Marker pointing to the entry from where a property was inherited.
  13473. Each call to `org-entry-get-with-inheritance' will set this marker to the
  13474. location of the entry where the inheritance search matched. If there was
  13475. no match, the marker will point nowhere.
  13476. Note that also `org-entry-get' calls this function, if the INHERIT flag
  13477. is set.")
  13478. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  13479. "Get PROPERTY of entry or content at point, search higher levels if needed.
  13480. The search will stop at the first ancestor which has the property defined.
  13481. If the value found is \"nil\", return nil to show that the property
  13482. should be considered as undefined (this is the meaning of nil here).
  13483. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  13484. (move-marker org-entry-property-inherited-from nil)
  13485. (let (tmp)
  13486. (save-excursion
  13487. (save-restriction
  13488. (widen)
  13489. (catch 'ex
  13490. (while t
  13491. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  13492. (or (ignore-errors (org-back-to-heading t))
  13493. (goto-char (point-min)))
  13494. (move-marker org-entry-property-inherited-from (point))
  13495. (throw 'ex tmp))
  13496. (or (ignore-errors (org-up-heading-safe))
  13497. (throw 'ex nil))))))
  13498. (setq tmp (or tmp
  13499. (cdr (assoc property org-file-properties))
  13500. (cdr (assoc property org-global-properties))
  13501. (cdr (assoc property org-global-properties-fixed))))
  13502. (if literal-nil tmp (org-not-nil tmp))))
  13503. (defvar org-property-changed-functions nil
  13504. "Hook called when the value of a property has changed.
  13505. Each hook function should accept two arguments, the name of the property
  13506. and the new value.")
  13507. (defun org-entry-put (pom property value)
  13508. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  13509. (org-with-point-at pom
  13510. (org-back-to-heading t)
  13511. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  13512. range)
  13513. (cond
  13514. ((equal property "TODO")
  13515. (when (and (stringp value) (string-match "\\S-" value)
  13516. (not (member value org-todo-keywords-1)))
  13517. (error "\"%s\" is not a valid TODO state" value))
  13518. (if (or (not value)
  13519. (not (string-match "\\S-" value)))
  13520. (setq value 'none))
  13521. (org-todo value)
  13522. (org-set-tags nil 'align))
  13523. ((equal property "PRIORITY")
  13524. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  13525. (string-to-char value) ?\ ))
  13526. (org-set-tags nil 'align))
  13527. ((equal property "CLOCKSUM")
  13528. (if (not (re-search-forward
  13529. (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
  13530. (error "Cannot find a clock log")
  13531. (goto-char (- (match-end 1) 2))
  13532. (cond
  13533. ((eq value 'earlier) (org-timestamp-down))
  13534. ((eq value 'later) (org-timestamp-up)))
  13535. (org-clock-sum-current-item)))
  13536. ((equal property "SCHEDULED")
  13537. (if (re-search-forward org-scheduled-time-regexp end t)
  13538. (cond
  13539. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13540. ((eq value 'later) (org-timestamp-change 1 'day))
  13541. (t (call-interactively 'org-schedule)))
  13542. (call-interactively 'org-schedule)))
  13543. ((equal property "DEADLINE")
  13544. (if (re-search-forward org-deadline-time-regexp end t)
  13545. (cond
  13546. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13547. ((eq value 'later) (org-timestamp-change 1 'day))
  13548. (t (call-interactively 'org-deadline)))
  13549. (call-interactively 'org-deadline)))
  13550. ((member property org-special-properties)
  13551. (error "The %s property can not yet be set with `org-entry-put'"
  13552. property))
  13553. (t ; a non-special property
  13554. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  13555. (setq range (org-get-property-block beg end 'force))
  13556. (goto-char (car range))
  13557. (if (re-search-forward
  13558. (org-re-property-keyword property) (cdr range) t)
  13559. (progn
  13560. (delete-region (match-beginning 0) (match-end 0))
  13561. (goto-char (match-beginning 0)))
  13562. (goto-char (cdr range))
  13563. (insert "\n")
  13564. (backward-char 1)
  13565. (org-indent-line))
  13566. (insert ":" property ":")
  13567. (and value (insert " " value))
  13568. (org-indent-line)))))
  13569. (run-hook-with-args 'org-property-changed-functions property value)))
  13570. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  13571. "Get all property keys in the current buffer.
  13572. With INCLUDE-SPECIALS, also list the special properties that reflect things
  13573. like tags and TODO state.
  13574. With INCLUDE-DEFAULTS, also include properties that has special meaning
  13575. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  13576. and others.
  13577. With INCLUDE-COLUMNS, also include property names given in COLUMN
  13578. formats in the current buffer."
  13579. (let (rtn range cfmt s p)
  13580. (save-excursion
  13581. (save-restriction
  13582. (widen)
  13583. (goto-char (point-min))
  13584. (while (re-search-forward org-property-start-re nil t)
  13585. (setq range (org-get-property-block))
  13586. (goto-char (car range))
  13587. (while (re-search-forward
  13588. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  13589. (cdr range) t)
  13590. (add-to-list 'rtn (org-match-string-no-properties 1)))
  13591. (outline-next-heading))))
  13592. (when include-specials
  13593. (setq rtn (append org-special-properties rtn)))
  13594. (when include-defaults
  13595. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  13596. (add-to-list 'rtn org-effort-property))
  13597. (when include-columns
  13598. (save-excursion
  13599. (save-restriction
  13600. (widen)
  13601. (goto-char (point-min))
  13602. (while (re-search-forward
  13603. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  13604. nil t)
  13605. (setq cfmt (match-string 2) s 0)
  13606. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  13607. cfmt s)
  13608. (setq s (match-end 0)
  13609. p (match-string 1 cfmt))
  13610. (unless (or (equal p "ITEM")
  13611. (member p org-special-properties))
  13612. (add-to-list 'rtn (match-string 1 cfmt))))))))
  13613. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  13614. (defun org-property-values (key)
  13615. "Return a list of all values of property KEY in the current buffer."
  13616. (save-excursion
  13617. (save-restriction
  13618. (widen)
  13619. (goto-char (point-min))
  13620. (let ((re (org-re-property key))
  13621. values)
  13622. (while (re-search-forward re nil t)
  13623. (add-to-list 'values (org-trim (match-string 1))))
  13624. (delete "" values)))))
  13625. (defun org-insert-property-drawer ()
  13626. "Insert a property drawer into the current entry."
  13627. (org-back-to-heading t)
  13628. (looking-at org-outline-regexp)
  13629. (let ((indent (if org-adapt-indentation
  13630. (- (match-end 0) (match-beginning 0))
  13631. 0))
  13632. (beg (point))
  13633. (re (concat "^[ \t]*" org-keyword-time-regexp))
  13634. end hiddenp)
  13635. (outline-next-heading)
  13636. (setq end (point))
  13637. (goto-char beg)
  13638. (while (re-search-forward re end t))
  13639. (setq hiddenp (outline-invisible-p))
  13640. (end-of-line 1)
  13641. (and (equal (char-after) ?\n) (forward-char 1))
  13642. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  13643. (if (member (match-string 1) '("CLOCK:" ":END:"))
  13644. ;; just skip this line
  13645. (beginning-of-line 2)
  13646. ;; Drawer start, find the end
  13647. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  13648. (beginning-of-line 1)))
  13649. (org-skip-over-state-notes)
  13650. (skip-chars-backward " \t\n\r")
  13651. (if (eq (char-before) ?*) (forward-char 1))
  13652. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  13653. (beginning-of-line 0)
  13654. (org-indent-to-column indent)
  13655. (beginning-of-line 2)
  13656. (org-indent-to-column indent)
  13657. (beginning-of-line 0)
  13658. (if hiddenp
  13659. (save-excursion
  13660. (org-back-to-heading t)
  13661. (hide-entry))
  13662. (org-flag-drawer t))))
  13663. (defun org-insert-drawer (&optional arg drawer)
  13664. "Insert a drawer at point.
  13665. Optional argument DRAWER, when non-nil, is a string representing
  13666. drawer's name. Otherwise, the user is prompted for a name.
  13667. If a region is active, insert the drawer around that region
  13668. instead.
  13669. Point is left between drawer's boundaries."
  13670. (interactive "P")
  13671. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  13672. "LOGBOOK"))
  13673. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  13674. ;; internally by Org. They are meant to be inserted
  13675. ;; automatically.
  13676. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  13677. ;; Remove system drawers from list. Note: For some reason,
  13678. ;; `org-completing-read' ignores the predicate while
  13679. ;; `completing-read' handles it fine.
  13680. (drawer (if arg "PROPERTIES"
  13681. (or drawer
  13682. (completing-read
  13683. "Drawer: " org-drawers
  13684. (lambda (d) (not (member d system-drawers))))))))
  13685. (cond
  13686. ;; With C-u, fall back on `org-insert-property-drawer'
  13687. (arg (org-insert-property-drawer))
  13688. ;; With an active region, insert a drawer at point.
  13689. ((not (org-region-active-p))
  13690. (progn
  13691. (unless (bolp) (insert "\n"))
  13692. (insert (format ":%s:\n\n:END:\n" drawer))
  13693. (forward-line -2)))
  13694. ;; Otherwise, insert the drawer at point
  13695. (t
  13696. (let ((rbeg (region-beginning))
  13697. (rend (copy-marker (region-end))))
  13698. (unwind-protect
  13699. (progn
  13700. (goto-char rbeg)
  13701. (beginning-of-line)
  13702. (when (save-excursion
  13703. (re-search-forward org-outline-regexp-bol rend t))
  13704. (error "Drawers cannot contain headlines"))
  13705. ;; Position point at the beginning of the first
  13706. ;; non-blank line in region. Insert drawer's opening
  13707. ;; there, then indent it.
  13708. (org-skip-whitespace)
  13709. (beginning-of-line)
  13710. (insert ":" drawer ":\n")
  13711. (forward-line -1)
  13712. (indent-for-tab-command)
  13713. ;; Move point to the beginning of the first blank line
  13714. ;; after the last non-blank line in region. Insert
  13715. ;; drawer's closing, then indent it.
  13716. (goto-char rend)
  13717. (skip-chars-backward " \r\t\n")
  13718. (insert "\n:END:")
  13719. (deactivate-mark t)
  13720. (indent-for-tab-command)
  13721. (unless (eolp) (insert "\n")))
  13722. ;; Clear marker, whatever the outcome of insertion is.
  13723. (set-marker rend nil)))))))
  13724. (defvar org-property-set-functions-alist nil
  13725. "Property set function alist.
  13726. Each entry should have the following format:
  13727. (PROPERTY . READ-FUNCTION)
  13728. The read function will be called with the same argument as
  13729. `org-completing-read'.")
  13730. (defun org-set-property-function (property)
  13731. "Get the function that should be used to set PROPERTY.
  13732. This is computed according to `org-property-set-functions-alist'."
  13733. (or (cdr (assoc property org-property-set-functions-alist))
  13734. 'org-completing-read))
  13735. (defun org-read-property-value (property)
  13736. "Read PROPERTY value from user."
  13737. (let* ((completion-ignore-case t)
  13738. (allowed (org-property-get-allowed-values nil property 'table))
  13739. (cur (org-entry-get nil property))
  13740. (prompt (concat property " value"
  13741. (if (and cur (string-match "\\S-" cur))
  13742. (concat " [" cur "]") "") ": "))
  13743. (set-function (org-set-property-function property))
  13744. (val (if allowed
  13745. (funcall set-function prompt allowed nil
  13746. (not (get-text-property 0 'org-unrestricted
  13747. (caar allowed))))
  13748. (let (org-completion-use-ido org-completion-use-iswitchb)
  13749. (funcall set-function prompt
  13750. (mapcar 'list (org-property-values property))
  13751. nil nil "" nil cur)))))
  13752. (if (equal val "")
  13753. cur
  13754. val)))
  13755. (defvar org-last-set-property nil)
  13756. (defun org-read-property-name ()
  13757. "Read a property name."
  13758. (let* ((completion-ignore-case t)
  13759. (keys (org-buffer-property-keys nil t t))
  13760. (default-prop (or (save-excursion
  13761. (save-match-data
  13762. (beginning-of-line)
  13763. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  13764. (null (string= (match-string 1) "END"))
  13765. (match-string 1))))
  13766. org-last-set-property))
  13767. (property (org-icompleting-read
  13768. (concat "Property"
  13769. (if default-prop (concat " [" default-prop "]") "")
  13770. ": ")
  13771. (mapcar 'list keys)
  13772. nil nil nil nil
  13773. default-prop
  13774. )))
  13775. (if (member property keys)
  13776. property
  13777. (or (cdr (assoc (downcase property)
  13778. (mapcar (lambda (x) (cons (downcase x) x))
  13779. keys)))
  13780. property))))
  13781. (defun org-set-property (property value)
  13782. "In the current entry, set PROPERTY to VALUE.
  13783. When called interactively, this will prompt for a property name, offering
  13784. completion on existing and default properties. And then it will prompt
  13785. for a value, offering completion either on allowed values (via an inherited
  13786. xxx_ALL property) or on existing values in other instances of this property
  13787. in the current file."
  13788. (interactive (list nil nil))
  13789. (let* ((property (or property (org-read-property-name)))
  13790. (value (or value (org-read-property-value property)))
  13791. (fn (cdr (assoc property org-properties-postprocess-alist))))
  13792. (setq org-last-set-property property)
  13793. ;; Possibly postprocess the inserted value:
  13794. (when fn (setq value (funcall fn value)))
  13795. (unless (equal (org-entry-get nil property) value)
  13796. (org-entry-put nil property value))))
  13797. (defun org-delete-property (property)
  13798. "In the current entry, delete PROPERTY."
  13799. (interactive
  13800. (let* ((completion-ignore-case t)
  13801. (prop (org-icompleting-read "Property: "
  13802. (org-entry-properties nil 'standard))))
  13803. (list prop)))
  13804. (message "Property %s %s" property
  13805. (if (org-entry-delete nil property)
  13806. "deleted"
  13807. "was not present in the entry")))
  13808. (defun org-delete-property-globally (property)
  13809. "Remove PROPERTY globally, from all entries."
  13810. (interactive
  13811. (let* ((completion-ignore-case t)
  13812. (prop (org-icompleting-read
  13813. "Globally remove property: "
  13814. (mapcar 'list (org-buffer-property-keys)))))
  13815. (list prop)))
  13816. (save-excursion
  13817. (save-restriction
  13818. (widen)
  13819. (goto-char (point-min))
  13820. (let ((cnt 0))
  13821. (while (re-search-forward
  13822. (org-re-property property)
  13823. nil t)
  13824. (setq cnt (1+ cnt))
  13825. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  13826. (message "Property \"%s\" removed from %d entries" property cnt)))))
  13827. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  13828. (defun org-compute-property-at-point ()
  13829. "Compute the property at point.
  13830. This looks for an enclosing column format, extracts the operator and
  13831. then applies it to the property in the column format's scope."
  13832. (interactive)
  13833. (unless (org-at-property-p)
  13834. (error "Not at a property"))
  13835. (let ((prop (org-match-string-no-properties 2)))
  13836. (org-columns-get-format-and-top-level)
  13837. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  13838. (error "No operator defined for property %s" prop))
  13839. (org-columns-compute prop)))
  13840. (defvar org-property-allowed-value-functions nil
  13841. "Hook for functions supplying allowed values for a specific property.
  13842. The functions must take a single argument, the name of the property, and
  13843. return a flat list of allowed values. If \":ETC\" is one of
  13844. the values, this means that these values are intended as defaults for
  13845. completion, but that other values should be allowed too.
  13846. The functions must return nil if they are not responsible for this
  13847. property.")
  13848. (defun org-property-get-allowed-values (pom property &optional table)
  13849. "Get allowed values for the property PROPERTY.
  13850. When TABLE is non-nil, return an alist that can directly be used for
  13851. completion."
  13852. (let (vals)
  13853. (cond
  13854. ((equal property "TODO")
  13855. (setq vals (org-with-point-at pom
  13856. (append org-todo-keywords-1 '("")))))
  13857. ((equal property "PRIORITY")
  13858. (let ((n org-lowest-priority))
  13859. (while (>= n org-highest-priority)
  13860. (push (char-to-string n) vals)
  13861. (setq n (1- n)))))
  13862. ((member property org-special-properties))
  13863. ((setq vals (run-hook-with-args-until-success
  13864. 'org-property-allowed-value-functions property)))
  13865. (t
  13866. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  13867. (when (and vals (string-match "\\S-" vals))
  13868. (setq vals (car (read-from-string (concat "(" vals ")"))))
  13869. (setq vals (mapcar (lambda (x)
  13870. (cond ((stringp x) x)
  13871. ((numberp x) (number-to-string x))
  13872. ((symbolp x) (symbol-name x))
  13873. (t "???")))
  13874. vals)))))
  13875. (when (member ":ETC" vals)
  13876. (setq vals (remove ":ETC" vals))
  13877. (org-add-props (car vals) '(org-unrestricted t)))
  13878. (if table (mapcar 'list vals) vals)))
  13879. (defun org-property-previous-allowed-value (&optional previous)
  13880. "Switch to the next allowed value for this property."
  13881. (interactive)
  13882. (org-property-next-allowed-value t))
  13883. (defun org-property-next-allowed-value (&optional previous)
  13884. "Switch to the next allowed value for this property."
  13885. (interactive)
  13886. (unless (org-at-property-p)
  13887. (error "Not at a property"))
  13888. (let* ((key (match-string 2))
  13889. (value (match-string 3))
  13890. (allowed (or (org-property-get-allowed-values (point) key)
  13891. (and (member value '("[ ]" "[-]" "[X]"))
  13892. '("[ ]" "[X]"))))
  13893. nval)
  13894. (unless allowed
  13895. (error "Allowed values for this property have not been defined"))
  13896. (if previous (setq allowed (reverse allowed)))
  13897. (if (member value allowed)
  13898. (setq nval (car (cdr (member value allowed)))))
  13899. (setq nval (or nval (car allowed)))
  13900. (if (equal nval value)
  13901. (error "Only one allowed value for this property"))
  13902. (org-at-property-p)
  13903. (replace-match (concat " :" key ": " nval) t t)
  13904. (org-indent-line)
  13905. (beginning-of-line 1)
  13906. (skip-chars-forward " \t")
  13907. (run-hook-with-args 'org-property-changed-functions key nval)))
  13908. (defun org-find-olp (path &optional this-buffer)
  13909. "Return a marker pointing to the entry at outline path OLP.
  13910. If anything goes wrong, throw an error.
  13911. You can wrap this call to catch the error like this:
  13912. (condition-case msg
  13913. (org-mobile-locate-entry (match-string 4))
  13914. (error (nth 1 msg)))
  13915. The return value will then be either a string with the error message,
  13916. or a marker if everything is OK.
  13917. If THIS-BUFFER is set, the outline path does not contain a file,
  13918. only headings."
  13919. (let* ((file (if this-buffer buffer-file-name (pop path)))
  13920. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  13921. (level 1)
  13922. (lmin 1)
  13923. (lmax 1)
  13924. limit re end found pos heading cnt flevel)
  13925. (unless buffer (error "File not found :%s" file))
  13926. (with-current-buffer buffer
  13927. (save-excursion
  13928. (save-restriction
  13929. (widen)
  13930. (setq limit (point-max))
  13931. (goto-char (point-min))
  13932. (while (setq heading (pop path))
  13933. (setq re (format org-complex-heading-regexp-format
  13934. (regexp-quote heading)))
  13935. (setq cnt 0 pos (point))
  13936. (while (re-search-forward re end t)
  13937. (setq level (- (match-end 1) (match-beginning 1)))
  13938. (if (and (>= level lmin) (<= level lmax))
  13939. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  13940. (when (= cnt 0) (error "Heading not found on level %d: %s"
  13941. lmax heading))
  13942. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  13943. lmax heading))
  13944. (goto-char found)
  13945. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  13946. (setq end (save-excursion (org-end-of-subtree t t))))
  13947. (when (org-at-heading-p)
  13948. (move-marker (make-marker) (point))))))))
  13949. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  13950. "Find node HEADING in BUFFER.
  13951. Return a marker to the heading if it was found, or nil if not.
  13952. If POS-ONLY is set, return just the position instead of a marker.
  13953. The heading text must match exact, but it may have a TODO keyword,
  13954. a priority cookie and tags in the standard locations."
  13955. (with-current-buffer (or buffer (current-buffer))
  13956. (save-excursion
  13957. (save-restriction
  13958. (widen)
  13959. (goto-char (point-min))
  13960. (let (case-fold-search)
  13961. (if (re-search-forward
  13962. (format org-complex-heading-regexp-format
  13963. (regexp-quote heading)) nil t)
  13964. (if pos-only
  13965. (match-beginning 0)
  13966. (move-marker (make-marker) (match-beginning 0)))))))))
  13967. (defun org-find-exact-heading-in-directory (heading &optional dir)
  13968. "Find Org node headline HEADING in all .org files in directory DIR.
  13969. When the target headline is found, return a marker to this location."
  13970. (let ((files (directory-files (or dir default-directory)
  13971. nil "\\`[^.#].*\\.org\\'"))
  13972. file visiting m buffer)
  13973. (catch 'found
  13974. (while (setq file (pop files))
  13975. (message "trying %s" file)
  13976. (setq visiting (org-find-base-buffer-visiting file))
  13977. (setq buffer (or visiting (find-file-noselect file)))
  13978. (setq m (org-find-exact-headline-in-buffer
  13979. heading buffer))
  13980. (when (and (not m) (not visiting)) (kill-buffer buffer))
  13981. (and m (throw 'found m))))))
  13982. (defun org-find-entry-with-id (ident)
  13983. "Locate the entry that contains the ID property with exact value IDENT.
  13984. IDENT can be a string, a symbol or a number, this function will search for
  13985. the string representation of it.
  13986. Return the position where this entry starts, or nil if there is no such entry."
  13987. (interactive "sID: ")
  13988. (let ((id (cond
  13989. ((stringp ident) ident)
  13990. ((symbol-name ident) (symbol-name ident))
  13991. ((numberp ident) (number-to-string ident))
  13992. (t (error "IDENT %s must be a string, symbol or number" ident))))
  13993. (case-fold-search nil))
  13994. (save-excursion
  13995. (save-restriction
  13996. (widen)
  13997. (goto-char (point-min))
  13998. (when (re-search-forward
  13999. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  14000. nil t)
  14001. (org-back-to-heading t)
  14002. (point))))))
  14003. ;;;; Timestamps
  14004. (defvar org-last-changed-timestamp nil)
  14005. (defvar org-last-inserted-timestamp nil
  14006. "The last time stamp inserted with `org-insert-time-stamp'.")
  14007. (defvar org-time-was-given) ; dynamically scoped parameter
  14008. (defvar org-end-time-was-given) ; dynamically scoped parameter
  14009. (defvar org-ts-what) ; dynamically scoped parameter
  14010. (defun org-time-stamp (arg &optional inactive)
  14011. "Prompt for a date/time and insert a time stamp.
  14012. If the user specifies a time like HH:MM or if this command is
  14013. called with at least one prefix argument, the time stamp contains
  14014. the date and the time. Otherwise, only the date is be included.
  14015. All parts of a date not specified by the user is filled in from
  14016. the current date/time. So if you just press return without
  14017. typing anything, the time stamp will represent the current
  14018. date/time.
  14019. If there is already a timestamp at the cursor, it will be
  14020. modified.
  14021. With two universal prefix arguments, insert an active timestamp
  14022. with the current time without prompting the user."
  14023. (interactive "P")
  14024. (let* ((ts nil)
  14025. (default-time
  14026. ;; Default time is either today, or, when entering a range,
  14027. ;; the range start.
  14028. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  14029. (save-excursion
  14030. (re-search-backward
  14031. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  14032. (- (point) 20) t)))
  14033. (apply 'encode-time (org-parse-time-string (match-string 1)))
  14034. (current-time)))
  14035. (default-input (and ts (org-get-compact-tod ts)))
  14036. (repeater (save-excursion
  14037. (save-match-data
  14038. (beginning-of-line)
  14039. (when (re-search-forward
  14040. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  14041. (save-excursion (progn (end-of-line) (point))) t)
  14042. (match-string 0)))))
  14043. org-time-was-given org-end-time-was-given time)
  14044. (cond
  14045. ((and (org-at-timestamp-p t)
  14046. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  14047. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  14048. (insert "--")
  14049. (setq time (let ((this-command this-command))
  14050. (org-read-date arg 'totime nil nil
  14051. default-time default-input inactive)))
  14052. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  14053. ((org-at-timestamp-p t)
  14054. (setq time (let ((this-command this-command))
  14055. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14056. (when (org-at-timestamp-p t) ; just to get the match data
  14057. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  14058. (replace-match "")
  14059. (setq org-last-changed-timestamp
  14060. (org-insert-time-stamp
  14061. time (or org-time-was-given arg)
  14062. inactive nil nil (list org-end-time-was-given)))
  14063. (when repeater (goto-char (1- (point))) (insert " " repeater)
  14064. (setq org-last-changed-timestamp
  14065. (concat (substring org-last-inserted-timestamp 0 -1)
  14066. " " repeater ">"))))
  14067. (message "Timestamp updated"))
  14068. ((equal arg '(16))
  14069. (org-insert-time-stamp (current-time) t))
  14070. (t
  14071. (setq time (let ((this-command this-command))
  14072. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14073. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  14074. nil nil (list org-end-time-was-given))))))
  14075. ;; FIXME: can we use this for something else, like computing time differences?
  14076. (defun org-get-compact-tod (s)
  14077. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  14078. (let* ((t1 (match-string 1 s))
  14079. (h1 (string-to-number (match-string 2 s)))
  14080. (m1 (string-to-number (match-string 3 s)))
  14081. (t2 (and (match-end 4) (match-string 5 s)))
  14082. (h2 (and t2 (string-to-number (match-string 6 s))))
  14083. (m2 (and t2 (string-to-number (match-string 7 s))))
  14084. dh dm)
  14085. (if (not t2)
  14086. t1
  14087. (setq dh (- h2 h1) dm (- m2 m1))
  14088. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  14089. (concat t1 "+" (number-to-string dh)
  14090. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  14091. (defun org-time-stamp-inactive (&optional arg)
  14092. "Insert an inactive time stamp.
  14093. An inactive time stamp is enclosed in square brackets instead of angle
  14094. brackets. It is inactive in the sense that it does not trigger agenda entries,
  14095. does not link to the calendar and cannot be changed with the S-cursor keys.
  14096. So these are more for recording a certain time/date."
  14097. (interactive "P")
  14098. (org-time-stamp arg 'inactive))
  14099. (defvar org-date-ovl (make-overlay 1 1))
  14100. (overlay-put org-date-ovl 'face 'org-date-selected)
  14101. (org-detach-overlay org-date-ovl)
  14102. (defvar org-ans1) ; dynamically scoped parameter
  14103. (defvar org-ans2) ; dynamically scoped parameter
  14104. (defvar org-plain-time-of-day-regexp) ; defined below
  14105. (defvar org-overriding-default-time nil) ; dynamically scoped
  14106. (defvar org-read-date-overlay nil)
  14107. (defvar org-dcst nil) ; dynamically scoped
  14108. (defvar org-read-date-history nil)
  14109. (defvar org-read-date-final-answer nil)
  14110. (defvar org-read-date-analyze-futurep nil)
  14111. (defvar org-read-date-analyze-forced-year nil)
  14112. (defvar org-read-date-inactive)
  14113. (defun org-read-date (&optional org-with-time to-time from-string prompt
  14114. default-time default-input inactive)
  14115. "Read a date, possibly a time, and make things smooth for the user.
  14116. The prompt will suggest to enter an ISO date, but you can also enter anything
  14117. which will at least partially be understood by `parse-time-string'.
  14118. Unrecognized parts of the date will default to the current day, month, year,
  14119. hour and minute. If this command is called to replace a timestamp at point,
  14120. or to enter the second timestamp of a range, the default time is taken
  14121. from the existing stamp. Furthermore, the command prefers the future,
  14122. so if you are giving a date where the year is not given, and the day-month
  14123. combination is already past in the current year, it will assume you
  14124. mean next year. For details, see the manual. A few examples:
  14125. 3-2-5 --> 2003-02-05
  14126. feb 15 --> currentyear-02-15
  14127. 2/15 --> currentyear-02-15
  14128. sep 12 9 --> 2009-09-12
  14129. 12:45 --> today 12:45
  14130. 22 sept 0:34 --> currentyear-09-22 0:34
  14131. 12 --> currentyear-currentmonth-12
  14132. Fri --> nearest Friday (today or later)
  14133. etc.
  14134. Furthermore you can specify a relative date by giving, as the *first* thing
  14135. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  14136. change in days weeks, months, years.
  14137. With a single plus or minus, the date is relative to today. With a double
  14138. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  14139. +4d --> four days from today
  14140. +4 --> same as above
  14141. +2w --> two weeks from today
  14142. ++5 --> five days from default date
  14143. The function understands only English month and weekday abbreviations.
  14144. While prompting, a calendar is popped up - you can also select the
  14145. date with the mouse (button 1). The calendar shows a period of three
  14146. months. To scroll it to other months, use the keys `>' and `<'.
  14147. If you don't like the calendar, turn it off with
  14148. \(setq org-read-date-popup-calendar nil)
  14149. With optional argument TO-TIME, the date will immediately be converted
  14150. to an internal time.
  14151. With an optional argument ORG-WITH-TIME, the prompt will suggest to
  14152. also insert a time. Note that when ORG-WITH-TIME is not set, you can
  14153. still enter a time, and this function will inform the calling routine
  14154. about this change. The calling routine may then choose to change the
  14155. format used to insert the time stamp into the buffer to include the time.
  14156. With optional argument FROM-STRING, read from this string instead from
  14157. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  14158. the time/date that is used for everything that is not specified by the
  14159. user."
  14160. (require 'parse-time)
  14161. (let* ((org-time-stamp-rounding-minutes
  14162. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  14163. (org-dcst org-display-custom-times)
  14164. (ct (org-current-time))
  14165. (org-def (or org-overriding-default-time default-time ct))
  14166. (org-defdecode (decode-time org-def))
  14167. (dummy (progn
  14168. (when (< (nth 2 org-defdecode) org-extend-today-until)
  14169. (setcar (nthcdr 2 org-defdecode) -1)
  14170. (setcar (nthcdr 1 org-defdecode) 59)
  14171. (setq org-def (apply 'encode-time org-defdecode)
  14172. org-defdecode (decode-time org-def)))))
  14173. (calendar-frame-setup nil)
  14174. (calendar-setup nil)
  14175. (calendar-move-hook nil)
  14176. (calendar-view-diary-initially-flag nil)
  14177. (calendar-view-holidays-initially-flag nil)
  14178. (timestr (format-time-string
  14179. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  14180. (prompt (concat (if prompt (concat prompt " ") "")
  14181. (format "Date+time [%s]: " timestr)))
  14182. ans (org-ans0 "") org-ans1 org-ans2 final)
  14183. (cond
  14184. (from-string (setq ans from-string))
  14185. (org-read-date-popup-calendar
  14186. (save-excursion
  14187. (save-window-excursion
  14188. (calendar)
  14189. (org-eval-in-calendar '(setq cursor-type nil) t)
  14190. (unwind-protect
  14191. (progn
  14192. (calendar-forward-day (- (time-to-days org-def)
  14193. (calendar-absolute-from-gregorian
  14194. (calendar-current-date))))
  14195. (org-eval-in-calendar nil t)
  14196. (let* ((old-map (current-local-map))
  14197. (map (copy-keymap calendar-mode-map))
  14198. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  14199. (org-defkey map (kbd "RET") 'org-calendar-select)
  14200. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  14201. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  14202. (org-defkey minibuffer-local-map [(meta shift left)]
  14203. (lambda () (interactive)
  14204. (org-eval-in-calendar '(calendar-backward-month 1))))
  14205. (org-defkey minibuffer-local-map [(meta shift right)]
  14206. (lambda () (interactive)
  14207. (org-eval-in-calendar '(calendar-forward-month 1))))
  14208. (org-defkey minibuffer-local-map [(meta shift up)]
  14209. (lambda () (interactive)
  14210. (org-eval-in-calendar '(calendar-backward-year 1))))
  14211. (org-defkey minibuffer-local-map [(meta shift down)]
  14212. (lambda () (interactive)
  14213. (org-eval-in-calendar '(calendar-forward-year 1))))
  14214. (org-defkey minibuffer-local-map [?\e (shift left)]
  14215. (lambda () (interactive)
  14216. (org-eval-in-calendar '(calendar-backward-month 1))))
  14217. (org-defkey minibuffer-local-map [?\e (shift right)]
  14218. (lambda () (interactive)
  14219. (org-eval-in-calendar '(calendar-forward-month 1))))
  14220. (org-defkey minibuffer-local-map [?\e (shift up)]
  14221. (lambda () (interactive)
  14222. (org-eval-in-calendar '(calendar-backward-year 1))))
  14223. (org-defkey minibuffer-local-map [?\e (shift down)]
  14224. (lambda () (interactive)
  14225. (org-eval-in-calendar '(calendar-forward-year 1))))
  14226. (org-defkey minibuffer-local-map [(shift up)]
  14227. (lambda () (interactive)
  14228. (org-eval-in-calendar '(calendar-backward-week 1))))
  14229. (org-defkey minibuffer-local-map [(shift down)]
  14230. (lambda () (interactive)
  14231. (org-eval-in-calendar '(calendar-forward-week 1))))
  14232. (org-defkey minibuffer-local-map [(shift left)]
  14233. (lambda () (interactive)
  14234. (org-eval-in-calendar '(calendar-backward-day 1))))
  14235. (org-defkey minibuffer-local-map [(shift right)]
  14236. (lambda () (interactive)
  14237. (org-eval-in-calendar '(calendar-forward-day 1))))
  14238. (org-defkey minibuffer-local-map ">"
  14239. (lambda () (interactive)
  14240. (org-eval-in-calendar '(scroll-calendar-left 1))))
  14241. (org-defkey minibuffer-local-map "<"
  14242. (lambda () (interactive)
  14243. (org-eval-in-calendar '(scroll-calendar-right 1))))
  14244. (org-defkey minibuffer-local-map "\C-v"
  14245. (lambda () (interactive)
  14246. (org-eval-in-calendar
  14247. '(calendar-scroll-left-three-months 1))))
  14248. (org-defkey minibuffer-local-map "\M-v"
  14249. (lambda () (interactive)
  14250. (org-eval-in-calendar
  14251. '(calendar-scroll-right-three-months 1))))
  14252. (run-hooks 'org-read-date-minibuffer-setup-hook)
  14253. (unwind-protect
  14254. (progn
  14255. (use-local-map map)
  14256. (setq org-read-date-inactive inactive)
  14257. (add-hook 'post-command-hook 'org-read-date-display)
  14258. (setq org-ans0 (read-string prompt default-input
  14259. 'org-read-date-history nil))
  14260. ;; org-ans0: from prompt
  14261. ;; org-ans1: from mouse click
  14262. ;; org-ans2: from calendar motion
  14263. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  14264. (remove-hook 'post-command-hook 'org-read-date-display)
  14265. (use-local-map old-map)
  14266. (when org-read-date-overlay
  14267. (delete-overlay org-read-date-overlay)
  14268. (setq org-read-date-overlay nil)))))
  14269. (bury-buffer "*Calendar*")))))
  14270. (t ; Naked prompt only
  14271. (unwind-protect
  14272. (setq ans (read-string prompt default-input
  14273. 'org-read-date-history timestr))
  14274. (when org-read-date-overlay
  14275. (delete-overlay org-read-date-overlay)
  14276. (setq org-read-date-overlay nil)))))
  14277. (setq final (org-read-date-analyze ans org-def org-defdecode))
  14278. (when org-read-date-analyze-forced-year
  14279. (message "Year was forced into %s"
  14280. (if org-read-date-force-compatible-dates
  14281. "compatible range (1970-2037)"
  14282. "range representable on this machine"))
  14283. (ding))
  14284. ;; One round trip to get rid of 34th of August and stuff like that....
  14285. (setq final (decode-time (apply 'encode-time final)))
  14286. (setq org-read-date-final-answer ans)
  14287. (if to-time
  14288. (apply 'encode-time final)
  14289. (if (and (boundp 'org-time-was-given) org-time-was-given)
  14290. (format "%04d-%02d-%02d %02d:%02d"
  14291. (nth 5 final) (nth 4 final) (nth 3 final)
  14292. (nth 2 final) (nth 1 final))
  14293. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  14294. (defvar org-def)
  14295. (defvar org-defdecode)
  14296. (defvar org-with-time)
  14297. (defun org-read-date-display ()
  14298. "Display the current date prompt interpretation in the minibuffer."
  14299. (when org-read-date-display-live
  14300. (when org-read-date-overlay
  14301. (delete-overlay org-read-date-overlay))
  14302. (when (minibufferp (current-buffer))
  14303. (save-excursion
  14304. (end-of-line 1)
  14305. (while (not (equal (buffer-substring
  14306. (max (point-min) (- (point) 4)) (point))
  14307. " "))
  14308. (insert " ")))
  14309. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14310. " " (or org-ans1 org-ans2)))
  14311. (org-end-time-was-given nil)
  14312. (f (org-read-date-analyze ans org-def org-defdecode))
  14313. (fmts (if org-dcst
  14314. org-time-stamp-custom-formats
  14315. org-time-stamp-formats))
  14316. (fmt (if (or org-with-time
  14317. (and (boundp 'org-time-was-given) org-time-was-given))
  14318. (cdr fmts)
  14319. (car fmts)))
  14320. (txt (format-time-string fmt (apply 'encode-time f)))
  14321. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  14322. (txt (concat "=> " txt)))
  14323. (when (and org-end-time-was-given
  14324. (string-match org-plain-time-of-day-regexp txt))
  14325. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  14326. org-end-time-was-given
  14327. (substring txt (match-end 0)))))
  14328. (when org-read-date-analyze-futurep
  14329. (setq txt (concat txt " (=>F)")))
  14330. (setq org-read-date-overlay
  14331. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  14332. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  14333. (defun org-read-date-analyze (ans org-def org-defdecode)
  14334. "Analyze the combined answer of the date prompt."
  14335. ;; FIXME: cleanup and comment
  14336. (let ((nowdecode (decode-time (current-time)))
  14337. delta deltan deltaw deltadef year month day
  14338. hour minute second wday pm h2 m2 tl wday1
  14339. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  14340. (setq org-read-date-analyze-futurep nil
  14341. org-read-date-analyze-forced-year nil)
  14342. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  14343. (setq ans "+0"))
  14344. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  14345. (setq ans (replace-match "" t t ans)
  14346. deltan (car delta)
  14347. deltaw (nth 1 delta)
  14348. deltadef (nth 2 delta)))
  14349. ;; Check if there is an iso week date in there. If yes, store the
  14350. ;; info and postpone interpreting it until the rest of the parsing
  14351. ;; is done.
  14352. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  14353. (setq iso-year (if (match-end 1)
  14354. (org-small-year-to-year
  14355. (string-to-number (match-string 1 ans))))
  14356. iso-weekday (if (match-end 3)
  14357. (string-to-number (match-string 3 ans)))
  14358. iso-week (string-to-number (match-string 2 ans)))
  14359. (setq ans (replace-match "" t t ans)))
  14360. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  14361. (when (string-match
  14362. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  14363. (setq year (if (match-end 2)
  14364. (string-to-number (match-string 2 ans))
  14365. (progn (setq kill-year t)
  14366. (string-to-number (format-time-string "%Y"))))
  14367. month (string-to-number (match-string 3 ans))
  14368. day (string-to-number (match-string 4 ans)))
  14369. (if (< year 100) (setq year (+ 2000 year)))
  14370. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14371. t nil ans)))
  14372. ;; Help matching dotted european dates
  14373. (when (string-match
  14374. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
  14375. (setq year (if (match-end 3)
  14376. (string-to-number (match-string 3 ans))
  14377. (progn (setq kill-year t)
  14378. (string-to-number (format-time-string "%Y"))))
  14379. day (string-to-number (match-string 1 ans))
  14380. month (string-to-number (match-string 2 ans))
  14381. ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14382. t nil ans)))
  14383. ;; Help matching american dates, like 5/30 or 5/30/7
  14384. (when (string-match
  14385. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  14386. (setq year (if (match-end 4)
  14387. (string-to-number (match-string 4 ans))
  14388. (progn (setq kill-year t)
  14389. (string-to-number (format-time-string "%Y"))))
  14390. month (string-to-number (match-string 1 ans))
  14391. day (string-to-number (match-string 2 ans)))
  14392. (if (< year 100) (setq year (+ 2000 year)))
  14393. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14394. t nil ans)))
  14395. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  14396. ;; If there is a time with am/pm, and *no* time without it, we convert
  14397. ;; so that matching will be successful.
  14398. (loop for i from 1 to 2 do ; twice, for end time as well
  14399. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  14400. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  14401. (setq hour (string-to-number (match-string 1 ans))
  14402. minute (if (match-end 3)
  14403. (string-to-number (match-string 3 ans))
  14404. 0)
  14405. pm (equal ?p
  14406. (string-to-char (downcase (match-string 4 ans)))))
  14407. (if (and (= hour 12) (not pm))
  14408. (setq hour 0)
  14409. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  14410. (setq ans (replace-match (format "%02d:%02d" hour minute)
  14411. t t ans))))
  14412. ;; Check if a time range is given as a duration
  14413. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  14414. (setq hour (string-to-number (match-string 1 ans))
  14415. h2 (+ hour (string-to-number (match-string 3 ans)))
  14416. minute (string-to-number (match-string 2 ans))
  14417. m2 (+ minute (if (match-end 5) (string-to-number
  14418. (match-string 5 ans))0)))
  14419. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  14420. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  14421. t t ans)))
  14422. ;; Check if there is a time range
  14423. (when (boundp 'org-end-time-was-given)
  14424. (setq org-time-was-given nil)
  14425. (when (and (string-match org-plain-time-of-day-regexp ans)
  14426. (match-end 8))
  14427. (setq org-end-time-was-given (match-string 8 ans))
  14428. (setq ans (concat (substring ans 0 (match-beginning 7))
  14429. (substring ans (match-end 7))))))
  14430. (setq tl (parse-time-string ans)
  14431. day (or (nth 3 tl) (nth 3 org-defdecode))
  14432. month (or (nth 4 tl)
  14433. (if (and org-read-date-prefer-future
  14434. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  14435. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  14436. (nth 4 org-defdecode)))
  14437. year (or (and (not kill-year) (nth 5 tl))
  14438. (if (and org-read-date-prefer-future
  14439. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  14440. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  14441. (nth 5 org-defdecode)))
  14442. hour (or (nth 2 tl) (nth 2 org-defdecode))
  14443. minute (or (nth 1 tl) (nth 1 org-defdecode))
  14444. second (or (nth 0 tl) 0)
  14445. wday (nth 6 tl))
  14446. (when (and (eq org-read-date-prefer-future 'time)
  14447. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  14448. (equal day (nth 3 nowdecode))
  14449. (equal month (nth 4 nowdecode))
  14450. (equal year (nth 5 nowdecode))
  14451. (nth 2 tl)
  14452. (or (< (nth 2 tl) (nth 2 nowdecode))
  14453. (and (= (nth 2 tl) (nth 2 nowdecode))
  14454. (nth 1 tl)
  14455. (< (nth 1 tl) (nth 1 nowdecode)))))
  14456. (setq day (1+ day)
  14457. futurep t))
  14458. ;; Special date definitions below
  14459. (cond
  14460. (iso-week
  14461. ;; There was an iso week
  14462. (require 'cal-iso)
  14463. (setq futurep nil)
  14464. (setq year (or iso-year year)
  14465. day (or iso-weekday wday 1)
  14466. wday nil ; to make sure that the trigger below does not match
  14467. iso-date (calendar-gregorian-from-absolute
  14468. (calendar-absolute-from-iso
  14469. (list iso-week day year))))
  14470. ; FIXME: Should we also push ISO weeks into the future?
  14471. ; (when (and org-read-date-prefer-future
  14472. ; (not iso-year)
  14473. ; (< (calendar-absolute-from-gregorian iso-date)
  14474. ; (time-to-days (current-time))))
  14475. ; (setq year (1+ year)
  14476. ; iso-date (calendar-gregorian-from-absolute
  14477. ; (calendar-absolute-from-iso
  14478. ; (list iso-week day year)))))
  14479. (setq month (car iso-date)
  14480. year (nth 2 iso-date)
  14481. day (nth 1 iso-date)))
  14482. (deltan
  14483. (setq futurep nil)
  14484. (unless deltadef
  14485. (let ((now (decode-time (current-time))))
  14486. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  14487. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  14488. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  14489. ((equal deltaw "m") (setq month (+ month deltan)))
  14490. ((equal deltaw "y") (setq year (+ year deltan)))))
  14491. ((and wday (not (nth 3 tl)))
  14492. ;; Weekday was given, but no day, so pick that day in the week
  14493. ;; on or after the derived date.
  14494. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  14495. (unless (equal wday wday1)
  14496. (setq day (+ day (% (- wday wday1 -7) 7))))))
  14497. (if (and (boundp 'org-time-was-given)
  14498. (nth 2 tl))
  14499. (setq org-time-was-given t))
  14500. (if (< year 100) (setq year (+ 2000 year)))
  14501. ;; Check of the date is representable
  14502. (if org-read-date-force-compatible-dates
  14503. (progn
  14504. (if (< year 1970)
  14505. (setq year 1970 org-read-date-analyze-forced-year t))
  14506. (if (> year 2037)
  14507. (setq year 2037 org-read-date-analyze-forced-year t)))
  14508. (condition-case nil
  14509. (ignore (encode-time second minute hour day month year))
  14510. (error
  14511. (setq year (nth 5 org-defdecode))
  14512. (setq org-read-date-analyze-forced-year t))))
  14513. (setq org-read-date-analyze-futurep futurep)
  14514. (list second minute hour day month year)))
  14515. (defvar parse-time-weekdays)
  14516. (defun org-read-date-get-relative (s today default)
  14517. "Check string S for special relative date string.
  14518. TODAY and DEFAULT are internal times, for today and for a default.
  14519. Return shift list (N what def-flag)
  14520. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  14521. N is the number of WHATs to shift.
  14522. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  14523. the DEFAULT date rather than TODAY."
  14524. (require 'parse-time)
  14525. (when (and
  14526. (string-match
  14527. (concat
  14528. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  14529. "\\([0-9]+\\)?"
  14530. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  14531. "\\([ \t]\\|$\\)") s)
  14532. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  14533. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  14534. (string-to-char (substring (match-string 1 s) -1))
  14535. ?+))
  14536. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  14537. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  14538. (what (if (match-end 3) (match-string 3 s) "d"))
  14539. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  14540. (date (if rel default today))
  14541. (wday (nth 6 (decode-time date)))
  14542. delta)
  14543. (if wday1
  14544. (progn
  14545. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  14546. (if (= dir ?-) (setq delta (- delta 7)))
  14547. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  14548. (list delta "d" rel))
  14549. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  14550. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  14551. "Turn a user-specified date into the internal representation.
  14552. The internal representation needed by the calendar is (month day year).
  14553. This is a wrapper to handle the brain-dead convention in calendar that
  14554. user function argument order change dependent on argument order."
  14555. (if (boundp 'calendar-date-style)
  14556. (cond
  14557. ((eq calendar-date-style 'american)
  14558. (list arg1 arg2 arg3))
  14559. ((eq calendar-date-style 'european)
  14560. (list arg2 arg1 arg3))
  14561. ((eq calendar-date-style 'iso)
  14562. (list arg2 arg3 arg1)))
  14563. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  14564. (if (org-bound-and-true-p european-calendar-style)
  14565. (list arg2 arg1 arg3)
  14566. (list arg1 arg2 arg3)))))
  14567. (defun org-eval-in-calendar (form &optional keepdate)
  14568. "Eval FORM in the calendar window and return to current window.
  14569. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  14570. otherwise stick to the current value of `org-ans2'."
  14571. (let ((sf (selected-frame))
  14572. (sw (selected-window)))
  14573. (select-window (get-buffer-window "*Calendar*" t))
  14574. (eval form)
  14575. (when (and (not keepdate) (calendar-cursor-to-date))
  14576. (let* ((date (calendar-cursor-to-date))
  14577. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14578. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  14579. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  14580. (select-window sw)
  14581. (org-select-frame-set-input-focus sf)))
  14582. (defun org-calendar-select ()
  14583. "Return to `org-read-date' with the date currently selected.
  14584. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14585. (interactive)
  14586. (when (calendar-cursor-to-date)
  14587. (let* ((date (calendar-cursor-to-date))
  14588. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14589. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14590. (if (active-minibuffer-window) (exit-minibuffer))))
  14591. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  14592. "Insert a date stamp for the date given by the internal TIME.
  14593. WITH-HM means use the stamp format that includes the time of the day.
  14594. INACTIVE means use square brackets instead of angular ones, so that the
  14595. stamp will not contribute to the agenda.
  14596. PRE and POST are optional strings to be inserted before and after the
  14597. stamp.
  14598. The command returns the inserted time stamp."
  14599. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  14600. stamp)
  14601. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  14602. (insert-before-markers (or pre ""))
  14603. (when (listp extra)
  14604. (setq extra (car extra))
  14605. (if (and (stringp extra)
  14606. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  14607. (setq extra (format "-%02d:%02d"
  14608. (string-to-number (match-string 1 extra))
  14609. (string-to-number (match-string 2 extra))))
  14610. (setq extra nil)))
  14611. (when extra
  14612. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  14613. (insert-before-markers (setq stamp (format-time-string fmt time)))
  14614. (insert-before-markers (or post ""))
  14615. (setq org-last-inserted-timestamp stamp)))
  14616. (defun org-toggle-time-stamp-overlays ()
  14617. "Toggle the use of custom time stamp formats."
  14618. (interactive)
  14619. (setq org-display-custom-times (not org-display-custom-times))
  14620. (unless org-display-custom-times
  14621. (let ((p (point-min)) (bmp (buffer-modified-p)))
  14622. (while (setq p (next-single-property-change p 'display))
  14623. (if (and (get-text-property p 'display)
  14624. (eq (get-text-property p 'face) 'org-date))
  14625. (remove-text-properties
  14626. p (setq p (next-single-property-change p 'display))
  14627. '(display t))))
  14628. (set-buffer-modified-p bmp)))
  14629. (if (featurep 'xemacs)
  14630. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  14631. (org-restart-font-lock)
  14632. (setq org-table-may-need-update t)
  14633. (if org-display-custom-times
  14634. (message "Time stamps are overlaid with custom format")
  14635. (message "Time stamp overlays removed")))
  14636. (defun org-display-custom-time (beg end)
  14637. "Overlay modified time stamp format over timestamp between BEG and END."
  14638. (let* ((ts (buffer-substring beg end))
  14639. t1 w1 with-hm tf time str w2 (off 0))
  14640. (save-match-data
  14641. (setq t1 (org-parse-time-string ts t))
  14642. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  14643. (setq off (- (match-end 0) (match-beginning 0)))))
  14644. (setq end (- end off))
  14645. (setq w1 (- end beg)
  14646. with-hm (and (nth 1 t1) (nth 2 t1))
  14647. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  14648. time (org-fix-decoded-time t1)
  14649. str (org-add-props
  14650. (format-time-string
  14651. (substring tf 1 -1) (apply 'encode-time time))
  14652. nil 'mouse-face 'highlight)
  14653. w2 (length str))
  14654. (if (not (= w2 w1))
  14655. (add-text-properties (1+ beg) (+ 2 beg)
  14656. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  14657. (if (featurep 'xemacs)
  14658. (progn
  14659. (put-text-property beg end 'invisible t)
  14660. (put-text-property beg end 'end-glyph (make-glyph str)))
  14661. (put-text-property beg end 'display str))))
  14662. (defun org-translate-time (string)
  14663. "Translate all timestamps in STRING to custom format.
  14664. But do this only if the variable `org-display-custom-times' is set."
  14665. (when org-display-custom-times
  14666. (save-match-data
  14667. (let* ((start 0)
  14668. (re org-ts-regexp-both)
  14669. t1 with-hm inactive tf time str beg end)
  14670. (while (setq start (string-match re string start))
  14671. (setq beg (match-beginning 0)
  14672. end (match-end 0)
  14673. t1 (save-match-data
  14674. (org-parse-time-string (substring string beg end) t))
  14675. with-hm (and (nth 1 t1) (nth 2 t1))
  14676. inactive (equal (substring string beg (1+ beg)) "[")
  14677. tf (funcall (if with-hm 'cdr 'car)
  14678. org-time-stamp-custom-formats)
  14679. time (org-fix-decoded-time t1)
  14680. str (format-time-string
  14681. (concat
  14682. (if inactive "[" "<") (substring tf 1 -1)
  14683. (if inactive "]" ">"))
  14684. (apply 'encode-time time))
  14685. string (replace-match str t t string)
  14686. start (+ start (length str)))))))
  14687. string)
  14688. (defun org-fix-decoded-time (time)
  14689. "Set 0 instead of nil for the first 6 elements of time.
  14690. Don't touch the rest."
  14691. (let ((n 0))
  14692. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  14693. (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.3")
  14694. (defun org-time-stamp-to-now (timestamp-string &optional seconds)
  14695. "Difference between TIMESTAMP-STRING and now in days.
  14696. If SECONDS is non-nil, return the difference in seconds."
  14697. (let ((fdiff (if seconds 'time-to-seconds 'time-to-days)))
  14698. (- (funcall fdiff (org-time-string-to-time timestamp-string))
  14699. (funcall fdiff (current-time)))))
  14700. (defun org-deadline-close (timestamp-string &optional ndays)
  14701. "Is the time in TIMESTAMP-STRING close to the current date?"
  14702. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  14703. (and (< (org-days-to-time timestamp-string) ndays)
  14704. (not (org-entry-is-done-p))))
  14705. (defun org-get-wdays (ts)
  14706. "Get the deadline lead time appropriate for timestring TS."
  14707. (cond
  14708. ((<= org-deadline-warning-days 0)
  14709. ;; 0 or negative, enforce this value no matter what
  14710. (- org-deadline-warning-days))
  14711. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  14712. ;; lead time is specified.
  14713. (floor (* (string-to-number (match-string 1 ts))
  14714. (cdr (assoc (match-string 2 ts)
  14715. '(("d" . 1) ("w" . 7)
  14716. ("m" . 30.4) ("y" . 365.25)))))))
  14717. ;; go for the default.
  14718. (t org-deadline-warning-days)))
  14719. (defun org-calendar-select-mouse (ev)
  14720. "Return to `org-read-date' with the date currently selected.
  14721. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14722. (interactive "e")
  14723. (mouse-set-point ev)
  14724. (when (calendar-cursor-to-date)
  14725. (let* ((date (calendar-cursor-to-date))
  14726. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14727. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14728. (if (active-minibuffer-window) (exit-minibuffer))))
  14729. (defun org-check-deadlines (ndays)
  14730. "Check if there are any deadlines due or past due.
  14731. A deadline is considered due if it happens within `org-deadline-warning-days'
  14732. days from today's date. If the deadline appears in an entry marked DONE,
  14733. it is not shown. The prefix arg NDAYS can be used to test that many
  14734. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  14735. (interactive "P")
  14736. (let* ((org-warn-days
  14737. (cond
  14738. ((equal ndays '(4)) 100000)
  14739. (ndays (prefix-numeric-value ndays))
  14740. (t (abs org-deadline-warning-days))))
  14741. (case-fold-search nil)
  14742. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14743. (callback
  14744. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  14745. (message "%d deadlines past-due or due within %d days"
  14746. (org-occur regexp nil callback)
  14747. org-warn-days)))
  14748. (defsubst org-re-timestamp (type)
  14749. "Return a regexp for timestamp TYPE.
  14750. Allowed values for TYPE are:
  14751. all: all timestamps
  14752. active: only active timestamps (<...>)
  14753. inactive: only inactive timestamps ([...])
  14754. scheduled: only scheduled timestamps
  14755. deadline: only deadline timestamps
  14756. When TYPE is nil, fall back on returning a regexp that matches
  14757. both scheduled and deadline timestamps."
  14758. (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
  14759. ((eq type 'active) org-ts-regexp)
  14760. ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
  14761. ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
  14762. ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14763. ((eq type 'scheduled-or-deadline)
  14764. (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
  14765. (defun org-check-before-date (date)
  14766. "Check if there are deadlines or scheduled entries before DATE."
  14767. (interactive (list (org-read-date)))
  14768. (let ((case-fold-search nil)
  14769. (regexp (org-re-timestamp org-ts-type))
  14770. (callback
  14771. (lambda () (time-less-p
  14772. (org-time-string-to-time (match-string 1))
  14773. (org-time-string-to-time date)))))
  14774. (message "%d entries before %s"
  14775. (org-occur regexp nil callback) date)))
  14776. (defun org-check-after-date (date)
  14777. "Check if there are deadlines or scheduled entries after DATE."
  14778. (interactive (list (org-read-date)))
  14779. (let ((case-fold-search nil)
  14780. (regexp (org-re-timestamp org-ts-type))
  14781. (callback
  14782. (lambda () (not
  14783. (time-less-p
  14784. (org-time-string-to-time (match-string 1))
  14785. (org-time-string-to-time date))))))
  14786. (message "%d entries after %s"
  14787. (org-occur regexp nil callback) date)))
  14788. (defun org-check-dates-range (start-date end-date)
  14789. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  14790. (interactive (list (org-read-date nil nil nil "Range starts")
  14791. (org-read-date nil nil nil "Range end")))
  14792. (let ((case-fold-search nil)
  14793. (regexp (org-re-timestamp org-ts-type))
  14794. (callback
  14795. (lambda ()
  14796. (let ((match (match-string 1)))
  14797. (and
  14798. (not (time-less-p
  14799. (org-time-string-to-time match)
  14800. (org-time-string-to-time start-date)))
  14801. (time-less-p
  14802. (org-time-string-to-time match)
  14803. (org-time-string-to-time end-date)))))))
  14804. (message "%d entries between %s and %s"
  14805. (org-occur regexp nil callback) start-date end-date)))
  14806. (defun org-evaluate-time-range (&optional to-buffer)
  14807. "Evaluate a time range by computing the difference between start and end.
  14808. Normally the result is just printed in the echo area, but with prefix arg
  14809. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  14810. If the time range is actually in a table, the result is inserted into the
  14811. next column.
  14812. For time difference computation, a year is assumed to be exactly 365
  14813. days in order to avoid rounding problems."
  14814. (interactive "P")
  14815. (or
  14816. (org-clock-update-time-maybe)
  14817. (save-excursion
  14818. (unless (org-at-date-range-p t)
  14819. (goto-char (point-at-bol))
  14820. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  14821. (if (not (org-at-date-range-p t))
  14822. (error "Not at a time-stamp range, and none found in current line")))
  14823. (let* ((ts1 (match-string 1))
  14824. (ts2 (match-string 2))
  14825. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  14826. (match-end (match-end 0))
  14827. (time1 (org-time-string-to-time ts1))
  14828. (time2 (org-time-string-to-time ts2))
  14829. (t1 (org-float-time time1))
  14830. (t2 (org-float-time time2))
  14831. (diff (abs (- t2 t1)))
  14832. (negative (< (- t2 t1) 0))
  14833. ;; (ys (floor (* 365 24 60 60)))
  14834. (ds (* 24 60 60))
  14835. (hs (* 60 60))
  14836. (fy "%dy %dd %02d:%02d")
  14837. (fy1 "%dy %dd")
  14838. (fd "%dd %02d:%02d")
  14839. (fd1 "%dd")
  14840. (fh "%02d:%02d")
  14841. y d h m align)
  14842. (if havetime
  14843. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14844. y 0
  14845. d (floor (/ diff ds)) diff (mod diff ds)
  14846. h (floor (/ diff hs)) diff (mod diff hs)
  14847. m (floor (/ diff 60)))
  14848. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14849. y 0
  14850. d (floor (+ (/ diff ds) 0.5))
  14851. h 0 m 0))
  14852. (if (not to-buffer)
  14853. (message "%s" (org-make-tdiff-string y d h m))
  14854. (if (org-at-table-p)
  14855. (progn
  14856. (goto-char match-end)
  14857. (setq align t)
  14858. (and (looking-at " *|") (goto-char (match-end 0))))
  14859. (goto-char match-end))
  14860. (if (looking-at
  14861. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  14862. (replace-match ""))
  14863. (if negative (insert " -"))
  14864. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  14865. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  14866. (insert " " (format fh h m))))
  14867. (if align (org-table-align))
  14868. (message "Time difference inserted")))))
  14869. (defun org-make-tdiff-string (y d h m)
  14870. (let ((fmt "")
  14871. (l nil))
  14872. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  14873. l (push y l)))
  14874. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  14875. l (push d l)))
  14876. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  14877. l (push h l)))
  14878. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  14879. l (push m l)))
  14880. (apply 'format fmt (nreverse l))))
  14881. (defun org-time-string-to-time (s &optional buffer pos)
  14882. "Convert a timestamp string into internal time."
  14883. (condition-case errdata
  14884. (apply 'encode-time (org-parse-time-string s))
  14885. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14886. s (if (not (and buffer pos))
  14887. ""
  14888. (format " at %d in buffer `%s'" pos buffer))
  14889. (cdr errdata)))))
  14890. (defun org-time-string-to-seconds (s)
  14891. "Convert a timestamp string to a number of seconds."
  14892. (org-float-time (org-time-string-to-time s)))
  14893. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  14894. "Convert a time stamp to an absolute day number.
  14895. If there is a specifier for a cyclic time stamp, get the closest date to
  14896. DAYNR.
  14897. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  14898. The variable date is bound by the calendar when this is called."
  14899. (cond
  14900. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  14901. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  14902. daynr
  14903. (+ daynr 1000)))
  14904. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  14905. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  14906. (time-to-days (current-time))) (match-string 0 s)
  14907. prefer show-all))
  14908. (t (time-to-days
  14909. (condition-case errdata
  14910. (apply 'encode-time (org-parse-time-string s))
  14911. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14912. s (if (not (and buffer pos))
  14913. ""
  14914. (format " at %d in buffer `%s'" pos buffer))
  14915. (cdr errdata))))))))
  14916. (defun org-days-to-iso-week (days)
  14917. "Return the iso week number."
  14918. (require 'cal-iso)
  14919. (car (calendar-iso-from-absolute days)))
  14920. (defun org-small-year-to-year (year)
  14921. "Convert 2-digit years into 4-digit years.
  14922. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  14923. The year 2000 cannot be abbreviated. Any year larger than 99
  14924. is returned unchanged."
  14925. (if (< year 38)
  14926. (setq year (+ 2000 year))
  14927. (if (< year 100)
  14928. (setq year (+ 1900 year))))
  14929. year)
  14930. (defun org-time-from-absolute (d)
  14931. "Return the time corresponding to date D.
  14932. D may be an absolute day number, or a calendar-type list (month day year)."
  14933. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  14934. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  14935. (defun org-calendar-holiday ()
  14936. "List of holidays, for Diary display in Org-mode."
  14937. (require 'holidays)
  14938. (let ((hl (funcall
  14939. (if (fboundp 'calendar-check-holidays)
  14940. 'calendar-check-holidays 'check-calendar-holidays) date)))
  14941. (if hl (mapconcat 'identity hl "; "))))
  14942. (defun org-diary-sexp-entry (sexp entry date)
  14943. "Process a SEXP diary ENTRY for DATE."
  14944. (require 'diary-lib)
  14945. (let ((result (if calendar-debug-sexp
  14946. (let ((stack-trace-on-error t))
  14947. (eval (car (read-from-string sexp))))
  14948. (condition-case nil
  14949. (eval (car (read-from-string sexp)))
  14950. (error
  14951. (beep)
  14952. (message "Bad sexp at line %d in %s: %s"
  14953. (org-current-line)
  14954. (buffer-file-name) sexp)
  14955. (sleep-for 2))))))
  14956. (cond ((stringp result) (split-string result "; "))
  14957. ((and (consp result)
  14958. (not (consp (cdr result)))
  14959. (stringp (cdr result))) (cdr result))
  14960. ((and (consp result)
  14961. (stringp (car result))) result)
  14962. (result entry))))
  14963. (defun org-diary-to-ical-string (frombuf)
  14964. "Get iCalendar entries from diary entries in buffer FROMBUF.
  14965. This uses the icalendar.el library."
  14966. (let* ((tmpdir (if (featurep 'xemacs)
  14967. (temp-directory)
  14968. temporary-file-directory))
  14969. (tmpfile (make-temp-name
  14970. (expand-file-name "orgics" tmpdir)))
  14971. buf rtn b e)
  14972. (with-current-buffer frombuf
  14973. (icalendar-export-region (point-min) (point-max) tmpfile)
  14974. (setq buf (find-buffer-visiting tmpfile))
  14975. (set-buffer buf)
  14976. (goto-char (point-min))
  14977. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  14978. (setq b (match-beginning 0)))
  14979. (goto-char (point-max))
  14980. (if (re-search-backward "^END:VEVENT" nil t)
  14981. (setq e (match-end 0)))
  14982. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  14983. (kill-buffer buf)
  14984. (delete-file tmpfile)
  14985. rtn))
  14986. (defun org-closest-date (start current change prefer show-all)
  14987. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  14988. When PREFER is `past', return a date that is either CURRENT or past.
  14989. When PREFER is `future', return a date that is either CURRENT or future.
  14990. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  14991. ;; Make the proper lists from the dates
  14992. (catch 'exit
  14993. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  14994. dn dw sday cday n1 n2 n0
  14995. d m y y1 y2 date1 date2 nmonths nm ny m2)
  14996. (setq start (org-date-to-gregorian start)
  14997. current (org-date-to-gregorian
  14998. (if show-all
  14999. current
  15000. (time-to-days (current-time))))
  15001. sday (calendar-absolute-from-gregorian start)
  15002. cday (calendar-absolute-from-gregorian current))
  15003. (if (<= cday sday) (throw 'exit sday))
  15004. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  15005. (setq dn (string-to-number (match-string 1 change))
  15006. dw (cdr (assoc (match-string 2 change) a1)))
  15007. (error "Invalid change specifier: %s" change))
  15008. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  15009. (cond
  15010. ((eq dw 'day)
  15011. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  15012. n2 (+ n1 dn)))
  15013. ((eq dw 'year)
  15014. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  15015. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  15016. (setq date1 (list m d y1)
  15017. n1 (calendar-absolute-from-gregorian date1)
  15018. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  15019. n2 (calendar-absolute-from-gregorian date2)))
  15020. ((eq dw 'month)
  15021. ;; approx number of month between the two dates
  15022. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  15023. ;; How often does dn fit in there?
  15024. (setq d (nth 1 start) m (car start) y (nth 2 start)
  15025. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  15026. m (+ m nm)
  15027. ny (floor (/ m 12))
  15028. y (+ y ny)
  15029. m (- m (* ny 12)))
  15030. (while (> m 12) (setq m (- m 12) y (1+ y)))
  15031. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  15032. (setq m2 (+ m dn) y2 y)
  15033. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  15034. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  15035. (while (<= n2 cday)
  15036. (setq n1 n2 m m2 y y2)
  15037. (setq m2 (+ m dn) y2 y)
  15038. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  15039. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  15040. ;; Make sure n1 is the earlier date
  15041. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  15042. (if show-all
  15043. (cond
  15044. ((eq prefer 'past) (if (= cday n2) n2 n1))
  15045. ((eq prefer 'future) (if (= cday n1) n1 n2))
  15046. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  15047. (cond
  15048. ((eq prefer 'past) (if (= cday n2) n2 n1))
  15049. ((eq prefer 'future) (if (= cday n1) n1 n2))
  15050. (t (if (= cday n1) n1 n2)))))))
  15051. (defun org-date-to-gregorian (date)
  15052. "Turn any specification of DATE into a Gregorian date for the calendar."
  15053. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  15054. ((and (listp date) (= (length date) 3)) date)
  15055. ((stringp date)
  15056. (setq date (org-parse-time-string date))
  15057. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  15058. ((listp date)
  15059. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  15060. (defun org-parse-time-string (s &optional nodefault)
  15061. "Parse the standard Org-mode time string.
  15062. This should be a lot faster than the normal `parse-time-string'.
  15063. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  15064. hour and minute fields will be nil if not given."
  15065. (if (string-match org-ts-regexp0 s)
  15066. (list 0
  15067. (if (or (match-beginning 8) (not nodefault))
  15068. (string-to-number (or (match-string 8 s) "0")))
  15069. (if (or (match-beginning 7) (not nodefault))
  15070. (string-to-number (or (match-string 7 s) "0")))
  15071. (string-to-number (match-string 4 s))
  15072. (string-to-number (match-string 3 s))
  15073. (string-to-number (match-string 2 s))
  15074. nil nil nil)
  15075. (error "Not a standard Org-mode time string: %s" s)))
  15076. (defun org-timestamp-up (&optional arg)
  15077. "Increase the date item at the cursor by one.
  15078. If the cursor is on the year, change the year. If it is on the month,
  15079. the day or the time, change that.
  15080. With prefix ARG, change by that many units."
  15081. (interactive "p")
  15082. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  15083. (defun org-timestamp-down (&optional arg)
  15084. "Decrease the date item at the cursor by one.
  15085. If the cursor is on the year, change the year. If it is on the month,
  15086. the day or the time, change that.
  15087. With prefix ARG, change by that many units."
  15088. (interactive "p")
  15089. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  15090. (defun org-timestamp-up-day (&optional arg)
  15091. "Increase the date in the time stamp by one day.
  15092. With prefix ARG, change that many days."
  15093. (interactive "p")
  15094. (if (and (not (org-at-timestamp-p t))
  15095. (org-at-heading-p))
  15096. (org-todo 'up)
  15097. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  15098. (defun org-timestamp-down-day (&optional arg)
  15099. "Decrease the date in the time stamp by one day.
  15100. With prefix ARG, change that many days."
  15101. (interactive "p")
  15102. (if (and (not (org-at-timestamp-p t))
  15103. (org-at-heading-p))
  15104. (org-todo 'down)
  15105. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  15106. (defun org-at-timestamp-p (&optional inactive-ok)
  15107. "Determine if the cursor is in or at a timestamp."
  15108. (interactive)
  15109. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  15110. (pos (point))
  15111. (ans (or (looking-at tsr)
  15112. (save-excursion
  15113. (skip-chars-backward "^[<\n\r\t")
  15114. (if (> (point) (point-min)) (backward-char 1))
  15115. (and (looking-at tsr)
  15116. (> (- (match-end 0) pos) -1))))))
  15117. (and ans
  15118. (boundp 'org-ts-what)
  15119. (setq org-ts-what
  15120. (cond
  15121. ((= pos (match-beginning 0)) 'bracket)
  15122. ;; Point is considered to be "on the bracket" whether
  15123. ;; it's really on it or right after it.
  15124. ((= pos (1- (match-end 0))) 'bracket)
  15125. ((= pos (match-end 0)) 'after)
  15126. ((org-pos-in-match-range pos 2) 'year)
  15127. ((org-pos-in-match-range pos 3) 'month)
  15128. ((org-pos-in-match-range pos 7) 'hour)
  15129. ((org-pos-in-match-range pos 8) 'minute)
  15130. ((or (org-pos-in-match-range pos 4)
  15131. (org-pos-in-match-range pos 5)) 'day)
  15132. ((and (> pos (or (match-end 8) (match-end 5)))
  15133. (< pos (match-end 0)))
  15134. (- pos (or (match-end 8) (match-end 5))))
  15135. (t 'day))))
  15136. ans))
  15137. (defun org-toggle-timestamp-type ()
  15138. "Toggle the type (<active> or [inactive]) of a time stamp."
  15139. (interactive)
  15140. (when (org-at-timestamp-p t)
  15141. (let ((beg (match-beginning 0)) (end (match-end 0))
  15142. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  15143. (save-excursion
  15144. (goto-char beg)
  15145. (while (re-search-forward "[][<>]" end t)
  15146. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  15147. t t)))
  15148. (message "Timestamp is now %sactive"
  15149. (if (equal (char-after beg) ?<) "" "in")))))
  15150. (defvar org-clock-history) ; defined in org-clock.el
  15151. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  15152. (defun org-timestamp-change (n &optional what updown)
  15153. "Change the date in the time stamp at point.
  15154. The date will be changed by N times WHAT. WHAT can be `day', `month',
  15155. `year', `minute', `second'. If WHAT is not given, the cursor position
  15156. in the timestamp determines what will be changed."
  15157. (let ((origin (point)) origin-cat
  15158. with-hm inactive
  15159. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  15160. org-ts-what
  15161. extra rem
  15162. ts time time0 fixnext clrgx)
  15163. (if (not (org-at-timestamp-p t))
  15164. (error "Not at a timestamp"))
  15165. (if (and (not what) (eq org-ts-what 'bracket))
  15166. (org-toggle-timestamp-type)
  15167. ;; Point isn't on brackets. Remember the part of the time-stamp
  15168. ;; the point was in. Indeed, size of time-stamps may change,
  15169. ;; but point must be kept in the same category nonetheless.
  15170. (setq origin-cat org-ts-what)
  15171. (if (and (not what) (not (eq org-ts-what 'day))
  15172. org-display-custom-times
  15173. (get-text-property (point) 'display)
  15174. (not (get-text-property (1- (point)) 'display)))
  15175. (setq org-ts-what 'day))
  15176. (setq org-ts-what (or what org-ts-what)
  15177. inactive (= (char-after (match-beginning 0)) ?\[)
  15178. ts (match-string 0))
  15179. (replace-match "")
  15180. (if (string-match
  15181. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  15182. ts)
  15183. (setq extra (match-string 1 ts)))
  15184. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  15185. (setq with-hm t))
  15186. (setq time0 (org-parse-time-string ts))
  15187. (when (and updown
  15188. (eq org-ts-what 'minute)
  15189. (not current-prefix-arg))
  15190. ;; This looks like s-up and s-down. Change by one rounding step.
  15191. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  15192. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  15193. (setcar (cdr time0) (+ (nth 1 time0)
  15194. (if (> n 0) (- rem) (- dm rem))))))
  15195. (setq time
  15196. (encode-time (or (car time0) 0)
  15197. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  15198. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  15199. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  15200. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  15201. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  15202. (nthcdr 6 time0)))
  15203. (when (and (member org-ts-what '(hour minute))
  15204. extra
  15205. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  15206. (setq extra (org-modify-ts-extra
  15207. extra
  15208. (if (eq org-ts-what 'hour) 2 5)
  15209. n dm)))
  15210. (when (integerp org-ts-what)
  15211. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  15212. (if (eq what 'calendar)
  15213. (let ((cal-date (org-get-date-from-calendar)))
  15214. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  15215. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  15216. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  15217. (setcar time0 (or (car time0) 0))
  15218. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  15219. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  15220. (setq time (apply 'encode-time time0))))
  15221. ;; Insert the new time-stamp, and ensure point stays in the same
  15222. ;; category as before (i.e. not after the last position in that
  15223. ;; category).
  15224. (let ((pos (point)))
  15225. ;; Stay before inserted string. `save-excursion' is of no use.
  15226. (setq org-last-changed-timestamp
  15227. (org-insert-time-stamp time with-hm inactive nil nil extra))
  15228. (goto-char pos))
  15229. (save-match-data
  15230. (looking-at org-ts-regexp3)
  15231. (goto-char (cond
  15232. ;; `day' category ends before `hour' if any, or at
  15233. ;; the end of the day name.
  15234. ((eq origin-cat 'day)
  15235. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  15236. ((eq origin-cat 'hour) (min (match-end 7) origin))
  15237. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  15238. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  15239. ;; `year' and `month' have both fixed size: point
  15240. ;; couldn't have moved into another part.
  15241. (t origin))))
  15242. ;; Update clock if on a CLOCK line.
  15243. (org-clock-update-time-maybe)
  15244. ;; Maybe adjust the closest clock in `org-clock-history'
  15245. (when org-clock-adjust-closest
  15246. (if (not (and (org-at-clock-log-p)
  15247. (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
  15248. org-clock-history))))))
  15249. (message "No clock to adjust")
  15250. (cond ((save-excursion ; fix previous clock?
  15251. (re-search-backward org-ts-regexp0 nil t)
  15252. (org-looking-back (concat org-clock-string " \\[")))
  15253. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  15254. ((save-excursion ; fix next clock?
  15255. (re-search-backward org-ts-regexp0 nil t)
  15256. (looking-at (concat org-ts-regexp0 "\\] =>")))
  15257. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  15258. (save-window-excursion
  15259. ;; Find closest clock to point, adjust the previous/next one in history
  15260. (let* ((p (save-excursion (org-back-to-heading t)))
  15261. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  15262. (clfixnth
  15263. (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
  15264. (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
  15265. (if (not clfixpos)
  15266. (message "No clock to adjust")
  15267. (save-excursion
  15268. (org-goto-marker-or-bmk clfixpos)
  15269. (org-show-subtree)
  15270. (when (re-search-forward clrgx nil t)
  15271. (goto-char (match-beginning 1))
  15272. (let (org-clock-adjust-closest)
  15273. (org-timestamp-change n org-ts-what updown))
  15274. (message "Clock adjusted in %s for heading: %s"
  15275. (file-name-nondirectory (buffer-file-name))
  15276. (org-get-heading t t)))))))))
  15277. ;; Try to recenter the calendar window, if any.
  15278. (if (and org-calendar-follow-timestamp-change
  15279. (get-buffer-window "*Calendar*" t)
  15280. (memq org-ts-what '(day month year)))
  15281. (org-recenter-calendar (time-to-days time))))))
  15282. (defun org-modify-ts-extra (s pos n dm)
  15283. "Change the different parts of the lead-time and repeat fields in timestamp."
  15284. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  15285. ng h m new rem)
  15286. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  15287. (cond
  15288. ((or (org-pos-in-match-range pos 2)
  15289. (org-pos-in-match-range pos 3))
  15290. (setq m (string-to-number (match-string 3 s))
  15291. h (string-to-number (match-string 2 s)))
  15292. (if (org-pos-in-match-range pos 2)
  15293. (setq h (+ h n))
  15294. (setq n (* dm (org-no-warnings (signum n))))
  15295. (when (not (= 0 (setq rem (% m dm))))
  15296. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  15297. (setq m (+ m n)))
  15298. (if (< m 0) (setq m (+ m 60) h (1- h)))
  15299. (if (> m 59) (setq m (- m 60) h (1+ h)))
  15300. (setq h (min 24 (max 0 h)))
  15301. (setq ng 1 new (format "-%02d:%02d" h m)))
  15302. ((org-pos-in-match-range pos 6)
  15303. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  15304. ((org-pos-in-match-range pos 5)
  15305. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  15306. ((org-pos-in-match-range pos 9)
  15307. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  15308. ((org-pos-in-match-range pos 8)
  15309. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  15310. (when ng
  15311. (setq s (concat
  15312. (substring s 0 (match-beginning ng))
  15313. new
  15314. (substring s (match-end ng))))))
  15315. s))
  15316. (defun org-recenter-calendar (date)
  15317. "If the calendar is visible, recenter it to DATE."
  15318. (let ((cwin (get-buffer-window "*Calendar*" t)))
  15319. (when cwin
  15320. (let ((calendar-move-hook nil))
  15321. (with-selected-window cwin
  15322. (calendar-goto-date (if (listp date) date
  15323. (calendar-gregorian-from-absolute date))))))))
  15324. (defun org-goto-calendar (&optional arg)
  15325. "Go to the Emacs calendar at the current date.
  15326. If there is a time stamp in the current line, go to that date.
  15327. A prefix ARG can be used to force the current date."
  15328. (interactive "P")
  15329. (let ((tsr org-ts-regexp) diff
  15330. (calendar-move-hook nil)
  15331. (calendar-view-holidays-initially-flag nil)
  15332. (calendar-view-diary-initially-flag nil))
  15333. (if (or (org-at-timestamp-p)
  15334. (save-excursion
  15335. (beginning-of-line 1)
  15336. (looking-at (concat ".*" tsr))))
  15337. (let ((d1 (time-to-days (current-time)))
  15338. (d2 (time-to-days
  15339. (org-time-string-to-time (match-string 1)))))
  15340. (setq diff (- d2 d1))))
  15341. (calendar)
  15342. (calendar-goto-today)
  15343. (if (and diff (not arg)) (calendar-forward-day diff))))
  15344. (defun org-get-date-from-calendar ()
  15345. "Return a list (month day year) of date at point in calendar."
  15346. (with-current-buffer "*Calendar*"
  15347. (save-match-data
  15348. (calendar-cursor-to-date))))
  15349. (defun org-date-from-calendar ()
  15350. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  15351. If there is already a time stamp at the cursor position, update it."
  15352. (interactive)
  15353. (if (org-at-timestamp-p t)
  15354. (org-timestamp-change 0 'calendar)
  15355. (let ((cal-date (org-get-date-from-calendar)))
  15356. (org-insert-time-stamp
  15357. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  15358. (defun org-minutes-to-hh:mm-string (m)
  15359. "Compute H:MM from a number of minutes."
  15360. (let ((h (/ m 60)))
  15361. (setq m (- m (* 60 h)))
  15362. (format org-time-clocksum-format h m)))
  15363. (defun org-hh:mm-string-to-minutes (s)
  15364. "Convert a string H:MM to a number of minutes.
  15365. If the string is just a number, interpret it as minutes.
  15366. In fact, the first hh:mm or number in the string will be taken,
  15367. there can be extra stuff in the string.
  15368. If no number is found, the return value is 0."
  15369. (cond
  15370. ((integerp s) s)
  15371. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  15372. (+ (* (string-to-number (match-string 1 s)) 60)
  15373. (string-to-number (match-string 2 s))))
  15374. ((string-match "\\([0-9]+\\)" s)
  15375. (string-to-number (match-string 1 s)))
  15376. (t 0)))
  15377. (defcustom org-effort-durations
  15378. `(("h" . 60)
  15379. ("d" . ,(* 60 8))
  15380. ("w" . ,(* 60 8 5))
  15381. ("m" . ,(* 60 8 5 4))
  15382. ("y" . ,(* 60 8 5 40)))
  15383. "Conversion factor to minutes for an effort modifier.
  15384. Each entry has the form (MODIFIER . MINUTES).
  15385. In an effort string, a number followed by MODIFIER is multiplied
  15386. by the specified number of MINUTES to obtain an effort in
  15387. minutes.
  15388. For example, if the value of this variable is ((\"hours\" . 60)), then an
  15389. effort string \"2hours\" is equivalent to 120 minutes."
  15390. :group 'org-agenda
  15391. :version "24.1"
  15392. :type '(alist :key-type (string :tag "Modifier")
  15393. :value-type (number :tag "Minutes")))
  15394. (defcustom org-image-actual-width t
  15395. "Should we use the actual width of images when inlining them?
  15396. When set to `t', always use the image width.
  15397. When set to a number, use imagemagick (when available) to set
  15398. the image's width to this value.
  15399. When set to a number in a list, try to get the width from the
  15400. #+ATTR.* keyword if it matches a width specification like
  15401. width=\"[0-9]+\", and fall back on that number if none is found.
  15402. When set to nil, try to get the width from an #+ATTR.* keyword
  15403. and fall back on the original width if none is found.
  15404. This requires Emacs >= 24.1, build with imagemagick support."
  15405. :group 'org-appearance
  15406. :version "24.3"
  15407. :type '(choice
  15408. (const :tag "Use the image width" t)
  15409. (integer :tag "Use a number of pixels")
  15410. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  15411. (const :tag "Use #+ATTR* or don't resize" nil)))
  15412. (defun org-duration-string-to-minutes (s &optional output-to-string)
  15413. "Convert a duration string S to minutes.
  15414. A bare number is interpreted as minutes, modifiers can be set by
  15415. customizing `org-effort-durations' (which see).
  15416. Entries containing a colon are interpreted as H:MM by
  15417. `org-hh:mm-string-to-minutes'."
  15418. (let ((result 0)
  15419. (re (concat "\\([0-9.]+\\) *\\("
  15420. (regexp-opt (mapcar 'car org-effort-durations))
  15421. "\\)")))
  15422. (while (string-match re s)
  15423. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  15424. (string-to-number (match-string 1 s))))
  15425. (setq s (replace-match "" nil t s)))
  15426. (setq result (floor result))
  15427. (incf result (org-hh:mm-string-to-minutes s))
  15428. (if output-to-string (number-to-string result) result)))
  15429. ;;;; Files
  15430. (defun org-save-all-org-buffers ()
  15431. "Save all Org-mode buffers without user confirmation."
  15432. (interactive)
  15433. (message "Saving all Org-mode buffers...")
  15434. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  15435. (when (featurep 'org-id) (org-id-locations-save))
  15436. (message "Saving all Org-mode buffers... done"))
  15437. (defun org-revert-all-org-buffers ()
  15438. "Revert all Org-mode buffers.
  15439. Prompt for confirmation when there are unsaved changes.
  15440. Be sure you know what you are doing before letting this function
  15441. overwrite your changes.
  15442. This function is useful in a setup where one tracks org files
  15443. with a version control system, to revert on one machine after pulling
  15444. changes from another. I believe the procedure must be like this:
  15445. 1. M-x org-save-all-org-buffers
  15446. 2. Pull changes from the other machine, resolve conflicts
  15447. 3. M-x org-revert-all-org-buffers"
  15448. (interactive)
  15449. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  15450. (error "Abort"))
  15451. (save-excursion
  15452. (save-window-excursion
  15453. (mapc
  15454. (lambda (b)
  15455. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  15456. (with-current-buffer b buffer-file-name))
  15457. (org-pop-to-buffer-same-window b)
  15458. (revert-buffer t 'no-confirm)))
  15459. (buffer-list))
  15460. (when (and (featurep 'org-id) org-id-track-globally)
  15461. (org-id-locations-load)))))
  15462. ;;;; Agenda files
  15463. ;;;###autoload
  15464. (defun org-switchb (&optional arg)
  15465. "Switch between Org buffers.
  15466. With one prefix argument, restrict available buffers to files.
  15467. With two prefix arguments, restrict available buffers to agenda files.
  15468. Defaults to `iswitchb' for buffer name completion.
  15469. Set `org-completion-use-ido' to make it use ido instead."
  15470. (interactive "P")
  15471. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  15472. ((equal arg '(16)) (org-buffer-list 'agenda))
  15473. (t (org-buffer-list))))
  15474. (org-completion-use-iswitchb org-completion-use-iswitchb)
  15475. (org-completion-use-ido org-completion-use-ido))
  15476. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  15477. (setq org-completion-use-iswitchb t))
  15478. (org-pop-to-buffer-same-window
  15479. (org-icompleting-read "Org buffer: "
  15480. (mapcar 'list (mapcar 'buffer-name blist))
  15481. nil t))))
  15482. ;;; Define some older names previously used for this functionality
  15483. ;;;###autoload
  15484. (defalias 'org-ido-switchb 'org-switchb)
  15485. ;;;###autoload
  15486. (defalias 'org-iswitchb 'org-switchb)
  15487. (defun org-buffer-list (&optional predicate exclude-tmp)
  15488. "Return a list of Org buffers.
  15489. PREDICATE can be `export', `files' or `agenda'.
  15490. export restrict the list to Export buffers.
  15491. files restrict the list to buffers visiting Org files.
  15492. agenda restrict the list to buffers visiting agenda files.
  15493. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  15494. (let* ((bfn nil)
  15495. (agenda-files (and (eq predicate 'agenda)
  15496. (mapcar 'file-truename (org-agenda-files t))))
  15497. (filter
  15498. (cond
  15499. ((eq predicate 'files)
  15500. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  15501. ((eq predicate 'export)
  15502. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  15503. ((eq predicate 'agenda)
  15504. (lambda (b)
  15505. (with-current-buffer b
  15506. (and (derived-mode-p 'org-mode)
  15507. (setq bfn (buffer-file-name b))
  15508. (member (file-truename bfn) agenda-files)))))
  15509. (t (lambda (b) (with-current-buffer b
  15510. (or (derived-mode-p 'org-mode)
  15511. (string-match "\*Org .*Export"
  15512. (buffer-name b)))))))))
  15513. (delq nil
  15514. (mapcar
  15515. (lambda(b)
  15516. (if (and (funcall filter b)
  15517. (or (not exclude-tmp)
  15518. (not (string-match "tmp" (buffer-name b)))))
  15519. b
  15520. nil))
  15521. (buffer-list)))))
  15522. (defun org-agenda-files (&optional unrestricted archives)
  15523. "Get the list of agenda files.
  15524. Optional UNRESTRICTED means return the full list even if a restriction
  15525. is currently in place.
  15526. When ARCHIVES is t, include all archive files that are really being
  15527. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  15528. `org-agenda-archives-mode' is t."
  15529. (let ((files
  15530. (cond
  15531. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  15532. ((stringp org-agenda-files) (org-read-agenda-file-list))
  15533. ((listp org-agenda-files) org-agenda-files)
  15534. (t (error "Invalid value of `org-agenda-files'")))))
  15535. (setq files (apply 'append
  15536. (mapcar (lambda (f)
  15537. (if (file-directory-p f)
  15538. (directory-files
  15539. f t org-agenda-file-regexp)
  15540. (list f)))
  15541. files)))
  15542. (when org-agenda-skip-unavailable-files
  15543. (setq files (delq nil
  15544. (mapcar (function
  15545. (lambda (file)
  15546. (and (file-readable-p file) file)))
  15547. files))))
  15548. (when (or (eq archives t)
  15549. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  15550. (setq files (org-add-archive-files files)))
  15551. files))
  15552. (defun org-agenda-file-p (&optional file)
  15553. "Return non-nil, if FILE is an agenda file.
  15554. If FILE is omitted, use the file associated with the current
  15555. buffer."
  15556. (member (or file (buffer-file-name))
  15557. (org-agenda-files t)))
  15558. (defun org-edit-agenda-file-list ()
  15559. "Edit the list of agenda files.
  15560. Depending on setup, this either uses customize to edit the variable
  15561. `org-agenda-files', or it visits the file that is holding the list. In the
  15562. latter case, the buffer is set up in a way that saving it automatically kills
  15563. the buffer and restores the previous window configuration."
  15564. (interactive)
  15565. (if (stringp org-agenda-files)
  15566. (let ((cw (current-window-configuration)))
  15567. (find-file org-agenda-files)
  15568. (org-set-local 'org-window-configuration cw)
  15569. (org-add-hook 'after-save-hook
  15570. (lambda ()
  15571. (set-window-configuration
  15572. (prog1 org-window-configuration
  15573. (kill-buffer (current-buffer))))
  15574. (org-install-agenda-files-menu)
  15575. (message "New agenda file list installed"))
  15576. nil 'local)
  15577. (message "%s" (substitute-command-keys
  15578. "Edit list and finish with \\[save-buffer]")))
  15579. (customize-variable 'org-agenda-files)))
  15580. (defun org-store-new-agenda-file-list (list)
  15581. "Set new value for the agenda file list and save it correctly."
  15582. (if (stringp org-agenda-files)
  15583. (let ((fe (org-read-agenda-file-list t)) b u)
  15584. (while (setq b (find-buffer-visiting org-agenda-files))
  15585. (kill-buffer b))
  15586. (with-temp-file org-agenda-files
  15587. (insert
  15588. (mapconcat
  15589. (lambda (f) ;; Keep un-expanded entries.
  15590. (if (setq u (assoc f fe))
  15591. (cdr u)
  15592. f))
  15593. list "\n")
  15594. "\n")))
  15595. (let ((org-mode-hook nil) (org-inhibit-startup t)
  15596. (org-insert-mode-line-in-empty-file nil))
  15597. (setq org-agenda-files list)
  15598. (customize-save-variable 'org-agenda-files org-agenda-files))))
  15599. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  15600. "Read the list of agenda files from a file.
  15601. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  15602. filenames, used by `org-store-new-agenda-file-list' to write back
  15603. un-expanded file names."
  15604. (when (file-directory-p org-agenda-files)
  15605. (error "`org-agenda-files' cannot be a single directory"))
  15606. (when (stringp org-agenda-files)
  15607. (with-temp-buffer
  15608. (insert-file-contents org-agenda-files)
  15609. (mapcar
  15610. (lambda (f)
  15611. (let ((e (expand-file-name (substitute-in-file-name f)
  15612. org-directory)))
  15613. (if pair-with-expansion
  15614. (cons e f)
  15615. e)))
  15616. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  15617. ;;;###autoload
  15618. (defun org-cycle-agenda-files ()
  15619. "Cycle through the files in `org-agenda-files'.
  15620. If the current buffer visits an agenda file, find the next one in the list.
  15621. If the current buffer does not, find the first agenda file."
  15622. (interactive)
  15623. (let* ((fs (org-agenda-files t))
  15624. (files (append fs (list (car fs))))
  15625. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  15626. file)
  15627. (unless files (error "No agenda files"))
  15628. (catch 'exit
  15629. (while (setq file (pop files))
  15630. (if (equal (file-truename file) tcf)
  15631. (when (car files)
  15632. (find-file (car files))
  15633. (throw 'exit t))))
  15634. (find-file (car fs)))
  15635. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  15636. (defun org-agenda-file-to-front (&optional to-end)
  15637. "Move/add the current file to the top of the agenda file list.
  15638. If the file is not present in the list, it is added to the front. If it is
  15639. present, it is moved there. With optional argument TO-END, add/move to the
  15640. end of the list."
  15641. (interactive "P")
  15642. (let ((org-agenda-skip-unavailable-files nil)
  15643. (file-alist (mapcar (lambda (x)
  15644. (cons (file-truename x) x))
  15645. (org-agenda-files t)))
  15646. (ctf (file-truename buffer-file-name))
  15647. x had)
  15648. (setq x (assoc ctf file-alist) had x)
  15649. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  15650. (if to-end
  15651. (setq file-alist (append (delq x file-alist) (list x)))
  15652. (setq file-alist (cons x (delq x file-alist))))
  15653. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  15654. (org-install-agenda-files-menu)
  15655. (message "File %s to %s of agenda file list"
  15656. (if had "moved" "added") (if to-end "end" "front"))))
  15657. (defun org-remove-file (&optional file)
  15658. "Remove current file from the list of files in variable `org-agenda-files'.
  15659. These are the files which are being checked for agenda entries.
  15660. Optional argument FILE means use this file instead of the current."
  15661. (interactive)
  15662. (let* ((org-agenda-skip-unavailable-files nil)
  15663. (file (or file buffer-file-name))
  15664. (true-file (file-truename file))
  15665. (afile (abbreviate-file-name file))
  15666. (files (delq nil (mapcar
  15667. (lambda (x)
  15668. (if (equal true-file
  15669. (file-truename x))
  15670. nil x))
  15671. (org-agenda-files t)))))
  15672. (if (not (= (length files) (length (org-agenda-files t))))
  15673. (progn
  15674. (org-store-new-agenda-file-list files)
  15675. (org-install-agenda-files-menu)
  15676. (message "Removed file: %s" afile))
  15677. (message "File was not in list: %s (not removed)" afile))))
  15678. (defun org-file-menu-entry (file)
  15679. (vector file (list 'find-file file) t))
  15680. (defun org-check-agenda-file (file)
  15681. "Make sure FILE exists. If not, ask user what to do."
  15682. (when (not (file-exists-p file))
  15683. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  15684. (abbreviate-file-name file))
  15685. (let ((r (downcase (read-char-exclusive))))
  15686. (cond
  15687. ((equal r ?r)
  15688. (org-remove-file file)
  15689. (throw 'nextfile t))
  15690. (t (error "Abort"))))))
  15691. (defun org-get-agenda-file-buffer (file)
  15692. "Get a buffer visiting FILE. If the buffer needs to be created, add
  15693. it to the list of buffers which might be released later."
  15694. (let ((buf (org-find-base-buffer-visiting file)))
  15695. (if buf
  15696. buf ; just return it
  15697. ;; Make a new buffer and remember it
  15698. (setq buf (find-file-noselect file))
  15699. (if buf (push buf org-agenda-new-buffers))
  15700. buf)))
  15701. (defun org-release-buffers (blist)
  15702. "Release all buffers in list, asking the user for confirmation when needed.
  15703. When a buffer is unmodified, it is just killed. When modified, it is saved
  15704. \(if the user agrees) and then killed."
  15705. (let (buf file)
  15706. (while (setq buf (pop blist))
  15707. (setq file (buffer-file-name buf))
  15708. (when (and (buffer-modified-p buf)
  15709. file
  15710. (y-or-n-p (format "Save file %s? " file)))
  15711. (with-current-buffer buf (save-buffer)))
  15712. (kill-buffer buf))))
  15713. (defun org-agenda-prepare-buffers (files)
  15714. "Create buffers for all agenda files, protect archived trees and comments."
  15715. (interactive)
  15716. (let ((pa '(:org-archived t))
  15717. (pc '(:org-comment t))
  15718. (pall '(:org-archived t :org-comment t))
  15719. (inhibit-read-only t)
  15720. (rea (concat ":" org-archive-tag ":"))
  15721. bmp file re)
  15722. (save-excursion
  15723. (save-restriction
  15724. (while (setq file (pop files))
  15725. (catch 'nextfile
  15726. (if (bufferp file)
  15727. (set-buffer file)
  15728. (org-check-agenda-file file)
  15729. (set-buffer (org-get-agenda-file-buffer file)))
  15730. (widen)
  15731. (setq bmp (buffer-modified-p))
  15732. (org-refresh-category-properties)
  15733. (setq org-todo-keywords-for-agenda
  15734. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  15735. (setq org-done-keywords-for-agenda
  15736. (append org-done-keywords-for-agenda org-done-keywords))
  15737. (setq org-todo-keyword-alist-for-agenda
  15738. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  15739. (setq org-drawers-for-agenda
  15740. (append org-drawers-for-agenda org-drawers))
  15741. (setq org-tag-alist-for-agenda
  15742. (append org-tag-alist-for-agenda org-tag-alist))
  15743. (save-excursion
  15744. (remove-text-properties (point-min) (point-max) pall)
  15745. (when org-agenda-skip-archived-trees
  15746. (goto-char (point-min))
  15747. (while (re-search-forward rea nil t)
  15748. (if (org-at-heading-p t)
  15749. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  15750. (goto-char (point-min))
  15751. (setq re (format org-heading-keyword-regexp-format
  15752. org-comment-string))
  15753. (while (re-search-forward re nil t)
  15754. (add-text-properties
  15755. (match-beginning 0) (org-end-of-subtree t) pc)))
  15756. (set-buffer-modified-p bmp)))))
  15757. (setq org-todo-keywords-for-agenda
  15758. (org-uniquify org-todo-keywords-for-agenda))
  15759. (setq org-todo-keyword-alist-for-agenda
  15760. (org-uniquify org-todo-keyword-alist-for-agenda)
  15761. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  15762. ;;;; Embedded LaTeX
  15763. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  15764. "Keymap for the minor `org-cdlatex-mode'.")
  15765. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  15766. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  15767. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  15768. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  15769. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  15770. (defvar org-cdlatex-texmathp-advice-is-done nil
  15771. "Flag remembering if we have applied the advice to texmathp already.")
  15772. (define-minor-mode org-cdlatex-mode
  15773. "Toggle the minor `org-cdlatex-mode'.
  15774. This mode supports entering LaTeX environment and math in LaTeX fragments
  15775. in Org-mode.
  15776. \\{org-cdlatex-mode-map}"
  15777. nil " OCDL" nil
  15778. (when org-cdlatex-mode
  15779. (require 'cdlatex)
  15780. (run-hooks 'cdlatex-mode-hook)
  15781. (cdlatex-compute-tables))
  15782. (unless org-cdlatex-texmathp-advice-is-done
  15783. (setq org-cdlatex-texmathp-advice-is-done t)
  15784. (defadvice texmathp (around org-math-always-on activate)
  15785. "Always return t in org-mode buffers.
  15786. This is because we want to insert math symbols without dollars even outside
  15787. the LaTeX math segments. If Orgmode thinks that point is actually inside
  15788. an embedded LaTeX fragment, let texmathp do its job.
  15789. \\[org-cdlatex-mode-map]"
  15790. (interactive)
  15791. (let (p)
  15792. (cond
  15793. ((not (derived-mode-p 'org-mode)) ad-do-it)
  15794. ((eq this-command 'cdlatex-math-symbol)
  15795. (setq ad-return-value t
  15796. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  15797. (t
  15798. (let ((p (org-inside-LaTeX-fragment-p)))
  15799. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  15800. (setq ad-return-value t
  15801. texmathp-why '("Org-mode embedded math" . 0))
  15802. (if p ad-do-it)))))))))
  15803. (defun turn-on-org-cdlatex ()
  15804. "Unconditionally turn on `org-cdlatex-mode'."
  15805. (org-cdlatex-mode 1))
  15806. (defun org-inside-LaTeX-fragment-p ()
  15807. "Test if point is inside a LaTeX fragment.
  15808. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  15809. sequence appearing also before point.
  15810. Even though the matchers for math are configurable, this function assumes
  15811. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  15812. delimiters are skipped when they have been removed by customization.
  15813. The return value is nil, or a cons cell with the delimiter and the
  15814. position of this delimiter.
  15815. This function does a reasonably good job, but can locally be fooled by
  15816. for example currency specifications. For example it will assume being in
  15817. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  15818. fragments that are properly closed, but during editing, we have to live
  15819. with the uncertainty caused by missing closing delimiters. This function
  15820. looks only before point, not after."
  15821. (catch 'exit
  15822. (let ((pos (point))
  15823. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  15824. (lim (progn
  15825. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  15826. (point)))
  15827. dd-on str (start 0) m re)
  15828. (goto-char pos)
  15829. (when dodollar
  15830. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  15831. re (nth 1 (assoc "$" org-latex-regexps)))
  15832. (while (string-match re str start)
  15833. (cond
  15834. ((= (match-end 0) (length str))
  15835. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  15836. ((= (match-end 0) (- (length str) 5))
  15837. (throw 'exit nil))
  15838. (t (setq start (match-end 0))))))
  15839. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  15840. (goto-char pos)
  15841. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  15842. (and (match-beginning 2) (throw 'exit nil))
  15843. ;; count $$
  15844. (while (re-search-backward "\\$\\$" lim t)
  15845. (setq dd-on (not dd-on)))
  15846. (goto-char pos)
  15847. (if dd-on (cons "$$" m))))))
  15848. (defun org-inside-latex-macro-p ()
  15849. "Is point inside a LaTeX macro or its arguments?"
  15850. (save-match-data
  15851. (org-in-regexp
  15852. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  15853. (defun org-try-cdlatex-tab ()
  15854. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  15855. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  15856. - inside a LaTeX fragment, or
  15857. - after the first word in a line, where an abbreviation expansion could
  15858. insert a LaTeX environment."
  15859. (when org-cdlatex-mode
  15860. (cond
  15861. ;; Before any word on the line: No expansion possible.
  15862. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  15863. ;; Just after first word on the line: Expand it. Make sure it
  15864. ;; cannot happen on headlines, though.
  15865. ((save-excursion
  15866. (skip-chars-backward "a-zA-Z0-9*")
  15867. (skip-chars-backward " \t")
  15868. (and (bolp) (not (org-at-heading-p))))
  15869. (cdlatex-tab) t)
  15870. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  15871. (defun org-cdlatex-underscore-caret (&optional arg)
  15872. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  15873. Revert to the normal definition outside of these fragments."
  15874. (interactive "P")
  15875. (if (org-inside-LaTeX-fragment-p)
  15876. (call-interactively 'cdlatex-sub-superscript)
  15877. (let (org-cdlatex-mode)
  15878. (call-interactively (key-binding (vector last-input-event))))))
  15879. (defun org-cdlatex-math-modify (&optional arg)
  15880. "Execute `cdlatex-math-modify' in LaTeX fragments.
  15881. Revert to the normal definition outside of these fragments."
  15882. (interactive "P")
  15883. (if (org-inside-LaTeX-fragment-p)
  15884. (call-interactively 'cdlatex-math-modify)
  15885. (let (org-cdlatex-mode)
  15886. (call-interactively (key-binding (vector last-input-event))))))
  15887. (defvar org-latex-fragment-image-overlays nil
  15888. "List of overlays carrying the images of latex fragments.")
  15889. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  15890. (defun org-remove-latex-fragment-image-overlays ()
  15891. "Remove all overlays with LaTeX fragment images in current buffer."
  15892. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  15893. (setq org-latex-fragment-image-overlays nil))
  15894. (defun org-preview-latex-fragment (&optional subtree)
  15895. "Preview the LaTeX fragment at point, or all locally or globally.
  15896. If the cursor is in a LaTeX fragment, create the image and overlay
  15897. it over the source code. If there is no fragment at point, display
  15898. all fragments in the current text, from one headline to the next. With
  15899. prefix SUBTREE, display all fragments in the current subtree. With a
  15900. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  15901. the cursor is before the first headline,
  15902. display all fragments in the buffer.
  15903. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  15904. (interactive "P")
  15905. (unless buffer-file-name
  15906. (error "Can't preview LaTeX fragment in a non-file buffer"))
  15907. (org-remove-latex-fragment-image-overlays)
  15908. (save-excursion
  15909. (save-restriction
  15910. (let (beg end at msg)
  15911. (cond
  15912. ((or (equal subtree '(16))
  15913. (not (save-excursion
  15914. (re-search-backward org-outline-regexp-bol nil t))))
  15915. (setq beg (point-min) end (point-max)
  15916. msg "Creating images for buffer...%s"))
  15917. ((equal subtree '(4))
  15918. (org-back-to-heading)
  15919. (setq beg (point) end (org-end-of-subtree t)
  15920. msg "Creating images for subtree...%s"))
  15921. (t
  15922. (if (setq at (org-inside-LaTeX-fragment-p))
  15923. (goto-char (max (point-min) (- (cdr at) 2)))
  15924. (org-back-to-heading))
  15925. (setq beg (point) end (progn (outline-next-heading) (point))
  15926. msg (if at "Creating image...%s"
  15927. "Creating images for entry...%s"))))
  15928. (message msg "")
  15929. (narrow-to-region beg end)
  15930. (goto-char beg)
  15931. (org-format-latex
  15932. (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
  15933. (file-name-nondirectory
  15934. buffer-file-name)))
  15935. default-directory 'overlays msg at 'forbuffer
  15936. org-latex-create-formula-image-program)
  15937. (message msg "done. Use `C-c C-c' to remove images.")))))
  15938. (defvar org-latex-regexps
  15939. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  15940. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  15941. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  15942. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15943. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15944. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  15945. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  15946. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  15947. "Regular expressions for matching embedded LaTeX.")
  15948. (defvar org-export-have-math nil) ;; dynamic scoping
  15949. (defun org-format-latex (prefix &optional dir overlays msg at
  15950. forbuffer processing-type)
  15951. "Replace LaTeX fragments with links to an image, and produce images.
  15952. Some of the options can be changed using the variable
  15953. `org-format-latex-options'."
  15954. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  15955. (let* ((prefixnodir (file-name-nondirectory prefix))
  15956. (absprefix (expand-file-name prefix dir))
  15957. (todir (file-name-directory absprefix))
  15958. (opt org-format-latex-options)
  15959. (optnew org-format-latex-options)
  15960. (matchers (plist-get opt :matchers))
  15961. (re-list org-latex-regexps)
  15962. (org-format-latex-header-extra
  15963. (plist-get (org-infile-export-plist) :latex-header-extra))
  15964. (cnt 0) txt hash link beg end re e checkdir
  15965. string
  15966. m n block-type block linkfile movefile ov)
  15967. ;; Check the different regular expressions
  15968. (while (setq e (pop re-list))
  15969. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  15970. block (if block-type "\n\n" ""))
  15971. (when (member m matchers)
  15972. (goto-char (point-min))
  15973. (while (re-search-forward re nil t)
  15974. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  15975. (not (get-text-property (match-beginning n)
  15976. 'org-protected))
  15977. (or (not overlays)
  15978. (not (eq (get-char-property (match-beginning n)
  15979. 'org-overlay-type)
  15980. 'org-latex-overlay))))
  15981. (setq org-export-have-math t)
  15982. (cond
  15983. ((eq processing-type 'verbatim)
  15984. ;; Leave the text verbatim, just protect it
  15985. (add-text-properties (match-beginning n) (match-end n)
  15986. '(org-protected t)))
  15987. ((eq processing-type 'mathjax)
  15988. ;; Prepare for MathJax processing
  15989. (setq string (match-string n))
  15990. (if (member m '("$" "$1"))
  15991. (save-excursion
  15992. (delete-region (match-beginning n) (match-end n))
  15993. (goto-char (match-beginning n))
  15994. (insert (org-add-props (concat "\\(" (substring string 1 -1)
  15995. "\\)")
  15996. '(org-protected t))))
  15997. (add-text-properties (match-beginning n) (match-end n)
  15998. '(org-protected t))))
  15999. ((or (eq processing-type 'dvipng)
  16000. (eq processing-type 'imagemagick))
  16001. ;; Process to an image
  16002. (setq txt (match-string n)
  16003. beg (match-beginning n) end (match-end n)
  16004. cnt (1+ cnt))
  16005. (let ((face (face-at-point))
  16006. (fg (plist-get opt :foreground))
  16007. (bg (plist-get opt :background))
  16008. print-length print-level) ; make sure full list is printed
  16009. (when forbuffer
  16010. ; Get the colors from the face at point
  16011. (goto-char beg)
  16012. (when (eq fg 'auto)
  16013. (setq fg (face-attribute face :foreground nil 'default)))
  16014. (when (eq bg 'auto)
  16015. (setq bg (face-attribute face :background nil 'default)))
  16016. (setq optnew (copy-sequence opt))
  16017. (plist-put optnew :foreground fg)
  16018. (plist-put optnew :background bg))
  16019. (setq hash (sha1 (prin1-to-string
  16020. (list org-format-latex-header
  16021. org-format-latex-header-extra
  16022. org-export-latex-default-packages-alist
  16023. org-export-latex-packages-alist
  16024. org-format-latex-options
  16025. forbuffer txt fg bg)))
  16026. linkfile (format "%s_%s.png" prefix hash)
  16027. movefile (format "%s_%s.png" absprefix hash)))
  16028. (setq link (concat block "[[file:" linkfile "]]" block))
  16029. (if msg (message msg cnt))
  16030. (goto-char beg)
  16031. (unless checkdir ; make sure the directory exists
  16032. (setq checkdir t)
  16033. (or (file-directory-p todir) (make-directory todir t)))
  16034. (org-create-formula-image
  16035. txt movefile optnew forbuffer processing-type)
  16036. (if overlays
  16037. (progn
  16038. (mapc (lambda (o)
  16039. (if (eq (overlay-get o 'org-overlay-type)
  16040. 'org-latex-overlay)
  16041. (delete-overlay o)))
  16042. (overlays-in beg end))
  16043. (setq ov (make-overlay beg end))
  16044. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  16045. (if (featurep 'xemacs)
  16046. (progn
  16047. (overlay-put ov 'invisible t)
  16048. (overlay-put
  16049. ov 'end-glyph
  16050. (make-glyph (vector 'png :file movefile))))
  16051. (overlay-put
  16052. ov 'display
  16053. (list 'image :type 'png :file movefile :ascent 'center)))
  16054. (push ov org-latex-fragment-image-overlays)
  16055. (goto-char end))
  16056. (delete-region beg end)
  16057. (insert (org-add-props link
  16058. (list 'org-latex-src
  16059. (replace-regexp-in-string
  16060. "\"" "" txt)
  16061. 'org-latex-src-embed-type
  16062. (if block-type 'paragraph 'character))))))
  16063. ((eq processing-type 'mathml)
  16064. ;; Process to MathML
  16065. (unless (save-match-data (org-format-latex-mathml-available-p))
  16066. (error "LaTeX to MathML converter not configured"))
  16067. (setq txt (match-string n)
  16068. beg (match-beginning n) end (match-end n)
  16069. cnt (1+ cnt))
  16070. (if msg (message msg cnt))
  16071. (goto-char beg)
  16072. (delete-region beg end)
  16073. (insert (org-format-latex-as-mathml
  16074. txt block-type prefix dir)))
  16075. (t
  16076. (error "Unknown conversion type %s for latex fragments"
  16077. processing-type)))))))))
  16078. (defun org-create-math-formula (latex-frag &optional mathml-file)
  16079. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  16080. Use `org-latex-to-mathml-convert-command'. If the conversion is
  16081. sucessful, return the portion between \"<math...> </math>\"
  16082. elements otherwise return nil. When MATHML-FILE is specified,
  16083. write the results in to that file. When invoked as an
  16084. interactive command, prompt for LATEX-FRAG, with initial value
  16085. set to the current active region and echo the results for user
  16086. inspection."
  16087. (interactive (list (let ((frag (when (org-region-active-p)
  16088. (buffer-substring-no-properties
  16089. (region-beginning) (region-end)))))
  16090. (read-string "LaTeX Fragment: " frag nil frag))))
  16091. (unless latex-frag (error "Invalid latex-frag"))
  16092. (let* ((tmp-in-file (file-relative-name
  16093. (make-temp-name (expand-file-name "ltxmathml-in"))))
  16094. (ignore (write-region latex-frag nil tmp-in-file))
  16095. (tmp-out-file (file-relative-name
  16096. (make-temp-name (expand-file-name "ltxmathml-out"))))
  16097. (cmd (format-spec
  16098. org-latex-to-mathml-convert-command
  16099. `((?j . ,(shell-quote-argument
  16100. (expand-file-name org-latex-to-mathml-jar-file)))
  16101. (?I . ,(shell-quote-argument tmp-in-file))
  16102. (?o . ,(shell-quote-argument tmp-out-file)))))
  16103. mathml shell-command-output)
  16104. (when (org-called-interactively-p 'any)
  16105. (unless (org-format-latex-mathml-available-p)
  16106. (error "LaTeX to MathML converter not configured")))
  16107. (message "Running %s" cmd)
  16108. (setq shell-command-output (shell-command-to-string cmd))
  16109. (setq mathml
  16110. (when (file-readable-p tmp-out-file)
  16111. (with-current-buffer (find-file-noselect tmp-out-file t)
  16112. (goto-char (point-min))
  16113. (when (re-search-forward
  16114. (concat
  16115. (regexp-quote
  16116. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  16117. "\\(.\\|\n\\)*"
  16118. (regexp-quote "</math>")) nil t)
  16119. (prog1 (match-string 0) (kill-buffer))))))
  16120. (cond
  16121. (mathml
  16122. (setq mathml
  16123. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  16124. (when mathml-file
  16125. (write-region mathml nil mathml-file))
  16126. (when (org-called-interactively-p 'any)
  16127. (message mathml)))
  16128. ((message "LaTeX to MathML conversion failed")
  16129. (message shell-command-output)))
  16130. (delete-file tmp-in-file)
  16131. (when (file-exists-p tmp-out-file)
  16132. (delete-file tmp-out-file))
  16133. mathml))
  16134. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  16135. prefix &optional dir)
  16136. "Use `org-create-math-formula' but check local cache first."
  16137. (let* ((absprefix (expand-file-name prefix dir))
  16138. (print-length nil) (print-level nil)
  16139. (formula-id (concat
  16140. "formula-"
  16141. (sha1
  16142. (prin1-to-string
  16143. (list latex-frag
  16144. org-latex-to-mathml-convert-command)))))
  16145. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  16146. (formula-cache-dir (file-name-directory formula-cache)))
  16147. (unless (file-directory-p formula-cache-dir)
  16148. (make-directory formula-cache-dir t))
  16149. (unless (file-exists-p formula-cache)
  16150. (org-create-math-formula latex-frag formula-cache))
  16151. (if (file-exists-p formula-cache)
  16152. ;; Successful conversion. Return the link to MathML file.
  16153. (org-add-props
  16154. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  16155. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  16156. 'org-latex-src-embed-type (if latex-frag-type
  16157. 'paragraph 'character)))
  16158. ;; Failed conversion. Return the LaTeX fragment verbatim
  16159. (add-text-properties
  16160. 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
  16161. latex-frag)))
  16162. (defun org-create-formula-image (string tofile options buffer &optional type)
  16163. "Create an image from LaTeX source using dvipng or convert.
  16164. This function calls either `org-create-formula-image-with-dvipng'
  16165. or `org-create-formula-image-with-imagemagick' depending on the
  16166. value of `org-latex-create-formula-image-program' or on the value
  16167. of the optional TYPE variable.
  16168. Note: ultimately these two function should be combined as they
  16169. share a good deal of logic."
  16170. (org-check-external-command
  16171. "latex" "needed to convert LaTeX fragments to images")
  16172. (funcall
  16173. (case (or type org-latex-create-formula-image-program)
  16174. ('dvipng
  16175. (org-check-external-command
  16176. "dvipng" "needed to convert LaTeX fragments to images")
  16177. #'org-create-formula-image-with-dvipng)
  16178. ('imagemagick
  16179. (org-check-external-command
  16180. "convert" "you need to install imagemagick")
  16181. #'org-create-formula-image-with-imagemagick)
  16182. (t (error
  16183. "invalid value of `org-latex-create-formula-image-program'")))
  16184. string tofile options buffer))
  16185. ;; This function borrows from Ganesh Swami's latex2png.el
  16186. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  16187. "This calls dvipng."
  16188. (require 'org-latex)
  16189. (let* ((tmpdir (if (featurep 'xemacs)
  16190. (temp-directory)
  16191. temporary-file-directory))
  16192. (texfilebase (make-temp-name
  16193. (expand-file-name "orgtex" tmpdir)))
  16194. (texfile (concat texfilebase ".tex"))
  16195. (dvifile (concat texfilebase ".dvi"))
  16196. (pngfile (concat texfilebase ".png"))
  16197. (fnh (if (featurep 'xemacs)
  16198. (font-height (face-font 'default))
  16199. (face-attribute 'default :height nil)))
  16200. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16201. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16202. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16203. "Black"))
  16204. (bg (or (plist-get options (if buffer :background :html-background))
  16205. "Transparent")))
  16206. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
  16207. (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
  16208. (if (eq bg 'default) (setq bg (org-dvipng-color :background))
  16209. (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
  16210. (with-temp-file texfile
  16211. (insert (org-splice-latex-header
  16212. org-format-latex-header
  16213. org-export-latex-default-packages-alist
  16214. org-export-latex-packages-alist t
  16215. org-format-latex-header-extra))
  16216. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  16217. (require 'org-latex)
  16218. (org-export-latex-fix-inputenc))
  16219. (let ((dir default-directory))
  16220. (condition-case nil
  16221. (progn
  16222. (cd tmpdir)
  16223. (call-process "latex" nil nil nil texfile))
  16224. (error nil))
  16225. (cd dir))
  16226. (if (not (file-exists-p dvifile))
  16227. (progn (message "Failed to create dvi file from %s" texfile) nil)
  16228. (condition-case nil
  16229. (if (featurep 'xemacs)
  16230. (call-process "dvipng" nil nil nil
  16231. "-fg" fg "-bg" bg
  16232. "-T" "tight"
  16233. "-o" pngfile
  16234. dvifile)
  16235. (call-process "dvipng" nil nil nil
  16236. "-fg" fg "-bg" bg
  16237. "-D" dpi
  16238. ;;"-x" scale "-y" scale
  16239. "-T" "tight"
  16240. "-o" pngfile
  16241. dvifile))
  16242. (error nil))
  16243. (if (not (file-exists-p pngfile))
  16244. (if org-format-latex-signal-error
  16245. (error "Failed to create png file from %s" texfile)
  16246. (message "Failed to create png file from %s" texfile)
  16247. nil)
  16248. ;; Use the requested file name and clean up
  16249. (copy-file pngfile tofile 'replace)
  16250. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  16251. (if (file-exists-p (concat texfilebase e))
  16252. (delete-file (concat texfilebase e))))
  16253. pngfile))))
  16254. (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
  16255. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  16256. "This calls convert, which is included into imagemagick."
  16257. (require 'org-latex)
  16258. (let* ((tmpdir (if (featurep 'xemacs)
  16259. (temp-directory)
  16260. temporary-file-directory))
  16261. (texfilebase (make-temp-name
  16262. (expand-file-name "orgtex" tmpdir)))
  16263. (texfile (concat texfilebase ".tex"))
  16264. (pdffile (concat texfilebase ".pdf"))
  16265. (pngfile (concat texfilebase ".png"))
  16266. (fnh (if (featurep 'xemacs)
  16267. (font-height (face-font 'default))
  16268. (face-attribute 'default :height nil)))
  16269. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16270. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16271. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16272. "black"))
  16273. (bg (or (plist-get options (if buffer :background :html-background))
  16274. "white")))
  16275. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  16276. (setq fg (org-latex-color-format fg)))
  16277. (if (eq bg 'default) (setq bg (org-latex-color :background))
  16278. (setq bg (org-latex-color-format
  16279. (if (string= bg "Transparent") "white" bg))))
  16280. (with-temp-file texfile
  16281. (insert (org-splice-latex-header
  16282. org-format-latex-header
  16283. org-export-latex-default-packages-alist
  16284. org-export-latex-packages-alist t
  16285. org-format-latex-header-extra))
  16286. (insert "\n\\begin{document}\n"
  16287. "\\definecolor{fg}{rgb}{" fg "}\n"
  16288. "\\definecolor{bg}{rgb}{" bg "}\n"
  16289. "\n\\pagecolor{bg}\n"
  16290. "\n{\\color{fg}\n"
  16291. string
  16292. "\n}\n"
  16293. "\n\\end{document}\n" )
  16294. (require 'org-latex)
  16295. (org-export-latex-fix-inputenc))
  16296. (let ((dir default-directory) cmd cmds latex-frags-cmds)
  16297. (condition-case nil
  16298. (progn
  16299. (cd tmpdir)
  16300. (setq cmds org-latex-to-pdf-process)
  16301. (while cmds
  16302. (setq latex-frags-cmds (pop cmds))
  16303. (if (listp latex-frags-cmds)
  16304. (setq cmds nil)
  16305. (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
  16306. (while latex-frags-cmds
  16307. (setq cmd (pop latex-frags-cmds))
  16308. (while (string-match "%b" cmd)
  16309. (setq cmd (replace-match
  16310. (save-match-data
  16311. (shell-quote-argument texfile))
  16312. t t cmd)))
  16313. (while (string-match "%f" cmd)
  16314. (setq cmd (replace-match
  16315. (save-match-data
  16316. (shell-quote-argument (file-name-nondirectory texfile)))
  16317. t t cmd)))
  16318. (while (string-match "%o" cmd)
  16319. (setq cmd (replace-match
  16320. (save-match-data
  16321. (shell-quote-argument (file-name-directory texfile)))
  16322. t t cmd)))
  16323. (setq cmd (split-string cmd))
  16324. (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
  16325. (error nil))
  16326. (cd dir))
  16327. (if (not (file-exists-p pdffile))
  16328. (progn (message "Failed to create pdf file from %s" texfile) nil)
  16329. (condition-case nil
  16330. (if (featurep 'xemacs)
  16331. (call-process "convert" nil nil nil
  16332. "-density" "96"
  16333. "-trim"
  16334. "-antialias"
  16335. pdffile
  16336. "-quality" "100"
  16337. ;; "-sharpen" "0x1.0"
  16338. pngfile)
  16339. (call-process "convert" nil nil nil
  16340. "-density" dpi
  16341. "-trim"
  16342. "-antialias"
  16343. pdffile
  16344. "-quality" "100"
  16345. ; "-sharpen" "0x1.0"
  16346. pngfile))
  16347. (error nil))
  16348. (if (not (file-exists-p pngfile))
  16349. (if org-format-latex-signal-error
  16350. (error "Failed to create png file from %s" texfile)
  16351. (message "Failed to create png file from %s" texfile)
  16352. nil)
  16353. ;; Use the requested file name and clean up
  16354. (copy-file pngfile tofile 'replace)
  16355. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  16356. (if (file-exists-p (concat texfilebase e))
  16357. (delete-file (concat texfilebase e))))
  16358. pngfile))))
  16359. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  16360. "Fill a LaTeX header template TPL.
  16361. In the template, the following place holders will be recognized:
  16362. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  16363. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  16364. [PACKAGES] \\usepackage statements for PKG
  16365. [NO-PACKAGES] do not include PKG
  16366. [EXTRA] the string EXTRA
  16367. [NO-EXTRA] do not include EXTRA
  16368. For backward compatibility, if both the positive and the negative place
  16369. holder is missing, the positive one (without the \"NO-\") will be
  16370. assumed to be present at the end of the template.
  16371. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  16372. EXTRA is a string.
  16373. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  16374. (let (rpl (end ""))
  16375. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  16376. (setq rpl (if (or (match-end 1) (not def-pkg))
  16377. "" (org-latex-packages-to-string def-pkg snippets-p t))
  16378. tpl (replace-match rpl t t tpl))
  16379. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  16380. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  16381. (setq rpl (if (or (match-end 1) (not pkg))
  16382. "" (org-latex-packages-to-string pkg snippets-p t))
  16383. tpl (replace-match rpl t t tpl))
  16384. (if pkg (setq end
  16385. (concat end "\n"
  16386. (org-latex-packages-to-string pkg snippets-p)))))
  16387. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  16388. (setq rpl (if (or (match-end 1) (not extra))
  16389. "" (concat extra "\n"))
  16390. tpl (replace-match rpl t t tpl))
  16391. (if (and extra (string-match "\\S-" extra))
  16392. (setq end (concat end "\n" extra))))
  16393. (if (string-match "\\S-" end)
  16394. (concat tpl "\n" end)
  16395. tpl)))
  16396. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  16397. "Turn an alist of packages into a string with the \\usepackage macros."
  16398. (setq pkg (mapconcat (lambda(p)
  16399. (cond
  16400. ((stringp p) p)
  16401. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  16402. (format "%% Package %s omitted" (cadr p)))
  16403. ((equal "" (car p))
  16404. (format "\\usepackage{%s}" (cadr p)))
  16405. (t
  16406. (format "\\usepackage[%s]{%s}"
  16407. (car p) (cadr p)))))
  16408. pkg
  16409. "\n"))
  16410. (if newline (concat pkg "\n") pkg))
  16411. (defun org-dvipng-color (attr)
  16412. "Return a RGB color specification for dvipng."
  16413. (apply 'format "rgb %s %s %s"
  16414. (mapcar 'org-normalize-color
  16415. (if (featurep 'xemacs)
  16416. (color-rgb-components
  16417. (face-property 'default
  16418. (cond ((eq attr :foreground) 'foreground)
  16419. ((eq attr :background) 'background))))
  16420. (color-values (face-attribute 'default attr nil))))))
  16421. (defun org-dvipng-color-format (color-name)
  16422. "Convert COLOR-NAME to a RGB color value for dvipng."
  16423. (apply 'format "rgb %s %s %s"
  16424. (mapcar 'org-normalize-color
  16425. (color-values color-name))))
  16426. (defun org-latex-color (attr)
  16427. "Return a RGB color for the LaTeX color package."
  16428. (apply 'format "%s,%s,%s"
  16429. (mapcar 'org-normalize-color
  16430. (if (featurep 'xemacs)
  16431. (color-rgb-components
  16432. (face-property 'default
  16433. (cond ((eq attr :foreground) 'foreground)
  16434. ((eq attr :background) 'background))))
  16435. (color-values (face-attribute 'default attr nil))))))
  16436. (defun org-latex-color-format (color-name)
  16437. "Convert COLOR-NAME to a RGB color value."
  16438. (apply 'format "%s,%s,%s"
  16439. (mapcar 'org-normalize-color
  16440. (color-values color-name))))
  16441. (defun org-normalize-color (value)
  16442. "Return string to be used as color value for an RGB component."
  16443. (format "%g" (/ value 65535.0)))
  16444. ;; Image display
  16445. (defvar org-inline-image-overlays nil)
  16446. (make-variable-buffer-local 'org-inline-image-overlays)
  16447. (defun org-toggle-inline-images (&optional include-linked)
  16448. "Toggle the display of inline images.
  16449. INCLUDE-LINKED is passed to `org-display-inline-images'."
  16450. (interactive "P")
  16451. (if org-inline-image-overlays
  16452. (progn
  16453. (org-remove-inline-images)
  16454. (message "Inline image display turned off"))
  16455. (org-display-inline-images include-linked)
  16456. (if (and (org-called-interactively-p)
  16457. org-inline-image-overlays)
  16458. (message "%d images displayed inline"
  16459. (length org-inline-image-overlays))
  16460. (message "No images to display inline"))))
  16461. (defun org-redisplay-inline-images ()
  16462. "Refresh the display of inline images."
  16463. (interactive)
  16464. (if (not org-inline-image-overlays)
  16465. (org-toggle-inline-images)
  16466. (org-toggle-inline-images)
  16467. (org-toggle-inline-images)))
  16468. (defun org-display-inline-images (&optional include-linked refresh beg end)
  16469. "Display inline images.
  16470. Normally only links without a description part are inlined, because this
  16471. is how it will work for export. When INCLUDE-LINKED is set, also links
  16472. with a description part will be inlined. This can be nice for a quick
  16473. look at those images, but it does not reflect what exported files will look
  16474. like.
  16475. When REFRESH is set, refresh existing images between BEG and END.
  16476. This will create new image displays only if necessary.
  16477. BEG and END default to the buffer boundaries."
  16478. (interactive "P")
  16479. (unless refresh
  16480. (org-remove-inline-images)
  16481. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  16482. (save-excursion
  16483. (save-restriction
  16484. (widen)
  16485. (setq beg (or beg (point-min)) end (or end (point-max)))
  16486. (goto-char beg)
  16487. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  16488. (substring (org-image-file-name-regexp) 0 -2)
  16489. "\\)\\]" (if include-linked "" "\\]")))
  16490. old file ov img type attrwidth width)
  16491. (while (re-search-forward re end t)
  16492. (setq old (get-char-property-and-overlay (match-beginning 1)
  16493. 'org-image-overlay)
  16494. file (expand-file-name
  16495. (concat (or (match-string 3) "") (match-string 4))))
  16496. (when (image-type-available-p 'imagemagick)
  16497. (setq attrwidth (if (or (listp org-image-actual-width)
  16498. (null org-image-actual-width))
  16499. (save-excursion
  16500. (save-match-data
  16501. (when (re-search-backward
  16502. "#\\+ATTR.*width=\"\\([^\"]+\\)\""
  16503. (save-excursion
  16504. (re-search-backward "^[ \t]*$\\|\\`" nil t)) t)
  16505. (string-to-number (match-string 1))))))
  16506. width (cond ((eq org-image-actual-width t) nil)
  16507. ((null org-image-actual-width) attrwidth)
  16508. ((numberp org-image-actual-width)
  16509. org-image-actual-width)
  16510. ((listp org-image-actual-width)
  16511. (or attrwidth (car org-image-actual-width))))
  16512. type (if width 'imagemagick)))
  16513. (when (file-exists-p file)
  16514. (if (and (car-safe old) refresh)
  16515. (image-refresh (overlay-get (cdr old) 'display))
  16516. (setq img (save-match-data (create-image file type nil :width width)))
  16517. (when img
  16518. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  16519. (overlay-put ov 'display img)
  16520. (overlay-put ov 'face 'default)
  16521. (overlay-put ov 'org-image-overlay t)
  16522. (overlay-put ov 'modification-hooks
  16523. (list 'org-display-inline-remove-overlay))
  16524. (push ov org-inline-image-overlays)))))))))
  16525. (define-obsolete-function-alias
  16526. 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
  16527. (defun org-display-inline-remove-overlay (ov after beg end &optional len)
  16528. "Remove inline-display overlay if a corresponding region is modified."
  16529. (let ((inhibit-modification-hooks t))
  16530. (when (and ov after)
  16531. (delete ov org-inline-image-overlays)
  16532. (delete-overlay ov))))
  16533. (defun org-remove-inline-images ()
  16534. "Remove inline display of images."
  16535. (interactive)
  16536. (mapc 'delete-overlay org-inline-image-overlays)
  16537. (setq org-inline-image-overlays nil))
  16538. ;;;; Key bindings
  16539. ;; Outline functions from `outline-mode-prefix-map'
  16540. ;; that can be remapped in Org:
  16541. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  16542. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  16543. (define-key org-mode-map [remap outline-forward-same-level]
  16544. 'org-forward-heading-same-level)
  16545. (define-key org-mode-map [remap outline-backward-same-level]
  16546. 'org-backward-heading-same-level)
  16547. (define-key org-mode-map [remap show-branches]
  16548. 'org-kill-note-or-show-branches)
  16549. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  16550. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  16551. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  16552. ;; Outline functions from `outline-mode-prefix-map' that can not
  16553. ;; be remapped in Org:
  16554. ;;
  16555. ;; - the column "key binding" shows whether the Outline function is still
  16556. ;; available in Org mode on the same key that it has been bound to in
  16557. ;; Outline mode:
  16558. ;; - "overridden": key used for a different functionality in Org mode
  16559. ;; - else: key still bound to the same Outline function in Org mode
  16560. ;;
  16561. ;; | Outline function | key binding | Org replacement |
  16562. ;; |------------------------------------+-------------+-----------------------|
  16563. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  16564. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  16565. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  16566. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  16567. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  16568. ;; | `show-entry' | overridden | no replacement |
  16569. ;; | `show-children' | `C-c C-i' | visibility cycling |
  16570. ;; | `show-branches' | `C-c C-k' | still same function |
  16571. ;; | `show-subtree' | overridden | visibility cycling |
  16572. ;; | `show-all' | overridden | no replacement |
  16573. ;; | `hide-subtree' | overridden | visibility cycling |
  16574. ;; | `hide-body' | overridden | no replacement |
  16575. ;; | `hide-entry' | overridden | visibility cycling |
  16576. ;; | `hide-leaves' | overridden | no replacement |
  16577. ;; | `hide-sublevels' | overridden | no replacement |
  16578. ;; | `hide-other' | overridden | no replacement |
  16579. ;; Make `C-c C-x' a prefix key
  16580. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  16581. ;; TAB key with modifiers
  16582. (org-defkey org-mode-map "\C-i" 'org-cycle)
  16583. (org-defkey org-mode-map [(tab)] 'org-cycle)
  16584. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  16585. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  16586. ;; The following line is necessary under Suse GNU/Linux
  16587. (unless (featurep 'xemacs)
  16588. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  16589. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  16590. (define-key org-mode-map [backtab] 'org-shifttab)
  16591. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  16592. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  16593. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  16594. ;; Cursor keys with modifiers
  16595. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  16596. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  16597. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  16598. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  16599. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  16600. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  16601. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  16602. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  16603. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  16604. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  16605. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  16606. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  16607. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  16608. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  16609. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  16610. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  16611. ;; Babel keys
  16612. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  16613. (mapc (lambda (pair)
  16614. (define-key org-babel-map (car pair) (cdr pair)))
  16615. org-babel-key-bindings)
  16616. ;;; Extra keys for tty access.
  16617. ;; We only set them when really needed because otherwise the
  16618. ;; menus don't show the simple keys
  16619. (when (or org-use-extra-keys
  16620. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  16621. (not window-system))
  16622. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  16623. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  16624. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  16625. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  16626. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  16627. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  16628. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  16629. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  16630. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  16631. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  16632. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  16633. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  16634. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  16635. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  16636. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  16637. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  16638. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  16639. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  16640. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  16641. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  16642. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  16643. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  16644. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  16645. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  16646. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  16647. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  16648. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  16649. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  16650. ;; All the other keys
  16651. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  16652. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  16653. (if (boundp 'narrow-map)
  16654. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  16655. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  16656. (if (boundp 'narrow-map)
  16657. (org-defkey narrow-map "b" 'org-narrow-to-block)
  16658. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  16659. (if (boundp 'narrow-map)
  16660. (org-defkey narrow-map "e" 'org-narrow-to-element)
  16661. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  16662. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  16663. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  16664. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  16665. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  16666. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  16667. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  16668. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  16669. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  16670. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  16671. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  16672. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  16673. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  16674. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  16675. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  16676. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  16677. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  16678. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  16679. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  16680. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  16681. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  16682. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  16683. (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
  16684. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  16685. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  16686. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  16687. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  16688. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  16689. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  16690. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  16691. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  16692. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  16693. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  16694. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  16695. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  16696. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  16697. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  16698. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  16699. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  16700. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  16701. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  16702. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  16703. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  16704. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  16705. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  16706. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  16707. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  16708. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  16709. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  16710. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  16711. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  16712. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  16713. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  16714. (org-defkey org-mode-map "\C-c^" 'org-sort)
  16715. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  16716. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  16717. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  16718. (org-defkey org-mode-map "\C-m" 'org-return)
  16719. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  16720. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  16721. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  16722. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  16723. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  16724. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  16725. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  16726. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  16727. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  16728. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  16729. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  16730. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  16731. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  16732. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  16733. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  16734. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  16735. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  16736. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  16737. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  16738. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  16739. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  16740. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  16741. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  16742. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  16743. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  16744. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  16745. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  16746. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  16747. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  16748. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  16749. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  16750. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  16751. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  16752. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  16753. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  16754. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  16755. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  16756. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  16757. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  16758. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  16759. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  16760. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  16761. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  16762. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  16763. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  16764. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  16765. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  16766. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  16767. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  16768. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  16769. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  16770. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  16771. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  16772. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  16773. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  16774. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  16775. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  16776. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  16777. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  16778. (when (featurep 'xemacs)
  16779. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  16780. (defconst org-speed-commands-default
  16781. '(
  16782. ("Outline Navigation")
  16783. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  16784. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  16785. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  16786. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  16787. ("u" . (org-speed-move-safe 'outline-up-heading))
  16788. ("j" . org-goto)
  16789. ("g" . (org-refile t))
  16790. ("Outline Visibility")
  16791. ("c" . org-cycle)
  16792. ("C" . org-shifttab)
  16793. (" " . org-display-outline-path)
  16794. (":" . org-columns)
  16795. ("Outline Structure Editing")
  16796. ("U" . org-shiftmetaup)
  16797. ("D" . org-shiftmetadown)
  16798. ("r" . org-metaright)
  16799. ("l" . org-metaleft)
  16800. ("R" . org-shiftmetaright)
  16801. ("L" . org-shiftmetaleft)
  16802. ("i" . (progn (forward-char 1) (call-interactively
  16803. 'org-insert-heading-respect-content)))
  16804. ("^" . org-sort)
  16805. ("w" . org-refile)
  16806. ("a" . org-archive-subtree-default-with-confirmation)
  16807. ("." . org-mark-subtree)
  16808. ("#" . org-toggle-comment)
  16809. ("Clock Commands")
  16810. ("I" . org-clock-in)
  16811. ("O" . org-clock-out)
  16812. ("Meta Data Editing")
  16813. ("t" . org-todo)
  16814. ("," . (org-priority))
  16815. ("0" . (org-priority ?\ ))
  16816. ("1" . (org-priority ?A))
  16817. ("2" . (org-priority ?B))
  16818. ("3" . (org-priority ?C))
  16819. (";" . org-set-tags-command)
  16820. ("e" . org-set-effort)
  16821. ("E" . org-inc-effort)
  16822. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  16823. (org-entry-put (point) "APPT_WARNTIME" m)))
  16824. ("Agenda Views etc")
  16825. ("v" . org-agenda)
  16826. ("/" . org-sparse-tree)
  16827. ("Misc")
  16828. ("o" . org-open-at-point)
  16829. ("?" . org-speed-command-help)
  16830. ("<" . (org-agenda-set-restriction-lock 'subtree))
  16831. (">" . (org-agenda-remove-restriction-lock))
  16832. )
  16833. "The default speed commands.")
  16834. (defun org-print-speed-command (e)
  16835. (if (> (length (car e)) 1)
  16836. (progn
  16837. (princ "\n")
  16838. (princ (car e))
  16839. (princ "\n")
  16840. (princ (make-string (length (car e)) ?-))
  16841. (princ "\n"))
  16842. (princ (car e))
  16843. (princ " ")
  16844. (if (symbolp (cdr e))
  16845. (princ (symbol-name (cdr e)))
  16846. (prin1 (cdr e)))
  16847. (princ "\n")))
  16848. (defun org-speed-command-help ()
  16849. "Show the available speed commands."
  16850. (interactive)
  16851. (if (not org-use-speed-commands)
  16852. (error "Speed commands are not activated, customize `org-use-speed-commands'")
  16853. (with-output-to-temp-buffer "*Help*"
  16854. (princ "User-defined Speed commands\n===========================\n")
  16855. (mapc 'org-print-speed-command org-speed-commands-user)
  16856. (princ "\n")
  16857. (princ "Built-in Speed commands\n=======================\n")
  16858. (mapc 'org-print-speed-command org-speed-commands-default))
  16859. (with-current-buffer "*Help*"
  16860. (setq truncate-lines t))))
  16861. (defun org-speed-move-safe (cmd)
  16862. "Execute CMD, but make sure that the cursor always ends up in a headline.
  16863. If not, return to the original position and throw an error."
  16864. (interactive)
  16865. (let ((pos (point)))
  16866. (call-interactively cmd)
  16867. (unless (and (bolp) (org-at-heading-p))
  16868. (goto-char pos)
  16869. (error "Boundary reached while executing %s" cmd))))
  16870. (defvar org-self-insert-command-undo-counter 0)
  16871. (defvar org-table-auto-blank-field) ; defined in org-table.el
  16872. (defvar org-speed-command nil)
  16873. (define-obsolete-function-alias
  16874. 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
  16875. (defun org-speed-command-activate (keys)
  16876. "Hook for activating single-letter speed commands.
  16877. `org-speed-commands-default' specifies a minimal command set.
  16878. Use `org-speed-commands-user' for further customization."
  16879. (when (or (and (bolp) (looking-at org-outline-regexp))
  16880. (and (functionp org-use-speed-commands)
  16881. (funcall org-use-speed-commands)))
  16882. (cdr (assoc keys (append org-speed-commands-user
  16883. org-speed-commands-default)))))
  16884. (define-obsolete-function-alias
  16885. 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
  16886. (defun org-babel-speed-command-activate (keys)
  16887. "Hook for activating single-letter code block commands."
  16888. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  16889. (cdr (assoc keys org-babel-key-bindings))))
  16890. (defcustom org-speed-command-hook
  16891. '(org-speed-command-default-hook org-babel-speed-command-hook)
  16892. "Hook for activating speed commands at strategic locations.
  16893. Hook functions are called in sequence until a valid handler is
  16894. found.
  16895. Each hook takes a single argument, a user-pressed command key
  16896. which is also a `self-insert-command' from the global map.
  16897. Within the hook, examine the cursor position and the command key
  16898. and return nil or a valid handler as appropriate. Handler could
  16899. be one of an interactive command, a function, or a form.
  16900. Set `org-use-speed-commands' to non-nil value to enable this
  16901. hook. The default setting is `org-speed-command-activate'."
  16902. :group 'org-structure
  16903. :version "24.1"
  16904. :type 'hook)
  16905. (defun org-self-insert-command (N)
  16906. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  16907. If the cursor is in a table looking at whitespace, the whitespace is
  16908. overwritten, and the table is not marked as requiring realignment."
  16909. (interactive "p")
  16910. (org-check-before-invisible-edit 'insert)
  16911. (cond
  16912. ((and org-use-speed-commands
  16913. (setq org-speed-command
  16914. (run-hook-with-args-until-success
  16915. 'org-speed-command-hook (this-command-keys))))
  16916. (cond
  16917. ((commandp org-speed-command)
  16918. (setq this-command org-speed-command)
  16919. (call-interactively org-speed-command))
  16920. ((functionp org-speed-command)
  16921. (funcall org-speed-command))
  16922. ((and org-speed-command (listp org-speed-command))
  16923. (eval org-speed-command))
  16924. (t (let (org-use-speed-commands)
  16925. (call-interactively 'org-self-insert-command)))))
  16926. ((and
  16927. (org-table-p)
  16928. (progn
  16929. ;; check if we blank the field, and if that triggers align
  16930. (and (featurep 'org-table) org-table-auto-blank-field
  16931. (member last-command
  16932. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  16933. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  16934. ;; got extra space, this field does not determine column width
  16935. (let (org-table-may-need-update) (org-table-blank-field))
  16936. ;; no extra space, this field may determine column width
  16937. (org-table-blank-field)))
  16938. t)
  16939. (eq N 1)
  16940. (looking-at "[^|\n]* |"))
  16941. (let (org-table-may-need-update)
  16942. (goto-char (1- (match-end 0)))
  16943. (backward-delete-char 1)
  16944. (goto-char (match-beginning 0))
  16945. (self-insert-command N)))
  16946. (t
  16947. (setq org-table-may-need-update t)
  16948. (self-insert-command N)
  16949. (org-fix-tags-on-the-fly)
  16950. (if org-self-insert-cluster-for-undo
  16951. (if (not (eq last-command 'org-self-insert-command))
  16952. (setq org-self-insert-command-undo-counter 1)
  16953. (if (>= org-self-insert-command-undo-counter 20)
  16954. (setq org-self-insert-command-undo-counter 1)
  16955. (and (> org-self-insert-command-undo-counter 0)
  16956. buffer-undo-list (listp buffer-undo-list)
  16957. (not (cadr buffer-undo-list)) ; remove nil entry
  16958. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  16959. (setq org-self-insert-command-undo-counter
  16960. (1+ org-self-insert-command-undo-counter))))))))
  16961. (defun org-check-before-invisible-edit (kind)
  16962. "Check is editing if kind KIND would be dangerous with invisible text around.
  16963. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  16964. ;; First, try to get out of here as quickly as possible, to reduce overhead
  16965. (if (and org-catch-invisible-edits
  16966. (or (not (boundp 'visible-mode)) (not visible-mode))
  16967. (or (get-char-property (point) 'invisible)
  16968. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  16969. ;; OK, we need to take a closer look
  16970. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  16971. (invisible-before-point (if (bobp) nil (get-char-property
  16972. (1- (point)) 'invisible)))
  16973. (border-and-ok-direction
  16974. (or
  16975. ;; Check if we are acting predictably before invisible text
  16976. (and invisible-at-point (not invisible-before-point)
  16977. (memq kind '(insert delete-backward)))
  16978. ;; Check if we are acting predictably after invisible text
  16979. ;; This works not well, and I have turned it off. It seems
  16980. ;; better to always show and stop after invisible text.
  16981. ;; (and (not invisible-at-point) invisible-before-point
  16982. ;; (memq kind '(insert delete)))
  16983. )))
  16984. (when (or (memq invisible-at-point '(outline org-hide-block t))
  16985. (memq invisible-before-point '(outline org-hide-block t)))
  16986. (if (eq org-catch-invisible-edits 'error)
  16987. (error "Editing in invisible areas is prohibited - make visible first"))
  16988. (if (and org-custom-properties-overlays
  16989. (y-or-n-p "Display invisible properties in this buffer? "))
  16990. (org-toggle-custom-properties-visibility)
  16991. ;; Make the area visible
  16992. (save-excursion
  16993. (if invisible-before-point
  16994. (goto-char (previous-single-char-property-change
  16995. (point) 'invisible)))
  16996. (org-cycle))
  16997. (cond
  16998. ((eq org-catch-invisible-edits 'show)
  16999. ;; That's it, we do the edit after showing
  17000. (message
  17001. "Unfolding invisible region around point before editing")
  17002. (sit-for 1))
  17003. ((and (eq org-catch-invisible-edits 'smart)
  17004. border-and-ok-direction)
  17005. (message "Unfolding invisible region around point before editing"))
  17006. (t
  17007. ;; Don't do the edit, make the user repeat it in full visibility
  17008. (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  17009. (defun org-fix-tags-on-the-fly ()
  17010. (when (and (equal (char-after (point-at-bol)) ?*)
  17011. (org-at-heading-p))
  17012. (org-align-tags-here org-tags-column)))
  17013. (defun org-delete-backward-char (N)
  17014. "Like `delete-backward-char', insert whitespace at field end in tables.
  17015. When deleting backwards, in tables this function will insert whitespace in
  17016. front of the next \"|\" separator, to keep the table aligned. The table will
  17017. still be marked for re-alignment if the field did fill the entire column,
  17018. because, in this case the deletion might narrow the column."
  17019. (interactive "p")
  17020. (org-check-before-invisible-edit 'delete-backward)
  17021. (if (and (org-table-p)
  17022. (eq N 1)
  17023. (string-match "|" (buffer-substring (point-at-bol) (point)))
  17024. (looking-at ".*?|"))
  17025. (let ((pos (point))
  17026. (noalign (looking-at "[^|\n\r]* |"))
  17027. (c org-table-may-need-update))
  17028. (backward-delete-char N)
  17029. (if (not overwrite-mode)
  17030. (progn
  17031. (skip-chars-forward "^|")
  17032. (insert " ")
  17033. (goto-char (1- pos))))
  17034. ;; noalign: if there were two spaces at the end, this field
  17035. ;; does not determine the width of the column.
  17036. (if noalign (setq org-table-may-need-update c)))
  17037. (backward-delete-char N)
  17038. (org-fix-tags-on-the-fly)))
  17039. (defun org-delete-char (N)
  17040. "Like `delete-char', but insert whitespace at field end in tables.
  17041. When deleting characters, in tables this function will insert whitespace in
  17042. front of the next \"|\" separator, to keep the table aligned. The table will
  17043. still be marked for re-alignment if the field did fill the entire column,
  17044. because, in this case the deletion might narrow the column."
  17045. (interactive "p")
  17046. (org-check-before-invisible-edit 'delete)
  17047. (if (and (org-table-p)
  17048. (not (bolp))
  17049. (not (= (char-after) ?|))
  17050. (eq N 1))
  17051. (if (looking-at ".*?|")
  17052. (let ((pos (point))
  17053. (noalign (looking-at "[^|\n\r]* |"))
  17054. (c org-table-may-need-update))
  17055. (replace-match (concat
  17056. (substring (match-string 0) 1 -1)
  17057. " |"))
  17058. (goto-char pos)
  17059. ;; noalign: if there were two spaces at the end, this field
  17060. ;; does not determine the width of the column.
  17061. (if noalign (setq org-table-may-need-update c)))
  17062. (delete-char N))
  17063. (delete-char N)
  17064. (org-fix-tags-on-the-fly)))
  17065. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  17066. (put 'org-self-insert-command 'delete-selection t)
  17067. (put 'orgtbl-self-insert-command 'delete-selection t)
  17068. (put 'org-delete-char 'delete-selection 'supersede)
  17069. (put 'org-delete-backward-char 'delete-selection 'supersede)
  17070. (put 'org-yank 'delete-selection 'yank)
  17071. ;; Make `flyspell-mode' delay after some commands
  17072. (put 'org-self-insert-command 'flyspell-delayed t)
  17073. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  17074. (put 'org-delete-char 'flyspell-delayed t)
  17075. (put 'org-delete-backward-char 'flyspell-delayed t)
  17076. ;; Make pabbrev-mode expand after org-mode commands
  17077. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  17078. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  17079. ;; How to do this: Measure non-white length of current string
  17080. ;; If equal to column width, we should realign.
  17081. (defun org-remap (map &rest commands)
  17082. "In MAP, remap the functions given in COMMANDS.
  17083. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  17084. (let (new old)
  17085. (while commands
  17086. (setq old (pop commands) new (pop commands))
  17087. (if (fboundp 'command-remapping)
  17088. (org-defkey map (vector 'remap old) new)
  17089. (substitute-key-definition old new map global-map)))))
  17090. (when (eq org-enable-table-editor 'optimized)
  17091. ;; If the user wants maximum table support, we need to hijack
  17092. ;; some standard editing functions
  17093. (org-remap org-mode-map
  17094. 'self-insert-command 'org-self-insert-command
  17095. 'delete-char 'org-delete-char
  17096. 'delete-backward-char 'org-delete-backward-char)
  17097. (org-defkey org-mode-map "|" 'org-force-self-insert))
  17098. (defvar org-ctrl-c-ctrl-c-hook nil
  17099. "Hook for functions attaching themselves to `C-c C-c'.
  17100. This can be used to add additional functionality to the C-c C-c
  17101. key which executes context-dependent commands. This hook is run
  17102. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  17103. run after the last test.
  17104. Each function will be called with no arguments. The function
  17105. must check if the context is appropriate for it to act. If yes,
  17106. it should do its thing and then return a non-nil value. If the
  17107. context is wrong, just do nothing and return nil.")
  17108. (defvar org-ctrl-c-ctrl-c-final-hook nil
  17109. "Hook for functions attaching themselves to `C-c C-c'.
  17110. This can be used to add additional functionality to the C-c C-c
  17111. key which executes context-dependent commands. This hook is run
  17112. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  17113. before the first test.
  17114. Each function will be called with no arguments. The function
  17115. must check if the context is appropriate for it to act. If yes,
  17116. it should do its thing and then return a non-nil value. If the
  17117. context is wrong, just do nothing and return nil.")
  17118. (defvar org-tab-first-hook nil
  17119. "Hook for functions to attach themselves to TAB.
  17120. See `org-ctrl-c-ctrl-c-hook' for more information.
  17121. This hook runs as the first action when TAB is pressed, even before
  17122. `org-cycle' messes around with the `outline-regexp' to cater for
  17123. inline tasks and plain list item folding.
  17124. If any function in this hook returns t, any other actions that
  17125. would have been caused by TAB (such as table field motion or visibility
  17126. cycling) will not occur.")
  17127. (defvar org-tab-after-check-for-table-hook nil
  17128. "Hook for functions to attach themselves to TAB.
  17129. See `org-ctrl-c-ctrl-c-hook' for more information.
  17130. This hook runs after it has been established that the cursor is not in a
  17131. table, but before checking if the cursor is in a headline or if global cycling
  17132. should be done.
  17133. If any function in this hook returns t, not other actions like visibility
  17134. cycling will be done.")
  17135. (defvar org-tab-after-check-for-cycling-hook nil
  17136. "Hook for functions to attach themselves to TAB.
  17137. See `org-ctrl-c-ctrl-c-hook' for more information.
  17138. This hook runs after it has been established that not table field motion and
  17139. not visibility should be done because of current context. This is probably
  17140. the place where a package like yasnippets can hook in.")
  17141. (defvar org-tab-before-tab-emulation-hook nil
  17142. "Hook for functions to attach themselves to TAB.
  17143. See `org-ctrl-c-ctrl-c-hook' for more information.
  17144. This hook runs after every other options for TAB have been exhausted, but
  17145. before indentation and \t insertion takes place.")
  17146. (defvar org-metaleft-hook nil
  17147. "Hook for functions attaching themselves to `M-left'.
  17148. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17149. (defvar org-metaright-hook nil
  17150. "Hook for functions attaching themselves to `M-right'.
  17151. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17152. (defvar org-metaup-hook nil
  17153. "Hook for functions attaching themselves to `M-up'.
  17154. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17155. (defvar org-metadown-hook nil
  17156. "Hook for functions attaching themselves to `M-down'.
  17157. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17158. (defvar org-shiftmetaleft-hook nil
  17159. "Hook for functions attaching themselves to `M-S-left'.
  17160. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17161. (defvar org-shiftmetaright-hook nil
  17162. "Hook for functions attaching themselves to `M-S-right'.
  17163. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17164. (defvar org-shiftmetaup-hook nil
  17165. "Hook for functions attaching themselves to `M-S-up'.
  17166. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17167. (defvar org-shiftmetadown-hook nil
  17168. "Hook for functions attaching themselves to `M-S-down'.
  17169. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17170. (defvar org-metareturn-hook nil
  17171. "Hook for functions attaching themselves to `M-RET'.
  17172. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17173. (defvar org-shiftup-hook nil
  17174. "Hook for functions attaching themselves to `S-up'.
  17175. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17176. (defvar org-shiftup-final-hook nil
  17177. "Hook for functions attaching themselves to `S-up'.
  17178. This one runs after all other options except shift-select have been excluded.
  17179. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17180. (defvar org-shiftdown-hook nil
  17181. "Hook for functions attaching themselves to `S-down'.
  17182. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17183. (defvar org-shiftdown-final-hook nil
  17184. "Hook for functions attaching themselves to `S-down'.
  17185. This one runs after all other options except shift-select have been excluded.
  17186. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17187. (defvar org-shiftleft-hook nil
  17188. "Hook for functions attaching themselves to `S-left'.
  17189. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17190. (defvar org-shiftleft-final-hook nil
  17191. "Hook for functions attaching themselves to `S-left'.
  17192. This one runs after all other options except shift-select have been excluded.
  17193. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17194. (defvar org-shiftright-hook nil
  17195. "Hook for functions attaching themselves to `S-right'.
  17196. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17197. (defvar org-shiftright-final-hook nil
  17198. "Hook for functions attaching themselves to `S-right'.
  17199. This one runs after all other options except shift-select have been excluded.
  17200. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17201. (defun org-modifier-cursor-error ()
  17202. "Throw an error, a modified cursor command was applied in wrong context."
  17203. (error "This command is active in special context like tables, headlines or items"))
  17204. (defun org-shiftselect-error ()
  17205. "Throw an error because Shift-Cursor command was applied in wrong context."
  17206. (if (and (boundp 'shift-select-mode) shift-select-mode)
  17207. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  17208. (error "This command works only in special context like headlines or timestamps")))
  17209. (defun org-call-for-shift-select (cmd)
  17210. (let ((this-command-keys-shift-translated t))
  17211. (call-interactively cmd)))
  17212. (defun org-shifttab (&optional arg)
  17213. "Global visibility cycling or move to previous table field.
  17214. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  17215. on context.
  17216. See the individual commands for more information."
  17217. (interactive "P")
  17218. (cond
  17219. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  17220. ((integerp arg)
  17221. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  17222. (message "Content view to level: %d" arg)
  17223. (org-content (prefix-numeric-value arg2))
  17224. (setq org-cycle-global-status 'overview)))
  17225. (t (call-interactively 'org-global-cycle))))
  17226. (defun org-shiftmetaleft ()
  17227. "Promote subtree or delete table column.
  17228. Calls `org-promote-subtree', `org-outdent-item-tree', or
  17229. `org-table-delete-column', depending on context. See the
  17230. individual commands for more information."
  17231. (interactive)
  17232. (cond
  17233. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  17234. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  17235. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  17236. ((if (not (org-region-active-p)) (org-at-item-p)
  17237. (save-excursion (goto-char (region-beginning))
  17238. (org-at-item-p)))
  17239. (call-interactively 'org-outdent-item-tree))
  17240. (t (org-modifier-cursor-error))))
  17241. (defun org-shiftmetaright ()
  17242. "Demote subtree or insert table column.
  17243. Calls `org-demote-subtree', `org-indent-item-tree', or
  17244. `org-table-insert-column', depending on context. See the
  17245. individual commands for more information."
  17246. (interactive)
  17247. (cond
  17248. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  17249. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  17250. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  17251. ((if (not (org-region-active-p)) (org-at-item-p)
  17252. (save-excursion (goto-char (region-beginning))
  17253. (org-at-item-p)))
  17254. (call-interactively 'org-indent-item-tree))
  17255. (t (org-modifier-cursor-error))))
  17256. (defun org-shiftmetaup (&optional arg)
  17257. "Move subtree up or kill table row.
  17258. Calls `org-move-subtree-up' or `org-table-kill-row' or
  17259. `org-move-item-up' or `org-timestamp-up', depending on context.
  17260. See the individual commands for more information."
  17261. (interactive "P")
  17262. (cond
  17263. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  17264. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  17265. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17266. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17267. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17268. (call-interactively 'org-timestamp-up)))
  17269. (t (org-modifier-cursor-error))))
  17270. (defun org-shiftmetadown (&optional arg)
  17271. "Move subtree down or insert table row.
  17272. Calls `org-move-subtree-down' or `org-table-insert-row' or
  17273. `org-move-item-down' or `org-timestamp-up', depending on context.
  17274. See the individual commands for more information."
  17275. (interactive "P")
  17276. (cond
  17277. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  17278. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  17279. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17280. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17281. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17282. (call-interactively 'org-timestamp-down)))
  17283. (t (org-modifier-cursor-error))))
  17284. (defsubst org-hidden-tree-error ()
  17285. (error
  17286. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  17287. (defun org-metaleft (&optional arg)
  17288. "Promote heading or move table column to left.
  17289. Calls `org-do-promote' or `org-table-move-column', depending on context.
  17290. With no specific context, calls the Emacs default `backward-word'.
  17291. See the individual commands for more information."
  17292. (interactive "P")
  17293. (cond
  17294. ((run-hook-with-args-until-success 'org-metaleft-hook))
  17295. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  17296. ((org-with-limited-levels
  17297. (or (org-at-heading-p)
  17298. (and (org-region-active-p)
  17299. (save-excursion
  17300. (goto-char (region-beginning))
  17301. (org-at-heading-p)))))
  17302. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17303. (call-interactively 'org-do-promote))
  17304. ;; At an inline task.
  17305. ((org-at-heading-p)
  17306. (call-interactively 'org-inlinetask-promote))
  17307. ((or (org-at-item-p)
  17308. (and (org-region-active-p)
  17309. (save-excursion
  17310. (goto-char (region-beginning))
  17311. (org-at-item-p))))
  17312. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17313. (call-interactively 'org-outdent-item))
  17314. (t (call-interactively 'backward-word))))
  17315. (defun org-metaright (&optional arg)
  17316. "Demote a subtree, a list item or move table column to right.
  17317. In front of a drawer or a block keyword, indent it correctly.
  17318. With no specific context, calls the Emacs default `forward-word'.
  17319. See the individual commands for more information."
  17320. (interactive "P")
  17321. (cond
  17322. ((run-hook-with-args-until-success 'org-metaright-hook))
  17323. ((org-at-table-p) (call-interactively 'org-table-move-column))
  17324. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  17325. ((org-at-block-p) (call-interactively 'org-indent-block))
  17326. ((org-with-limited-levels
  17327. (or (org-at-heading-p)
  17328. (and (org-region-active-p)
  17329. (save-excursion
  17330. (goto-char (region-beginning))
  17331. (org-at-heading-p)))))
  17332. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17333. (call-interactively 'org-do-demote))
  17334. ;; At an inline task.
  17335. ((org-at-heading-p)
  17336. (call-interactively 'org-inlinetask-demote))
  17337. ((or (org-at-item-p)
  17338. (and (org-region-active-p)
  17339. (save-excursion
  17340. (goto-char (region-beginning))
  17341. (org-at-item-p))))
  17342. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17343. (call-interactively 'org-indent-item))
  17344. (t (call-interactively 'forward-word))))
  17345. (defun org-check-for-hidden (what)
  17346. "Check if there are hidden headlines/items in the current visual line.
  17347. WHAT can be either `headlines' or `items'. If the current line is
  17348. an outline or item heading and it has a folded subtree below it,
  17349. this function returns t, nil otherwise."
  17350. (let ((re (cond
  17351. ((eq what 'headlines) org-outline-regexp-bol)
  17352. ((eq what 'items) (org-item-beginning-re))
  17353. (t (error "This should not happen"))))
  17354. beg end)
  17355. (save-excursion
  17356. (catch 'exit
  17357. (unless (org-region-active-p)
  17358. (setq beg (point-at-bol))
  17359. (beginning-of-line 2)
  17360. (while (and (not (eobp)) ;; this is like `next-line'
  17361. (get-char-property (1- (point)) 'invisible))
  17362. (beginning-of-line 2))
  17363. (setq end (point))
  17364. (goto-char beg)
  17365. (goto-char (point-at-eol))
  17366. (setq end (max end (point)))
  17367. (while (re-search-forward re end t)
  17368. (if (get-char-property (match-beginning 0) 'invisible)
  17369. (throw 'exit t))))
  17370. nil))))
  17371. (autoload 'org-element-at-point "org-element")
  17372. (declare-function org-element-at-point "org-element" (&optional keep-trail))
  17373. (declare-function org-element-type "org-element" (element))
  17374. (declare-function org-element-context "org-element" ())
  17375. (declare-function org-element-contents "org-element" (element))
  17376. (declare-function org-element-property "org-element" (property element))
  17377. (declare-function org-element-paragraph-parser "org-element" (limit))
  17378. (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
  17379. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  17380. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  17381. (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
  17382. (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
  17383. (defun org-metaup (&optional arg)
  17384. "Move subtree up or move table row up.
  17385. Calls `org-move-subtree-up' or `org-table-move-row' or
  17386. `org-move-item-up', depending on context. See the individual commands
  17387. for more information."
  17388. (interactive "P")
  17389. (cond
  17390. ((run-hook-with-args-until-success 'org-metaup-hook))
  17391. ((org-region-active-p)
  17392. (let* ((a (min (region-beginning) (region-end)))
  17393. (b (1- (max (region-beginning) (region-end))))
  17394. (c (save-excursion (goto-char a)
  17395. (move-beginning-of-line 0)))
  17396. (d (save-excursion (goto-char a)
  17397. (move-end-of-line 0) (point))))
  17398. (transpose-regions a b c d)
  17399. (goto-char c)))
  17400. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  17401. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17402. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17403. (t (org-drag-element-backward))))
  17404. (defun org-metadown (&optional arg)
  17405. "Move subtree down or move table row down.
  17406. Calls `org-move-subtree-down' or `org-table-move-row' or
  17407. `org-move-item-down', depending on context. See the individual
  17408. commands for more information."
  17409. (interactive "P")
  17410. (cond
  17411. ((run-hook-with-args-until-success 'org-metadown-hook))
  17412. ((org-region-active-p)
  17413. (let* ((a (min (region-beginning) (region-end)))
  17414. (b (max (region-beginning) (region-end)))
  17415. (c (save-excursion (goto-char b)
  17416. (move-beginning-of-line 1)))
  17417. (d (save-excursion (goto-char b)
  17418. (move-end-of-line 1) (1+ (point)))))
  17419. (transpose-regions a b c d)
  17420. (goto-char d)))
  17421. ((org-at-table-p) (call-interactively 'org-table-move-row))
  17422. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17423. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17424. (t (org-drag-element-forward))))
  17425. (defun org-shiftup (&optional arg)
  17426. "Increase item in timestamp or increase priority of current headline.
  17427. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  17428. depending on context. See the individual commands for more information."
  17429. (interactive "P")
  17430. (cond
  17431. ((run-hook-with-args-until-success 'org-shiftup-hook))
  17432. ((and org-support-shift-select (org-region-active-p))
  17433. (org-call-for-shift-select 'previous-line))
  17434. ((org-at-timestamp-p t)
  17435. (call-interactively (if org-edit-timestamp-down-means-later
  17436. 'org-timestamp-down 'org-timestamp-up)))
  17437. ((and (not (eq org-support-shift-select 'always))
  17438. org-enable-priority-commands
  17439. (org-at-heading-p))
  17440. (call-interactively 'org-priority-up))
  17441. ((and (not org-support-shift-select) (org-at-item-p))
  17442. (call-interactively 'org-previous-item))
  17443. ((org-clocktable-try-shift 'up arg))
  17444. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  17445. (org-support-shift-select
  17446. (org-call-for-shift-select 'previous-line))
  17447. (t (org-shiftselect-error))))
  17448. (defun org-shiftdown (&optional arg)
  17449. "Decrease item in timestamp or decrease priority of current headline.
  17450. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  17451. depending on context. See the individual commands for more information."
  17452. (interactive "P")
  17453. (cond
  17454. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  17455. ((and org-support-shift-select (org-region-active-p))
  17456. (org-call-for-shift-select 'next-line))
  17457. ((org-at-timestamp-p t)
  17458. (call-interactively (if org-edit-timestamp-down-means-later
  17459. 'org-timestamp-up 'org-timestamp-down)))
  17460. ((and (not (eq org-support-shift-select 'always))
  17461. org-enable-priority-commands
  17462. (org-at-heading-p))
  17463. (call-interactively 'org-priority-down))
  17464. ((and (not org-support-shift-select) (org-at-item-p))
  17465. (call-interactively 'org-next-item))
  17466. ((org-clocktable-try-shift 'down arg))
  17467. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  17468. (org-support-shift-select
  17469. (org-call-for-shift-select 'next-line))
  17470. (t (org-shiftselect-error))))
  17471. (defun org-shiftright (&optional arg)
  17472. "Cycle the thing at point or in the current line, depending on context.
  17473. Depending on context, this does one of the following:
  17474. - switch a timestamp at point one day into the future
  17475. - on a headline, switch to the next TODO keyword.
  17476. - on an item, switch entire list to the next bullet type
  17477. - on a property line, switch to the next allowed value
  17478. - on a clocktable definition line, move time block into the future"
  17479. (interactive "P")
  17480. (cond
  17481. ((run-hook-with-args-until-success 'org-shiftright-hook))
  17482. ((and org-support-shift-select (org-region-active-p))
  17483. (org-call-for-shift-select 'forward-char))
  17484. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  17485. ((and (not (eq org-support-shift-select 'always))
  17486. (org-at-heading-p))
  17487. (let ((org-inhibit-logging
  17488. (not org-treat-S-cursor-todo-selection-as-state-change))
  17489. (org-inhibit-blocking
  17490. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17491. (org-call-with-arg 'org-todo 'right)))
  17492. ((or (and org-support-shift-select
  17493. (not (eq org-support-shift-select 'always))
  17494. (org-at-item-bullet-p))
  17495. (and (not org-support-shift-select) (org-at-item-p)))
  17496. (org-call-with-arg 'org-cycle-list-bullet nil))
  17497. ((and (not (eq org-support-shift-select 'always))
  17498. (org-at-property-p))
  17499. (call-interactively 'org-property-next-allowed-value))
  17500. ((org-clocktable-try-shift 'right arg))
  17501. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  17502. (org-support-shift-select
  17503. (org-call-for-shift-select 'forward-char))
  17504. (t (org-shiftselect-error))))
  17505. (defun org-shiftleft (&optional arg)
  17506. "Cycle the thing at point or in the current line, depending on context.
  17507. Depending on context, this does one of the following:
  17508. - switch a timestamp at point one day into the past
  17509. - on a headline, switch to the previous TODO keyword.
  17510. - on an item, switch entire list to the previous bullet type
  17511. - on a property line, switch to the previous allowed value
  17512. - on a clocktable definition line, move time block into the past"
  17513. (interactive "P")
  17514. (cond
  17515. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  17516. ((and org-support-shift-select (org-region-active-p))
  17517. (org-call-for-shift-select 'backward-char))
  17518. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  17519. ((and (not (eq org-support-shift-select 'always))
  17520. (org-at-heading-p))
  17521. (let ((org-inhibit-logging
  17522. (not org-treat-S-cursor-todo-selection-as-state-change))
  17523. (org-inhibit-blocking
  17524. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17525. (org-call-with-arg 'org-todo 'left)))
  17526. ((or (and org-support-shift-select
  17527. (not (eq org-support-shift-select 'always))
  17528. (org-at-item-bullet-p))
  17529. (and (not org-support-shift-select) (org-at-item-p)))
  17530. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  17531. ((and (not (eq org-support-shift-select 'always))
  17532. (org-at-property-p))
  17533. (call-interactively 'org-property-previous-allowed-value))
  17534. ((org-clocktable-try-shift 'left arg))
  17535. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  17536. (org-support-shift-select
  17537. (org-call-for-shift-select 'backward-char))
  17538. (t (org-shiftselect-error))))
  17539. (defun org-shiftcontrolright ()
  17540. "Switch to next TODO set."
  17541. (interactive)
  17542. (cond
  17543. ((and org-support-shift-select (org-region-active-p))
  17544. (org-call-for-shift-select 'forward-word))
  17545. ((and (not (eq org-support-shift-select 'always))
  17546. (org-at-heading-p))
  17547. (org-call-with-arg 'org-todo 'nextset))
  17548. (org-support-shift-select
  17549. (org-call-for-shift-select 'forward-word))
  17550. (t (org-shiftselect-error))))
  17551. (defun org-shiftcontrolleft ()
  17552. "Switch to previous TODO set."
  17553. (interactive)
  17554. (cond
  17555. ((and org-support-shift-select (org-region-active-p))
  17556. (org-call-for-shift-select 'backward-word))
  17557. ((and (not (eq org-support-shift-select 'always))
  17558. (org-at-heading-p))
  17559. (org-call-with-arg 'org-todo 'previousset))
  17560. (org-support-shift-select
  17561. (org-call-for-shift-select 'backward-word))
  17562. (t (org-shiftselect-error))))
  17563. (defun org-shiftcontrolup ()
  17564. "Change timestamps synchronously up in CLOCK log lines."
  17565. (interactive)
  17566. (cond ((and (not org-support-shift-select)
  17567. (org-at-clock-log-p)
  17568. (org-at-timestamp-p t))
  17569. (org-clock-timestamps-up))
  17570. (t (org-shiftselect-error))))
  17571. (defun org-shiftcontroldown ()
  17572. "Change timestamps synchronously down in CLOCK log lines."
  17573. (interactive)
  17574. (cond ((and (not org-support-shift-select)
  17575. (org-at-clock-log-p)
  17576. (org-at-timestamp-p t))
  17577. (org-clock-timestamps-down))
  17578. (t (org-shiftselect-error))))
  17579. (defun org-ctrl-c-ret ()
  17580. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  17581. (interactive)
  17582. (cond
  17583. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  17584. (t (call-interactively 'org-insert-heading))))
  17585. (defun org-find-visible ()
  17586. (let ((s (point)))
  17587. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17588. (get-char-property s 'invisible)))
  17589. s))
  17590. (defun org-find-invisible ()
  17591. (let ((s (point)))
  17592. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17593. (not (get-char-property s 'invisible))))
  17594. s))
  17595. (defun org-copy-visible (beg end)
  17596. "Copy the visible parts of the region."
  17597. (interactive "r")
  17598. (let (snippets s)
  17599. (save-excursion
  17600. (save-restriction
  17601. (narrow-to-region beg end)
  17602. (setq s (goto-char (point-min)))
  17603. (while (not (= (point) (point-max)))
  17604. (goto-char (org-find-invisible))
  17605. (push (buffer-substring s (point)) snippets)
  17606. (setq s (goto-char (org-find-visible))))))
  17607. (kill-new (apply 'concat (nreverse snippets)))))
  17608. (defun org-copy-special ()
  17609. "Copy region in table or copy current subtree.
  17610. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  17611. See the individual commands for more information."
  17612. (interactive)
  17613. (call-interactively
  17614. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  17615. (defun org-cut-special ()
  17616. "Cut region in table or cut current subtree.
  17617. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  17618. See the individual commands for more information."
  17619. (interactive)
  17620. (call-interactively
  17621. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  17622. (defun org-paste-special (arg)
  17623. "Paste rectangular region into table, or past subtree relative to level.
  17624. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  17625. See the individual commands for more information."
  17626. (interactive "P")
  17627. (if (org-at-table-p)
  17628. (org-table-paste-rectangle)
  17629. (org-paste-subtree arg)))
  17630. (defun org-edit-special (&optional arg)
  17631. "Call a special editor for the stuff at point.
  17632. When at a table, call the formula editor with `org-table-edit-formulas'.
  17633. When at the first line of an src example, call `org-edit-src-code'.
  17634. When in an #+include line, visit the include file. Otherwise call
  17635. `ffap' to visit the file at point."
  17636. (interactive)
  17637. ;; possibly prep session before editing source
  17638. (when arg
  17639. (let* ((info (org-babel-get-src-block-info))
  17640. (lang (nth 0 info))
  17641. (params (nth 2 info))
  17642. (session (cdr (assoc :session params))))
  17643. (when (and info session) ;; we are in a source-code block with a session
  17644. (funcall
  17645. (intern (concat "org-babel-prep-session:" lang)) session params))))
  17646. (cond ;; proceed with `org-edit-special'
  17647. ((save-excursion
  17648. (beginning-of-line 1)
  17649. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  17650. (find-file (org-trim (match-string 1))))
  17651. ((org-edit-src-code))
  17652. ((org-edit-fixed-width-region))
  17653. ((org-at-table.el-p)
  17654. (org-edit-src-code))
  17655. ((or (org-at-table-p)
  17656. (save-excursion
  17657. (beginning-of-line 1)
  17658. (let ((case-fold-search )) (looking-at "[ \t]*#\\+tblfm:"))))
  17659. (call-interactively 'org-table-edit-formulas))
  17660. (t (call-interactively 'ffap))))
  17661. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  17662. (defun org-ctrl-c-ctrl-c (&optional arg)
  17663. "Set tags in headline, or update according to changed information at point.
  17664. This command does many different things, depending on context:
  17665. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  17666. this is what we do.
  17667. - If the cursor is on a statistics cookie, update it.
  17668. - If the cursor is in a headline, prompt for tags and insert them
  17669. into the current line, aligned to `org-tags-column'. When called
  17670. with prefix arg, realign all tags in the current buffer.
  17671. - If the cursor is in one of the special #+KEYWORD lines, this
  17672. triggers scanning the buffer for these lines and updating the
  17673. information.
  17674. - If the cursor is inside a table, realign the table. This command
  17675. works even if the automatic table editor has been turned off.
  17676. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  17677. the entire table.
  17678. - If the cursor is at a footnote reference or definition, jump to
  17679. the corresponding definition or references, respectively.
  17680. - If the cursor is a the beginning of a dynamic block, update it.
  17681. - If the current buffer is a capture buffer, close note and file it.
  17682. - If the cursor is on a <<<target>>>, update radio targets and
  17683. corresponding links in this buffer.
  17684. - If the cursor is on a numbered item in a plain list, renumber the
  17685. ordered list.
  17686. - If the cursor is on a checkbox, toggle it.
  17687. - If the cursor is on a code block, evaluate it. The variable
  17688. `org-confirm-babel-evaluate' can be used to control prompting
  17689. before code block evaluation, by default every code block
  17690. evaluation requires confirmation. Code block evaluation can be
  17691. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  17692. (interactive "P")
  17693. (let ((org-enable-table-editor t))
  17694. (cond
  17695. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  17696. org-occur-highlights
  17697. org-latex-fragment-image-overlays)
  17698. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  17699. (org-remove-occur-highlights)
  17700. (org-remove-latex-fragment-image-overlays)
  17701. (message "Temporary highlights/overlays removed from current buffer"))
  17702. ((and (local-variable-p 'org-finish-function (current-buffer))
  17703. (fboundp org-finish-function))
  17704. (funcall org-finish-function))
  17705. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  17706. ((org-in-regexp org-ts-regexp-both)
  17707. (org-timestamp-change 0 'day))
  17708. ((or (looking-at org-property-start-re)
  17709. (org-at-property-p))
  17710. (call-interactively 'org-property-action))
  17711. ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
  17712. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  17713. (or (org-at-heading-p) (org-at-item-p)))
  17714. (call-interactively 'org-update-statistics-cookies))
  17715. ((org-at-heading-p) (call-interactively 'org-set-tags))
  17716. ((org-at-table.el-p)
  17717. (message "Use C-c ' to edit table.el tables"))
  17718. ((org-at-table-p)
  17719. (org-table-maybe-eval-formula)
  17720. (if arg
  17721. (call-interactively 'org-table-recalculate)
  17722. (org-table-maybe-recalculate-line))
  17723. (call-interactively 'org-table-align)
  17724. (orgtbl-send-table 'maybe))
  17725. ((or (org-footnote-at-reference-p)
  17726. (org-footnote-at-definition-p))
  17727. (call-interactively 'org-footnote-action))
  17728. ((org-at-item-checkbox-p)
  17729. ;; Cursor at a checkbox: repair list and update checkboxes. Send
  17730. ;; list only if at top item.
  17731. (let* ((cbox (match-string 1))
  17732. (struct (org-list-struct))
  17733. (old-struct (copy-tree struct))
  17734. (parents (org-list-parents-alist struct))
  17735. (orderedp (org-entry-get nil "ORDERED"))
  17736. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17737. block-item)
  17738. ;; Use a light version of `org-toggle-checkbox' to avoid
  17739. ;; computing list structure twice.
  17740. (let ((new-box (cond
  17741. ((equal arg '(16)) "[-]")
  17742. ((equal arg '(4)) nil)
  17743. ((equal "[X]" cbox) "[ ]")
  17744. (t "[X]"))))
  17745. (if (and firstp arg)
  17746. ;; If at first item of sub-list, remove check-box from
  17747. ;; every item at the same level.
  17748. (mapc
  17749. (lambda (pos) (org-list-set-checkbox pos struct new-box))
  17750. (org-list-get-all-items
  17751. (point-at-bol) struct (org-list-prevs-alist struct)))
  17752. (org-list-set-checkbox (point-at-bol) struct new-box)))
  17753. ;; Replicate `org-list-write-struct', while grabbing a return
  17754. ;; value from `org-list-struct-fix-box'.
  17755. (org-list-struct-fix-ind struct parents 2)
  17756. (org-list-struct-fix-item-end struct)
  17757. (let ((prevs (org-list-prevs-alist struct)))
  17758. (org-list-struct-fix-bul struct prevs)
  17759. (org-list-struct-fix-ind struct parents)
  17760. (setq block-item
  17761. (org-list-struct-fix-box struct parents prevs orderedp)))
  17762. (org-list-struct-apply-struct struct old-struct)
  17763. (org-update-checkbox-count-maybe)
  17764. (when block-item
  17765. (message
  17766. "Checkboxes were removed due to unchecked box at line %d"
  17767. (org-current-line block-item)))
  17768. (when firstp (org-list-send-list 'maybe))))
  17769. ((org-at-item-p)
  17770. ;; Cursor at an item: repair list. Do checkbox related actions
  17771. ;; only if function was called with an argument. Send list only
  17772. ;; if at top item.
  17773. (let* ((struct (org-list-struct))
  17774. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17775. old-struct)
  17776. (when arg
  17777. (setq old-struct (copy-tree struct))
  17778. (if firstp
  17779. ;; If at first item of sub-list, add check-box to every
  17780. ;; item at the same level.
  17781. (mapc
  17782. (lambda (pos)
  17783. (unless (org-list-get-checkbox pos struct)
  17784. (org-list-set-checkbox pos struct "[ ]")))
  17785. (org-list-get-all-items
  17786. (point-at-bol) struct (org-list-prevs-alist struct)))
  17787. (org-list-set-checkbox (point-at-bol) struct "[ ]")))
  17788. (org-list-write-struct
  17789. struct (org-list-parents-alist struct) old-struct)
  17790. (when arg (org-update-checkbox-count-maybe))
  17791. (when firstp (org-list-send-list 'maybe))))
  17792. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  17793. ;; Dynamic block
  17794. (beginning-of-line 1)
  17795. (save-excursion (org-update-dblock)))
  17796. ((save-excursion
  17797. (let ((case-fold-search t))
  17798. (beginning-of-line 1)
  17799. (looking-at "[ \t]*#\\+\\([a-z]+\\)")))
  17800. (cond
  17801. ((or (equal (match-string 1) "TBLFM")
  17802. (equal (match-string 1) "tblfm"))
  17803. ;; Recalculate the table before this line
  17804. (save-excursion
  17805. (beginning-of-line 1)
  17806. (skip-chars-backward " \r\n\t")
  17807. (if (org-at-table-p)
  17808. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  17809. (t
  17810. (let ((org-inhibit-startup-visibility-stuff t)
  17811. (org-startup-align-all-tables nil))
  17812. (when (boundp 'org-table-coordinate-overlays)
  17813. (mapc 'delete-overlay org-table-coordinate-overlays)
  17814. (setq org-table-coordinate-overlays nil))
  17815. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  17816. (message "Local setup has been refreshed"))))
  17817. ((org-clock-update-time-maybe))
  17818. (t
  17819. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  17820. (error "C-c C-c can do nothing useful at this location"))))))
  17821. (defun org-mode-restart ()
  17822. "Restart Org-mode, to scan again for special lines.
  17823. Also updates the keyword regular expressions."
  17824. (interactive)
  17825. (org-mode)
  17826. (message "Org-mode restarted"))
  17827. (defun org-kill-note-or-show-branches ()
  17828. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  17829. (interactive)
  17830. (if (not org-finish-function)
  17831. (progn
  17832. (hide-subtree)
  17833. (call-interactively 'show-branches))
  17834. (let ((org-note-abort t))
  17835. (funcall org-finish-function))))
  17836. (defun org-return (&optional indent)
  17837. "Goto next table row or insert a newline.
  17838. Calls `org-table-next-row' or `newline', depending on context.
  17839. See the individual commands for more information."
  17840. (interactive)
  17841. (let (org-ts-what)
  17842. (cond
  17843. ((or (bobp) (org-in-src-block-p))
  17844. (if indent (newline-and-indent) (newline)))
  17845. ((org-at-table-p)
  17846. (org-table-justify-field-maybe)
  17847. (call-interactively 'org-table-next-row))
  17848. ;; when `newline-and-indent' is called within a list, make sure
  17849. ;; text moved stays inside the item.
  17850. ((and (org-in-item-p) indent)
  17851. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  17852. (progn
  17853. (save-match-data (newline))
  17854. (org-indent-line-to (length (match-string 0))))
  17855. (let ((ind (org-get-indentation)))
  17856. (newline)
  17857. (if (org-looking-back org-list-end-re)
  17858. (org-indent-line)
  17859. (org-indent-line-to ind)))))
  17860. ((and org-return-follows-link
  17861. (org-at-timestamp-p t)
  17862. (not (eq org-ts-what 'after)))
  17863. (org-follow-timestamp-link))
  17864. ((and org-return-follows-link
  17865. (let ((tprop (get-text-property (point) 'face)))
  17866. (or (eq tprop 'org-link)
  17867. (and (listp tprop) (memq 'org-link tprop)))))
  17868. (call-interactively 'org-open-at-point))
  17869. ((and (org-at-heading-p)
  17870. (looking-at
  17871. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  17872. (org-show-entry)
  17873. (end-of-line 1)
  17874. (newline))
  17875. (t (if indent (newline-and-indent) (newline))))))
  17876. (defun org-return-indent ()
  17877. "Goto next table row or insert a newline and indent.
  17878. Calls `org-table-next-row' or `newline-and-indent', depending on
  17879. context. See the individual commands for more information."
  17880. (interactive)
  17881. (org-return t))
  17882. (defun org-ctrl-c-star ()
  17883. "Compute table, or change heading status of lines.
  17884. Calls `org-table-recalculate' or `org-toggle-heading',
  17885. depending on context."
  17886. (interactive)
  17887. (cond
  17888. ((org-at-table-p)
  17889. (call-interactively 'org-table-recalculate))
  17890. (t
  17891. ;; Convert all lines in region to list items
  17892. (call-interactively 'org-toggle-heading))))
  17893. (defun org-ctrl-c-minus ()
  17894. "Insert separator line in table or modify bullet status of line.
  17895. Also turns a plain line or a region of lines into list items.
  17896. Calls `org-table-insert-hline', `org-toggle-item', or
  17897. `org-cycle-list-bullet', depending on context."
  17898. (interactive)
  17899. (cond
  17900. ((org-at-table-p)
  17901. (call-interactively 'org-table-insert-hline))
  17902. ((org-region-active-p)
  17903. (call-interactively 'org-toggle-item))
  17904. ((org-in-item-p)
  17905. (call-interactively 'org-cycle-list-bullet))
  17906. (t
  17907. (call-interactively 'org-toggle-item))))
  17908. (defun org-toggle-item (arg)
  17909. "Convert headings or normal lines to items, items to normal lines.
  17910. If there is no active region, only the current line is considered.
  17911. If the first non blank line in the region is an headline, convert
  17912. all headlines to items, shifting text accordingly.
  17913. If it is an item, convert all items to normal lines.
  17914. If it is normal text, change region into an item. With a prefix
  17915. argument ARG, change each line in region into an item."
  17916. (interactive "P")
  17917. (let ((shift-text
  17918. (function
  17919. ;; Shift text in current section to IND, from point to END.
  17920. ;; The function leaves point to END line.
  17921. (lambda (ind end)
  17922. (let ((min-i 1000) (end (copy-marker end)))
  17923. ;; First determine the minimum indentation (MIN-I) of
  17924. ;; the text.
  17925. (save-excursion
  17926. (catch 'exit
  17927. (while (< (point) end)
  17928. (let ((i (org-get-indentation)))
  17929. (cond
  17930. ;; Skip blank lines and inline tasks.
  17931. ((looking-at "^[ \t]*$"))
  17932. ((looking-at org-outline-regexp-bol))
  17933. ;; We can't find less than 0 indentation.
  17934. ((zerop i) (throw 'exit (setq min-i 0)))
  17935. ((< i min-i) (setq min-i i))))
  17936. (forward-line))))
  17937. ;; Then indent each line so that a line indented to
  17938. ;; MIN-I becomes indented to IND. Ignore blank lines
  17939. ;; and inline tasks in the process.
  17940. (let ((delta (- ind min-i)))
  17941. (while (< (point) end)
  17942. (unless (or (looking-at "^[ \t]*$")
  17943. (looking-at org-outline-regexp-bol))
  17944. (org-indent-line-to (+ (org-get-indentation) delta)))
  17945. (forward-line)))))))
  17946. (skip-blanks
  17947. (function
  17948. ;; Return beginning of first non-blank line, starting from
  17949. ;; line at POS.
  17950. (lambda (pos)
  17951. (save-excursion
  17952. (goto-char pos)
  17953. (skip-chars-forward " \r\t\n")
  17954. (point-at-bol)))))
  17955. beg end)
  17956. ;; Determine boundaries of changes.
  17957. (if (org-region-active-p)
  17958. (setq beg (funcall skip-blanks (region-beginning))
  17959. end (copy-marker (region-end)))
  17960. (setq beg (funcall skip-blanks (point-at-bol))
  17961. end (copy-marker (point-at-eol))))
  17962. ;; Depending on the starting line, choose an action on the text
  17963. ;; between BEG and END.
  17964. (org-with-limited-levels
  17965. (save-excursion
  17966. (goto-char beg)
  17967. (cond
  17968. ;; Case 1. Start at an item: de-itemize. Note that it only
  17969. ;; happens when a region is active: `org-ctrl-c-minus'
  17970. ;; would call `org-cycle-list-bullet' otherwise.
  17971. ((org-at-item-p)
  17972. (while (< (point) end)
  17973. (when (org-at-item-p)
  17974. (skip-chars-forward " \t")
  17975. (delete-region (point) (match-end 0)))
  17976. (forward-line)))
  17977. ;; Case 2. Start at an heading: convert to items.
  17978. ((org-at-heading-p)
  17979. (let* ((bul (org-list-bullet-string "-"))
  17980. (bul-len (length bul))
  17981. ;; Indentation of the first heading. It should be
  17982. ;; relative to the indentation of its parent, if any.
  17983. (start-ind (save-excursion
  17984. (cond
  17985. ((not org-adapt-indentation) 0)
  17986. ((not (outline-previous-heading)) 0)
  17987. (t (length (match-string 0))))))
  17988. ;; Level of first heading. Further headings will be
  17989. ;; compared to it to determine hierarchy in the list.
  17990. (ref-level (org-reduced-level (org-outline-level))))
  17991. (while (< (point) end)
  17992. (let* ((level (org-reduced-level (org-outline-level)))
  17993. (delta (max 0 (- level ref-level))))
  17994. ;; If current headline is less indented than the first
  17995. ;; one, set it as reference, in order to preserve
  17996. ;; subtrees.
  17997. (when (< level ref-level) (setq ref-level level))
  17998. (replace-match bul t t)
  17999. (org-indent-line-to (+ start-ind (* delta bul-len)))
  18000. ;; Ensure all text down to END (or SECTION-END) belongs
  18001. ;; to the newly created item.
  18002. (let ((section-end (save-excursion
  18003. (or (outline-next-heading) (point)))))
  18004. (forward-line)
  18005. (funcall shift-text
  18006. (+ start-ind (* (1+ delta) bul-len))
  18007. (min end section-end)))))))
  18008. ;; Case 3. Normal line with ARG: turn each non-item line into
  18009. ;; an item.
  18010. (arg
  18011. (while (< (point) end)
  18012. (unless (or (org-at-heading-p) (org-at-item-p))
  18013. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  18014. (replace-match
  18015. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  18016. (forward-line)))
  18017. ;; Case 4. Normal line without ARG: make the first line of
  18018. ;; region an item, and shift indentation of others
  18019. ;; lines to set them as item's body.
  18020. (t (let* ((bul (org-list-bullet-string "-"))
  18021. (bul-len (length bul))
  18022. (ref-ind (org-get-indentation)))
  18023. (skip-chars-forward " \t")
  18024. (insert bul)
  18025. (forward-line)
  18026. (while (< (point) end)
  18027. ;; Ensure that lines less indented than first one
  18028. ;; still get included in item body.
  18029. (funcall shift-text
  18030. (+ ref-ind bul-len)
  18031. (min end (save-excursion (or (outline-next-heading)
  18032. (point)))))
  18033. (forward-line)))))))))
  18034. (defun org-toggle-heading (&optional nstars)
  18035. "Convert headings to normal text, or items or text to headings.
  18036. If there is no active region, only the current line is considered.
  18037. With a \\[universal-argument] prefix, convert the whole list at
  18038. point into heading.
  18039. In a region:
  18040. - If the first non blank line is an headline, remove the stars
  18041. from all headlines in the region.
  18042. - If it is a normal line turn each and every normal line (i.e. not an
  18043. heading or an item) in the region into a heading.
  18044. - If it is a plain list item, turn all plain list items into headings.
  18045. When converting a line into a heading, the number of stars is chosen
  18046. such that the lines become children of the current entry. However,
  18047. when a prefix argument is given, its value determines the number of
  18048. stars to add."
  18049. (interactive "P")
  18050. (let ((skip-blanks
  18051. (function
  18052. ;; Return beginning of first non-blank line, starting from
  18053. ;; line at POS.
  18054. (lambda (pos)
  18055. (save-excursion
  18056. (goto-char pos)
  18057. (while (org-at-comment-p) (forward-line))
  18058. (skip-chars-forward " \r\t\n")
  18059. (point-at-bol)))))
  18060. beg end toggled)
  18061. ;; Determine boundaries of changes. If a universal prefix has
  18062. ;; been given, put the list in a region. If region ends at a bol,
  18063. ;; do not consider the last line to be in the region.
  18064. (when (and current-prefix-arg (org-at-item-p))
  18065. (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
  18066. (org-mark-element))
  18067. (if (org-region-active-p)
  18068. (setq beg (funcall skip-blanks (region-beginning))
  18069. end (copy-marker (save-excursion
  18070. (goto-char (region-end))
  18071. (if (bolp) (point) (point-at-eol)))))
  18072. (setq beg (funcall skip-blanks (point-at-bol))
  18073. end (copy-marker (point-at-eol))))
  18074. ;; Ensure inline tasks don't count as headings.
  18075. (org-with-limited-levels
  18076. (save-excursion
  18077. (goto-char beg)
  18078. (cond
  18079. ;; Case 1. Started at an heading: de-star headings.
  18080. ((org-at-heading-p)
  18081. (while (< (point) end)
  18082. (when (org-at-heading-p t)
  18083. (looking-at org-outline-regexp) (replace-match "")
  18084. (setq toggled t))
  18085. (forward-line)))
  18086. ;; Case 2. Started at an item: change items into headlines.
  18087. ;; One star will be added by `org-list-to-subtree'.
  18088. ((org-at-item-p)
  18089. (let* ((stars (make-string
  18090. (if nstars
  18091. ;; subtract the star that will be added again by
  18092. ;; `org-list-to-subtree'
  18093. (1- (prefix-numeric-value current-prefix-arg))
  18094. (or (org-current-level) 0))
  18095. ?*))
  18096. (add-stars
  18097. (cond (nstars "") ; stars from prefix only
  18098. ((equal stars "") "") ; before first heading
  18099. (org-odd-levels-only "*") ; inside heading, odd
  18100. (t "")))) ; inside heading, oddeven
  18101. (while (< (point) end)
  18102. (when (org-at-item-p)
  18103. ;; Pay attention to cases when region ends before list.
  18104. (let* ((struct (org-list-struct))
  18105. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  18106. (save-restriction
  18107. (narrow-to-region (point) list-end)
  18108. (insert
  18109. (org-list-to-subtree
  18110. (org-list-parse-list t)
  18111. '(:istart (concat stars add-stars (funcall get-stars depth))
  18112. :icount (concat stars add-stars (funcall get-stars depth)))))))
  18113. (setq toggled t))
  18114. (forward-line))))
  18115. ;; Case 3. Started at normal text: make every line an heading,
  18116. ;; skipping headlines and items.
  18117. (t (let* ((stars (make-string
  18118. (if nstars
  18119. (prefix-numeric-value current-prefix-arg)
  18120. (or (org-current-level) 0))
  18121. ?*))
  18122. (add-stars
  18123. (cond (nstars "") ; stars from prefix only
  18124. ((equal stars "") "*") ; before first heading
  18125. (org-odd-levels-only "**") ; inside heading, odd
  18126. (t "*"))) ; inside heading, oddeven
  18127. (rpl (concat stars add-stars " ")))
  18128. (while (< (point) end)
  18129. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  18130. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  18131. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  18132. (forward-line)))))))
  18133. (unless toggled (message "Cannot toggle heading from here"))))
  18134. (defun org-meta-return (&optional arg)
  18135. "Insert a new heading or wrap a region in a table.
  18136. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  18137. See the individual commands for more information."
  18138. (interactive "P")
  18139. (cond
  18140. ((run-hook-with-args-until-success 'org-metareturn-hook))
  18141. ((or (org-at-drawer-p) (org-at-property-p))
  18142. (newline-and-indent))
  18143. ((org-at-table-p)
  18144. (call-interactively 'org-table-wrap-region))
  18145. (t (call-interactively 'org-insert-heading))))
  18146. ;;; Menu entries
  18147. (defsubst org-in-subtree-not-table-p ()
  18148. "Are we in a subtree and not in a table?"
  18149. (and (not (org-before-first-heading-p))
  18150. (not (org-at-table-p))))
  18151. ;; Define the Org-mode menus
  18152. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  18153. '("Tbl"
  18154. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  18155. ["Next Field" org-cycle (org-at-table-p)]
  18156. ["Previous Field" org-shifttab (org-at-table-p)]
  18157. ["Next Row" org-return (org-at-table-p)]
  18158. "--"
  18159. ["Blank Field" org-table-blank-field (org-at-table-p)]
  18160. ["Edit Field" org-table-edit-field (org-at-table-p)]
  18161. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  18162. "--"
  18163. ("Column"
  18164. ["Move Column Left" org-metaleft (org-at-table-p)]
  18165. ["Move Column Right" org-metaright (org-at-table-p)]
  18166. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  18167. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  18168. ("Row"
  18169. ["Move Row Up" org-metaup (org-at-table-p)]
  18170. ["Move Row Down" org-metadown (org-at-table-p)]
  18171. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  18172. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  18173. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  18174. "--"
  18175. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  18176. ("Rectangle"
  18177. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  18178. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  18179. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  18180. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  18181. "--"
  18182. ("Calculate"
  18183. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  18184. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  18185. ["Edit Formulas" org-edit-special (org-at-table-p)]
  18186. "--"
  18187. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  18188. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  18189. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  18190. "--"
  18191. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  18192. "--"
  18193. ["Sum Column/Rectangle" org-table-sum
  18194. (or (org-at-table-p) (org-region-active-p))]
  18195. ["Which Column?" org-table-current-column (org-at-table-p)])
  18196. ["Debug Formulas"
  18197. org-table-toggle-formula-debugger
  18198. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  18199. ["Show Col/Row Numbers"
  18200. org-table-toggle-coordinate-overlays
  18201. :style toggle
  18202. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  18203. "--"
  18204. ["Create" org-table-create (and (not (org-at-table-p))
  18205. org-enable-table-editor)]
  18206. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  18207. ["Import from File" org-table-import (not (org-at-table-p))]
  18208. ["Export to File" org-table-export (org-at-table-p)]
  18209. "--"
  18210. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  18211. (easy-menu-define org-org-menu org-mode-map "Org menu"
  18212. '("Org"
  18213. ("Show/Hide"
  18214. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  18215. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  18216. ["Sparse Tree..." org-sparse-tree t]
  18217. ["Reveal Context" org-reveal t]
  18218. ["Show All" show-all t]
  18219. "--"
  18220. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  18221. "--"
  18222. ["New Heading" org-insert-heading t]
  18223. ("Navigate Headings"
  18224. ["Up" outline-up-heading t]
  18225. ["Next" outline-next-visible-heading t]
  18226. ["Previous" outline-previous-visible-heading t]
  18227. ["Next Same Level" outline-forward-same-level t]
  18228. ["Previous Same Level" outline-backward-same-level t]
  18229. "--"
  18230. ["Jump" org-goto t])
  18231. ("Edit Structure"
  18232. ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
  18233. "--"
  18234. ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
  18235. ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
  18236. "--"
  18237. ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
  18238. ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
  18239. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  18240. "--"
  18241. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  18242. "--"
  18243. ["Copy visible text" org-copy-visible t]
  18244. "--"
  18245. ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
  18246. ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
  18247. ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
  18248. ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
  18249. "--"
  18250. ["Sort Region/Children" org-sort t]
  18251. "--"
  18252. ["Convert to odd levels" org-convert-to-odd-levels t]
  18253. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  18254. ("Editing"
  18255. ["Emphasis..." org-emphasize t]
  18256. ["Edit Source Example" org-edit-special t]
  18257. "--"
  18258. ["Footnote new/jump" org-footnote-action t]
  18259. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  18260. ("Archive"
  18261. ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
  18262. "--"
  18263. ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
  18264. ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
  18265. ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
  18266. )
  18267. "--"
  18268. ("Hyperlinks"
  18269. ["Store Link (Global)" org-store-link t]
  18270. ["Find existing link to here" org-occur-link-in-agenda-files t]
  18271. ["Insert Link" org-insert-link t]
  18272. ["Follow Link" org-open-at-point t]
  18273. "--"
  18274. ["Next link" org-next-link t]
  18275. ["Previous link" org-previous-link t]
  18276. "--"
  18277. ["Descriptive Links"
  18278. org-toggle-link-display
  18279. :style radio
  18280. :selected org-descriptive-links
  18281. ]
  18282. ["Literal Links"
  18283. org-toggle-link-display
  18284. :style radio
  18285. :selected (not org-descriptive-links)])
  18286. "--"
  18287. ("TODO Lists"
  18288. ["TODO/DONE/-" org-todo t]
  18289. ("Select keyword"
  18290. ["Next keyword" org-shiftright (org-at-heading-p)]
  18291. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  18292. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  18293. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  18294. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  18295. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  18296. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  18297. "--"
  18298. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  18299. :selected org-enforce-todo-dependencies :style toggle :active t]
  18300. "Settings for tree at point"
  18301. ["Do Children sequentially" org-toggle-ordered-property :style radio
  18302. :selected (org-entry-get nil "ORDERED")
  18303. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18304. ["Do Children parallel" org-toggle-ordered-property :style radio
  18305. :selected (not (org-entry-get nil "ORDERED"))
  18306. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18307. "--"
  18308. ["Set Priority" org-priority t]
  18309. ["Priority Up" org-shiftup t]
  18310. ["Priority Down" org-shiftdown t]
  18311. "--"
  18312. ["Get news from all feeds" org-feed-update-all t]
  18313. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  18314. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  18315. ("TAGS and Properties"
  18316. ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
  18317. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  18318. "--"
  18319. ["Set property" org-set-property (not (org-before-first-heading-p))]
  18320. ["Column view of properties" org-columns t]
  18321. ["Insert Column View DBlock" org-insert-columns-dblock t])
  18322. ("Dates and Scheduling"
  18323. ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
  18324. ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
  18325. ("Change Date"
  18326. ["1 Day Later" org-shiftright (org-at-timestamp-p)]
  18327. ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
  18328. ["1 ... Later" org-shiftup (org-at-timestamp-p)]
  18329. ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
  18330. ["Compute Time Range" org-evaluate-time-range t]
  18331. ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
  18332. ["Deadline" org-deadline (not (org-before-first-heading-p))]
  18333. "--"
  18334. ["Custom time format" org-toggle-time-stamp-overlays
  18335. :style radio :selected org-display-custom-times]
  18336. "--"
  18337. ["Goto Calendar" org-goto-calendar t]
  18338. ["Date from Calendar" org-date-from-calendar t]
  18339. "--"
  18340. ["Start/Restart Timer" org-timer-start t]
  18341. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  18342. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  18343. ["Insert Timer String" org-timer t]
  18344. ["Insert Timer Item" org-timer-item t])
  18345. ("Logging work"
  18346. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  18347. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  18348. ["Clock out" org-clock-out t]
  18349. ["Clock cancel" org-clock-cancel t]
  18350. "--"
  18351. ["Mark as default task" org-clock-mark-default-task t]
  18352. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  18353. ["Goto running clock" org-clock-goto t]
  18354. "--"
  18355. ["Display times" org-clock-display t]
  18356. ["Create clock table" org-clock-report t]
  18357. "--"
  18358. ["Record DONE time"
  18359. (progn (setq org-log-done (not org-log-done))
  18360. (message "Switching to %s will %s record a timestamp"
  18361. (car org-done-keywords)
  18362. (if org-log-done "automatically" "not")))
  18363. :style toggle :selected org-log-done])
  18364. "--"
  18365. ["Agenda Command..." org-agenda t]
  18366. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  18367. ("File List for Agenda")
  18368. ("Special views current file"
  18369. ["TODO Tree" org-show-todo-tree t]
  18370. ["Check Deadlines" org-check-deadlines t]
  18371. ["Timeline" org-timeline t]
  18372. ["Tags/Property tree" org-match-sparse-tree t])
  18373. "--"
  18374. ["Export/Publish..." org-export t]
  18375. ("LaTeX"
  18376. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  18377. :selected org-cdlatex-mode]
  18378. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  18379. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  18380. ["Modify math symbol" org-cdlatex-math-modify
  18381. (org-inside-LaTeX-fragment-p)]
  18382. ["Insert citation" org-reftex-citation t]
  18383. "--"
  18384. ["Template for BEAMER" (progn (require 'org-beamer)
  18385. (org-insert-beamer-options-template)) t])
  18386. "--"
  18387. ("MobileOrg"
  18388. ["Push Files and Views" org-mobile-push t]
  18389. ["Get Captured and Flagged" org-mobile-pull t]
  18390. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  18391. "--"
  18392. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  18393. "--"
  18394. ("Documentation"
  18395. ["Show Version" org-version t]
  18396. ["Info Documentation" org-info t])
  18397. ("Customize"
  18398. ["Browse Org Group" org-customize t]
  18399. "--"
  18400. ["Expand This Menu" org-create-customize-menu
  18401. (fboundp 'customize-menu-create)])
  18402. ["Send bug report" org-submit-bug-report t]
  18403. "--"
  18404. ("Refresh/Reload"
  18405. ["Refresh setup current buffer" org-mode-restart t]
  18406. ["Reload Org (after update)" org-reload t]
  18407. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  18408. ))
  18409. (defun org-info (&optional node)
  18410. "Read documentation for Org-mode in the info system.
  18411. With optional NODE, go directly to that node."
  18412. (interactive)
  18413. (info (format "(org)%s" (or node ""))))
  18414. ;;;###autoload
  18415. (defun org-submit-bug-report ()
  18416. "Submit a bug report on Org-mode via mail.
  18417. Don't hesitate to report any problems or inaccurate documentation.
  18418. If you don't have setup sending mail from (X)Emacs, please copy the
  18419. output buffer into your mail program, as it gives us important
  18420. information about your Org-mode version and configuration."
  18421. (interactive)
  18422. (require 'reporter)
  18423. (org-load-modules-maybe)
  18424. (org-require-autoloaded-modules)
  18425. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  18426. (reporter-submit-bug-report
  18427. "emacs-orgmode@gnu.org"
  18428. (org-version nil 'full)
  18429. (let (list)
  18430. (save-window-excursion
  18431. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  18432. (delete-other-windows)
  18433. (erase-buffer)
  18434. (insert "You are about to submit a bug report to the Org-mode mailing list.
  18435. We would like to add your full Org-mode and Outline configuration to the
  18436. bug report. This greatly simplifies the work of the maintainer and
  18437. other experts on the mailing list.
  18438. HOWEVER, some variables you have customized may contain private
  18439. information. The names of customers, colleagues, or friends, might
  18440. appear in the form of file names, tags, todo states, or search strings.
  18441. If you answer yes to the prompt, you might want to check and remove
  18442. such private information before sending the email.")
  18443. (add-text-properties (point-min) (point-max) '(face org-warning))
  18444. (when (yes-or-no-p "Include your Org-mode configuration ")
  18445. (mapatoms
  18446. (lambda (v)
  18447. (and (boundp v)
  18448. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  18449. (or (and (symbol-value v)
  18450. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  18451. (and
  18452. (get v 'custom-type) (get v 'standard-value)
  18453. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  18454. (push v list)))))
  18455. (kill-buffer (get-buffer "*Warn about privacy*"))
  18456. list))
  18457. nil nil
  18458. "Remember to cover the basics, that is, what you expected to happen and
  18459. what in fact did happen. You don't know how to make a good report? See
  18460. http://orgmode.org/manual/Feedback.html#Feedback
  18461. Your bug report will be posted to the Org-mode mailing list.
  18462. ------------------------------------------------------------------------")
  18463. (save-excursion
  18464. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  18465. (replace-match "\\1Bug: \\3 [\\2]")))))
  18466. (defun org-install-agenda-files-menu ()
  18467. (let ((bl (buffer-list)))
  18468. (save-excursion
  18469. (while bl
  18470. (set-buffer (pop bl))
  18471. (if (derived-mode-p 'org-mode) (setq bl nil)))
  18472. (when (derived-mode-p 'org-mode)
  18473. (easy-menu-change
  18474. '("Org") "File List for Agenda"
  18475. (append
  18476. (list
  18477. ["Edit File List" (org-edit-agenda-file-list) t]
  18478. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  18479. ["Remove Current File from List" org-remove-file t]
  18480. ["Cycle through agenda files" org-cycle-agenda-files t]
  18481. ["Occur in all agenda files" org-occur-in-agenda-files t]
  18482. "--")
  18483. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  18484. ;;;; Documentation
  18485. ;;;###autoload
  18486. (defun org-require-autoloaded-modules ()
  18487. (interactive)
  18488. (mapc 'require
  18489. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  18490. org-docbook org-exp org-html org-icalendar
  18491. org-id org-latex
  18492. org-publish org-remember org-table
  18493. org-timer org-xoxo)))
  18494. ;;;###autoload
  18495. (defun org-reload (&optional uncompiled)
  18496. "Reload all org lisp files.
  18497. With prefix arg UNCOMPILED, load the uncompiled versions."
  18498. (interactive "P")
  18499. (require 'find-func)
  18500. (let* ((file-re "^org\\(-.*\\)?\\.el")
  18501. (dir-org (file-name-directory (org-find-library-dir "org")))
  18502. (dir-org-contrib (ignore-errors
  18503. (file-name-directory
  18504. (org-find-library-dir "org-contribdir"))))
  18505. (babel-files
  18506. (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
  18507. (append (list nil "comint" "eval" "exp" "keys"
  18508. "lob" "ref" "table" "tangle")
  18509. (delq nil
  18510. (mapcar
  18511. (lambda (lang)
  18512. (when (cdr lang) (symbol-name (car lang))))
  18513. org-babel-load-languages)))))
  18514. (files
  18515. (append babel-files
  18516. (and dir-org-contrib
  18517. (directory-files dir-org-contrib t file-re))
  18518. (directory-files dir-org t file-re)))
  18519. (remove-re (concat (if (featurep 'xemacs)
  18520. "org-colview" "org-colview-xemacs")
  18521. "\\'")))
  18522. (setq files (mapcar 'file-name-sans-extension files))
  18523. (setq files (mapcar
  18524. (lambda (x) (if (string-match remove-re x) nil x))
  18525. files))
  18526. (setq files (delq nil files))
  18527. (mapc
  18528. (lambda (f)
  18529. (when (featurep (intern (file-name-nondirectory f)))
  18530. (if (and (not uncompiled)
  18531. (file-exists-p (concat f ".elc")))
  18532. (load (concat f ".elc") nil nil 'nosuffix)
  18533. (load (concat f ".el") nil nil 'nosuffix))))
  18534. files)
  18535. (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
  18536. (org-version nil 'full 'message))
  18537. ;;;###autoload
  18538. (defun org-customize ()
  18539. "Call the customize function with org as argument."
  18540. (interactive)
  18541. (org-load-modules-maybe)
  18542. (org-require-autoloaded-modules)
  18543. (customize-browse 'org))
  18544. (defun org-create-customize-menu ()
  18545. "Create a full customization menu for Org-mode, insert it into the menu."
  18546. (interactive)
  18547. (org-load-modules-maybe)
  18548. (org-require-autoloaded-modules)
  18549. (if (fboundp 'customize-menu-create)
  18550. (progn
  18551. (easy-menu-change
  18552. '("Org") "Customize"
  18553. `(["Browse Org group" org-customize t]
  18554. "--"
  18555. ,(customize-menu-create 'org)
  18556. ["Set" Custom-set t]
  18557. ["Save" Custom-save t]
  18558. ["Reset to Current" Custom-reset-current t]
  18559. ["Reset to Saved" Custom-reset-saved t]
  18560. ["Reset to Standard Settings" Custom-reset-standard t]))
  18561. (message "\"Org\"-menu now contains full customization menu"))
  18562. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  18563. ;;;; Miscellaneous stuff
  18564. ;;; Generally useful functions
  18565. (defun org-get-at-bol (property)
  18566. "Get text property PROPERTY at beginning of line."
  18567. (get-text-property (point-at-bol) property))
  18568. (defun org-find-text-property-in-string (prop s)
  18569. "Return the first non-nil value of property PROP in string S."
  18570. (or (get-text-property 0 prop s)
  18571. (get-text-property (or (next-single-property-change 0 prop s) 0)
  18572. prop s)))
  18573. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  18574. "Display the given MESSAGE as a warning."
  18575. (if (fboundp 'display-warning)
  18576. (display-warning 'org message
  18577. (if (featurep 'xemacs) 'warning :warning))
  18578. (let ((buf (get-buffer-create "*Org warnings*")))
  18579. (with-current-buffer buf
  18580. (goto-char (point-max))
  18581. (insert "Warning (Org): " message)
  18582. (unless (bolp)
  18583. (newline)))
  18584. (display-buffer buf)
  18585. (sit-for 0))))
  18586. (defun org-eval (form)
  18587. "Eval FORM and return result."
  18588. (condition-case error
  18589. (eval form)
  18590. (error (format "%%![Error: %s]" error))))
  18591. (defun org-in-clocktable-p ()
  18592. "Check if the cursor is in a clocktable."
  18593. (let ((pos (point)) start)
  18594. (save-excursion
  18595. (end-of-line 1)
  18596. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  18597. (setq start (match-beginning 0))
  18598. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  18599. (>= (match-end 0) pos)
  18600. start))))
  18601. (defun org-in-commented-line ()
  18602. "Is point in a line starting with `#'?"
  18603. (equal (char-after (point-at-bol)) ?#))
  18604. (defun org-in-indented-comment-line ()
  18605. "Is point in a line starting with `#' after some white space?"
  18606. (save-excursion
  18607. (save-match-data
  18608. (goto-char (point-at-bol))
  18609. (looking-at "[ \t]*#"))))
  18610. (defun org-in-verbatim-emphasis ()
  18611. (save-match-data
  18612. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  18613. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  18614. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  18615. (if (and marker (marker-buffer marker)
  18616. (buffer-live-p (marker-buffer marker)))
  18617. (progn
  18618. (org-pop-to-buffer-same-window (marker-buffer marker))
  18619. (if (or (> marker (point-max)) (< marker (point-min)))
  18620. (widen))
  18621. (goto-char marker)
  18622. (org-show-context 'org-goto))
  18623. (if bookmark
  18624. (bookmark-jump bookmark)
  18625. (error "Cannot find location"))))
  18626. (defun org-quote-csv-field (s)
  18627. "Quote field for inclusion in CSV material."
  18628. (if (string-match "[\",]" s)
  18629. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  18630. s))
  18631. (defun org-force-self-insert (N)
  18632. "Needed to enforce self-insert under remapping."
  18633. (interactive "p")
  18634. (self-insert-command N))
  18635. (defun org-string-width (s)
  18636. "Compute width of string, ignoring invisible characters.
  18637. This ignores character with invisibility property `org-link', and also
  18638. characters with property `org-cwidth', because these will become invisible
  18639. upon the next fontification round."
  18640. (let (b l)
  18641. (when (or (eq t buffer-invisibility-spec)
  18642. (assq 'org-link buffer-invisibility-spec))
  18643. (while (setq b (text-property-any 0 (length s)
  18644. 'invisible 'org-link s))
  18645. (setq s (concat (substring s 0 b)
  18646. (substring s (or (next-single-property-change
  18647. b 'invisible s) (length s)))))))
  18648. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  18649. (setq s (concat (substring s 0 b)
  18650. (substring s (or (next-single-property-change
  18651. b 'org-cwidth s) (length s))))))
  18652. (setq l (string-width s) b -1)
  18653. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  18654. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  18655. l))
  18656. (defun org-shorten-string (s maxlength)
  18657. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  18658. If the string is shorter or has length MAXLENGTH, just return the
  18659. original string. If it is longer, the functions finds a space in the
  18660. string, breaks this string off at that locations and adds three dots
  18661. as ellipsis. Including the ellipsis, the string will not be longer
  18662. than MAXLENGTH. If finding a good breaking point in the string does
  18663. not work, the string is just chopped off in the middle of a word
  18664. if necessary."
  18665. (if (<= (length s) maxlength)
  18666. s
  18667. (let* ((n (max (- maxlength 4) 1))
  18668. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  18669. (if (string-match re s)
  18670. (concat (match-string 1 s) "...")
  18671. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  18672. (defun org-get-indentation (&optional line)
  18673. "Get the indentation of the current line, interpreting tabs.
  18674. When LINE is given, assume it represents a line and compute its indentation."
  18675. (if line
  18676. (if (string-match "^ *" (org-remove-tabs line))
  18677. (match-end 0))
  18678. (save-excursion
  18679. (beginning-of-line 1)
  18680. (skip-chars-forward " \t")
  18681. (current-column))))
  18682. (defun org-get-string-indentation (s)
  18683. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  18684. (let ((n -1) (i 0) (w tab-width) c)
  18685. (catch 'exit
  18686. (while (< (setq n (1+ n)) (length s))
  18687. (setq c (aref s n))
  18688. (cond ((= c ?\ ) (setq i (1+ i)))
  18689. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  18690. (t (throw 'exit t)))))
  18691. i))
  18692. (defun org-remove-tabs (s &optional width)
  18693. "Replace tabulators in S with spaces.
  18694. Assumes that s is a single line, starting in column 0."
  18695. (setq width (or width tab-width))
  18696. (while (string-match "\t" s)
  18697. (setq s (replace-match
  18698. (make-string
  18699. (- (* width (/ (+ (match-beginning 0) width) width))
  18700. (match-beginning 0)) ?\ )
  18701. t t s)))
  18702. s)
  18703. (defun org-fix-indentation (line ind)
  18704. "Fix indentation in LINE.
  18705. IND is a cons cell with target and minimum indentation.
  18706. If the current indentation in LINE is smaller than the minimum,
  18707. leave it alone. If it is larger than ind, set it to the target."
  18708. (let* ((l (org-remove-tabs line))
  18709. (i (org-get-indentation l))
  18710. (i1 (car ind)) (i2 (cdr ind)))
  18711. (if (>= i i2) (setq l (substring line i2)))
  18712. (if (> i1 0)
  18713. (concat (make-string i1 ?\ ) l)
  18714. l)))
  18715. (defun org-remove-indentation (code &optional n)
  18716. "Remove the maximum common indentation from the lines in CODE.
  18717. N may optionally be the number of spaces to remove."
  18718. (with-temp-buffer
  18719. (insert code)
  18720. (org-do-remove-indentation n)
  18721. (buffer-string)))
  18722. (defun org-do-remove-indentation (&optional n)
  18723. "Remove the maximum common indentation from the buffer."
  18724. (untabify (point-min) (point-max))
  18725. (let ((min 10000) re)
  18726. (if n
  18727. (setq min n)
  18728. (goto-char (point-min))
  18729. (while (re-search-forward "^ *[^ \n]" nil t)
  18730. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  18731. (unless (or (= min 0) (= min 10000))
  18732. (setq re (format "^ \\{%d\\}" min))
  18733. (goto-char (point-min))
  18734. (while (re-search-forward re nil t)
  18735. (replace-match "")
  18736. (end-of-line 1))
  18737. min)))
  18738. (defun org-fill-template (template alist)
  18739. "Find each %key of ALIST in TEMPLATE and replace it."
  18740. (let ((case-fold-search nil)
  18741. entry key value)
  18742. (setq alist (sort (copy-sequence alist)
  18743. (lambda (a b) (< (length (car a)) (length (car b))))))
  18744. (while (setq entry (pop alist))
  18745. (setq template
  18746. (replace-regexp-in-string
  18747. (concat "%" (regexp-quote (car entry)))
  18748. (or (cdr entry) "") template t t)))
  18749. template))
  18750. (defun org-base-buffer (buffer)
  18751. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  18752. (if (not buffer)
  18753. buffer
  18754. (or (buffer-base-buffer buffer)
  18755. buffer)))
  18756. (defun org-trim (s)
  18757. "Remove whitespace at beginning and end of string."
  18758. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  18759. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  18760. s)
  18761. (defun org-wrap (string &optional width lines)
  18762. "Wrap string to either a number of lines, or a width in characters.
  18763. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  18764. that costs. If there is a word longer than WIDTH, the text is actually
  18765. wrapped to the length of that word.
  18766. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  18767. many lines, whatever width that takes.
  18768. The return value is a list of lines, without newlines at the end."
  18769. (let* ((words (org-split-string string "[ \t\n]+"))
  18770. (maxword (apply 'max (mapcar 'org-string-width words)))
  18771. w ll)
  18772. (cond (width
  18773. (org-do-wrap words (max maxword width)))
  18774. (lines
  18775. (setq w maxword)
  18776. (setq ll (org-do-wrap words maxword))
  18777. (if (<= (length ll) lines)
  18778. ll
  18779. (setq ll words)
  18780. (while (> (length ll) lines)
  18781. (setq w (1+ w))
  18782. (setq ll (org-do-wrap words w)))
  18783. ll))
  18784. (t (error "Cannot wrap this")))))
  18785. (defun org-do-wrap (words width)
  18786. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  18787. (let (lines line)
  18788. (while words
  18789. (setq line (pop words))
  18790. (while (and words (< (+ (length line) (length (car words))) width))
  18791. (setq line (concat line " " (pop words))))
  18792. (setq lines (push line lines)))
  18793. (nreverse lines)))
  18794. (defun org-split-string (string &optional separators)
  18795. "Splits STRING into substrings at SEPARATORS.
  18796. No empty strings are returned if there are matches at the beginning
  18797. and end of string."
  18798. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  18799. (start 0)
  18800. notfirst
  18801. (list nil))
  18802. (while (and (string-match rexp string
  18803. (if (and notfirst
  18804. (= start (match-beginning 0))
  18805. (< start (length string)))
  18806. (1+ start) start))
  18807. (< (match-beginning 0) (length string)))
  18808. (setq notfirst t)
  18809. (or (eq (match-beginning 0) 0)
  18810. (and (eq (match-beginning 0) (match-end 0))
  18811. (eq (match-beginning 0) start))
  18812. (setq list
  18813. (cons (substring string start (match-beginning 0))
  18814. list)))
  18815. (setq start (match-end 0)))
  18816. (or (eq start (length string))
  18817. (setq list
  18818. (cons (substring string start)
  18819. list)))
  18820. (nreverse list)))
  18821. (defun org-quote-vert (s)
  18822. "Replace \"|\" with \"\\vert\"."
  18823. (while (string-match "|" s)
  18824. (setq s (replace-match "\\vert" t t s)))
  18825. s)
  18826. (defun org-uuidgen-p (s)
  18827. "Is S an ID created by UUIDGEN?"
  18828. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  18829. (defun org-in-src-block-p nil
  18830. "Whether point is in a code source block."
  18831. (let (ov)
  18832. (when (setq ov (overlays-at (point)))
  18833. (memq 'org-block-background
  18834. (overlay-properties
  18835. (car ov))))))
  18836. (defun org-context ()
  18837. "Return a list of contexts of the current cursor position.
  18838. If several contexts apply, all are returned.
  18839. Each context entry is a list with a symbol naming the context, and
  18840. two positions indicating start and end of the context. Possible
  18841. contexts are:
  18842. :headline anywhere in a headline
  18843. :headline-stars on the leading stars in a headline
  18844. :todo-keyword on a TODO keyword (including DONE) in a headline
  18845. :tags on the TAGS in a headline
  18846. :priority on the priority cookie in a headline
  18847. :item on the first line of a plain list item
  18848. :item-bullet on the bullet/number of a plain list item
  18849. :checkbox on the checkbox in a plain list item
  18850. :table in an org-mode table
  18851. :table-special on a special filed in a table
  18852. :table-table in a table.el table
  18853. :clocktable in a clocktable
  18854. :src-block in a source block
  18855. :link on a hyperlink
  18856. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  18857. :target on a <<target>>
  18858. :radio-target on a <<<radio-target>>>
  18859. :latex-fragment on a LaTeX fragment
  18860. :latex-preview on a LaTeX fragment with overlaid preview image
  18861. This function expects the position to be visible because it uses font-lock
  18862. faces as a help to recognize the following contexts: :table-special, :link,
  18863. and :keyword."
  18864. (let* ((f (get-text-property (point) 'face))
  18865. (faces (if (listp f) f (list f)))
  18866. (case-fold-search t)
  18867. (p (point)) clist o)
  18868. ;; First the large context
  18869. (cond
  18870. ((org-at-heading-p t)
  18871. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  18872. (when (progn
  18873. (beginning-of-line 1)
  18874. (looking-at org-todo-line-tags-regexp))
  18875. (push (org-point-in-group p 1 :headline-stars) clist)
  18876. (push (org-point-in-group p 2 :todo-keyword) clist)
  18877. (push (org-point-in-group p 4 :tags) clist))
  18878. (goto-char p)
  18879. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  18880. (if (looking-at "\\[#[A-Z0-9]\\]")
  18881. (push (org-point-in-group p 0 :priority) clist)))
  18882. ((org-at-item-p)
  18883. (push (org-point-in-group p 2 :item-bullet) clist)
  18884. (push (list :item (point-at-bol)
  18885. (save-excursion (org-end-of-item) (point)))
  18886. clist)
  18887. (and (org-at-item-checkbox-p)
  18888. (push (org-point-in-group p 0 :checkbox) clist)))
  18889. ((org-at-table-p)
  18890. (push (list :table (org-table-begin) (org-table-end)) clist)
  18891. (if (memq 'org-formula faces)
  18892. (push (list :table-special
  18893. (previous-single-property-change p 'face)
  18894. (next-single-property-change p 'face)) clist)))
  18895. ((org-at-table-p 'any)
  18896. (push (list :table-table) clist)))
  18897. (goto-char p)
  18898. (let ((case-fold-search t))
  18899. ;; New the "medium" contexts: clocktables, source blocks
  18900. (cond ((org-in-clocktable-p)
  18901. (push (list :clocktable
  18902. (and (or (looking-at "#\\+BEGIN: clocktable")
  18903. (search-backward "#+BEGIN: clocktable" nil t))
  18904. (match-beginning 0))
  18905. (and (re-search-forward "#\\+END:?" nil t)
  18906. (match-end 0))) clist))
  18907. ((org-in-src-block-p)
  18908. (push (list :src-block
  18909. (and (or (looking-at "#\\+BEGIN_SRC")
  18910. (search-backward "#+BEGIN_SRC" nil t))
  18911. (match-beginning 0))
  18912. (and (search-forward "#+END_SRC" nil t)
  18913. (match-beginning 0))) clist))))
  18914. (goto-char p)
  18915. ;; Now the small context
  18916. (cond
  18917. ((org-at-timestamp-p)
  18918. (push (org-point-in-group p 0 :timestamp) clist))
  18919. ((memq 'org-link faces)
  18920. (push (list :link
  18921. (previous-single-property-change p 'face)
  18922. (next-single-property-change p 'face)) clist))
  18923. ((memq 'org-special-keyword faces)
  18924. (push (list :keyword
  18925. (previous-single-property-change p 'face)
  18926. (next-single-property-change p 'face)) clist))
  18927. ((org-at-target-p)
  18928. (push (org-point-in-group p 0 :target) clist)
  18929. (goto-char (1- (match-beginning 0)))
  18930. (if (looking-at org-radio-target-regexp)
  18931. (push (org-point-in-group p 0 :radio-target) clist))
  18932. (goto-char p))
  18933. ((setq o (car (delq nil
  18934. (mapcar
  18935. (lambda (x)
  18936. (if (memq x org-latex-fragment-image-overlays) x))
  18937. (overlays-at (point))))))
  18938. (push (list :latex-fragment
  18939. (overlay-start o) (overlay-end o)) clist)
  18940. (push (list :latex-preview
  18941. (overlay-start o) (overlay-end o)) clist))
  18942. ((org-inside-LaTeX-fragment-p)
  18943. ;; FIXME: positions wrong.
  18944. (push (list :latex-fragment (point) (point)) clist)))
  18945. (setq clist (nreverse (delq nil clist)))
  18946. clist))
  18947. ;; FIXME: Compare with at-regexp-p Do we need both?
  18948. (defun org-in-regexp (re &optional nlines visually)
  18949. "Check if point is inside a match of regexp.
  18950. Normally only the current line is checked, but you can include NLINES extra
  18951. lines both before and after point into the search.
  18952. If VISUALLY is set, require that the cursor is not after the match but
  18953. really on, so that the block visually is on the match."
  18954. (catch 'exit
  18955. (let ((pos (point))
  18956. (eol (point-at-eol (+ 1 (or nlines 0))))
  18957. (inc (if visually 1 0)))
  18958. (save-excursion
  18959. (beginning-of-line (- 1 (or nlines 0)))
  18960. (while (re-search-forward re eol t)
  18961. (if (and (<= (match-beginning 0) pos)
  18962. (>= (+ inc (match-end 0)) pos))
  18963. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  18964. (defun org-at-regexp-p (regexp)
  18965. "Is point inside a match of REGEXP in the current line?"
  18966. (catch 'exit
  18967. (save-excursion
  18968. (let ((pos (point)) (end (point-at-eol)))
  18969. (beginning-of-line 1)
  18970. (while (re-search-forward regexp end t)
  18971. (if (and (<= (match-beginning 0) pos)
  18972. (>= (match-end 0) pos))
  18973. (throw 'exit t)))
  18974. nil))))
  18975. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  18976. "Non-nil when point is between matches of START-RE and END-RE.
  18977. Also return a non-nil value when point is on one of the matches.
  18978. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  18979. buffer positions. Default values are the positions of headlines
  18980. surrounding the point.
  18981. The functions returns a cons cell whose car (resp. cdr) is the
  18982. position before START-RE (resp. after END-RE)."
  18983. (save-match-data
  18984. (let ((pos (point))
  18985. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  18986. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  18987. beg end)
  18988. (save-excursion
  18989. ;; Point is on a block when on START-RE or if START-RE can be
  18990. ;; found before it...
  18991. (and (or (org-at-regexp-p start-re)
  18992. (re-search-backward start-re limit-up t))
  18993. (setq beg (match-beginning 0))
  18994. ;; ... and END-RE after it...
  18995. (goto-char (match-end 0))
  18996. (re-search-forward end-re limit-down t)
  18997. (> (setq end (match-end 0)) pos)
  18998. ;; ... without another START-RE in-between.
  18999. (goto-char (match-beginning 0))
  19000. (not (re-search-backward start-re (1+ beg) t))
  19001. ;; Return value.
  19002. (cons beg end))))))
  19003. (defun org-in-block-p (names)
  19004. "Non-nil when point belongs to a block whose name belongs to NAMES.
  19005. NAMES is a list of strings containing names of blocks.
  19006. Return first block name matched, or nil. Beware that in case of
  19007. nested blocks, the returned name may not belong to the closest
  19008. block from point."
  19009. (save-match-data
  19010. (catch 'exit
  19011. (let ((case-fold-search t)
  19012. (lim-up (save-excursion (outline-previous-heading)))
  19013. (lim-down (save-excursion (outline-next-heading))))
  19014. (mapc (lambda (name)
  19015. (let ((n (regexp-quote name)))
  19016. (when (org-between-regexps-p
  19017. (concat "^[ \t]*#\\+begin_" n)
  19018. (concat "^[ \t]*#\\+end_" n)
  19019. lim-up lim-down)
  19020. (throw 'exit n))))
  19021. names))
  19022. nil)))
  19023. (defun org-occur-in-agenda-files (regexp &optional nlines)
  19024. "Call `multi-occur' with buffers for all agenda files."
  19025. (interactive "sOrg-files matching: \np")
  19026. (let* ((files (org-agenda-files))
  19027. (tnames (mapcar 'file-truename files))
  19028. (extra org-agenda-text-search-extra-files)
  19029. f)
  19030. (when (eq (car extra) 'agenda-archives)
  19031. (setq extra (cdr extra))
  19032. (setq files (org-add-archive-files files)))
  19033. (while (setq f (pop extra))
  19034. (unless (member (file-truename f) tnames)
  19035. (add-to-list 'files f 'append)
  19036. (add-to-list 'tnames (file-truename f) 'append)))
  19037. (multi-occur
  19038. (mapcar (lambda (x)
  19039. (with-current-buffer
  19040. (or (get-file-buffer x) (find-file-noselect x))
  19041. (widen)
  19042. (current-buffer)))
  19043. files)
  19044. regexp)))
  19045. (if (boundp 'occur-mode-find-occurrence-hook)
  19046. ;; Emacs 23
  19047. (add-hook 'occur-mode-find-occurrence-hook
  19048. (lambda ()
  19049. (when (derived-mode-p 'org-mode)
  19050. (org-reveal))))
  19051. ;; Emacs 22
  19052. (defadvice occur-mode-goto-occurrence
  19053. (after org-occur-reveal activate)
  19054. (and (derived-mode-p 'org-mode) (org-reveal)))
  19055. (defadvice occur-mode-goto-occurrence-other-window
  19056. (after org-occur-reveal activate)
  19057. (and (derived-mode-p 'org-mode) (org-reveal)))
  19058. (defadvice occur-mode-display-occurrence
  19059. (after org-occur-reveal activate)
  19060. (when (derived-mode-p 'org-mode)
  19061. (let ((pos (occur-mode-find-occurrence)))
  19062. (with-current-buffer (marker-buffer pos)
  19063. (save-excursion
  19064. (goto-char pos)
  19065. (org-reveal)))))))
  19066. (defun org-occur-link-in-agenda-files ()
  19067. "Create a link and search for it in the agendas.
  19068. The link is not stored in `org-stored-links', it is just created
  19069. for the search purpose."
  19070. (interactive)
  19071. (let ((link (condition-case nil
  19072. (org-store-link nil)
  19073. (error "Unable to create a link to here"))))
  19074. (org-occur-in-agenda-files (regexp-quote link))))
  19075. (defun org-uniquify (list)
  19076. "Remove duplicate elements from LIST."
  19077. (let (res)
  19078. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  19079. res))
  19080. (defun org-delete-all (elts list)
  19081. "Remove all elements in ELTS from LIST."
  19082. (while elts
  19083. (setq list (delete (pop elts) list)))
  19084. list)
  19085. (defun org-count (cl-item cl-seq)
  19086. "Count the number of occurrences of ITEM in SEQ.
  19087. Taken from `count' in cl-seq.el with all keyword arguments removed."
  19088. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  19089. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  19090. (while (< cl-start cl-end)
  19091. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  19092. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  19093. (setq cl-start (1+ cl-start)))
  19094. cl-count))
  19095. (defun org-remove-if (predicate seq)
  19096. "Remove everything from SEQ that fulfills PREDICATE."
  19097. (let (res e)
  19098. (while seq
  19099. (setq e (pop seq))
  19100. (if (not (funcall predicate e)) (push e res)))
  19101. (nreverse res)))
  19102. (defun org-remove-if-not (predicate seq)
  19103. "Remove everything from SEQ that does not fulfill PREDICATE."
  19104. (let (res e)
  19105. (while seq
  19106. (setq e (pop seq))
  19107. (if (funcall predicate e) (push e res)))
  19108. (nreverse res)))
  19109. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  19110. "Reduce two-argument FUNCTION across SEQ.
  19111. Taken from `reduce' in cl-seq.el with all keyword arguments but
  19112. \":initial-value\" removed."
  19113. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  19114. (cadr (memq :initial-value cl-keys)))
  19115. (cl-seq (pop cl-seq))
  19116. (t (funcall cl-func)))))
  19117. (while cl-seq
  19118. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  19119. cl-accum))
  19120. (defun org-back-over-empty-lines ()
  19121. "Move backwards over whitespace, to the beginning of the first empty line.
  19122. Returns the number of empty lines passed."
  19123. (let ((pos (point)))
  19124. (if (cdr (assoc 'heading org-blank-before-new-entry))
  19125. (skip-chars-backward " \t\n\r")
  19126. (unless (eobp)
  19127. (forward-line -1)))
  19128. (beginning-of-line 2)
  19129. (goto-char (min (point) pos))
  19130. (count-lines (point) pos)))
  19131. (defun org-skip-whitespace ()
  19132. (skip-chars-forward " \t\n\r"))
  19133. (defun org-point-in-group (point group &optional context)
  19134. "Check if POINT is in match-group GROUP.
  19135. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  19136. match. If the match group does not exist or point is not inside it,
  19137. return nil."
  19138. (and (match-beginning group)
  19139. (>= point (match-beginning group))
  19140. (<= point (match-end group))
  19141. (if context
  19142. (list context (match-beginning group) (match-end group))
  19143. t)))
  19144. (defun org-switch-to-buffer-other-window (&rest args)
  19145. "Switch to buffer in a second window on the current frame.
  19146. In particular, do not allow pop-up frames.
  19147. Returns the newly created buffer."
  19148. (let (pop-up-frames special-display-buffer-names special-display-regexps
  19149. special-display-function)
  19150. (apply 'switch-to-buffer-other-window args)))
  19151. (defun org-combine-plists (&rest plists)
  19152. "Create a single property list from all plists in PLISTS.
  19153. The process starts by copying the first list, and then setting properties
  19154. from the other lists. Settings in the last list are the most significant
  19155. ones and overrule settings in the other lists."
  19156. (let ((rtn (copy-sequence (pop plists)))
  19157. p v ls)
  19158. (while plists
  19159. (setq ls (pop plists))
  19160. (while ls
  19161. (setq p (pop ls) v (pop ls))
  19162. (setq rtn (plist-put rtn p v))))
  19163. rtn))
  19164. (defun org-replace-escapes (string table)
  19165. "Replace %-escapes in STRING with values in TABLE.
  19166. TABLE is an association list with keys like \"%a\" and string values.
  19167. The sequences in STRING may contain normal field width and padding information,
  19168. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  19169. so values can contain further %-escapes if they are define later in TABLE."
  19170. (let ((tbl (copy-alist table))
  19171. (case-fold-search nil)
  19172. (pchg 0)
  19173. e re rpl)
  19174. (while (setq e (pop tbl))
  19175. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  19176. (when (and (cdr e) (string-match re (cdr e)))
  19177. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  19178. (safe "SREF"))
  19179. (add-text-properties 0 3 (list 'sref sref) safe)
  19180. (setcdr e (replace-match safe t t (cdr e)))))
  19181. (while (string-match re string)
  19182. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  19183. (cdr e)))
  19184. (setq string (replace-match rpl t t string))))
  19185. (while (setq pchg (next-property-change pchg string))
  19186. (let ((sref (get-text-property pchg 'sref string)))
  19187. (when (and sref (string-match "SREF" string pchg))
  19188. (setq string (replace-match sref t t string)))))
  19189. string))
  19190. (defun org-sublist (list start end)
  19191. "Return a section of LIST, from START to END.
  19192. Counting starts at 1."
  19193. (let (rtn (c start))
  19194. (setq list (nthcdr (1- start) list))
  19195. (while (and list (<= c end))
  19196. (push (pop list) rtn)
  19197. (setq c (1+ c)))
  19198. (nreverse rtn)))
  19199. (defun org-find-base-buffer-visiting (file)
  19200. "Like `find-buffer-visiting' but always return the base buffer and
  19201. not an indirect buffer."
  19202. (let ((buf (or (get-file-buffer file)
  19203. (find-buffer-visiting file))))
  19204. (if buf
  19205. (or (buffer-base-buffer buf) buf)
  19206. nil)))
  19207. (defun org-image-file-name-regexp (&optional extensions)
  19208. "Return regexp matching the file names of images.
  19209. If EXTENSIONS is given, only match these."
  19210. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  19211. (image-file-name-regexp)
  19212. (let ((image-file-name-extensions
  19213. (or extensions
  19214. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  19215. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  19216. (concat "\\."
  19217. (regexp-opt (nconc (mapcar 'upcase
  19218. image-file-name-extensions)
  19219. image-file-name-extensions)
  19220. t)
  19221. "\\'"))))
  19222. (defun org-file-image-p (file &optional extensions)
  19223. "Return non-nil if FILE is an image."
  19224. (save-match-data
  19225. (string-match (org-image-file-name-regexp extensions) file)))
  19226. (defun org-get-cursor-date ()
  19227. "Return the date at cursor in as a time.
  19228. This works in the calendar and in the agenda, anywhere else it just
  19229. returns the current time."
  19230. (let (date day defd)
  19231. (cond
  19232. ((eq major-mode 'calendar-mode)
  19233. (setq date (calendar-cursor-to-date)
  19234. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  19235. ((eq major-mode 'org-agenda-mode)
  19236. (setq day (get-text-property (point) 'day))
  19237. (if day
  19238. (setq date (calendar-gregorian-from-absolute day)
  19239. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  19240. (nth 2 date))))))
  19241. (or defd (current-time))))
  19242. (defvar org-agenda-action-marker (make-marker)
  19243. "Marker pointing to the entry for the next agenda action.")
  19244. (defun org-mark-entry-for-agenda-action ()
  19245. "Mark the current entry as target of an agenda action.
  19246. Agenda actions are actions executed from the agenda with the key `k',
  19247. which make use of the date at the cursor."
  19248. (interactive)
  19249. (move-marker org-agenda-action-marker
  19250. (save-excursion (org-back-to-heading t) (point))
  19251. (current-buffer))
  19252. (message
  19253. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  19254. (defun org-mark-subtree (&optional up)
  19255. "Mark the current subtree.
  19256. This puts point at the start of the current subtree, and mark at
  19257. the end. If a numeric prefix UP is given, move up into the
  19258. hierarchy of headlines by UP levels before marking the subtree."
  19259. (interactive "P")
  19260. (org-with-limited-levels
  19261. (cond ((org-at-heading-p) (beginning-of-line))
  19262. ((org-before-first-heading-p) (error "Not in a subtree"))
  19263. (t (outline-previous-visible-heading 1))))
  19264. (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
  19265. (if (org-called-interactively-p 'any)
  19266. (call-interactively 'org-mark-element)
  19267. (org-mark-element)))
  19268. ;;; Macros
  19269. ;; Macros are expanded with `org-macro-replace-all', which relies
  19270. ;; internally on `org-macro-expand'.
  19271. ;; Templates for expansion are stored in the buffer-local variable
  19272. ;; `org-macro-templates'. This variable is updated by
  19273. ;; `org-macro-initialize-templates'.
  19274. (defvar org-macro-templates nil
  19275. "Alist containing all macro templates in current buffer.
  19276. Associations are in the shape of (NAME . TEMPLATE) where NAME
  19277. stands for macro's name and template for its replacement value,
  19278. both as strings. This is an internal variable. Do not set it
  19279. directly, use instead:
  19280. #+MACRO: name template")
  19281. (make-variable-buffer-local 'org-macro-templates)
  19282. (defun org-macro-expand (macro)
  19283. "Return expanded MACRO, as a string.
  19284. MACRO is an object, obtained, for example, with
  19285. `org-element-context'. Return nil if no template was found."
  19286. (let ((template
  19287. (cdr (assoc-string (org-element-property :key macro)
  19288. org-macro-templates
  19289. ;; Macro names are case-insensitive.
  19290. t))))
  19291. (when template
  19292. (let ((value (replace-regexp-in-string
  19293. "\\$[0-9]+"
  19294. (lambda (arg)
  19295. (or (nth (1- (string-to-number (substring arg 1)))
  19296. (org-element-property :args macro))
  19297. ;; No argument provided: remove
  19298. ;; place-holder.
  19299. ""))
  19300. template)))
  19301. ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
  19302. (when (string-match "\\`(eval\\>" value)
  19303. (setq value (eval (read value))))
  19304. ;; Return string.
  19305. (format "%s" (or value ""))))))
  19306. (defun org-macro-replace-all ()
  19307. "Replace all macros in current buffer by their expansion."
  19308. (save-excursion
  19309. (goto-char (point-min))
  19310. (while (re-search-forward "{{{[-A-Za-z0-9_]" nil t)
  19311. (let ((object (org-element-context)))
  19312. (when (eq (org-element-type object) 'macro)
  19313. (let ((value (org-macro-expand object)))
  19314. (when value
  19315. (delete-region
  19316. (org-element-property :begin object)
  19317. ;; Preserve white spaces after the macro.
  19318. (progn (goto-char (org-element-property :end object))
  19319. (skip-chars-backward " \t")
  19320. (point)))
  19321. ;; Leave point before replacement in case of recursive
  19322. ;; expansions.
  19323. (save-excursion (insert value)))))))))
  19324. (defun org-macro-initialize-templates ()
  19325. "Collect macro templates defined in current buffer.
  19326. Templates are stored in buffer-local variable
  19327. `org-macro-templates'. In addition to buffer-defined macros, the
  19328. function installs the following ones: \"property\", \"date\",
  19329. \"time\". and, if appropriate, \"input-file\" and
  19330. \"modification-time\"."
  19331. (let ((case-fold-search t)
  19332. (set-template
  19333. (lambda (cell)
  19334. ;; Add CELL to `org-macro-templates' if there's no
  19335. ;; association matching its name already. Otherwise,
  19336. ;; replace old association with the new one in that
  19337. ;; variable.
  19338. (let ((old-template (assoc (car cell) org-macro-templates)))
  19339. (if old-template (setcdr old-template (cdr cell))
  19340. (push cell org-macro-templates))))))
  19341. ;; Install buffer-local macros.
  19342. (org-with-wide-buffer
  19343. (goto-char (point-min))
  19344. (while (re-search-forward "^[ \t]*#\\+MACRO:" nil t)
  19345. (let ((element (org-element-at-point)))
  19346. (when (eq (org-element-type element) 'keyword)
  19347. (let ((value (org-element-property :value element)))
  19348. (when (string-match "^\\(.*?\\)\\(?:\\s-+\\(.*\\)\\)?\\s-*$" value)
  19349. (funcall set-template
  19350. (cons (match-string 1 value)
  19351. (or (match-string 2 value) "")))))))))
  19352. ;; Install hard-coded macros.
  19353. (mapc (lambda (cell) (funcall set-template cell))
  19354. (list
  19355. (cons "property" "(eval (org-entry-get nil \"$1\" 'selective))")
  19356. (cons "date" "(eval (format-time-string \"$1\"))")
  19357. (cons "time" "(eval (format-time-string \"$1\"))")))
  19358. (let ((visited-file (buffer-file-name (buffer-base-buffer))))
  19359. (when (and visited-file (file-exists-p visited-file))
  19360. (mapc (lambda (cell) (funcall set-template cell))
  19361. (list
  19362. (cons "input-file" (file-name-nondirectory visited-file))
  19363. (cons "modification-time"
  19364. (format "(eval (format-time-string \"$1\" '%s))"
  19365. (prin1-to-string
  19366. (nth 5 (file-attributes visited-file)))))))))))
  19367. ;;; Indentation
  19368. (defun org-indent-line ()
  19369. "Indent line depending on context."
  19370. (interactive)
  19371. (let* ((pos (point))
  19372. (itemp (org-at-item-p))
  19373. (case-fold-search t)
  19374. (org-drawer-regexp (or org-drawer-regexp "\000"))
  19375. (inline-task-p (and (featurep 'org-inlinetask)
  19376. (org-inlinetask-in-task-p)))
  19377. (inline-re (and inline-task-p
  19378. (org-inlinetask-outline-regexp)))
  19379. column)
  19380. (if (and orgstruct-is-++ (eq pos (point)))
  19381. (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
  19382. (indent-according-to-mode))
  19383. (beginning-of-line 1)
  19384. (cond
  19385. ;; Headings
  19386. ((looking-at org-outline-regexp) (setq column 0))
  19387. ;; Included files
  19388. ((looking-at "#\\+include:") (setq column 0))
  19389. ;; Footnote definition
  19390. ((looking-at org-footnote-definition-re) (setq column 0))
  19391. ;; Literal examples
  19392. ((looking-at "[ \t]*:\\( \\|$\\)")
  19393. (setq column (org-get-indentation))) ; do nothing
  19394. ;; Lists
  19395. ((ignore-errors (goto-char (org-in-item-p)))
  19396. (setq column (if itemp
  19397. (org-get-indentation)
  19398. (org-list-item-body-column (point))))
  19399. (goto-char pos))
  19400. ;; Drawers
  19401. ((and (looking-at "[ \t]*:END:")
  19402. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  19403. (save-excursion
  19404. (goto-char (1- (match-beginning 1)))
  19405. (setq column (current-column))))
  19406. ;; Special blocks
  19407. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  19408. (save-excursion
  19409. (re-search-backward
  19410. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  19411. (setq column (org-get-indentation (match-string 0))))
  19412. ((and (not (looking-at "[ \t]*#\\+begin_"))
  19413. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  19414. (save-excursion
  19415. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  19416. (setq column
  19417. (cond ((equal (downcase (match-string 1)) "src")
  19418. ;; src blocks: let `org-edit-src-exit' handle them
  19419. (org-get-indentation))
  19420. ((equal (downcase (match-string 1)) "example")
  19421. (max (org-get-indentation)
  19422. (org-get-indentation (match-string 0))))
  19423. (t
  19424. (org-get-indentation (match-string 0))))))
  19425. ;; This line has nothing special, look at the previous relevant
  19426. ;; line to compute indentation
  19427. (t
  19428. (beginning-of-line 0)
  19429. (while (and (not (bobp))
  19430. (not (looking-at org-drawer-regexp))
  19431. ;; When point started in an inline task, do not move
  19432. ;; above task starting line.
  19433. (not (and inline-task-p (looking-at inline-re)))
  19434. ;; Skip drawers, blocks, empty lines, verbatim,
  19435. ;; comments, tables, footnotes definitions, lists,
  19436. ;; inline tasks.
  19437. (or (and (looking-at "[ \t]*:END:")
  19438. (re-search-backward org-drawer-regexp nil t))
  19439. (and (looking-at "[ \t]*#\\+end_")
  19440. (re-search-backward "[ \t]*#\\+begin_"nil t))
  19441. (looking-at "[ \t]*[\n:#|]")
  19442. (looking-at org-footnote-definition-re)
  19443. (and (ignore-errors (goto-char (org-in-item-p)))
  19444. (goto-char
  19445. (org-list-get-top-point (org-list-struct))))
  19446. (and (not inline-task-p)
  19447. (featurep 'org-inlinetask)
  19448. (org-inlinetask-in-task-p)
  19449. (or (org-inlinetask-goto-beginning) t))))
  19450. (beginning-of-line 0))
  19451. (cond
  19452. ;; There was an heading above.
  19453. ((looking-at "\\*+[ \t]+")
  19454. (if (not org-adapt-indentation)
  19455. (setq column 0)
  19456. (goto-char (match-end 0))
  19457. (setq column (current-column))))
  19458. ;; A drawer had started and is unfinished
  19459. ((looking-at org-drawer-regexp)
  19460. (goto-char (1- (match-beginning 1)))
  19461. (setq column (current-column)))
  19462. ;; Else, nothing noticeable found: get indentation and go on.
  19463. (t (setq column (org-get-indentation))))))
  19464. ;; Now apply indentation and move cursor accordingly
  19465. (goto-char pos)
  19466. (if (<= (current-column) (current-indentation))
  19467. (org-indent-line-to column)
  19468. (save-excursion (org-indent-line-to column)))
  19469. ;; Special polishing for properties, see `org-property-format'
  19470. (setq column (current-column))
  19471. (beginning-of-line 1)
  19472. (if (looking-at
  19473. "\\([ \t]*\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  19474. (replace-match (concat (match-string 1)
  19475. (format org-property-format
  19476. (match-string 2) (match-string 3)))
  19477. t t))
  19478. (org-move-to-column column))))
  19479. (defun org-indent-drawer ()
  19480. "Indent the drawer at point."
  19481. (interactive)
  19482. (let ((p (point))
  19483. (e (and (save-excursion (re-search-forward ":END:" nil t))
  19484. (match-end 0)))
  19485. (folded
  19486. (save-excursion
  19487. (end-of-line)
  19488. (when (overlays-at (point))
  19489. (member 'invisible (overlay-properties
  19490. (car (overlays-at (point)))))))))
  19491. (when folded (org-cycle))
  19492. (indent-for-tab-command)
  19493. (while (and (move-beginning-of-line 2) (< (point) e))
  19494. (indent-for-tab-command))
  19495. (goto-char p)
  19496. (when folded (org-cycle)))
  19497. (message "Drawer at point indented"))
  19498. (defun org-indent-block ()
  19499. "Indent the block at point."
  19500. (interactive)
  19501. (let ((p (point))
  19502. (case-fold-search t)
  19503. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  19504. (match-end 0)))
  19505. (folded
  19506. (save-excursion
  19507. (end-of-line)
  19508. (when (overlays-at (point))
  19509. (member 'invisible (overlay-properties
  19510. (car (overlays-at (point)))))))))
  19511. (when folded (org-cycle))
  19512. (indent-for-tab-command)
  19513. (while (and (move-beginning-of-line 2) (< (point) e))
  19514. (indent-for-tab-command))
  19515. (goto-char p)
  19516. (when folded (org-cycle)))
  19517. (message "Block at point indented"))
  19518. (defun org-indent-region (start end)
  19519. "Indent region."
  19520. (interactive "r")
  19521. (save-excursion
  19522. (let ((line-end (org-current-line end)))
  19523. (goto-char start)
  19524. (while (< (org-current-line) line-end)
  19525. (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
  19526. (t (call-interactively 'org-indent-line)))
  19527. (move-beginning-of-line 2)))))
  19528. ;;; Filling
  19529. ;; We use our own fill-paragraph and auto-fill functions.
  19530. ;; `org-fill-paragraph' relies on adaptive filling and context
  19531. ;; checking. Appropriate `fill-prefix' is computed with
  19532. ;; `org-adaptive-fill-function'.
  19533. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  19534. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  19535. ;; `org-adaptive-fill-function' value. Internally,
  19536. ;; `org-comment-line-break-function' breaks the line.
  19537. ;; `org-setup-filling' installs filling and auto-filling related
  19538. ;; variables during `org-mode' initialization.
  19539. (defun org-setup-filling ()
  19540. (interactive)
  19541. ;; Prevent auto-fill from inserting unwanted new items.
  19542. (when (boundp 'fill-nobreak-predicate)
  19543. (org-set-local
  19544. 'fill-nobreak-predicate
  19545. (org-uniquify
  19546. (append fill-nobreak-predicate
  19547. '(org-fill-paragraph-separate-nobreak-p
  19548. org-fill-line-break-nobreak-p)))))
  19549. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  19550. (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
  19551. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  19552. (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
  19553. (defvar org-element-paragraph-separate) ; org-element.el
  19554. (defun org-fill-paragraph-separate-nobreak-p ()
  19555. "Non-nil when a line break at point would insert a new item."
  19556. (looking-at (substring org-element-paragraph-separate 1)))
  19557. (defun org-fill-line-break-nobreak-p ()
  19558. "Non-nil when a line break at point would create an Org line break."
  19559. (save-excursion
  19560. (skip-chars-backward "[ \t]")
  19561. (skip-chars-backward "\\\\")
  19562. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  19563. (declare-function message-in-body-p "message" ())
  19564. (defvar org-element--affiliated-re) ; From org-element.el
  19565. (defun org-adaptive-fill-function ()
  19566. "Compute a fill prefix for the current line.
  19567. Return fill prefix, as a string, or nil if current line isn't
  19568. meant to be filled."
  19569. (org-with-wide-buffer
  19570. (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
  19571. ;; FIXME: This is really the job of orgstruct++-mode
  19572. (let* ((p (line-beginning-position))
  19573. (element (save-excursion (beginning-of-line)
  19574. (org-element-at-point)))
  19575. (type (org-element-type element))
  19576. (post-affiliated
  19577. (save-excursion
  19578. (goto-char (org-element-property :begin element))
  19579. (while (looking-at org-element--affiliated-re) (forward-line))
  19580. (point))))
  19581. (unless (< p post-affiliated)
  19582. (case type
  19583. (comment (looking-at "[ \t]*# ?") (match-string 0))
  19584. (footnote-definition "")
  19585. ((item plain-list)
  19586. (make-string (org-list-item-body-column post-affiliated) ? ))
  19587. (paragraph
  19588. ;; Fill prefix is usually the same as the current line,
  19589. ;; except if the paragraph is at the beginning of an item.
  19590. (let ((parent (org-element-property :parent element)))
  19591. (cond ((eq (org-element-type parent) 'item)
  19592. (make-string (org-list-item-body-column
  19593. (org-element-property :begin parent))
  19594. ? ))
  19595. ((save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  19596. (match-string 0))
  19597. (t ""))))
  19598. (comment-block
  19599. ;; Only fill contents if P is within block boundaries.
  19600. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  19601. (forward-line)
  19602. (point)))
  19603. (cend (save-excursion
  19604. (goto-char (org-element-property :end element))
  19605. (skip-chars-backward " \r\t\n")
  19606. (line-beginning-position))))
  19607. (when (and (>= p cbeg) (< p cend))
  19608. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  19609. (match-string 0)
  19610. ""))))))))))
  19611. (declare-function message-goto-body "message" ())
  19612. (defvar message-cite-prefix-regexp) ; From message.el
  19613. (defvar org-element-all-objects) ; From org-element.el
  19614. (defun org-fill-paragraph (&optional justify)
  19615. "Fill element at point, when applicable.
  19616. This function only applies to comment blocks, comments, example
  19617. blocks and paragraphs. Also, as a special case, re-align table
  19618. when point is at one.
  19619. If JUSTIFY is non-nil (interactively, with prefix argument),
  19620. justify as well. If `sentence-end-double-space' is non-nil, then
  19621. period followed by one space does not end a sentence, so don't
  19622. break a line there. The variable `fill-column' controls the
  19623. width for filling.
  19624. For convenience, when point is at a plain list, an item or
  19625. a footnote definition, try to fill the first paragraph within."
  19626. ;; Falls back on message-fill-paragraph when necessary
  19627. (interactive)
  19628. (if (and (derived-mode-p 'message-mode)
  19629. (or (not (message-in-body-p))
  19630. (save-excursion (move-beginning-of-line 1)
  19631. (looking-at message-cite-prefix-regexp))))
  19632. (let ((fill-paragraph-function
  19633. (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
  19634. (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
  19635. (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
  19636. (paragraph-separate
  19637. (cadadr (assoc 'paragraph-separate org-fb-vars))))
  19638. (fill-paragraph nil))
  19639. (save-excursion
  19640. ;; Move to end of line in order to get the first paragraph
  19641. ;; within a plain list or a footnote definition.
  19642. (end-of-line)
  19643. (let ((element (org-element-at-point)))
  19644. ;; First check if point is in a blank line at the beginning of
  19645. ;; the buffer. In that case, ignore filling.
  19646. (if (< (point) (org-element-property :begin element)) t
  19647. (case (org-element-type element)
  19648. ;; Align Org tables, leave table.el tables as-is.
  19649. (table-row (org-table-align) t)
  19650. (table
  19651. (when (eq (org-element-property :type element) 'org)
  19652. (org-table-align))
  19653. t)
  19654. (paragraph
  19655. ;; Paragraphs may contain `line-break' type objects.
  19656. (let ((beg (max (point-min)
  19657. (org-element-property :contents-begin element)))
  19658. (end (min (point-max)
  19659. (org-element-property :contents-end element))))
  19660. ;; Do nothing if point is at an affiliated keyword.
  19661. (if (< (point) beg) t
  19662. (when (derived-mode-p 'message-mode)
  19663. ;; In `message-mode', do not fill following
  19664. ;; citation in current paragraph nor text before
  19665. ;; message body.
  19666. (let ((body-start (save-excursion (message-goto-body))))
  19667. (when body-start (setq beg (max body-start beg))))
  19668. (when (save-excursion
  19669. (re-search-forward
  19670. (concat "^" message-cite-prefix-regexp) end t))
  19671. (setq end (match-beginning 0))))
  19672. ;; Fill paragraph, taking line breaks into
  19673. ;; consideration. For that, slice the paragraph
  19674. ;; using line breaks as separators, and fill the
  19675. ;; parts in reverse order to avoid messing with
  19676. ;; markers.
  19677. (save-excursion
  19678. (goto-char end)
  19679. (mapc
  19680. (lambda (pos)
  19681. (fill-region-as-paragraph pos (point) justify)
  19682. (goto-char pos))
  19683. ;; Find the list of ending positions for line
  19684. ;; breaks in the current paragraph. Add paragraph
  19685. ;; beginning to include first slice.
  19686. (nreverse
  19687. (cons
  19688. beg
  19689. (org-element-map
  19690. (org-element--parse-objects
  19691. beg end nil org-element-all-objects)
  19692. 'line-break
  19693. (lambda (lb) (org-element-property :end lb)))))))
  19694. t)))
  19695. ;; Contents of `comment-block' type elements should be
  19696. ;; filled as plain text, but only if point is within block
  19697. ;; markers.
  19698. (comment-block
  19699. (let* ((case-fold-search t)
  19700. (beg (save-excursion
  19701. (goto-char (org-element-property :begin element))
  19702. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  19703. (forward-line)
  19704. (point)))
  19705. (end (save-excursion
  19706. (goto-char (org-element-property :end element))
  19707. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  19708. (line-beginning-position))))
  19709. (when (and (>= (point) beg) (< (point) end))
  19710. (fill-region-as-paragraph
  19711. (save-excursion
  19712. (end-of-line)
  19713. (re-search-backward "^[ \t]*$" beg 'move)
  19714. (line-beginning-position))
  19715. (save-excursion
  19716. (beginning-of-line)
  19717. (re-search-forward "^[ \t]*$" end 'move)
  19718. (line-beginning-position))
  19719. justify)))
  19720. t)
  19721. ;; Fill comments.
  19722. (comment (fill-comment-paragraph justify))
  19723. ;; Ignore every other element.
  19724. (otherwise t)))))))
  19725. (defun org-auto-fill-function ()
  19726. "Auto-fill function."
  19727. ;; Check if auto-filling is meaningful.
  19728. (let ((fc (current-fill-column)))
  19729. (when (and fc (> (current-column) fc))
  19730. (let ((fill-prefix (org-adaptive-fill-function)))
  19731. (when fill-prefix (do-auto-fill))))))
  19732. (defun org-comment-line-break-function (&optional soft)
  19733. "Break line at point and indent, continuing comment if within one.
  19734. The inserted newline is marked hard if variable
  19735. `use-hard-newlines' is true, unless optional argument SOFT is
  19736. non-nil."
  19737. (if soft (insert-and-inherit ?\n) (newline 1))
  19738. (save-excursion (forward-char -1) (delete-horizontal-space))
  19739. (delete-horizontal-space)
  19740. (indent-to-left-margin)
  19741. (insert-before-markers-and-inherit fill-prefix))
  19742. ;;; Comments
  19743. ;; Org comments syntax is quite complex. It requires the entire line
  19744. ;; to be just a comment. Also, even with the right syntax at the
  19745. ;; beginning of line, some some elements (i.e. verse-block or
  19746. ;; example-block) don't accept comments. Usual Emacs comment commands
  19747. ;; cannot cope with those requirements. Therefore, Org replaces them.
  19748. ;; Org still relies on `comment-dwim', but cannot trust
  19749. ;; `comment-only-p'. So, `comment-region-function' and
  19750. ;; `uncomment-region-function' both point
  19751. ;; to`org-comment-or-uncomment-region'. Eventually,
  19752. ;; `org-insert-comment' takes care of insertion of comments at the
  19753. ;; beginning of line.
  19754. ;; `org-setup-comments-handling' install comments related variables
  19755. ;; during `org-mode' initialization.
  19756. (defun org-setup-comments-handling ()
  19757. (interactive)
  19758. (org-set-local 'comment-use-syntax nil)
  19759. (org-set-local 'comment-start "# ")
  19760. (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  19761. (org-set-local 'comment-insert-comment-function 'org-insert-comment)
  19762. (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
  19763. (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
  19764. (defun org-insert-comment ()
  19765. "Insert an empty comment above current line.
  19766. If the line is empty, insert comment at its beginning."
  19767. (beginning-of-line)
  19768. (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
  19769. (org-indent-line)
  19770. (insert "# "))
  19771. (defvar comment-empty-lines) ; From newcomment.el.
  19772. (defun org-comment-or-uncomment-region (beg end &rest ignore)
  19773. "Comment or uncomment each non-blank line in the region.
  19774. Uncomment each non-blank line between BEG and END if it only
  19775. contains commented lines. Otherwise, comment them."
  19776. (save-restriction
  19777. ;; Restrict region
  19778. (narrow-to-region (save-excursion (goto-char beg)
  19779. (skip-chars-forward " \r\t\n" end)
  19780. (line-beginning-position))
  19781. (save-excursion (goto-char end)
  19782. (skip-chars-backward " \r\t\n" beg)
  19783. (line-end-position)))
  19784. (let ((uncommentp
  19785. ;; UNCOMMENTP is non-nil when every non blank line between
  19786. ;; BEG and END is a comment.
  19787. (save-excursion
  19788. (goto-char (point-min))
  19789. (while (and (not (eobp))
  19790. (let ((element (org-element-at-point)))
  19791. (and (eq (org-element-type element) 'comment)
  19792. (goto-char (min (point-max)
  19793. (org-element-property
  19794. :end element)))))))
  19795. (eobp))))
  19796. (if uncommentp
  19797. ;; Only blank lines and comments in region: uncomment it.
  19798. (save-excursion
  19799. (goto-char (point-min))
  19800. (while (not (eobp))
  19801. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  19802. (replace-match "" nil nil nil 1))
  19803. (forward-line)))
  19804. ;; Comment each line in region.
  19805. (let ((min-indent (point-max)))
  19806. ;; First find the minimum indentation across all lines.
  19807. (save-excursion
  19808. (goto-char (point-min))
  19809. (while (and (not (eobp)) (not (zerop min-indent)))
  19810. (unless (looking-at "[ \t]*$")
  19811. (setq min-indent (min min-indent (current-indentation))))
  19812. (forward-line)))
  19813. ;; Then loop over all lines.
  19814. (save-excursion
  19815. (goto-char (point-min))
  19816. (while (not (eobp))
  19817. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  19818. (org-move-to-column min-indent t)
  19819. (insert comment-start))
  19820. (forward-line))))))))
  19821. ;;; Other stuff.
  19822. (defun org-toggle-fixed-width-section (arg)
  19823. "Toggle the fixed-width export.
  19824. If there is no active region, the QUOTE keyword at the current headline is
  19825. inserted or removed. When present, it causes the text between this headline
  19826. and the next to be exported as fixed-width text, and unmodified.
  19827. If there is an active region, this command adds or removes a colon as the
  19828. first character of this line. If the first character of a line is a colon,
  19829. this line is also exported in fixed-width font."
  19830. (interactive "P")
  19831. (let* ((cc 0)
  19832. (regionp (org-region-active-p))
  19833. (beg (if regionp (region-beginning) (point)))
  19834. (end (if regionp (region-end)))
  19835. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  19836. (case-fold-search nil)
  19837. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  19838. off)
  19839. (if regionp
  19840. (save-excursion
  19841. (goto-char beg)
  19842. (setq cc (current-column))
  19843. (beginning-of-line 1)
  19844. (setq off (looking-at re))
  19845. (while (> nlines 0)
  19846. (setq nlines (1- nlines))
  19847. (beginning-of-line 1)
  19848. (cond
  19849. (arg
  19850. (org-move-to-column cc t)
  19851. (insert ": \n")
  19852. (forward-line -1))
  19853. ((and off (looking-at re))
  19854. (replace-match "" t t nil 1))
  19855. ((not off) (org-move-to-column cc t) (insert ": ")))
  19856. (forward-line 1)))
  19857. (save-excursion
  19858. (org-back-to-heading)
  19859. (cond
  19860. ((looking-at (format org-heading-keyword-regexp-format
  19861. org-quote-string))
  19862. (goto-char (match-end 1))
  19863. (looking-at (concat " +" org-quote-string))
  19864. (replace-match "" t t)
  19865. (when (eolp) (insert " ")))
  19866. ((looking-at org-outline-regexp)
  19867. (goto-char (match-end 0))
  19868. (insert org-quote-string " ")))))))
  19869. (defun org-reftex-citation ()
  19870. "Use reftex-citation to insert a citation into the buffer.
  19871. This looks for a line like
  19872. #+BIBLIOGRAPHY: foo plain option:-d
  19873. and derives from it that foo.bib is the bibliography file relevant
  19874. for this document. It then installs the necessary environment for RefTeX
  19875. to work in this buffer and calls `reftex-citation' to insert a citation
  19876. into the buffer.
  19877. Export of such citations to both LaTeX and HTML is handled by the contributed
  19878. package org-exp-bibtex by Taru Karttunen."
  19879. (interactive)
  19880. (let ((reftex-docstruct-symbol 'rds)
  19881. (reftex-cite-format "\\cite{%l}")
  19882. rds bib)
  19883. (save-excursion
  19884. (save-restriction
  19885. (widen)
  19886. (let ((case-fold-search t)
  19887. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  19888. (if (not (save-excursion
  19889. (or (re-search-forward re nil t)
  19890. (re-search-backward re nil t))))
  19891. (error "No bibliography defined in file")
  19892. (setq bib (concat (match-string 1) ".bib")
  19893. rds (list (list 'bib bib)))))))
  19894. (call-interactively 'reftex-citation)))
  19895. ;;;; Functions extending outline functionality
  19896. (defun org-beginning-of-line (&optional arg)
  19897. "Go to the beginning of the current line. If that is invisible, continue
  19898. to a visible line beginning. This makes the function of C-a more intuitive.
  19899. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19900. first attempt, and only move to after the tags when the cursor is already
  19901. beyond the end of the headline."
  19902. (interactive "P")
  19903. (let ((pos (point))
  19904. (special (if (consp org-special-ctrl-a/e)
  19905. (car org-special-ctrl-a/e)
  19906. org-special-ctrl-a/e))
  19907. refpos)
  19908. (if (org-bound-and-true-p line-move-visual)
  19909. (beginning-of-visual-line 1)
  19910. (beginning-of-line 1))
  19911. (if (and arg (fboundp 'move-beginning-of-line))
  19912. (call-interactively 'move-beginning-of-line)
  19913. (if (bobp)
  19914. nil
  19915. (backward-char 1)
  19916. (if (org-truely-invisible-p)
  19917. (while (and (not (bobp)) (org-truely-invisible-p))
  19918. (backward-char 1)
  19919. (beginning-of-line 1))
  19920. (forward-char 1))))
  19921. (when special
  19922. (cond
  19923. ((and (looking-at org-complex-heading-regexp)
  19924. (= (char-after (match-end 1)) ?\ ))
  19925. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  19926. (point-at-eol)))
  19927. (goto-char
  19928. (if (eq special t)
  19929. (cond ((> pos refpos) refpos)
  19930. ((= pos (point)) refpos)
  19931. (t (point)))
  19932. (cond ((> pos (point)) (point))
  19933. ((not (eq last-command this-command)) (point))
  19934. (t refpos)))))
  19935. ((org-at-item-p)
  19936. ;; Being at an item and not looking at an the item means point
  19937. ;; was previously moved to beginning of a visual line, which
  19938. ;; doesn't contain the item. Therefore, do nothing special,
  19939. ;; just stay here.
  19940. (when (looking-at org-list-full-item-re)
  19941. ;; Set special position at first white space character after
  19942. ;; bullet, and check-box, if any.
  19943. (let ((after-bullet
  19944. (let ((box (match-end 3)))
  19945. (if (not box) (match-end 1)
  19946. (let ((after (char-after box)))
  19947. (if (and after (= after ? )) (1+ box) box))))))
  19948. ;; Special case: Move point to special position when
  19949. ;; currently after it or at beginning of line.
  19950. (if (eq special t)
  19951. (when (or (> pos after-bullet) (= (point) pos))
  19952. (goto-char after-bullet))
  19953. ;; Reversed case: Move point to special position when
  19954. ;; point was already at beginning of line and command is
  19955. ;; repeated.
  19956. (when (and (= (point) pos) (eq last-command this-command))
  19957. (goto-char after-bullet))))))))
  19958. (org-no-warnings
  19959. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19960. (defun org-end-of-line (&optional arg)
  19961. "Go to the end of the line.
  19962. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19963. first attempt, and only move to after the tags when the cursor is already
  19964. beyond the end of the headline."
  19965. (interactive "P")
  19966. (let ((special (if (consp org-special-ctrl-a/e)
  19967. (cdr org-special-ctrl-a/e)
  19968. org-special-ctrl-a/e)))
  19969. (cond
  19970. ((or (not special) arg
  19971. (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
  19972. (call-interactively
  19973. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19974. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19975. (t 'end-of-line))))
  19976. ((org-at-heading-p)
  19977. (let ((pos (point)))
  19978. (beginning-of-line 1)
  19979. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  19980. (if (eq special t)
  19981. (if (or (< pos (match-beginning 1))
  19982. (= pos (match-end 0)))
  19983. (goto-char (match-beginning 1))
  19984. (goto-char (match-end 0)))
  19985. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  19986. (goto-char (match-end 0))
  19987. (goto-char (match-beginning 1))))
  19988. (call-interactively (if (fboundp 'move-end-of-line)
  19989. 'move-end-of-line
  19990. 'end-of-line)))))
  19991. ((org-at-drawer-p)
  19992. (move-end-of-line 1)
  19993. (when (overlays-at (1- (point))) (backward-char 1)))
  19994. ;; At an item: Move before any hidden text.
  19995. (t (call-interactively
  19996. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19997. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19998. (t 'end-of-line)))))
  19999. (org-no-warnings
  20000. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  20001. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  20002. (define-key org-mode-map "\C-e" 'org-end-of-line)
  20003. (defun org-backward-sentence (&optional arg)
  20004. "Go to beginning of sentence, or beginning of table field.
  20005. This will call `backward-sentence' or `org-table-beginning-of-field',
  20006. depending on context."
  20007. (interactive "P")
  20008. (cond
  20009. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  20010. (t (call-interactively 'backward-sentence))))
  20011. (defun org-forward-sentence (&optional arg)
  20012. "Go to end of sentence, or end of table field.
  20013. This will call `forward-sentence' or `org-table-end-of-field',
  20014. depending on context."
  20015. (interactive "P")
  20016. (cond
  20017. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  20018. (t (call-interactively 'forward-sentence))))
  20019. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  20020. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  20021. (defun org-kill-line (&optional arg)
  20022. "Kill line, to tags or end of line."
  20023. (interactive "P")
  20024. (cond
  20025. ((or (not org-special-ctrl-k)
  20026. (bolp)
  20027. (not (org-at-heading-p)))
  20028. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  20029. org-ctrl-k-protect-subtree)
  20030. (if (or (eq org-ctrl-k-protect-subtree 'error)
  20031. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  20032. (error "C-k aborted - would kill hidden subtree")))
  20033. (call-interactively
  20034. (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
  20035. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  20036. (kill-region (point) (match-beginning 1))
  20037. (org-set-tags nil t))
  20038. (t (kill-region (point) (point-at-eol)))))
  20039. (define-key org-mode-map "\C-k" 'org-kill-line)
  20040. (defun org-yank (&optional arg)
  20041. "Yank. If the kill is a subtree, treat it specially.
  20042. This command will look at the current kill and check if is a single
  20043. subtree, or a series of subtrees[1]. If it passes the test, and if the
  20044. cursor is at the beginning of a line or after the stars of a currently
  20045. empty headline, then the yank is handled specially. How exactly depends
  20046. on the value of the following variables, both set by default.
  20047. org-yank-folded-subtrees
  20048. When set, the subtree(s) will be folded after insertion, but only
  20049. if doing so would now swallow text after the yanked text.
  20050. org-yank-adjusted-subtrees
  20051. When set, the subtree will be promoted or demoted in order to
  20052. fit into the local outline tree structure, which means that the level
  20053. will be adjusted so that it becomes the smaller one of the two
  20054. *visible* surrounding headings.
  20055. Any prefix to this command will cause `yank' to be called directly with
  20056. no special treatment. In particular, a simple \\[universal-argument] prefix \
  20057. will just
  20058. plainly yank the text as it is.
  20059. \[1] The test checks if the first non-white line is a heading
  20060. and if there are no other headings with fewer stars."
  20061. (interactive "P")
  20062. (org-yank-generic 'yank arg))
  20063. (defun org-yank-generic (command arg)
  20064. "Perform some yank-like command.
  20065. This function implements the behavior described in the `org-yank'
  20066. documentation. However, it has been generalized to work for any
  20067. interactive command with similar behavior."
  20068. ;; pretend to be command COMMAND
  20069. (setq this-command command)
  20070. (if arg
  20071. (call-interactively command)
  20072. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  20073. (and (org-kill-is-subtree-p)
  20074. (or (bolp)
  20075. (and (looking-at "[ \t]*$")
  20076. (string-match
  20077. "\\`\\*+\\'"
  20078. (buffer-substring (point-at-bol) (point)))))))
  20079. swallowp)
  20080. (cond
  20081. ((and subtreep org-yank-folded-subtrees)
  20082. (let ((beg (point))
  20083. end)
  20084. (if (and subtreep org-yank-adjusted-subtrees)
  20085. (org-paste-subtree nil nil 'for-yank)
  20086. (call-interactively command))
  20087. (setq end (point))
  20088. (goto-char beg)
  20089. (when (and (bolp) subtreep
  20090. (not (setq swallowp
  20091. (org-yank-folding-would-swallow-text beg end))))
  20092. (org-with-limited-levels
  20093. (or (looking-at org-outline-regexp)
  20094. (re-search-forward org-outline-regexp-bol end t))
  20095. (while (and (< (point) end) (looking-at org-outline-regexp))
  20096. (hide-subtree)
  20097. (org-cycle-show-empty-lines 'folded)
  20098. (condition-case nil
  20099. (outline-forward-same-level 1)
  20100. (error (goto-char end))))))
  20101. (when swallowp
  20102. (message
  20103. "Inserted text not folded because that would swallow text"))
  20104. (goto-char end)
  20105. (skip-chars-forward " \t\n\r")
  20106. (beginning-of-line 1)
  20107. (push-mark beg 'nomsg)))
  20108. ((and subtreep org-yank-adjusted-subtrees)
  20109. (let ((beg (point-at-bol)))
  20110. (org-paste-subtree nil nil 'for-yank)
  20111. (push-mark beg 'nomsg)))
  20112. (t
  20113. (call-interactively command))))))
  20114. (defun org-yank-folding-would-swallow-text (beg end)
  20115. "Would hide-subtree at BEG swallow any text after END?"
  20116. (let (level)
  20117. (org-with-limited-levels
  20118. (save-excursion
  20119. (goto-char beg)
  20120. (when (or (looking-at org-outline-regexp)
  20121. (re-search-forward org-outline-regexp-bol end t))
  20122. (setq level (org-outline-level)))
  20123. (goto-char end)
  20124. (skip-chars-forward " \t\r\n\v\f")
  20125. (if (or (eobp)
  20126. (and (bolp) (looking-at org-outline-regexp)
  20127. (<= (org-outline-level) level)))
  20128. nil ; Nothing would be swallowed
  20129. t))))) ; something would swallow
  20130. (define-key org-mode-map "\C-y" 'org-yank)
  20131. (defun org-truely-invisible-p ()
  20132. "Check if point is at a character currently not visible.
  20133. This version does not only check the character property, but also
  20134. `visible-mode'."
  20135. ;; Early versions of noutline don't have `outline-invisible-p'.
  20136. (if (org-bound-and-true-p visible-mode)
  20137. nil
  20138. (outline-invisible-p)))
  20139. (defun org-invisible-p2 ()
  20140. "Check if point is at a character currently not visible."
  20141. (save-excursion
  20142. (if (and (eolp) (not (bobp))) (backward-char 1))
  20143. ;; Early versions of noutline don't have `outline-invisible-p'.
  20144. (outline-invisible-p)))
  20145. (defun org-back-to-heading (&optional invisible-ok)
  20146. "Call `outline-back-to-heading', but provide a better error message."
  20147. (condition-case nil
  20148. (outline-back-to-heading invisible-ok)
  20149. (error (error "Before first headline at position %d in buffer %s"
  20150. (point) (current-buffer)))))
  20151. (defun org-before-first-heading-p ()
  20152. "Before first heading?"
  20153. (save-excursion
  20154. (end-of-line)
  20155. (null (re-search-backward org-outline-regexp-bol nil t))))
  20156. (defun org-at-heading-p (&optional ignored)
  20157. (outline-on-heading-p t))
  20158. ;; Compatibility alias with Org versions < 7.8.03
  20159. (defalias 'org-on-heading-p 'org-at-heading-p)
  20160. (defun org-at-comment-p nil
  20161. "Is cursor in a line starting with a # character?"
  20162. (save-excursion
  20163. (beginning-of-line)
  20164. (looking-at "^#")))
  20165. (defun org-at-drawer-p nil
  20166. "Is cursor at a drawer keyword?"
  20167. (save-excursion
  20168. (move-beginning-of-line 1)
  20169. (looking-at org-drawer-regexp)))
  20170. (defun org-at-block-p nil
  20171. "Is cursor at a block keyword?"
  20172. (save-excursion
  20173. (move-beginning-of-line 1)
  20174. (looking-at org-block-regexp)))
  20175. (defun org-point-at-end-of-empty-headline ()
  20176. "If point is at the end of an empty headline, return t, else nil.
  20177. If the heading only contains a TODO keyword, it is still still considered
  20178. empty."
  20179. (and (looking-at "[ \t]*$")
  20180. (when org-todo-line-regexp
  20181. (save-excursion
  20182. (beginning-of-line 1)
  20183. (let ((case-fold-search nil))
  20184. (looking-at org-todo-line-regexp)
  20185. (string= (match-string 3) ""))))))
  20186. (defun org-at-heading-or-item-p ()
  20187. (or (org-at-heading-p) (org-at-item-p)))
  20188. (defun org-at-target-p ()
  20189. (or (org-in-regexp org-radio-target-regexp)
  20190. (org-in-regexp org-target-regexp)))
  20191. ;; Compatibility alias with Org versions < 7.8.03
  20192. (defalias 'org-on-target-p 'org-at-target-p)
  20193. (defun org-up-heading-all (arg)
  20194. "Move to the heading line of which the present line is a subheading.
  20195. This function considers both visible and invisible heading lines.
  20196. With argument, move up ARG levels."
  20197. (if (fboundp 'outline-up-heading-all)
  20198. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  20199. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  20200. (defun org-up-heading-safe ()
  20201. "Move to the heading line of which the present line is a subheading.
  20202. This version will not throw an error. It will return the level of the
  20203. headline found, or nil if no higher level is found.
  20204. Also, this function will be a lot faster than `outline-up-heading',
  20205. because it relies on stars being the outline starters. This can really
  20206. make a significant difference in outlines with very many siblings."
  20207. (let (start-level re)
  20208. (org-back-to-heading t)
  20209. (setq start-level (funcall outline-level))
  20210. (if (equal start-level 1)
  20211. nil
  20212. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  20213. (if (re-search-backward re nil t)
  20214. (funcall outline-level)))))
  20215. (defun org-first-sibling-p ()
  20216. "Is this heading the first child of its parents?"
  20217. (interactive)
  20218. (let ((re org-outline-regexp-bol)
  20219. level l)
  20220. (unless (org-at-heading-p t)
  20221. (error "Not at a heading"))
  20222. (setq level (funcall outline-level))
  20223. (save-excursion
  20224. (if (not (re-search-backward re nil t))
  20225. t
  20226. (setq l (funcall outline-level))
  20227. (< l level)))))
  20228. (defun org-goto-sibling (&optional previous)
  20229. "Goto the next sibling, even if it is invisible.
  20230. When PREVIOUS is set, go to the previous sibling instead. Returns t
  20231. when a sibling was found. When none is found, return nil and don't
  20232. move point."
  20233. (let ((fun (if previous 're-search-backward 're-search-forward))
  20234. (pos (point))
  20235. (re org-outline-regexp-bol)
  20236. level l)
  20237. (when (condition-case nil (org-back-to-heading t) (error nil))
  20238. (setq level (funcall outline-level))
  20239. (catch 'exit
  20240. (or previous (forward-char 1))
  20241. (while (funcall fun re nil t)
  20242. (setq l (funcall outline-level))
  20243. (when (< l level) (goto-char pos) (throw 'exit nil))
  20244. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  20245. (goto-char pos)
  20246. nil))))
  20247. (defun org-show-siblings ()
  20248. "Show all siblings of the current headline."
  20249. (save-excursion
  20250. (while (org-goto-sibling) (org-flag-heading nil)))
  20251. (save-excursion
  20252. (while (org-goto-sibling 'previous)
  20253. (org-flag-heading nil))))
  20254. (defun org-goto-first-child ()
  20255. "Goto the first child, even if it is invisible.
  20256. Return t when a child was found. Otherwise don't move point and
  20257. return nil."
  20258. (let (level (pos (point)) (re org-outline-regexp-bol))
  20259. (when (condition-case nil (org-back-to-heading t) (error nil))
  20260. (setq level (outline-level))
  20261. (forward-char 1)
  20262. (if (and (re-search-forward re nil t) (> (outline-level) level))
  20263. (progn (goto-char (match-beginning 0)) t)
  20264. (goto-char pos) nil))))
  20265. (defun org-show-hidden-entry ()
  20266. "Show an entry where even the heading is hidden."
  20267. (save-excursion
  20268. (org-show-entry)))
  20269. (defun org-flag-heading (flag &optional entry)
  20270. "Flag the current heading. FLAG non-nil means make invisible.
  20271. When ENTRY is non-nil, show the entire entry."
  20272. (save-excursion
  20273. (org-back-to-heading t)
  20274. ;; Check if we should show the entire entry
  20275. (if entry
  20276. (progn
  20277. (org-show-entry)
  20278. (save-excursion
  20279. (and (outline-next-heading)
  20280. (org-flag-heading nil))))
  20281. (outline-flag-region (max (point-min) (1- (point)))
  20282. (save-excursion (outline-end-of-heading) (point))
  20283. flag))))
  20284. (defun org-get-next-sibling ()
  20285. "Move to next heading of the same level, and return point.
  20286. If there is no such heading, return nil.
  20287. This is like outline-next-sibling, but invisible headings are ok."
  20288. (let ((level (funcall outline-level)))
  20289. (outline-next-heading)
  20290. (while (and (not (eobp)) (> (funcall outline-level) level))
  20291. (outline-next-heading))
  20292. (if (or (eobp) (< (funcall outline-level) level))
  20293. nil
  20294. (point))))
  20295. (defun org-get-last-sibling ()
  20296. "Move to previous heading of the same level, and return point.
  20297. If there is no such heading, return nil."
  20298. (let ((opoint (point))
  20299. (level (funcall outline-level)))
  20300. (outline-previous-heading)
  20301. (when (and (/= (point) opoint) (outline-on-heading-p t))
  20302. (while (and (> (funcall outline-level) level)
  20303. (not (bobp)))
  20304. (outline-previous-heading))
  20305. (if (< (funcall outline-level) level)
  20306. nil
  20307. (point)))))
  20308. (defun org-end-of-subtree (&optional invisible-ok to-heading)
  20309. "Goto to the end of a subtree."
  20310. ;; This contains an exact copy of the original function, but it uses
  20311. ;; `org-back-to-heading', to make it work also in invisible
  20312. ;; trees. And is uses an invisible-ok argument.
  20313. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  20314. ;; Furthermore, when used inside Org, finding the end of a large subtree
  20315. ;; with many children and grandchildren etc, this can be much faster
  20316. ;; than the outline version.
  20317. (org-back-to-heading invisible-ok)
  20318. (let ((first t)
  20319. (level (funcall outline-level)))
  20320. (if (and (derived-mode-p 'org-mode) (< level 1000))
  20321. ;; A true heading (not a plain list item), in Org-mode
  20322. ;; This means we can easily find the end by looking
  20323. ;; only for the right number of stars. Using a regexp to do
  20324. ;; this is so much faster than using a Lisp loop.
  20325. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  20326. (forward-char 1)
  20327. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  20328. ;; something else, do it the slow way
  20329. (while (and (not (eobp))
  20330. (or first (> (funcall outline-level) level)))
  20331. (setq first nil)
  20332. (outline-next-heading)))
  20333. (unless to-heading
  20334. (if (memq (preceding-char) '(?\n ?\^M))
  20335. (progn
  20336. ;; Go to end of line before heading
  20337. (forward-char -1)
  20338. (if (memq (preceding-char) '(?\n ?\^M))
  20339. ;; leave blank line before heading
  20340. (forward-char -1))))))
  20341. (point))
  20342. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  20343. "Use Org version in org-mode, for dramatic speed-up."
  20344. (if (derived-mode-p 'org-mode)
  20345. (progn
  20346. (org-end-of-subtree nil t)
  20347. (unless (eobp) (backward-char 1)))
  20348. ad-do-it))
  20349. (defun org-end-of-meta-data-and-drawers ()
  20350. "Jump to the first text after meta data and drawers in the current entry.
  20351. This will move over empty lines, lines with planning time stamps,
  20352. clocking lines, and drawers."
  20353. (org-back-to-heading t)
  20354. (let ((end (save-excursion (outline-next-heading) (point)))
  20355. (re (concat "\\(" org-drawer-regexp "\\)"
  20356. "\\|" "[ \t]*" org-keyword-time-regexp)))
  20357. (forward-line 1)
  20358. (while (re-search-forward re end t)
  20359. (if (not (match-end 1))
  20360. ;; empty or planning line
  20361. (forward-line 1)
  20362. ;; a drawer, find the end
  20363. (re-search-forward "^[ \t]*:END:" end 'move)
  20364. (forward-line 1)))
  20365. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  20366. (point)))
  20367. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  20368. "Move forward to the arg'th subheading at same level as this one.
  20369. Stop at the first and last subheadings of a superior heading.
  20370. Normally this only looks at visible headings, but when INVISIBLE-OK is
  20371. non-nil it will also look at invisible ones."
  20372. (interactive "p")
  20373. (org-back-to-heading invisible-ok)
  20374. (org-at-heading-p)
  20375. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20376. (re (format "^\\*\\{1,%d\\} " level))
  20377. l)
  20378. (forward-char 1)
  20379. (while (> arg 0)
  20380. (while (and (re-search-forward re nil 'move)
  20381. (setq l (- (match-end 0) (match-beginning 0) 1))
  20382. (= l level)
  20383. (not invisible-ok)
  20384. (progn (backward-char 1) (outline-invisible-p)))
  20385. (if (< l level) (setq arg 1)))
  20386. (setq arg (1- arg)))
  20387. (beginning-of-line 1)))
  20388. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  20389. "Move backward to the arg'th subheading at same level as this one.
  20390. Stop at the first and last subheadings of a superior heading."
  20391. (interactive "p")
  20392. (org-back-to-heading)
  20393. (org-at-heading-p)
  20394. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20395. (re (format "^\\*\\{1,%d\\} " level))
  20396. l)
  20397. (while (> arg 0)
  20398. (while (and (re-search-backward re nil 'move)
  20399. (setq l (- (match-end 0) (match-beginning 0) 1))
  20400. (= l level)
  20401. (not invisible-ok)
  20402. (outline-invisible-p))
  20403. (if (< l level) (setq arg 1)))
  20404. (setq arg (1- arg)))))
  20405. ;;;###autoload
  20406. (defun org-forward-element ()
  20407. "Move forward by one element.
  20408. Move to the next element at the same level, when possible."
  20409. (interactive)
  20410. (cond ((eobp) (error "Cannot move further down"))
  20411. ((org-with-limited-levels (org-at-heading-p))
  20412. (let ((origin (point)))
  20413. (org-forward-heading-same-level 1)
  20414. (unless (org-with-limited-levels (org-at-heading-p))
  20415. (goto-char origin)
  20416. (error "Cannot move further down"))))
  20417. (t
  20418. (let* ((elem (org-element-at-point))
  20419. (end (org-element-property :end elem))
  20420. (parent (org-element-property :parent elem)))
  20421. (if (and parent (= (org-element-property :contents-end parent) end))
  20422. (goto-char (org-element-property :end parent))
  20423. (goto-char end))))))
  20424. ;;;###autoload
  20425. (defun org-backward-element ()
  20426. "Move backward by one element.
  20427. Move to the previous element at the same level, when possible."
  20428. (interactive)
  20429. (cond ((bobp) (error "Cannot move further up"))
  20430. ((org-with-limited-levels (org-at-heading-p))
  20431. ;; At an headline, move to the previous one, if any, or stay
  20432. ;; here.
  20433. (let ((origin (point)))
  20434. (org-backward-heading-same-level 1)
  20435. (unless (org-with-limited-levels (org-at-heading-p))
  20436. (goto-char origin)
  20437. (error "Cannot move further up"))))
  20438. (t
  20439. (let* ((trail (org-element-at-point 'keep-trail))
  20440. (elem (car trail))
  20441. (prev-elem (nth 1 trail))
  20442. (beg (org-element-property :begin elem)))
  20443. (cond
  20444. ;; Move to beginning of current element if point isn't
  20445. ;; there already.
  20446. ((/= (point) beg) (goto-char beg))
  20447. (prev-elem (goto-char (org-element-property :begin prev-elem)))
  20448. ((org-before-first-heading-p) (goto-char (point-min)))
  20449. (t (org-back-to-heading)))))))
  20450. ;;;###autoload
  20451. (defun org-up-element ()
  20452. "Move to upper element."
  20453. (interactive)
  20454. (if (org-with-limited-levels (org-at-heading-p))
  20455. (unless (org-up-heading-safe) (error "No surrounding element"))
  20456. (let* ((elem (org-element-at-point))
  20457. (parent (org-element-property :parent elem)))
  20458. (if parent (goto-char (org-element-property :begin parent))
  20459. (if (org-with-limited-levels (org-before-first-heading-p))
  20460. (error "No surrounding element")
  20461. (org-with-limited-levels (org-back-to-heading)))))))
  20462. ;;;###autoload
  20463. (defvar org-element-greater-elements)
  20464. (defun org-down-element ()
  20465. "Move to inner element."
  20466. (interactive)
  20467. (let ((element (org-element-at-point)))
  20468. (cond
  20469. ((memq (org-element-type element) '(plain-list table))
  20470. (goto-char (org-element-property :contents-begin element))
  20471. (forward-char))
  20472. ((memq (org-element-type element) org-element-greater-elements)
  20473. ;; If contents are hidden, first disclose them.
  20474. (when (org-element-property :hiddenp element) (org-cycle))
  20475. (goto-char (or (org-element-property :contents-begin element)
  20476. (error "No content for this element"))))
  20477. (t (error "No inner element")))))
  20478. ;;;###autoload
  20479. (defun org-drag-element-backward ()
  20480. "Move backward element at point."
  20481. (interactive)
  20482. (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
  20483. (let* ((trail (org-element-at-point 'keep-trail))
  20484. (elem (car trail))
  20485. (prev-elem (nth 1 trail)))
  20486. ;; Error out if no previous element or previous element is
  20487. ;; a parent of the current one.
  20488. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  20489. (error "Cannot drag element backward")
  20490. (let ((pos (point)))
  20491. (org-element-swap-A-B prev-elem elem)
  20492. (goto-char (+ (org-element-property :begin prev-elem)
  20493. (- pos (org-element-property :begin elem)))))))))
  20494. ;;;###autoload
  20495. (defun org-drag-element-forward ()
  20496. "Move forward element at point."
  20497. (interactive)
  20498. (let* ((pos (point))
  20499. (elem (org-element-at-point)))
  20500. (when (= (point-max) (org-element-property :end elem))
  20501. (error "Cannot drag element forward"))
  20502. (goto-char (org-element-property :end elem))
  20503. (let ((next-elem (org-element-at-point)))
  20504. (when (or (org-element-nested-p elem next-elem)
  20505. (and (eq (org-element-type next-elem) 'headline)
  20506. (not (eq (org-element-type elem) 'headline))))
  20507. (goto-char pos)
  20508. (error "Cannot drag element forward"))
  20509. ;; Compute new position of point: it's shifted by NEXT-ELEM
  20510. ;; body's length (without final blanks) and by the length of
  20511. ;; blanks between ELEM and NEXT-ELEM.
  20512. (let ((size-next (- (save-excursion
  20513. (goto-char (org-element-property :end next-elem))
  20514. (skip-chars-backward " \r\t\n")
  20515. (forward-line)
  20516. ;; Small correction if buffer doesn't end
  20517. ;; with a newline character.
  20518. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  20519. (org-element-property :begin next-elem)))
  20520. (size-blank (- (org-element-property :end elem)
  20521. (save-excursion
  20522. (goto-char (org-element-property :end elem))
  20523. (skip-chars-backward " \r\t\n")
  20524. (forward-line)
  20525. (point)))))
  20526. (org-element-swap-A-B elem next-elem)
  20527. (goto-char (+ pos size-next size-blank))))))
  20528. ;;;###autoload
  20529. (defun org-mark-element ()
  20530. "Put point at beginning of this element, mark at end.
  20531. Interactively, if this command is repeated or (in Transient Mark
  20532. mode) if the mark is active, it marks the next element after the
  20533. ones already marked."
  20534. (interactive)
  20535. (let (deactivate-mark)
  20536. (if (and (org-called-interactively-p 'any)
  20537. (or (and (eq last-command this-command) (mark t))
  20538. (and transient-mark-mode mark-active)))
  20539. (set-mark
  20540. (save-excursion
  20541. (goto-char (mark))
  20542. (goto-char (org-element-property :end (org-element-at-point)))))
  20543. (let ((element (org-element-at-point)))
  20544. (end-of-line)
  20545. (push-mark (org-element-property :end element) t t)
  20546. (goto-char (org-element-property :begin element))))))
  20547. ;;;###autoload
  20548. (defun org-narrow-to-element ()
  20549. "Narrow buffer to current element."
  20550. (interactive)
  20551. (let ((elem (org-element-at-point)))
  20552. (cond
  20553. ((eq (car elem) 'headline)
  20554. (narrow-to-region
  20555. (org-element-property :begin elem)
  20556. (org-element-property :end elem)))
  20557. ((memq (car elem) org-element-greater-elements)
  20558. (narrow-to-region
  20559. (org-element-property :contents-begin elem)
  20560. (org-element-property :contents-end elem)))
  20561. (t
  20562. (narrow-to-region
  20563. (org-element-property :begin elem)
  20564. (org-element-property :end elem))))))
  20565. ;;;###autoload
  20566. (defun org-transpose-element ()
  20567. "Transpose current and previous elements, keeping blank lines between.
  20568. Point is moved after both elements."
  20569. (interactive)
  20570. (org-skip-whitespace)
  20571. (let ((end (org-element-property :end (org-element-at-point))))
  20572. (org-drag-element-backward)
  20573. (goto-char end)))
  20574. ;;;###autoload
  20575. (defun org-unindent-buffer ()
  20576. "Un-indent the visible part of the buffer.
  20577. Relative indentation (between items, inside blocks, etc.) isn't
  20578. modified."
  20579. (interactive)
  20580. (unless (eq major-mode 'org-mode)
  20581. (error "Cannot un-indent a buffer not in Org mode"))
  20582. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  20583. unindent-tree ; For byte-compiler.
  20584. (unindent-tree
  20585. (function
  20586. (lambda (contents)
  20587. (mapc
  20588. (lambda (element)
  20589. (if (memq (org-element-type element) '(headline section))
  20590. (funcall unindent-tree (org-element-contents element))
  20591. (save-excursion
  20592. (save-restriction
  20593. (narrow-to-region
  20594. (org-element-property :begin element)
  20595. (org-element-property :end element))
  20596. (org-do-remove-indentation)))))
  20597. (reverse contents))))))
  20598. (funcall unindent-tree (org-element-contents parse-tree))))
  20599. (defun org-show-subtree ()
  20600. "Show everything after this heading at deeper levels."
  20601. (interactive)
  20602. (outline-flag-region
  20603. (point)
  20604. (save-excursion
  20605. (org-end-of-subtree t t))
  20606. nil))
  20607. (defun org-show-entry ()
  20608. "Show the body directly following this heading.
  20609. Show the heading too, if it is currently invisible."
  20610. (interactive)
  20611. (save-excursion
  20612. (condition-case nil
  20613. (progn
  20614. (org-back-to-heading t)
  20615. (outline-flag-region
  20616. (max (point-min) (1- (point)))
  20617. (save-excursion
  20618. (if (re-search-forward
  20619. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  20620. (match-beginning 1)
  20621. (point-max)))
  20622. nil)
  20623. (org-cycle-hide-drawers 'children))
  20624. (error nil))))
  20625. (defun org-make-options-regexp (kwds &optional extra)
  20626. "Make a regular expression for keyword lines."
  20627. (concat
  20628. "^#\\+\\("
  20629. (mapconcat 'regexp-quote kwds "\\|")
  20630. (if extra (concat "\\|" extra))
  20631. "\\):[ \t]*\\(.*\\)"))
  20632. ;; Make isearch reveal the necessary context
  20633. (defun org-isearch-end ()
  20634. "Reveal context after isearch exits."
  20635. (when isearch-success ; only if search was successful
  20636. (if (featurep 'xemacs)
  20637. ;; Under XEmacs, the hook is run in the correct place,
  20638. ;; we directly show the context.
  20639. (org-show-context 'isearch)
  20640. ;; In Emacs the hook runs *before* restoring the overlays.
  20641. ;; So we have to use a one-time post-command-hook to do this.
  20642. ;; (Emacs 22 has a special variable, see function `org-mode')
  20643. (unless (and (boundp 'isearch-mode-end-hook-quit)
  20644. isearch-mode-end-hook-quit)
  20645. ;; Only when the isearch was not quitted.
  20646. (org-add-hook 'post-command-hook 'org-isearch-post-command
  20647. 'append 'local)))))
  20648. (defun org-isearch-post-command ()
  20649. "Remove self from hook, and show context."
  20650. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  20651. (org-show-context 'isearch))
  20652. ;;;; Integration with and fixes for other packages
  20653. ;;; Imenu support
  20654. (defvar org-imenu-markers nil
  20655. "All markers currently used by Imenu.")
  20656. (make-variable-buffer-local 'org-imenu-markers)
  20657. (defun org-imenu-new-marker (&optional pos)
  20658. "Return a new marker for use by Imenu, and remember the marker."
  20659. (let ((m (make-marker)))
  20660. (move-marker m (or pos (point)))
  20661. (push m org-imenu-markers)
  20662. m))
  20663. (defun org-imenu-get-tree ()
  20664. "Produce the index for Imenu."
  20665. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  20666. (setq org-imenu-markers nil)
  20667. (let* ((n org-imenu-depth)
  20668. (re (concat "^" (org-get-limited-outline-regexp)))
  20669. (subs (make-vector (1+ n) nil))
  20670. (last-level 0)
  20671. m level head)
  20672. (save-excursion
  20673. (save-restriction
  20674. (widen)
  20675. (goto-char (point-max))
  20676. (while (re-search-backward re nil t)
  20677. (setq level (org-reduced-level (funcall outline-level)))
  20678. (when (and (<= level n)
  20679. (looking-at org-complex-heading-regexp))
  20680. (setq head (org-link-display-format
  20681. (org-match-string-no-properties 4))
  20682. m (org-imenu-new-marker))
  20683. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  20684. (if (>= level last-level)
  20685. (push (cons head m) (aref subs level))
  20686. (push (cons head (aref subs (1+ level))) (aref subs level))
  20687. (loop for i from (1+ level) to n do (aset subs i nil)))
  20688. (setq last-level level)))))
  20689. (aref subs 1)))
  20690. (eval-after-load "imenu"
  20691. '(progn
  20692. (add-hook 'imenu-after-jump-hook
  20693. (lambda ()
  20694. (if (derived-mode-p 'org-mode)
  20695. (org-show-context 'org-goto))))))
  20696. (defun org-link-display-format (link)
  20697. "Replace a link with either the description, or the link target
  20698. if no description is present"
  20699. (save-match-data
  20700. (if (string-match org-bracket-link-analytic-regexp link)
  20701. (replace-match (if (match-end 5)
  20702. (match-string 5 link)
  20703. (concat (match-string 1 link)
  20704. (match-string 3 link)))
  20705. nil t link)
  20706. link)))
  20707. (defun org-toggle-link-display ()
  20708. "Toggle the literal or descriptive display of links."
  20709. (interactive)
  20710. (if org-descriptive-links
  20711. (progn (org-remove-from-invisibility-spec '(org-link))
  20712. (org-restart-font-lock)
  20713. (setq org-descriptive-links nil))
  20714. (progn (add-to-invisibility-spec '(org-link))
  20715. (org-restart-font-lock)
  20716. (setq org-descriptive-links t))))
  20717. ;; Speedbar support
  20718. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  20719. "Overlay marking the agenda restriction line in speedbar.")
  20720. (overlay-put org-speedbar-restriction-lock-overlay
  20721. 'face 'org-agenda-restriction-lock)
  20722. (overlay-put org-speedbar-restriction-lock-overlay
  20723. 'help-echo "Agendas are currently limited to this item.")
  20724. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  20725. (defun org-speedbar-set-agenda-restriction ()
  20726. "Restrict future agenda commands to the location at point in speedbar.
  20727. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  20728. (interactive)
  20729. (require 'org-agenda)
  20730. (let (p m tp np dir txt)
  20731. (cond
  20732. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20733. 'org-imenu t))
  20734. (setq m (get-text-property p 'org-imenu-marker))
  20735. (with-current-buffer (marker-buffer m)
  20736. (goto-char m)
  20737. (org-agenda-set-restriction-lock 'subtree)))
  20738. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20739. 'speedbar-function 'speedbar-find-file))
  20740. (setq tp (previous-single-property-change
  20741. (1+ p) 'speedbar-function)
  20742. np (next-single-property-change
  20743. tp 'speedbar-function)
  20744. dir (speedbar-line-directory)
  20745. txt (buffer-substring-no-properties (or tp (point-min))
  20746. (or np (point-max))))
  20747. (with-current-buffer (find-file-noselect
  20748. (let ((default-directory dir))
  20749. (expand-file-name txt)))
  20750. (unless (derived-mode-p 'org-mode)
  20751. (error "Cannot restrict to non-Org-mode file"))
  20752. (org-agenda-set-restriction-lock 'file)))
  20753. (t (error "Don't know how to restrict Org-mode's agenda")))
  20754. (move-overlay org-speedbar-restriction-lock-overlay
  20755. (point-at-bol) (point-at-eol))
  20756. (setq current-prefix-arg nil)
  20757. (org-agenda-maybe-redo)))
  20758. (eval-after-load "speedbar"
  20759. '(progn
  20760. (speedbar-add-supported-extension ".org")
  20761. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  20762. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  20763. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  20764. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  20765. (add-hook 'speedbar-visiting-tag-hook
  20766. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  20767. ;;; Fixes and Hacks for problems with other packages
  20768. ;; Make flyspell not check words in links, to not mess up our keymap
  20769. (defun org-mode-flyspell-verify ()
  20770. "Don't let flyspell put overlays at active buttons, or on
  20771. {todo,all-time,additional-option-like}-keywords."
  20772. (let ((pos (max (1- (point)) (point-min)))
  20773. (word (thing-at-point 'word)))
  20774. (and (not (get-text-property pos 'keymap))
  20775. (not (get-text-property pos 'org-no-flyspell))
  20776. (not (member word org-todo-keywords-1))
  20777. (not (member word org-all-time-keywords))
  20778. (not (member word org-options-keywords))
  20779. (not (member word (mapcar 'car org-startup-options)))
  20780. (not (member word org-additional-option-like-keywords-for-flyspell)))))
  20781. (defun org-remove-flyspell-overlays-in (beg end)
  20782. "Remove flyspell overlays in region."
  20783. (and (org-bound-and-true-p flyspell-mode)
  20784. (fboundp 'flyspell-delete-region-overlays)
  20785. (flyspell-delete-region-overlays beg end))
  20786. (add-text-properties beg end '(org-no-flyspell t)))
  20787. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  20788. (eval-after-load "bookmark"
  20789. '(if (boundp 'bookmark-after-jump-hook)
  20790. ;; We can use the hook
  20791. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  20792. ;; Hook not available, use advice
  20793. (defadvice bookmark-jump (after org-make-visible activate)
  20794. "Make the position visible."
  20795. (org-bookmark-jump-unhide))))
  20796. ;; Make sure saveplace shows the location if it was hidden
  20797. (eval-after-load "saveplace"
  20798. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  20799. "Make the position visible."
  20800. (org-bookmark-jump-unhide)))
  20801. ;; Make sure ecb shows the location if it was hidden
  20802. (eval-after-load "ecb"
  20803. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  20804. "Make hierarchy visible when jumping into location from ECB tree buffer."
  20805. (if (derived-mode-p 'org-mode)
  20806. (org-show-context))))
  20807. (defun org-bookmark-jump-unhide ()
  20808. "Unhide the current position, to show the bookmark location."
  20809. (and (derived-mode-p 'org-mode)
  20810. (or (outline-invisible-p)
  20811. (save-excursion (goto-char (max (point-min) (1- (point))))
  20812. (outline-invisible-p)))
  20813. (org-show-context 'bookmark-jump)))
  20814. ;; Make session.el ignore our circular variable
  20815. (eval-after-load "session"
  20816. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  20817. ;;;; Experimental code
  20818. (defun org-closed-in-range ()
  20819. "Sparse tree of items closed in a certain time range.
  20820. Still experimental, may disappear in the future."
  20821. (interactive)
  20822. ;; Get the time interval from the user.
  20823. (let* ((time1 (org-float-time
  20824. (org-read-date nil 'to-time nil "Starting date: ")))
  20825. (time2 (org-float-time
  20826. (org-read-date nil 'to-time nil "End date:")))
  20827. ;; callback function
  20828. (callback (lambda ()
  20829. (let ((time
  20830. (org-float-time
  20831. (apply 'encode-time
  20832. (org-parse-time-string
  20833. (match-string 1))))))
  20834. ;; check if time in interval
  20835. (and (>= time time1) (<= time time2))))))
  20836. ;; make tree, check each match with the callback
  20837. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  20838. ;;;; Finish up
  20839. (provide 'org)
  20840. (run-hooks 'org-load-hook)
  20841. ;;; org.el ends here