org.el 844 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
  4. ;;
  5. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  6. ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
  7. ;; Keywords: outlines, hypermedia, calendar, wp
  8. ;; Homepage: http://orgmode.org
  9. ;;
  10. ;; This file is part of GNU Emacs.
  11. ;;
  12. ;; GNU Emacs is free software: you can redistribute it and/or modify
  13. ;; it under the terms of the GNU General Public License as published by
  14. ;; the Free Software Foundation, either version 3 of the License, or
  15. ;; (at your option) any later version.
  16. ;; GNU Emacs is distributed in the hope that it will be useful,
  17. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. ;; GNU General Public License for more details.
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  22. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  23. ;;
  24. ;;; Commentary:
  25. ;;
  26. ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  27. ;; project planning with a fast and effective plain-text system.
  28. ;;
  29. ;; Org-mode develops organizational tasks around NOTES files that contain
  30. ;; information about projects as plain text. Org-mode is implemented on
  31. ;; top of outline-mode, which makes it possible to keep the content of
  32. ;; large files well structured. Visibility cycling and structure editing
  33. ;; help to work with the tree. Tables are easily created with a built-in
  34. ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
  35. ;; and scheduling. It dynamically compiles entries into an agenda that
  36. ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
  37. ;; Plain text URL-like links connect to websites, emails, Usenet
  38. ;; messages, BBDB entries, and any files related to the projects. For
  39. ;; printing and sharing of notes, an Org-mode file can be exported as a
  40. ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
  41. ;; iCalendar file. It can also serve as a publishing tool for a set of
  42. ;; linked webpages.
  43. ;;
  44. ;; Installation and Activation
  45. ;; ---------------------------
  46. ;; See the corresponding sections in the manual at
  47. ;;
  48. ;; http://orgmode.org/org.html#Installation
  49. ;;
  50. ;; Documentation
  51. ;; -------------
  52. ;; The documentation of Org-mode can be found in the TeXInfo file. The
  53. ;; distribution also contains a PDF version of it. At the homepage of
  54. ;; Org-mode, you can read the same text online as HTML. There is also an
  55. ;; excellent reference card made by Philip Rooke. This card can be found
  56. ;; in the etc/ directory of Emacs 22.
  57. ;;
  58. ;; A list of recent changes can be found at
  59. ;; http://orgmode.org/Changes.html
  60. ;;
  61. ;;; Code:
  62. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  63. (defvar org-table-formula-constants-local nil
  64. "Local version of `org-table-formula-constants'.")
  65. (make-variable-buffer-local 'org-table-formula-constants-local)
  66. ;;;; Require other packages
  67. (eval-when-compile
  68. (require 'cl)
  69. (require 'gnus-sum))
  70. (require 'calendar)
  71. (require 'find-func)
  72. (require 'format-spec)
  73. ;; `org-outline-regexp' ought to be a defconst but is let-binding in
  74. ;; some places -- e.g. see the macro org-with-limited-levels.
  75. ;;
  76. ;; In Org buffers, the value of `outline-regexp' is that of
  77. ;; `org-outline-regexp'. The only function still directly relying on
  78. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  79. ;; job when `orgstruct-mode' is active.
  80. (defvar org-outline-regexp "\\*+ "
  81. "Regexp to match Org headlines.")
  82. (defvar org-outline-regexp-bol "^\\*+ "
  83. "Regexp to match Org headlines.
  84. This is similar to `org-outline-regexp' but additionally makes
  85. sure that we are at the beginning of the line.")
  86. (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  87. "Matches an headline, putting stars and text into groups.
  88. Stars are put in group 1 and the trimmed body in group 2.")
  89. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  90. (when (fboundp 'defvaralias)
  91. (unless (boundp 'calendar-view-holidays-initially-flag)
  92. (defvaralias 'calendar-view-holidays-initially-flag
  93. 'view-calendar-holidays-initially))
  94. (unless (boundp 'calendar-view-diary-initially-flag)
  95. (defvaralias 'calendar-view-diary-initially-flag
  96. 'view-diary-entries-initially))
  97. (unless (boundp 'diary-fancy-buffer)
  98. (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
  99. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  100. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  101. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  102. (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
  103. (declare-function org-at-clock-log-p "org-clock" ())
  104. (declare-function org-clock-timestamps-up "org-clock" ())
  105. (declare-function org-clock-timestamps-down "org-clock" ())
  106. ;; load languages based on value of `org-babel-load-languages'
  107. (defvar org-babel-load-languages)
  108. ;;;###autoload
  109. (defun org-babel-do-load-languages (sym value)
  110. "Load the languages defined in `org-babel-load-languages'."
  111. (set-default sym value)
  112. (mapc (lambda (pair)
  113. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  114. (if active
  115. (progn
  116. (require (intern (concat "ob-" lang))))
  117. (progn
  118. (funcall 'fmakunbound
  119. (intern (concat "org-babel-execute:" lang)))
  120. (funcall 'fmakunbound
  121. (intern (concat "org-babel-expand-body:" lang)))))))
  122. org-babel-load-languages))
  123. (defcustom org-babel-load-languages '((emacs-lisp . t))
  124. "Languages which can be evaluated in Org-mode buffers.
  125. This list can be used to load support for any of the languages
  126. below, note that each language will depend on a different set of
  127. system executables and/or Emacs modes. When a language is
  128. \"loaded\", then code blocks in that language can be evaluated
  129. with `org-babel-execute-src-block' bound by default to C-c
  130. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  131. be set to remove code block evaluation from the C-c C-c
  132. keybinding. By default only Emacs Lisp (which has no
  133. requirements) is loaded."
  134. :group 'org-babel
  135. :set 'org-babel-do-load-languages
  136. :version "24.1"
  137. :type '(alist :tag "Babel Languages"
  138. :key-type
  139. (choice
  140. (const :tag "Awk" awk)
  141. (const :tag "C" C)
  142. (const :tag "R" R)
  143. (const :tag "Asymptote" asymptote)
  144. (const :tag "Calc" calc)
  145. (const :tag "Clojure" clojure)
  146. (const :tag "CSS" css)
  147. (const :tag "Ditaa" ditaa)
  148. (const :tag "Dot" dot)
  149. (const :tag "Emacs Lisp" emacs-lisp)
  150. (const :tag "Fortran" fortran)
  151. (const :tag "Gnuplot" gnuplot)
  152. (const :tag "Haskell" haskell)
  153. (const :tag "IO" io)
  154. (const :tag "Java" java)
  155. (const :tag "Javascript" js)
  156. (const :tag "LaTeX" latex)
  157. (const :tag "Ledger" ledger)
  158. (const :tag "Lilypond" lilypond)
  159. (const :tag "Lisp" lisp)
  160. (const :tag "Maxima" maxima)
  161. (const :tag "Matlab" matlab)
  162. (const :tag "Mscgen" mscgen)
  163. (const :tag "Ocaml" ocaml)
  164. (const :tag "Octave" octave)
  165. (const :tag "Org" org)
  166. (const :tag "Perl" perl)
  167. (const :tag "Pico Lisp" picolisp)
  168. (const :tag "PlantUML" plantuml)
  169. (const :tag "Python" python)
  170. (const :tag "Ruby" ruby)
  171. (const :tag "Sass" sass)
  172. (const :tag "Scala" scala)
  173. (const :tag "Scheme" scheme)
  174. (const :tag "Screen" screen)
  175. (const :tag "Shell Script" sh)
  176. (const :tag "Shen" shen)
  177. (const :tag "Sql" sql)
  178. (const :tag "Sqlite" sqlite))
  179. :value-type (boolean :tag "Activate" :value t)))
  180. ;;;; Customization variables
  181. (defcustom org-clone-delete-id nil
  182. "Remove ID property of clones of a subtree.
  183. When non-nil, clones of a subtree don't inherit the ID property.
  184. Otherwise they inherit the ID property with a new unique
  185. identifier."
  186. :type 'boolean
  187. :version "24.1"
  188. :group 'org-id)
  189. ;;; Version
  190. (require 'org-compat)
  191. (org-check-version)
  192. ;;;###autoload
  193. (defun org-version (&optional here full message)
  194. "Show the org-mode version in the echo area.
  195. With prefix argument HERE, insert it at point.
  196. When FULL is non-nil, use a verbose version string.
  197. When MESSAGE is non-nil, display a message with the version."
  198. (interactive "P")
  199. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  200. (org-install-dir (ignore-errors (org-find-library-dir "org-install.el")))
  201. (org-trash (or
  202. (and (fboundp 'org-release) (fboundp 'org-git-version))
  203. (load (concat org-dir "org-version.el")
  204. 'noerror 'nomessage 'nosuffix)))
  205. (org-version (org-release))
  206. (git-version (org-git-version))
  207. (version (format "Org-mode version %s (%s @ %s)"
  208. org-version
  209. git-version
  210. (if org-install-dir
  211. (if (string= org-dir org-install-dir)
  212. org-install-dir
  213. (concat "mixed installation! " org-install-dir " and " org-dir))
  214. "org-install.el can not be found!")))
  215. (_version (if full version org-version)))
  216. (if (org-called-interactively-p 'interactive)
  217. (if here
  218. (insert version)
  219. (message version))
  220. (if message (message _version))
  221. _version)))
  222. ;;; Compatibility constants
  223. ;;; The custom variables
  224. (defgroup org nil
  225. "Outline-based notes management and organizer."
  226. :tag "Org"
  227. :group 'outlines
  228. :group 'calendar)
  229. (defcustom org-mode-hook nil
  230. "Mode hook for Org-mode, run after the mode was turned on."
  231. :group 'org
  232. :type 'hook)
  233. (defcustom org-load-hook nil
  234. "Hook that is run after org.el has been loaded."
  235. :group 'org
  236. :type 'hook)
  237. (defcustom org-log-buffer-setup-hook nil
  238. "Hook that is run after an Org log buffer is created."
  239. :group 'org
  240. :version "24.1"
  241. :type 'hook)
  242. (defvar org-modules) ; defined below
  243. (defvar org-modules-loaded nil
  244. "Have the modules been loaded already?")
  245. (defun org-load-modules-maybe (&optional force)
  246. "Load all extensions listed in `org-modules'."
  247. (when (or force (not org-modules-loaded))
  248. (mapc (lambda (ext)
  249. (condition-case nil (require ext)
  250. (error (message "Problems while trying to load feature `%s'" ext))))
  251. org-modules)
  252. (setq org-modules-loaded t)))
  253. (defun org-set-modules (var value)
  254. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  255. (set var value)
  256. (when (featurep 'org)
  257. (org-load-modules-maybe 'force)))
  258. (when (org-bound-and-true-p org-modules)
  259. (let ((a (member 'org-infojs org-modules)))
  260. (and a (setcar a 'org-jsinfo))))
  261. (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)
  262. "Modules that should always be loaded together with org.el.
  263. If a description starts with <C>, the file is not part of Emacs
  264. and loading it will require that you have downloaded and properly installed
  265. the org-mode distribution.
  266. You can also use this system to load external packages (i.e. neither Org
  267. core modules, nor modules from the CONTRIB directory). Just add symbols
  268. to the end of the list. If the package is called org-xyz.el, then you need
  269. to add the symbol `xyz', and the package must have a call to
  270. (provide 'org-xyz)"
  271. :group 'org
  272. :set 'org-set-modules
  273. :type
  274. '(set :greedy t
  275. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  276. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  277. (const :tag " crypt: Encryption of subtrees" org-crypt)
  278. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  279. (const :tag " docview: Links to doc-view buffers" org-docview)
  280. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  281. (const :tag " id: Global IDs for identifying entries" org-id)
  282. (const :tag " info: Links to Info nodes" org-info)
  283. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  284. (const :tag " habit: Track your consistency with habits" org-habit)
  285. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  286. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  287. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  288. (const :tag " mew Links to Mew folders/messages" org-mew)
  289. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  290. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  291. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  292. (const :tag " special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  293. (const :tag " vm: Links to VM folders/messages" org-vm)
  294. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  295. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  296. (const :tag " mouse: Additional mouse support" org-mouse)
  297. (const :tag " TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  298. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  299. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  300. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  301. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  302. (const :tag "C collector: Collect properties into tables" org-collector)
  303. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  304. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  305. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  306. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  307. (const :tag "C eval: Include command output as text" org-eval)
  308. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  309. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  310. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  311. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  312. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  313. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  314. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  315. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  316. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  317. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  318. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  319. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  320. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  321. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  322. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  323. (const :tag "C registry: A registry for Org-mode links" org-registry)
  324. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  325. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  326. (const :tag "C secretary: Team management with org-mode" org-secretary)
  327. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  328. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  329. (const :tag "C track: Keep up with Org-mode development" org-track)
  330. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  331. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  332. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  333. (defcustom org-support-shift-select nil
  334. "Non-nil means make shift-cursor commands select text when possible.
  335. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  336. start selecting a region, or enlarge regions started in this way.
  337. In Org-mode, in special contexts, these same keys are used for
  338. other purposes, important enough to compete with shift selection.
  339. Org tries to balance these needs by supporting `shift-select-mode'
  340. outside these special contexts, under control of this variable.
  341. The default of this variable is nil, to avoid confusing behavior. Shifted
  342. cursor keys will then execute Org commands in the following contexts:
  343. - on a headline, changing TODO state (left/right) and priority (up/down)
  344. - on a time stamp, changing the time
  345. - in a plain list item, changing the bullet type
  346. - in a property definition line, switching between allowed values
  347. - in the BEGIN line of a clock table (changing the time block).
  348. Outside these contexts, the commands will throw an error.
  349. When this variable is t and the cursor is not in a special
  350. context, Org-mode will support shift-selection for making and
  351. enlarging regions. To make this more effective, the bullet
  352. cycling will no longer happen anywhere in an item line, but only
  353. if the cursor is exactly on the bullet.
  354. If you set this variable to the symbol `always', then the keys
  355. will not be special in headlines, property lines, and item lines,
  356. to make shift selection work there as well. If this is what you
  357. want, you can use the following alternative commands: `C-c C-t'
  358. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  359. can be used to switch TODO sets, `C-c -' to cycle item bullet
  360. types, and properties can be edited by hand or in column view.
  361. However, when the cursor is on a timestamp, shift-cursor commands
  362. will still edit the time stamp - this is just too good to give up.
  363. XEmacs user should have this variable set to nil, because
  364. `shift-select-mode' is in Emacs 23 or later only."
  365. :group 'org
  366. :type '(choice
  367. (const :tag "Never" nil)
  368. (const :tag "When outside special context" t)
  369. (const :tag "Everywhere except timestamps" always)))
  370. (defcustom org-loop-over-headlines-in-active-region nil
  371. "Shall some commands act upon headlines in the active region?
  372. When set to `t', some commands will be performed in all headlines
  373. within the active region.
  374. When set to `start-level', some commands will be performed in all
  375. headlines within the active region, provided that these headlines
  376. are of the same level than the first one.
  377. When set to a string, those commands will be performed on the
  378. matching headlines within the active region. Such string must be
  379. a tags/property/todo match as it is used in the agenda tags view.
  380. The list of commands is: `org-schedule', `org-deadline',
  381. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  382. `org-archive-to-archive-sibling'. The archiving commands skip
  383. already archived entries."
  384. :type '(choice (const :tag "Don't loop" nil)
  385. (const :tag "All headlines in active region" t)
  386. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  387. (string :tag "Tags/Property/Todo matcher"))
  388. :version "24.1"
  389. :group 'org-todo
  390. :group 'org-archive)
  391. (defgroup org-startup nil
  392. "Options concerning startup of Org-mode."
  393. :tag "Org Startup"
  394. :group 'org)
  395. (defcustom org-startup-folded t
  396. "Non-nil means entering Org-mode will switch to OVERVIEW.
  397. This can also be configured on a per-file basis by adding one of
  398. the following lines anywhere in the buffer:
  399. #+STARTUP: fold (or `overview', this is equivalent)
  400. #+STARTUP: nofold (or `showall', this is equivalent)
  401. #+STARTUP: content
  402. #+STARTUP: showeverything"
  403. :group 'org-startup
  404. :type '(choice
  405. (const :tag "nofold: show all" nil)
  406. (const :tag "fold: overview" t)
  407. (const :tag "content: all headlines" content)
  408. (const :tag "show everything, even drawers" showeverything)))
  409. (defcustom org-startup-truncated t
  410. "Non-nil means entering Org-mode will set `truncate-lines'.
  411. This is useful since some lines containing links can be very long and
  412. uninteresting. Also tables look terrible when wrapped."
  413. :group 'org-startup
  414. :type 'boolean)
  415. (defcustom org-startup-indented nil
  416. "Non-nil means turn on `org-indent-mode' on startup.
  417. This can also be configured on a per-file basis by adding one of
  418. the following lines anywhere in the buffer:
  419. #+STARTUP: indent
  420. #+STARTUP: noindent"
  421. :group 'org-structure
  422. :type '(choice
  423. (const :tag "Not" nil)
  424. (const :tag "Globally (slow on startup in large files)" t)))
  425. (defcustom org-use-sub-superscripts t
  426. "Non-nil means interpret \"_\" and \"^\" for export.
  427. When this option is turned on, you can use TeX-like syntax for sub- and
  428. superscripts. Several characters after \"_\" or \"^\" will be
  429. considered as a single item - so grouping with {} is normally not
  430. needed. For example, the following things will be parsed as single
  431. sub- or superscripts.
  432. 10^24 or 10^tau several digits will be considered 1 item.
  433. 10^-12 or 10^-tau a leading sign with digits or a word
  434. x^2-y^3 will be read as x^2 - y^3, because items are
  435. terminated by almost any nonword/nondigit char.
  436. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  437. Still, ambiguity is possible - so when in doubt use {} to enclose the
  438. sub/superscript. If you set this variable to the symbol `{}',
  439. the braces are *required* in order to trigger interpretations as
  440. sub/superscript. This can be helpful in documents that need \"_\"
  441. frequently in plain text.
  442. Not all export backends support this, but HTML does.
  443. This option can also be set with the #+OPTIONS line, e.g. \"^:nil\"."
  444. :group 'org-startup
  445. :group 'org-export-translation
  446. :version "24.1"
  447. :type '(choice
  448. (const :tag "Always interpret" t)
  449. (const :tag "Only with braces" {})
  450. (const :tag "Never interpret" nil)))
  451. (if (fboundp 'defvaralias)
  452. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
  453. (defcustom org-startup-with-beamer-mode nil
  454. "Non-nil means turn on `org-beamer-mode' on startup.
  455. This can also be configured on a per-file basis by adding one of
  456. the following lines anywhere in the buffer:
  457. #+STARTUP: beamer"
  458. :group 'org-startup
  459. :version "24.1"
  460. :type 'boolean)
  461. (defcustom org-startup-align-all-tables nil
  462. "Non-nil means align all tables when visiting a file.
  463. This is useful when the column width in tables is forced with <N> cookies
  464. in table fields. Such tables will look correct only after the first re-align.
  465. This can also be configured on a per-file basis by adding one of
  466. the following lines anywhere in the buffer:
  467. #+STARTUP: align
  468. #+STARTUP: noalign"
  469. :group 'org-startup
  470. :type 'boolean)
  471. (defcustom org-startup-with-inline-images nil
  472. "Non-nil means show inline images when loading a new Org file.
  473. This can also be configured on a per-file basis by adding one of
  474. the following lines anywhere in the buffer:
  475. #+STARTUP: inlineimages
  476. #+STARTUP: noinlineimages"
  477. :group 'org-startup
  478. :version "24.1"
  479. :type 'boolean)
  480. (defcustom org-insert-mode-line-in-empty-file nil
  481. "Non-nil means insert the first line setting Org-mode in empty files.
  482. When the function `org-mode' is called interactively in an empty file, this
  483. normally means that the file name does not automatically trigger Org-mode.
  484. To ensure that the file will always be in Org-mode in the future, a
  485. line enforcing Org-mode will be inserted into the buffer, if this option
  486. has been set."
  487. :group 'org-startup
  488. :type 'boolean)
  489. (defcustom org-replace-disputed-keys nil
  490. "Non-nil means use alternative key bindings for some keys.
  491. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  492. These keys are also used by other packages like shift-selection-mode'
  493. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  494. If you want to use Org-mode together with one of these other modes,
  495. or more generally if you would like to move some Org-mode commands to
  496. other keys, set this variable and configure the keys with the variable
  497. `org-disputed-keys'.
  498. This option is only relevant at load-time of Org-mode, and must be set
  499. *before* org.el is loaded. Changing it requires a restart of Emacs to
  500. become effective."
  501. :group 'org-startup
  502. :type 'boolean)
  503. (defcustom org-use-extra-keys nil
  504. "Non-nil means use extra key sequence definitions for certain commands.
  505. This happens automatically if you run XEmacs or if `window-system'
  506. is nil. This variable lets you do the same manually. You must
  507. set it before loading org.
  508. Example: on Carbon Emacs 22 running graphically, with an external
  509. keyboard on a Powerbook, the default way of setting M-left might
  510. not work for either Alt or ESC. Setting this variable will make
  511. it work for ESC."
  512. :group 'org-startup
  513. :type 'boolean)
  514. (if (fboundp 'defvaralias)
  515. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  516. (defcustom org-disputed-keys
  517. '(([(shift up)] . [(meta p)])
  518. ([(shift down)] . [(meta n)])
  519. ([(shift left)] . [(meta -)])
  520. ([(shift right)] . [(meta +)])
  521. ([(control shift right)] . [(meta shift +)])
  522. ([(control shift left)] . [(meta shift -)]))
  523. "Keys for which Org-mode and other modes compete.
  524. This is an alist, cars are the default keys, second element specifies
  525. the alternative to use when `org-replace-disputed-keys' is t.
  526. Keys can be specified in any syntax supported by `define-key'.
  527. The value of this option takes effect only at Org-mode's startup,
  528. therefore you'll have to restart Emacs to apply it after changing."
  529. :group 'org-startup
  530. :type 'alist)
  531. (defun org-key (key)
  532. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  533. Or return the original if not disputed.
  534. Also apply the translations defined in `org-xemacs-key-equivalents'."
  535. (when org-replace-disputed-keys
  536. (let* ((nkey (key-description key))
  537. (x (org-find-if (lambda (x)
  538. (equal (key-description (car x)) nkey))
  539. org-disputed-keys)))
  540. (setq key (if x (cdr x) key))))
  541. (when (featurep 'xemacs)
  542. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  543. key)
  544. (defun org-find-if (predicate seq)
  545. (catch 'exit
  546. (while seq
  547. (if (funcall predicate (car seq))
  548. (throw 'exit (car seq))
  549. (pop seq)))))
  550. (defun org-defkey (keymap key def)
  551. "Define a key, possibly translated, as returned by `org-key'."
  552. (define-key keymap (org-key key) def))
  553. (defcustom org-ellipsis nil
  554. "The ellipsis to use in the Org-mode outline.
  555. When nil, just use the standard three dots. When a string, use that instead,
  556. When a face, use the standard 3 dots, but with the specified face.
  557. The change affects only Org-mode (which will then use its own display table).
  558. Changing this requires executing `M-x org-mode' in a buffer to become
  559. effective."
  560. :group 'org-startup
  561. :type '(choice (const :tag "Default" nil)
  562. (face :tag "Face" :value org-warning)
  563. (string :tag "String" :value "...#")))
  564. (defvar org-display-table nil
  565. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  566. (defgroup org-keywords nil
  567. "Keywords in Org-mode."
  568. :tag "Org Keywords"
  569. :group 'org)
  570. (defcustom org-deadline-string "DEADLINE:"
  571. "String to mark deadline entries.
  572. A deadline is this string, followed by a time stamp. Should be a word,
  573. terminated by a colon. You can insert a schedule keyword and
  574. a timestamp with \\[org-deadline].
  575. Changes become only effective after restarting Emacs."
  576. :group 'org-keywords
  577. :type 'string)
  578. (defcustom org-scheduled-string "SCHEDULED:"
  579. "String to mark scheduled TODO entries.
  580. A schedule is this string, followed by a time stamp. Should be a word,
  581. terminated by a colon. You can insert a schedule keyword and
  582. a timestamp with \\[org-schedule].
  583. Changes become only effective after restarting Emacs."
  584. :group 'org-keywords
  585. :type 'string)
  586. (defcustom org-closed-string "CLOSED:"
  587. "String used as the prefix for timestamps logging closing a TODO entry."
  588. :group 'org-keywords
  589. :type 'string)
  590. (defcustom org-clock-string "CLOCK:"
  591. "String used as prefix for timestamps clocking work hours on an item."
  592. :group 'org-keywords
  593. :type 'string)
  594. (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
  595. org-scheduled-string "\\|"
  596. org-deadline-string "\\|"
  597. org-closed-string "\\|"
  598. org-clock-string "\\)")
  599. "Matches a line with planning or clock info.")
  600. (defcustom org-comment-string "COMMENT"
  601. "Entries starting with this keyword will never be exported.
  602. An entry can be toggled between COMMENT and normal with
  603. \\[org-toggle-comment].
  604. Changes become only effective after restarting Emacs."
  605. :group 'org-keywords
  606. :type 'string)
  607. (defcustom org-quote-string "QUOTE"
  608. "Entries starting with this keyword will be exported in fixed-width font.
  609. Quoting applies only to the text in the entry following the headline, and does
  610. not extend beyond the next headline, even if that is lower level.
  611. An entry can be toggled between QUOTE and normal with
  612. \\[org-toggle-fixed-width-section]."
  613. :group 'org-keywords
  614. :type 'string)
  615. (defconst org-repeat-re
  616. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  617. "Regular expression for specifying repeated events.
  618. After a match, group 1 contains the repeat expression.")
  619. (defgroup org-structure nil
  620. "Options concerning the general structure of Org-mode files."
  621. :tag "Org Structure"
  622. :group 'org)
  623. (defgroup org-reveal-location nil
  624. "Options about how to make context of a location visible."
  625. :tag "Org Reveal Location"
  626. :group 'org-structure)
  627. (defconst org-context-choice
  628. '(choice
  629. (const :tag "Always" t)
  630. (const :tag "Never" nil)
  631. (repeat :greedy t :tag "Individual contexts"
  632. (cons
  633. (choice :tag "Context"
  634. (const agenda)
  635. (const org-goto)
  636. (const occur-tree)
  637. (const tags-tree)
  638. (const link-search)
  639. (const mark-goto)
  640. (const bookmark-jump)
  641. (const isearch)
  642. (const default))
  643. (boolean))))
  644. "Contexts for the reveal options.")
  645. (defcustom org-show-hierarchy-above '((default . t))
  646. "Non-nil means show full hierarchy when revealing a location.
  647. Org-mode often shows locations in an org-mode file which might have
  648. been invisible before. When this is set, the hierarchy of headings
  649. above the exposed location is shown.
  650. Turning this off for example for sparse trees makes them very compact.
  651. Instead of t, this can also be an alist specifying this option for different
  652. contexts. Valid contexts are
  653. agenda when exposing an entry from the agenda
  654. org-goto when using the command `org-goto' on key C-c C-j
  655. occur-tree when using the command `org-occur' on key C-c /
  656. tags-tree when constructing a sparse tree based on tags matches
  657. link-search when exposing search matches associated with a link
  658. mark-goto when exposing the jump goal of a mark
  659. bookmark-jump when exposing a bookmark location
  660. isearch when exiting from an incremental search
  661. default default for all contexts not set explicitly"
  662. :group 'org-reveal-location
  663. :type org-context-choice)
  664. (defcustom org-show-following-heading '((default . nil))
  665. "Non-nil means show following heading when revealing a location.
  666. Org-mode often shows locations in an org-mode file which might have
  667. been invisible before. When this is set, the heading following the
  668. match is shown.
  669. Turning this off for example for sparse trees makes them very compact,
  670. but makes it harder to edit the location of the match. In such a case,
  671. use the command \\[org-reveal] to show more context.
  672. Instead of t, this can also be an alist specifying this option for different
  673. contexts. See `org-show-hierarchy-above' for valid contexts."
  674. :group 'org-reveal-location
  675. :type org-context-choice)
  676. (defcustom org-show-siblings '((default . nil) (isearch t))
  677. "Non-nil means show all sibling heading when revealing a location.
  678. Org-mode often shows locations in an org-mode file which might have
  679. been invisible before. When this is set, the sibling of the current entry
  680. heading are all made visible. If `org-show-hierarchy-above' is t,
  681. the same happens on each level of the hierarchy above the current entry.
  682. By default this is on for the isearch context, off for all other contexts.
  683. Turning this off for example for sparse trees makes them very compact,
  684. but makes it harder to edit the location of the match. In such a case,
  685. use the command \\[org-reveal] to show more context.
  686. Instead of t, this can also be an alist specifying this option for different
  687. contexts. See `org-show-hierarchy-above' for valid contexts."
  688. :group 'org-reveal-location
  689. :type org-context-choice)
  690. (defcustom org-show-entry-below '((default . nil))
  691. "Non-nil means show the entry below a headline when revealing a location.
  692. Org-mode often shows locations in an org-mode file which might have
  693. been invisible before. When this is set, the text below the headline that is
  694. exposed is also shown.
  695. By default this is off for all contexts.
  696. Instead of t, this can also be an alist specifying this option for different
  697. contexts. See `org-show-hierarchy-above' for valid contexts."
  698. :group 'org-reveal-location
  699. :type org-context-choice)
  700. (defcustom org-indirect-buffer-display 'other-window
  701. "How should indirect tree buffers be displayed?
  702. This applies to indirect buffers created with the commands
  703. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  704. Valid values are:
  705. current-window Display in the current window
  706. other-window Just display in another window.
  707. dedicated-frame Create one new frame, and re-use it each time.
  708. new-frame Make a new frame each time. Note that in this case
  709. previously-made indirect buffers are kept, and you need to
  710. kill these buffers yourself."
  711. :group 'org-structure
  712. :group 'org-agenda-windows
  713. :type '(choice
  714. (const :tag "In current window" current-window)
  715. (const :tag "In current frame, other window" other-window)
  716. (const :tag "Each time a new frame" new-frame)
  717. (const :tag "One dedicated frame" dedicated-frame)))
  718. (defcustom org-use-speed-commands nil
  719. "Non-nil means activate single letter commands at beginning of a headline.
  720. This may also be a function to test for appropriate locations where speed
  721. commands should be active."
  722. :group 'org-structure
  723. :type '(choice
  724. (const :tag "Never" nil)
  725. (const :tag "At beginning of headline stars" t)
  726. (function)))
  727. (defcustom org-speed-commands-user nil
  728. "Alist of additional speed commands.
  729. This list will be checked before `org-speed-commands-default'
  730. when the variable `org-use-speed-commands' is non-nil
  731. and when the cursor is at the beginning of a headline.
  732. The car if each entry is a string with a single letter, which must
  733. be assigned to `self-insert-command' in the global map.
  734. The cdr is either a command to be called interactively, a function
  735. to be called, or a form to be evaluated.
  736. An entry that is just a list with a single string will be interpreted
  737. as a descriptive headline that will be added when listing the speed
  738. commands in the Help buffer using the `?' speed command."
  739. :group 'org-structure
  740. :type '(repeat :value ("k" . ignore)
  741. (choice :value ("k" . ignore)
  742. (list :tag "Descriptive Headline" (string :tag "Headline"))
  743. (cons :tag "Letter and Command"
  744. (string :tag "Command letter")
  745. (choice
  746. (function)
  747. (sexp))))))
  748. (defgroup org-cycle nil
  749. "Options concerning visibility cycling in Org-mode."
  750. :tag "Org Cycle"
  751. :group 'org-structure)
  752. (defcustom org-cycle-skip-children-state-if-no-children t
  753. "Non-nil means skip CHILDREN state in entries that don't have any."
  754. :group 'org-cycle
  755. :type 'boolean)
  756. (defcustom org-cycle-max-level nil
  757. "Maximum level which should still be subject to visibility cycling.
  758. Levels higher than this will, for cycling, be treated as text, not a headline.
  759. When `org-odd-levels-only' is set, a value of N in this variable actually
  760. means 2N-1 stars as the limiting headline.
  761. When nil, cycle all levels.
  762. Note that the limiting level of cycling is also influenced by
  763. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  764. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  765. than its value."
  766. :group 'org-cycle
  767. :type '(choice
  768. (const :tag "No limit" nil)
  769. (integer :tag "Maximum level")))
  770. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  771. "Names of drawers. Drawers are not opened by cycling on the headline above.
  772. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  773. this:
  774. :DRAWERNAME:
  775. .....
  776. :END:
  777. The drawer \"PROPERTIES\" is special for capturing properties through
  778. the property API.
  779. Drawers can be defined on the per-file basis with a line like:
  780. #+DRAWERS: HIDDEN STATE PROPERTIES"
  781. :group 'org-structure
  782. :group 'org-cycle
  783. :type '(repeat (string :tag "Drawer Name")))
  784. (defcustom org-hide-block-startup nil
  785. "Non-nil means entering Org-mode will fold all blocks.
  786. This can also be set in on a per-file basis with
  787. #+STARTUP: hideblocks
  788. #+STARTUP: showblocks"
  789. :group 'org-startup
  790. :group 'org-cycle
  791. :type 'boolean)
  792. (defcustom org-cycle-global-at-bob nil
  793. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  794. This makes it possible to do global cycling without having to use S-TAB or
  795. \\[universal-argument] TAB. For this special case to work, the first line \
  796. of the buffer
  797. must not be a headline - it may be empty or some other text. When used in
  798. this way, `org-cycle-hook' is disables temporarily, to make sure the
  799. cursor stays at the beginning of the buffer.
  800. When this option is nil, don't do anything special at the beginning
  801. of the buffer."
  802. :group 'org-cycle
  803. :type 'boolean)
  804. (defcustom org-cycle-level-after-item/entry-creation t
  805. "Non-nil means cycle entry level or item indentation in new empty entries.
  806. When the cursor is at the end of an empty headline, i.e with only stars
  807. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  808. and then all possible ancestor states, before returning to the original state.
  809. This makes data entry extremely fast: M-RET to create a new headline,
  810. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  811. When the cursor is at the end of an empty plain list item, one TAB will
  812. make it a subitem, two or more tabs will back up to make this an item
  813. higher up in the item hierarchy."
  814. :group 'org-cycle
  815. :type 'boolean)
  816. (defcustom org-cycle-emulate-tab t
  817. "Where should `org-cycle' emulate TAB.
  818. nil Never
  819. white Only in completely white lines
  820. whitestart Only at the beginning of lines, before the first non-white char
  821. t Everywhere except in headlines
  822. exc-hl-bol Everywhere except at the start of a headline
  823. If TAB is used in a place where it does not emulate TAB, the current subtree
  824. visibility is cycled."
  825. :group 'org-cycle
  826. :type '(choice (const :tag "Never" nil)
  827. (const :tag "Only in completely white lines" white)
  828. (const :tag "Before first char in a line" whitestart)
  829. (const :tag "Everywhere except in headlines" t)
  830. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  831. ))
  832. (defcustom org-cycle-separator-lines 2
  833. "Number of empty lines needed to keep an empty line between collapsed trees.
  834. If you leave an empty line between the end of a subtree and the following
  835. headline, this empty line is hidden when the subtree is folded.
  836. Org-mode will leave (exactly) one empty line visible if the number of
  837. empty lines is equal or larger to the number given in this variable.
  838. So the default 2 means at least 2 empty lines after the end of a subtree
  839. are needed to produce free space between a collapsed subtree and the
  840. following headline.
  841. If the number is negative, and the number of empty lines is at least -N,
  842. all empty lines are shown.
  843. Special case: when 0, never leave empty lines in collapsed view."
  844. :group 'org-cycle
  845. :type 'integer)
  846. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  847. (defcustom org-pre-cycle-hook nil
  848. "Hook that is run before visibility cycling is happening.
  849. The function(s) in this hook must accept a single argument which indicates
  850. the new state that will be set right after running this hook. The
  851. argument is a symbol. Before a global state change, it can have the values
  852. `overview', `content', or `all'. Before a local state change, it can have
  853. the values `folded', `children', or `subtree'."
  854. :group 'org-cycle
  855. :type 'hook)
  856. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  857. org-cycle-hide-drawers
  858. org-cycle-show-empty-lines
  859. org-optimize-window-after-visibility-change)
  860. "Hook that is run after `org-cycle' has changed the buffer visibility.
  861. The function(s) in this hook must accept a single argument which indicates
  862. the new state that was set by the most recent `org-cycle' command. The
  863. argument is a symbol. After a global state change, it can have the values
  864. `overview', `content', or `all'. After a local state change, it can have
  865. the values `folded', `children', or `subtree'."
  866. :group 'org-cycle
  867. :type 'hook)
  868. (defgroup org-edit-structure nil
  869. "Options concerning structure editing in Org-mode."
  870. :tag "Org Edit Structure"
  871. :group 'org-structure)
  872. (defcustom org-odd-levels-only nil
  873. "Non-nil means skip even levels and only use odd levels for the outline.
  874. This has the effect that two stars are being added/taken away in
  875. promotion/demotion commands. It also influences how levels are
  876. handled by the exporters.
  877. Changing it requires restart of `font-lock-mode' to become effective
  878. for fontification also in regions already fontified.
  879. You may also set this on a per-file basis by adding one of the following
  880. lines to the buffer:
  881. #+STARTUP: odd
  882. #+STARTUP: oddeven"
  883. :group 'org-edit-structure
  884. :group 'org-appearance
  885. :type 'boolean)
  886. (defcustom org-adapt-indentation t
  887. "Non-nil means adapt indentation to outline node level.
  888. When this variable is set, Org assumes that you write outlines by
  889. indenting text in each node to align with the headline (after the stars).
  890. The following issues are influenced by this variable:
  891. - When this is set and the *entire* text in an entry is indented, the
  892. indentation is increased by one space in a demotion command, and
  893. decreased by one in a promotion command. If any line in the entry
  894. body starts with text at column 0, indentation is not changed at all.
  895. - Property drawers and planning information is inserted indented when
  896. this variable s set. When nil, they will not be indented.
  897. - TAB indents a line relative to context. The lines below a headline
  898. will be indented when this variable is set.
  899. Note that this is all about true indentation, by adding and removing
  900. space characters. See also `org-indent.el' which does level-dependent
  901. indentation in a virtual way, i.e. at display time in Emacs."
  902. :group 'org-edit-structure
  903. :type 'boolean)
  904. (defcustom org-special-ctrl-a/e nil
  905. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  906. When t, `C-a' will bring back the cursor to the beginning of the
  907. headline text, i.e. after the stars and after a possible TODO
  908. keyword. In an item, this will be the position after bullet and
  909. check-box, if any. When the cursor is already at that position,
  910. another `C-a' will bring it to the beginning of the line.
  911. `C-e' will jump to the end of the headline, ignoring the presence
  912. of tags in the headline. A second `C-e' will then jump to the
  913. true end of the line, after any tags. This also means that, when
  914. this variable is non-nil, `C-e' also will never jump beyond the
  915. end of the heading of a folded section, i.e. not after the
  916. ellipses.
  917. When set to the symbol `reversed', the first `C-a' or `C-e' works
  918. normally, going to the true line boundary first. Only a directly
  919. following, identical keypress will bring the cursor to the
  920. special positions.
  921. This may also be a cons cell where the behavior for `C-a' and
  922. `C-e' is set separately."
  923. :group 'org-edit-structure
  924. :type '(choice
  925. (const :tag "off" nil)
  926. (const :tag "on: after stars/bullet and before tags first" t)
  927. (const :tag "reversed: true line boundary first" reversed)
  928. (cons :tag "Set C-a and C-e separately"
  929. (choice :tag "Special C-a"
  930. (const :tag "off" nil)
  931. (const :tag "on: after stars/bullet first" t)
  932. (const :tag "reversed: before stars/bullet first" reversed))
  933. (choice :tag "Special C-e"
  934. (const :tag "off" nil)
  935. (const :tag "on: before tags first" t)
  936. (const :tag "reversed: after tags first" reversed)))))
  937. (if (fboundp 'defvaralias)
  938. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  939. (defcustom org-special-ctrl-k nil
  940. "Non-nil means `C-k' will behave specially in headlines.
  941. When nil, `C-k' will call the default `kill-line' command.
  942. When t, the following will happen while the cursor is in the headline:
  943. - When the cursor is at the beginning of a headline, kill the entire
  944. line and possible the folded subtree below the line.
  945. - When in the middle of the headline text, kill the headline up to the tags.
  946. - When after the headline text, kill the tags."
  947. :group 'org-edit-structure
  948. :type 'boolean)
  949. (defcustom org-ctrl-k-protect-subtree nil
  950. "Non-nil means, do not delete a hidden subtree with C-k.
  951. When set to the symbol `error', simply throw an error when C-k is
  952. used to kill (part-of) a headline that has hidden text behind it.
  953. Any other non-nil value will result in a query to the user, if it is
  954. OK to kill that hidden subtree. When nil, kill without remorse."
  955. :group 'org-edit-structure
  956. :version "24.1"
  957. :type '(choice
  958. (const :tag "Do not protect hidden subtrees" nil)
  959. (const :tag "Protect hidden subtrees with a security query" t)
  960. (const :tag "Never kill a hidden subtree with C-k" error)))
  961. (defcustom org-catch-invisible-edits nil
  962. "Check if in invisible region before inserting or deleting a character.
  963. Valid values are:
  964. nil Do not check, so just do invisible edits.
  965. error Throw an error and do nothing.
  966. show Make point visible, and do the requested edit.
  967. show-and-error Make point visible, then throw an error and abort the edit.
  968. smart Make point visible, and do insertion/deletion if it is
  969. adjacent to visible text and the change feels predictable.
  970. Never delete a previously invisible character or add in the
  971. middle or right after an invisible region. Basically, this
  972. allows insertion and backward-delete right before ellipses.
  973. FIXME: maybe in this case we should not even show?"
  974. :group 'org-edit-structure
  975. :version "24.1"
  976. :type '(choice
  977. (const :tag "Do not check" nil)
  978. (const :tag "Throw error when trying to edit" error)
  979. (const :tag "Unhide, but do not do the edit" show-and-error)
  980. (const :tag "Show invisible part and do the edit" show)
  981. (const :tag "Be smart and do the right thing" smart)))
  982. (defcustom org-yank-folded-subtrees t
  983. "Non-nil means when yanking subtrees, fold them.
  984. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  985. it starts with a heading and all other headings in it are either children
  986. or siblings, then fold all the subtrees. However, do this only if no
  987. text after the yank would be swallowed into a folded tree by this action."
  988. :group 'org-edit-structure
  989. :type 'boolean)
  990. (defcustom org-yank-adjusted-subtrees nil
  991. "Non-nil means when yanking subtrees, adjust the level.
  992. With this setting, `org-paste-subtree' is used to insert the subtree, see
  993. this function for details."
  994. :group 'org-edit-structure
  995. :type 'boolean)
  996. (defcustom org-M-RET-may-split-line '((default . t))
  997. "Non-nil means M-RET will split the line at the cursor position.
  998. When nil, it will go to the end of the line before making a
  999. new line.
  1000. You may also set this option in a different way for different
  1001. contexts. Valid contexts are:
  1002. headline when creating a new headline
  1003. item when creating a new item
  1004. table in a table field
  1005. default the value to be used for all contexts not explicitly
  1006. customized"
  1007. :group 'org-structure
  1008. :group 'org-table
  1009. :type '(choice
  1010. (const :tag "Always" t)
  1011. (const :tag "Never" nil)
  1012. (repeat :greedy t :tag "Individual contexts"
  1013. (cons
  1014. (choice :tag "Context"
  1015. (const headline)
  1016. (const item)
  1017. (const table)
  1018. (const default))
  1019. (boolean)))))
  1020. (defcustom org-insert-heading-respect-content nil
  1021. "Non-nil means insert new headings after the current subtree.
  1022. When nil, the new heading is created directly after the current line.
  1023. The commands \\[org-insert-heading-respect-content] and
  1024. \\[org-insert-todo-heading-respect-content] turn this variable on
  1025. for the duration of the command."
  1026. :group 'org-structure
  1027. :type 'boolean)
  1028. (defcustom org-blank-before-new-entry '((heading . auto)
  1029. (plain-list-item . auto))
  1030. "Should `org-insert-heading' leave a blank line before new heading/item?
  1031. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1032. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1033. which case Org will look at the surrounding headings/items and try to
  1034. make an intelligent decision whether to insert a blank line or not.
  1035. For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
  1036. set, the setting here is ignored and no empty line is inserted, to avoid
  1037. breaking the list structure."
  1038. :group 'org-edit-structure
  1039. :type '(list
  1040. (cons (const heading)
  1041. (choice (const :tag "Never" nil)
  1042. (const :tag "Always" t)
  1043. (const :tag "Auto" auto)))
  1044. (cons (const plain-list-item)
  1045. (choice (const :tag "Never" nil)
  1046. (const :tag "Always" t)
  1047. (const :tag "Auto" auto)))))
  1048. (defcustom org-insert-heading-hook nil
  1049. "Hook being run after inserting a new heading."
  1050. :group 'org-edit-structure
  1051. :type 'hook)
  1052. (defcustom org-enable-fixed-width-editor t
  1053. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1054. This currently only means they are never auto-wrapped.
  1055. When nil, such lines will be treated like ordinary lines.
  1056. See also the QUOTE keyword."
  1057. :group 'org-edit-structure
  1058. :type 'boolean)
  1059. (defcustom org-goto-auto-isearch t
  1060. "Non-nil means typing characters in `org-goto' starts incremental search."
  1061. :group 'org-edit-structure
  1062. :type 'boolean)
  1063. (defgroup org-sparse-trees nil
  1064. "Options concerning sparse trees in Org-mode."
  1065. :tag "Org Sparse Trees"
  1066. :group 'org-structure)
  1067. (defcustom org-highlight-sparse-tree-matches t
  1068. "Non-nil means highlight all matches that define a sparse tree.
  1069. The highlights will automatically disappear the next time the buffer is
  1070. changed by an edit command."
  1071. :group 'org-sparse-trees
  1072. :type 'boolean)
  1073. (defcustom org-remove-highlights-with-change t
  1074. "Non-nil means any change to the buffer will remove temporary highlights.
  1075. Such highlights are created by `org-occur' and `org-clock-display'.
  1076. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1077. The highlights created by `org-preview-latex-fragment' always need
  1078. `C-c C-c' to be removed."
  1079. :group 'org-sparse-trees
  1080. :group 'org-time
  1081. :type 'boolean)
  1082. (defcustom org-occur-hook '(org-first-headline-recenter)
  1083. "Hook that is run after `org-occur' has constructed a sparse tree.
  1084. This can be used to recenter the window to show as much of the structure
  1085. as possible."
  1086. :group 'org-sparse-trees
  1087. :type 'hook)
  1088. (defgroup org-imenu-and-speedbar nil
  1089. "Options concerning imenu and speedbar in Org-mode."
  1090. :tag "Org Imenu and Speedbar"
  1091. :group 'org-structure)
  1092. (defcustom org-imenu-depth 2
  1093. "The maximum level for Imenu access to Org-mode headlines.
  1094. This also applied for speedbar access."
  1095. :group 'org-imenu-and-speedbar
  1096. :type 'integer)
  1097. (defgroup org-table nil
  1098. "Options concerning tables in Org-mode."
  1099. :tag "Org Table"
  1100. :group 'org)
  1101. (defcustom org-enable-table-editor 'optimized
  1102. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1103. When nil, such lines will be treated like ordinary lines.
  1104. When equal to the symbol `optimized', the table editor will be optimized to
  1105. do the following:
  1106. - Automatic overwrite mode in front of whitespace in table fields.
  1107. This makes the structure of the table stay in tact as long as the edited
  1108. field does not exceed the column width.
  1109. - Minimize the number of realigns. Normally, the table is aligned each time
  1110. TAB or RET are pressed to move to another field. With optimization this
  1111. happens only if changes to a field might have changed the column width.
  1112. Optimization requires replacing the functions `self-insert-command',
  1113. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1114. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1115. very good at guessing when a re-align will be necessary, but you can always
  1116. force one with \\[org-ctrl-c-ctrl-c].
  1117. If you would like to use the optimized version in Org-mode, but the
  1118. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1119. This variable can be used to turn on and off the table editor during a session,
  1120. but in order to toggle optimization, a restart is required.
  1121. See also the variable `org-table-auto-blank-field'."
  1122. :group 'org-table
  1123. :type '(choice
  1124. (const :tag "off" nil)
  1125. (const :tag "on" t)
  1126. (const :tag "on, optimized" optimized)))
  1127. (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
  1128. (version<= emacs-version "24.1"))
  1129. "Non-nil means cluster self-insert commands for undo when possible.
  1130. If this is set, then, like in the Emacs command loop, 20 consecutive
  1131. characters will be undone together.
  1132. This is configurable, because there is some impact on typing performance."
  1133. :group 'org-table
  1134. :type 'boolean)
  1135. (defcustom org-table-tab-recognizes-table.el t
  1136. "Non-nil means TAB will automatically notice a table.el table.
  1137. When it sees such a table, it moves point into it and - if necessary -
  1138. calls `table-recognize-table'."
  1139. :group 'org-table-editing
  1140. :type 'boolean)
  1141. (defgroup org-link nil
  1142. "Options concerning links in Org-mode."
  1143. :tag "Org Link"
  1144. :group 'org)
  1145. (defvar org-link-abbrev-alist-local nil
  1146. "Buffer-local version of `org-link-abbrev-alist', which see.
  1147. The value of this is taken from the #+LINK lines.")
  1148. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1149. (defcustom org-link-abbrev-alist nil
  1150. "Alist of link abbreviations.
  1151. The car of each element is a string, to be replaced at the start of a link.
  1152. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1153. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1154. [[linkkey:tag][description]]
  1155. The 'linkkey' must be a word word, starting with a letter, followed
  1156. by letters, numbers, '-' or '_'.
  1157. If REPLACE is a string, the tag will simply be appended to create the link.
  1158. If the string contains \"%s\", the tag will be inserted there. If the string
  1159. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1160. at that point (see the function `url-hexify-string'). If the string contains
  1161. the specifier \"%(my-function)\", then the custom function `my-function' will
  1162. be invoked: this function takes the tag as its only argument and must return
  1163. a string.
  1164. REPLACE may also be a function that will be called with the tag as the
  1165. only argument to create the link, which should be returned as a string.
  1166. See the manual for examples."
  1167. :group 'org-link
  1168. :type '(repeat
  1169. (cons
  1170. (string :tag "Protocol")
  1171. (choice
  1172. (string :tag "Format")
  1173. (function)))))
  1174. (defcustom org-descriptive-links t
  1175. "Non-nil means Org will display descriptive links.
  1176. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1177. \"Org Website\", hiding the link itself and just displaying its
  1178. description. When set to `nil', Org will display the full links
  1179. literally.
  1180. You can interactively set the value of this variable by calling
  1181. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1182. :group 'org-link
  1183. :type 'boolean)
  1184. (defcustom org-link-file-path-type 'adaptive
  1185. "How the path name in file links should be stored.
  1186. Valid values are:
  1187. relative Relative to the current directory, i.e. the directory of the file
  1188. into which the link is being inserted.
  1189. absolute Absolute path, if possible with ~ for home directory.
  1190. noabbrev Absolute path, no abbreviation of home directory.
  1191. adaptive Use relative path for files in the current directory and sub-
  1192. directories of it. For other files, use an absolute path."
  1193. :group 'org-link
  1194. :type '(choice
  1195. (const relative)
  1196. (const absolute)
  1197. (const noabbrev)
  1198. (const adaptive)))
  1199. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1200. "Types of links that should be activated in Org-mode files.
  1201. This is a list of symbols, each leading to the activation of a certain link
  1202. type. In principle, it does not hurt to turn on most link types - there may
  1203. be a small gain when turning off unused link types. The types are:
  1204. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1205. angle Links in angular brackets that may contain whitespace like
  1206. <bbdb:Carsten Dominik>.
  1207. plain Plain links in normal text, no whitespace, like http://google.com.
  1208. radio Text that is matched by a radio target, see manual for details.
  1209. tag Tag settings in a headline (link to tag search).
  1210. date Time stamps (link to calendar).
  1211. footnote Footnote labels.
  1212. Changing this variable requires a restart of Emacs to become effective."
  1213. :group 'org-link
  1214. :type '(set :greedy t
  1215. (const :tag "Double bracket links" bracket)
  1216. (const :tag "Angular bracket links" angle)
  1217. (const :tag "Plain text links" plain)
  1218. (const :tag "Radio target matches" radio)
  1219. (const :tag "Tags" tag)
  1220. (const :tag "Timestamps" date)
  1221. (const :tag "Footnotes" footnote)))
  1222. (defcustom org-make-link-description-function nil
  1223. "Function to use to generate link descriptions from links.
  1224. If nil the link location will be used. This function must take
  1225. two parameters; the first is the link and the second the
  1226. description `org-insert-link' has generated, and should return the
  1227. description to use."
  1228. :group 'org-link
  1229. :type 'function)
  1230. (defgroup org-link-store nil
  1231. "Options concerning storing links in Org-mode."
  1232. :tag "Org Store Link"
  1233. :group 'org-link)
  1234. (defcustom org-url-hexify-p t
  1235. "When non-nil, hexify URL when creating a link."
  1236. :type 'boolean
  1237. ;; :version "24.3"
  1238. :group 'org-link-store)
  1239. (defcustom org-email-link-description-format "Email %c: %.30s"
  1240. "Format of the description part of a link to an email or usenet message.
  1241. The following %-escapes will be replaced by corresponding information:
  1242. %F full \"From\" field
  1243. %f name, taken from \"From\" field, address if no name
  1244. %T full \"To\" field
  1245. %t first name in \"To\" field, address if no name
  1246. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1247. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1248. %s subject
  1249. %d date
  1250. %m message-id.
  1251. You may use normal field width specification between the % and the letter.
  1252. This is for example useful to limit the length of the subject.
  1253. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1254. :group 'org-link-store
  1255. :type 'string)
  1256. (defcustom org-from-is-user-regexp
  1257. (let (r1 r2)
  1258. (when (and user-mail-address (not (string= user-mail-address "")))
  1259. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1260. (when (and user-full-name (not (string= user-full-name "")))
  1261. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1262. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1263. "Regexp matched against the \"From:\" header of an email or usenet message.
  1264. It should match if the message is from the user him/herself."
  1265. :group 'org-link-store
  1266. :type 'regexp)
  1267. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1268. "Non-nil means storing a link to an Org file will use entry IDs.
  1269. Note that before this variable is even considered, org-id must be loaded,
  1270. so please customize `org-modules' and turn it on.
  1271. The variable can have the following values:
  1272. t Create an ID if needed to make a link to the current entry.
  1273. create-if-interactive
  1274. If `org-store-link' is called directly (interactively, as a user
  1275. command), do create an ID to support the link. But when doing the
  1276. job for remember, only use the ID if it already exists. The
  1277. purpose of this setting is to avoid proliferation of unwanted
  1278. IDs, just because you happen to be in an Org file when you
  1279. call `org-capture' that automatically and preemptively creates a
  1280. link. If you do want to get an ID link in a remember template to
  1281. an entry not having an ID, create it first by explicitly creating
  1282. a link to it, using `C-c C-l' first.
  1283. create-if-interactive-and-no-custom-id
  1284. Like create-if-interactive, but do not create an ID if there is
  1285. a CUSTOM_ID property defined in the entry. This is the default.
  1286. use-existing
  1287. Use existing ID, do not create one.
  1288. nil Never use an ID to make a link, instead link using a text search for
  1289. the headline text."
  1290. :group 'org-link-store
  1291. :type '(choice
  1292. (const :tag "Create ID to make link" t)
  1293. (const :tag "Create if storing link interactively"
  1294. create-if-interactive)
  1295. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1296. create-if-interactive-and-no-custom-id)
  1297. (const :tag "Only use existing" use-existing)
  1298. (const :tag "Do not use ID to create link" nil)))
  1299. (defcustom org-context-in-file-links t
  1300. "Non-nil means file links from `org-store-link' contain context.
  1301. A search string will be added to the file name with :: as separator and
  1302. used to find the context when the link is activated by the command
  1303. `org-open-at-point'. When this option is t, the entire active region
  1304. will be placed in the search string of the file link. If set to a
  1305. positive integer, only the first n lines of context will be stored.
  1306. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1307. negates this setting for the duration of the command."
  1308. :group 'org-link-store
  1309. :type '(choice boolean integer))
  1310. (defcustom org-keep-stored-link-after-insertion nil
  1311. "Non-nil means keep link in list for entire session.
  1312. The command `org-store-link' adds a link pointing to the current
  1313. location to an internal list. These links accumulate during a session.
  1314. The command `org-insert-link' can be used to insert links into any
  1315. Org-mode file (offering completion for all stored links). When this
  1316. option is nil, every link which has been inserted once using \\[org-insert-link]
  1317. will be removed from the list, to make completing the unused links
  1318. more efficient."
  1319. :group 'org-link-store
  1320. :type 'boolean)
  1321. (defgroup org-link-follow nil
  1322. "Options concerning following links in Org-mode."
  1323. :tag "Org Follow Link"
  1324. :group 'org-link)
  1325. (defcustom org-link-translation-function nil
  1326. "Function to translate links with different syntax to Org syntax.
  1327. This can be used to translate links created for example by the Planner
  1328. or emacs-wiki packages to Org syntax.
  1329. The function must accept two parameters, a TYPE containing the link
  1330. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1331. which is everything after the link protocol. It should return a cons
  1332. with possibly modified values of type and path.
  1333. Org contains a function for this, so if you set this variable to
  1334. `org-translate-link-from-planner', you should be able follow many
  1335. links created by planner."
  1336. :group 'org-link-follow
  1337. :type 'function)
  1338. (defcustom org-follow-link-hook nil
  1339. "Hook that is run after a link has been followed."
  1340. :group 'org-link-follow
  1341. :type 'hook)
  1342. (defcustom org-tab-follows-link nil
  1343. "Non-nil means on links TAB will follow the link.
  1344. Needs to be set before org.el is loaded.
  1345. This really should not be used, it does not make sense, and the
  1346. implementation is bad."
  1347. :group 'org-link-follow
  1348. :type 'boolean)
  1349. (defcustom org-return-follows-link nil
  1350. "Non-nil means on links RET will follow the link."
  1351. :group 'org-link-follow
  1352. :type 'boolean)
  1353. (defcustom org-mouse-1-follows-link
  1354. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1355. "Non-nil means mouse-1 on a link will follow the link.
  1356. A longer mouse click will still set point. Does not work on XEmacs.
  1357. Needs to be set before org.el is loaded."
  1358. :group 'org-link-follow
  1359. :type 'boolean)
  1360. (defcustom org-mark-ring-length 4
  1361. "Number of different positions to be recorded in the ring.
  1362. Changing this requires a restart of Emacs to work correctly."
  1363. :group 'org-link-follow
  1364. :type 'integer)
  1365. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1366. "Non-nil means internal links in Org files must exactly match a headline.
  1367. When nil, the link search tries to match a phrase with all words
  1368. in the search text."
  1369. :group 'org-link-follow
  1370. :version "24.1"
  1371. :type '(choice
  1372. (const :tag "Use fuzzy text search" nil)
  1373. (const :tag "Match only exact headline" t)
  1374. (const :tag "Match exact headline or query to create it"
  1375. query-to-create)))
  1376. (defcustom org-link-frame-setup
  1377. '((vm . vm-visit-folder-other-frame)
  1378. (vm-imap . vm-visit-imap-folder-other-frame)
  1379. (gnus . org-gnus-no-new-news)
  1380. (file . find-file-other-window)
  1381. (wl . wl-other-frame))
  1382. "Setup the frame configuration for following links.
  1383. When following a link with Emacs, it may often be useful to display
  1384. this link in another window or frame. This variable can be used to
  1385. set this up for the different types of links.
  1386. For VM, use any of
  1387. `vm-visit-folder'
  1388. `vm-visit-folder-other-window'
  1389. `vm-visit-folder-other-frame'
  1390. For Gnus, use any of
  1391. `gnus'
  1392. `gnus-other-frame'
  1393. `org-gnus-no-new-news'
  1394. For FILE, use any of
  1395. `find-file'
  1396. `find-file-other-window'
  1397. `find-file-other-frame'
  1398. For Wanderlust use any of
  1399. `wl'
  1400. `wl-other-frame'
  1401. For the calendar, use the variable `calendar-setup'.
  1402. For BBDB, it is currently only possible to display the matches in
  1403. another window."
  1404. :group 'org-link-follow
  1405. :type '(list
  1406. (cons (const vm)
  1407. (choice
  1408. (const vm-visit-folder)
  1409. (const vm-visit-folder-other-window)
  1410. (const vm-visit-folder-other-frame)))
  1411. (cons (const gnus)
  1412. (choice
  1413. (const gnus)
  1414. (const gnus-other-frame)
  1415. (const org-gnus-no-new-news)))
  1416. (cons (const file)
  1417. (choice
  1418. (const find-file)
  1419. (const find-file-other-window)
  1420. (const find-file-other-frame)))
  1421. (cons (const wl)
  1422. (choice
  1423. (const wl)
  1424. (const wl-other-frame)))))
  1425. (defcustom org-display-internal-link-with-indirect-buffer nil
  1426. "Non-nil means use indirect buffer to display infile links.
  1427. Activating internal links (from one location in a file to another location
  1428. in the same file) normally just jumps to the location. When the link is
  1429. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1430. is displayed in
  1431. another window. When this option is set, the other window actually displays
  1432. an indirect buffer clone of the current buffer, to avoid any visibility
  1433. changes to the current buffer."
  1434. :group 'org-link-follow
  1435. :type 'boolean)
  1436. (defcustom org-open-non-existing-files nil
  1437. "Non-nil means `org-open-file' will open non-existing files.
  1438. When nil, an error will be generated.
  1439. This variable applies only to external applications because they
  1440. might choke on non-existing files. If the link is to a file that
  1441. will be opened in Emacs, the variable is ignored."
  1442. :group 'org-link-follow
  1443. :type 'boolean)
  1444. (defcustom org-open-directory-means-index-dot-org nil
  1445. "Non-nil means a link to a directory really means to index.org.
  1446. When nil, following a directory link will run dired or open a finder/explorer
  1447. window on that directory."
  1448. :group 'org-link-follow
  1449. :type 'boolean)
  1450. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1451. "Function and arguments to call for following mailto links.
  1452. This is a list with the first element being a Lisp function, and the
  1453. remaining elements being arguments to the function. In string arguments,
  1454. %a will be replaced by the address, and %s will be replaced by the subject
  1455. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1456. :group 'org-link-follow
  1457. :type '(choice
  1458. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1459. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1460. (const :tag "message-mail" (message-mail "%a" "%s"))
  1461. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1462. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1463. "Non-nil means ask for confirmation before executing shell links.
  1464. Shell links can be dangerous: just think about a link
  1465. [[shell:rm -rf ~/*][Google Search]]
  1466. This link would show up in your Org-mode document as \"Google Search\",
  1467. but really it would remove your entire home directory.
  1468. Therefore we advise against setting this variable to nil.
  1469. Just change it to `y-or-n-p' if you want to confirm with a
  1470. single keystroke rather than having to type \"yes\"."
  1471. :group 'org-link-follow
  1472. :type '(choice
  1473. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1474. (const :tag "with y-or-n (faster)" y-or-n-p)
  1475. (const :tag "no confirmation (dangerous)" nil)))
  1476. (put 'org-confirm-shell-link-function
  1477. 'safe-local-variable
  1478. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1479. (defcustom org-confirm-shell-link-not-regexp ""
  1480. "A regexp to skip confirmation for shell links."
  1481. :group 'org-link-follow
  1482. :version "24.1"
  1483. :type 'regexp)
  1484. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1485. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1486. Elisp links can be dangerous: just think about a link
  1487. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1488. This link would show up in your Org-mode document as \"Google Search\",
  1489. but really it would remove your entire home directory.
  1490. Therefore we advise against setting this variable to nil.
  1491. Just change it to `y-or-n-p' if you want to confirm with a
  1492. single keystroke rather than having to type \"yes\"."
  1493. :group 'org-link-follow
  1494. :type '(choice
  1495. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1496. (const :tag "with y-or-n (faster)" y-or-n-p)
  1497. (const :tag "no confirmation (dangerous)" nil)))
  1498. (put 'org-confirm-shell-link-function
  1499. 'safe-local-variable
  1500. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1501. (defcustom org-confirm-elisp-link-not-regexp ""
  1502. "A regexp to skip confirmation for Elisp links."
  1503. :group 'org-link-follow
  1504. :version "24.1"
  1505. :type 'regexp)
  1506. (defconst org-file-apps-defaults-gnu
  1507. '((remote . emacs)
  1508. (system . mailcap)
  1509. (t . mailcap))
  1510. "Default file applications on a UNIX or GNU/Linux system.
  1511. See `org-file-apps'.")
  1512. (defconst org-file-apps-defaults-macosx
  1513. '((remote . emacs)
  1514. (t . "open %s")
  1515. (system . "open %s")
  1516. ("ps.gz" . "gv %s")
  1517. ("eps.gz" . "gv %s")
  1518. ("dvi" . "xdvi %s")
  1519. ("fig" . "xfig %s"))
  1520. "Default file applications on a MacOS X system.
  1521. The system \"open\" is known as a default, but we use X11 applications
  1522. for some files for which the OS does not have a good default.
  1523. See `org-file-apps'.")
  1524. (defconst org-file-apps-defaults-windowsnt
  1525. (list
  1526. '(remote . emacs)
  1527. (cons t
  1528. (list (if (featurep 'xemacs)
  1529. 'mswindows-shell-execute
  1530. 'w32-shell-execute)
  1531. "open" 'file))
  1532. (cons 'system
  1533. (list (if (featurep 'xemacs)
  1534. 'mswindows-shell-execute
  1535. 'w32-shell-execute)
  1536. "open" 'file)))
  1537. "Default file applications on a Windows NT system.
  1538. The system \"open\" is used for most files.
  1539. See `org-file-apps'.")
  1540. (defcustom org-file-apps
  1541. '(
  1542. (auto-mode . emacs)
  1543. ("\\.mm\\'" . default)
  1544. ("\\.x?html?\\'" . default)
  1545. ("\\.pdf\\'" . default)
  1546. )
  1547. "External applications for opening `file:path' items in a document.
  1548. Org-mode uses system defaults for different file types, but
  1549. you can use this variable to set the application for a given file
  1550. extension. The entries in this list are cons cells where the car identifies
  1551. files and the cdr the corresponding command. Possible values for the
  1552. file identifier are
  1553. \"string\" A string as a file identifier can be interpreted in different
  1554. ways, depending on its contents:
  1555. - Alphanumeric characters only:
  1556. Match links with this file extension.
  1557. Example: (\"pdf\" . \"evince %s\")
  1558. to open PDFs with evince.
  1559. - Regular expression: Match links where the
  1560. filename matches the regexp. If you want to
  1561. use groups here, use shy groups.
  1562. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1563. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1564. to open *.html and *.xhtml with firefox.
  1565. - Regular expression which contains (non-shy) groups:
  1566. Match links where the whole link, including \"::\", and
  1567. anything after that, matches the regexp.
  1568. In a custom command string, %1, %2, etc. are replaced with
  1569. the parts of the link that were matched by the groups.
  1570. For backwards compatibility, if a command string is given
  1571. that does not use any of the group matches, this case is
  1572. handled identically to the second one (i.e. match against
  1573. file name only).
  1574. In a custom lisp form, you can access the group matches with
  1575. (match-string n link).
  1576. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1577. to open [[file:document.pdf::5]] with evince at page 5.
  1578. `directory' Matches a directory
  1579. `remote' Matches a remote file, accessible through tramp or efs.
  1580. Remote files most likely should be visited through Emacs
  1581. because external applications cannot handle such paths.
  1582. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1583. so all files Emacs knows how to handle. Using this with
  1584. command `emacs' will open most files in Emacs. Beware that this
  1585. will also open html files inside Emacs, unless you add
  1586. (\"html\" . default) to the list as well.
  1587. t Default for files not matched by any of the other options.
  1588. `system' The system command to open files, like `open' on Windows
  1589. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1590. that will be selected if you call `C-c C-o' with a double
  1591. \\[universal-argument] \\[universal-argument] prefix.
  1592. Possible values for the command are:
  1593. `emacs' The file will be visited by the current Emacs process.
  1594. `default' Use the default application for this file type, which is the
  1595. association for t in the list, most likely in the system-specific
  1596. part.
  1597. This can be used to overrule an unwanted setting in the
  1598. system-specific variable.
  1599. `system' Use the system command for opening files, like \"open\".
  1600. This command is specified by the entry whose car is `system'.
  1601. Most likely, the system-specific version of this variable
  1602. does define this command, but you can overrule/replace it
  1603. here.
  1604. string A command to be executed by a shell; %s will be replaced
  1605. by the path to the file.
  1606. sexp A Lisp form which will be evaluated. The file path will
  1607. be available in the Lisp variable `file'.
  1608. For more examples, see the system specific constants
  1609. `org-file-apps-defaults-macosx'
  1610. `org-file-apps-defaults-windowsnt'
  1611. `org-file-apps-defaults-gnu'."
  1612. :group 'org-link-follow
  1613. :type '(repeat
  1614. (cons (choice :value ""
  1615. (string :tag "Extension")
  1616. (const :tag "System command to open files" system)
  1617. (const :tag "Default for unrecognized files" t)
  1618. (const :tag "Remote file" remote)
  1619. (const :tag "Links to a directory" directory)
  1620. (const :tag "Any files that have Emacs modes"
  1621. auto-mode))
  1622. (choice :value ""
  1623. (const :tag "Visit with Emacs" emacs)
  1624. (const :tag "Use default" default)
  1625. (const :tag "Use the system command" system)
  1626. (string :tag "Command")
  1627. (sexp :tag "Lisp form")))))
  1628. (defcustom org-doi-server-url "http://dx.doi.org/"
  1629. "The URL of the DOI server."
  1630. :type 'string
  1631. ;; :version "24.3"
  1632. :group 'org-link-follow)
  1633. (defgroup org-refile nil
  1634. "Options concerning refiling entries in Org-mode."
  1635. :tag "Org Refile"
  1636. :group 'org)
  1637. (defcustom org-directory "~/org"
  1638. "Directory with org files.
  1639. This is just a default location to look for Org files. There is no need
  1640. at all to put your files into this directory. It is only used in the
  1641. following situations:
  1642. 1. When a remember template specifies a target file that is not an
  1643. absolute path. The path will then be interpreted relative to
  1644. `org-directory'
  1645. 2. When a remember note is filed away in an interactive way (when exiting the
  1646. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1647. with `org-directory' as the default path."
  1648. :group 'org-refile
  1649. :group 'org-remember
  1650. :type 'directory)
  1651. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1652. "Default target for storing notes.
  1653. Used as a fall back file for org-remember.el and org-capture.el, for
  1654. templates that do not specify a target file."
  1655. :group 'org-refile
  1656. :group 'org-remember
  1657. :type '(choice
  1658. (const :tag "Default from remember-data-file" nil)
  1659. file))
  1660. (defcustom org-goto-interface 'outline
  1661. "The default interface to be used for `org-goto'.
  1662. Allowed values are:
  1663. outline The interface shows an outline of the relevant file
  1664. and the correct heading is found by moving through
  1665. the outline or by searching with incremental search.
  1666. outline-path-completion Headlines in the current buffer are offered via
  1667. completion. This is the interface also used by
  1668. the refile command."
  1669. :group 'org-refile
  1670. :type '(choice
  1671. (const :tag "Outline" outline)
  1672. (const :tag "Outline-path-completion" outline-path-completion)))
  1673. (defcustom org-goto-max-level 5
  1674. "Maximum target level when running `org-goto' with refile interface."
  1675. :group 'org-refile
  1676. :type 'integer)
  1677. (defcustom org-reverse-note-order nil
  1678. "Non-nil means store new notes at the beginning of a file or entry.
  1679. When nil, new notes will be filed to the end of a file or entry.
  1680. This can also be a list with cons cells of regular expressions that
  1681. are matched against file names, and values."
  1682. :group 'org-remember
  1683. :group 'org-refile
  1684. :type '(choice
  1685. (const :tag "Reverse always" t)
  1686. (const :tag "Reverse never" nil)
  1687. (repeat :tag "By file name regexp"
  1688. (cons regexp boolean))))
  1689. (defcustom org-log-refile nil
  1690. "Information to record when a task is refiled.
  1691. Possible values are:
  1692. nil Don't add anything
  1693. time Add a time stamp to the task
  1694. note Prompt for a note and add it with template `org-log-note-headings'
  1695. This option can also be set with on a per-file-basis with
  1696. #+STARTUP: nologrefile
  1697. #+STARTUP: logrefile
  1698. #+STARTUP: lognoterefile
  1699. You can have local logging settings for a subtree by setting the LOGGING
  1700. property to one or more of these keywords.
  1701. When bulk-refiling from the agenda, the value `note' is forbidden and
  1702. will temporarily be changed to `time'."
  1703. :group 'org-refile
  1704. :group 'org-progress
  1705. :version "24.1"
  1706. :type '(choice
  1707. (const :tag "No logging" nil)
  1708. (const :tag "Record timestamp" time)
  1709. (const :tag "Record timestamp with note." note)))
  1710. (defcustom org-refile-targets nil
  1711. "Targets for refiling entries with \\[org-refile].
  1712. This is a list of cons cells. Each cell contains:
  1713. - a specification of the files to be considered, either a list of files,
  1714. or a symbol whose function or variable value will be used to retrieve
  1715. a file name or a list of file names. If you use `org-agenda-files' for
  1716. that, all agenda files will be scanned for targets. Nil means consider
  1717. headings in the current buffer.
  1718. - A specification of how to find candidate refile targets. This may be
  1719. any of:
  1720. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1721. This tag has to be present in all target headlines, inheritance will
  1722. not be considered.
  1723. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1724. todo keyword.
  1725. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1726. headlines that are refiling targets.
  1727. - a cons cell (:level . N). Any headline of level N is considered a target.
  1728. Note that, when `org-odd-levels-only' is set, level corresponds to
  1729. order in hierarchy, not to the number of stars.
  1730. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1731. Note that, when `org-odd-levels-only' is set, level corresponds to
  1732. order in hierarchy, not to the number of stars.
  1733. Each element of this list generates a set of possible targets.
  1734. The union of these sets is presented (with completion) to
  1735. the user by `org-refile'.
  1736. You can set the variable `org-refile-target-verify-function' to a function
  1737. to verify each headline found by the simple criteria above.
  1738. When this variable is nil, all top-level headlines in the current buffer
  1739. are used, equivalent to the value `((nil . (:level . 1))'."
  1740. :group 'org-refile
  1741. :type '(repeat
  1742. (cons
  1743. (choice :value org-agenda-files
  1744. (const :tag "All agenda files" org-agenda-files)
  1745. (const :tag "Current buffer" nil)
  1746. (function) (variable) (file))
  1747. (choice :tag "Identify target headline by"
  1748. (cons :tag "Specific tag" (const :value :tag) (string))
  1749. (cons :tag "TODO keyword" (const :value :todo) (string))
  1750. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1751. (cons :tag "Level number" (const :value :level) (integer))
  1752. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1753. (defcustom org-refile-target-verify-function nil
  1754. "Function to verify if the headline at point should be a refile target.
  1755. The function will be called without arguments, with point at the
  1756. beginning of the headline. It should return t and leave point
  1757. where it is if the headline is a valid target for refiling.
  1758. If the target should not be selected, the function must return nil.
  1759. In addition to this, it may move point to a place from where the search
  1760. should be continued. For example, the function may decide that the entire
  1761. subtree of the current entry should be excluded and move point to the end
  1762. of the subtree."
  1763. :group 'org-refile
  1764. :type 'function)
  1765. (defcustom org-refile-use-cache nil
  1766. "Non-nil means cache refile targets to speed up the process.
  1767. The cache for a particular file will be updated automatically when
  1768. the buffer has been killed, or when any of the marker used for flagging
  1769. refile targets no longer points at a live buffer.
  1770. If you have added new entries to a buffer that might themselves be targets,
  1771. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1772. find that easier, `C-u C-u C-u C-c C-w'."
  1773. :group 'org-refile
  1774. :version "24.1"
  1775. :type 'boolean)
  1776. (defcustom org-refile-use-outline-path nil
  1777. "Non-nil means provide refile targets as paths.
  1778. So a level 3 headline will be available as level1/level2/level3.
  1779. When the value is `file', also include the file name (without directory)
  1780. into the path. In this case, you can also stop the completion after
  1781. the file name, to get entries inserted as top level in the file.
  1782. When `full-file-path', include the full file path."
  1783. :group 'org-refile
  1784. :type '(choice
  1785. (const :tag "Not" nil)
  1786. (const :tag "Yes" t)
  1787. (const :tag "Start with file name" file)
  1788. (const :tag "Start with full file path" full-file-path)))
  1789. (defcustom org-outline-path-complete-in-steps t
  1790. "Non-nil means complete the outline path in hierarchical steps.
  1791. When Org-mode uses the refile interface to select an outline path
  1792. \(see variable `org-refile-use-outline-path'), the completion of
  1793. the path can be done is a single go, or if can be done in steps down
  1794. the headline hierarchy. Going in steps is probably the best if you
  1795. do not use a special completion package like `ido' or `icicles'.
  1796. However, when using these packages, going in one step can be very
  1797. fast, while still showing the whole path to the entry."
  1798. :group 'org-refile
  1799. :type 'boolean)
  1800. (defcustom org-refile-allow-creating-parent-nodes nil
  1801. "Non-nil means allow to create new nodes as refile targets.
  1802. New nodes are then created by adding \"/new node name\" to the completion
  1803. of an existing node. When the value of this variable is `confirm',
  1804. new node creation must be confirmed by the user (recommended)
  1805. When nil, the completion must match an existing entry.
  1806. Note that, if the new heading is not seen by the criteria
  1807. listed in `org-refile-targets', multiple instances of the same
  1808. heading would be created by trying again to file under the new
  1809. heading."
  1810. :group 'org-refile
  1811. :type '(choice
  1812. (const :tag "Never" nil)
  1813. (const :tag "Always" t)
  1814. (const :tag "Prompt for confirmation" confirm)))
  1815. (defcustom org-refile-active-region-within-subtree nil
  1816. "Non-nil means also refile active region within a subtree.
  1817. By default `org-refile' doesn't allow refiling regions if they
  1818. don't contain a set of subtrees, but it might be convenient to
  1819. do so sometimes: in that case, the first line of the region is
  1820. converted to a headline before refiling."
  1821. :group 'org-refile
  1822. :version "24.1"
  1823. :type 'boolean)
  1824. (defgroup org-todo nil
  1825. "Options concerning TODO items in Org-mode."
  1826. :tag "Org TODO"
  1827. :group 'org)
  1828. (defgroup org-progress nil
  1829. "Options concerning Progress logging in Org-mode."
  1830. :tag "Org Progress"
  1831. :group 'org-time)
  1832. (defvar org-todo-interpretation-widgets
  1833. '((:tag "Sequence (cycling hits every state)" sequence)
  1834. (:tag "Type (cycling directly to DONE)" type))
  1835. "The available interpretation symbols for customizing `org-todo-keywords'.
  1836. Interested libraries should add to this list.")
  1837. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1838. "List of TODO entry keyword sequences and their interpretation.
  1839. \\<org-mode-map>This is a list of sequences.
  1840. Each sequence starts with a symbol, either `sequence' or `type',
  1841. indicating if the keywords should be interpreted as a sequence of
  1842. action steps, or as different types of TODO items. The first
  1843. keywords are states requiring action - these states will select a headline
  1844. for inclusion into the global TODO list Org-mode produces. If one of
  1845. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1846. signify that no further action is necessary. If \"|\" is not found,
  1847. the last keyword is treated as the only DONE state of the sequence.
  1848. The command \\[org-todo] cycles an entry through these states, and one
  1849. additional state where no keyword is present. For details about this
  1850. cycling, see the manual.
  1851. TODO keywords and interpretation can also be set on a per-file basis with
  1852. the special #+SEQ_TODO and #+TYP_TODO lines.
  1853. Each keyword can optionally specify a character for fast state selection
  1854. \(in combination with the variable `org-use-fast-todo-selection')
  1855. and specifiers for state change logging, using the same syntax that
  1856. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  1857. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1858. indicates to record a time stamp each time this state is selected.
  1859. Each keyword may also specify if a timestamp or a note should be
  1860. recorded when entering or leaving the state, by adding additional
  1861. characters in the parenthesis after the keyword. This looks like this:
  1862. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1863. record only the time of the state change. With X and Y being either
  1864. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1865. Y when leaving the state if and only if the *target* state does not
  1866. define X. You may omit any of the fast-selection key or X or /Y,
  1867. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1868. For backward compatibility, this variable may also be just a list
  1869. of keywords. In this case the interpretation (sequence or type) will be
  1870. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1871. :group 'org-todo
  1872. :group 'org-keywords
  1873. :type '(choice
  1874. (repeat :tag "Old syntax, just keywords"
  1875. (string :tag "Keyword"))
  1876. (repeat :tag "New syntax"
  1877. (cons
  1878. (choice
  1879. :tag "Interpretation"
  1880. ;;Quick and dirty way to see
  1881. ;;`org-todo-interpretations'. This takes the
  1882. ;;place of item arguments
  1883. :convert-widget
  1884. (lambda (widget)
  1885. (widget-put widget
  1886. :args (mapcar
  1887. #'(lambda (x)
  1888. (widget-convert
  1889. (cons 'const x)))
  1890. org-todo-interpretation-widgets))
  1891. widget))
  1892. (repeat
  1893. (string :tag "Keyword"))))))
  1894. (defvar org-todo-keywords-1 nil
  1895. "All TODO and DONE keywords active in a buffer.")
  1896. (make-variable-buffer-local 'org-todo-keywords-1)
  1897. (defvar org-todo-keywords-for-agenda nil)
  1898. (defvar org-done-keywords-for-agenda nil)
  1899. (defvar org-drawers-for-agenda nil)
  1900. (defvar org-todo-keyword-alist-for-agenda nil)
  1901. (defvar org-tag-alist-for-agenda nil)
  1902. (defvar org-agenda-contributing-files nil)
  1903. (defvar org-not-done-keywords nil)
  1904. (make-variable-buffer-local 'org-not-done-keywords)
  1905. (defvar org-done-keywords nil)
  1906. (make-variable-buffer-local 'org-done-keywords)
  1907. (defvar org-todo-heads nil)
  1908. (make-variable-buffer-local 'org-todo-heads)
  1909. (defvar org-todo-sets nil)
  1910. (make-variable-buffer-local 'org-todo-sets)
  1911. (defvar org-todo-log-states nil)
  1912. (make-variable-buffer-local 'org-todo-log-states)
  1913. (defvar org-todo-kwd-alist nil)
  1914. (make-variable-buffer-local 'org-todo-kwd-alist)
  1915. (defvar org-todo-key-alist nil)
  1916. (make-variable-buffer-local 'org-todo-key-alist)
  1917. (defvar org-todo-key-trigger nil)
  1918. (make-variable-buffer-local 'org-todo-key-trigger)
  1919. (defcustom org-todo-interpretation 'sequence
  1920. "Controls how TODO keywords are interpreted.
  1921. This variable is in principle obsolete and is only used for
  1922. backward compatibility, if the interpretation of todo keywords is
  1923. not given already in `org-todo-keywords'. See that variable for
  1924. more information."
  1925. :group 'org-todo
  1926. :group 'org-keywords
  1927. :type '(choice (const sequence)
  1928. (const type)))
  1929. (defcustom org-use-fast-todo-selection t
  1930. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1931. This variable describes if and under what circumstances the cycling
  1932. mechanism for TODO keywords will be replaced by a single-key, direct
  1933. selection scheme.
  1934. When nil, fast selection is never used.
  1935. When the symbol `prefix', it will be used when `org-todo' is called
  1936. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  1937. `C-u t' in an agenda buffer.
  1938. When t, fast selection is used by default. In this case, the prefix
  1939. argument forces cycling instead.
  1940. In all cases, the special interface is only used if access keys have
  1941. actually been assigned by the user, i.e. if keywords in the configuration
  1942. are followed by a letter in parenthesis, like TODO(t)."
  1943. :group 'org-todo
  1944. :type '(choice
  1945. (const :tag "Never" nil)
  1946. (const :tag "By default" t)
  1947. (const :tag "Only with C-u C-c C-t" prefix)))
  1948. (defcustom org-provide-todo-statistics t
  1949. "Non-nil means update todo statistics after insert and toggle.
  1950. ALL-HEADLINES means update todo statistics by including headlines
  1951. with no TODO keyword as well, counting them as not done.
  1952. A list of TODO keywords means the same, but skip keywords that are
  1953. not in this list.
  1954. When this is set, todo statistics is updated in the parent of the
  1955. current entry each time a todo state is changed."
  1956. :group 'org-todo
  1957. :type '(choice
  1958. (const :tag "Yes, only for TODO entries" t)
  1959. (const :tag "Yes, including all entries" 'all-headlines)
  1960. (repeat :tag "Yes, for TODOs in this list"
  1961. (string :tag "TODO keyword"))
  1962. (other :tag "No TODO statistics" nil)))
  1963. (defcustom org-hierarchical-todo-statistics t
  1964. "Non-nil means TODO statistics covers just direct children.
  1965. When nil, all entries in the subtree are considered.
  1966. This has only an effect if `org-provide-todo-statistics' is set.
  1967. To set this to nil for only a single subtree, use a COOKIE_DATA
  1968. property and include the word \"recursive\" into the value."
  1969. :group 'org-todo
  1970. :type 'boolean)
  1971. (defcustom org-after-todo-state-change-hook nil
  1972. "Hook which is run after the state of a TODO item was changed.
  1973. The new state (a string with a TODO keyword, or nil) is available in the
  1974. Lisp variable `org-state'."
  1975. :group 'org-todo
  1976. :type 'hook)
  1977. (defvar org-blocker-hook nil
  1978. "Hook for functions that are allowed to block a state change.
  1979. Each function gets as its single argument a property list, see
  1980. `org-trigger-hook' for more information about this list.
  1981. If any of the functions in this hook returns nil, the state change
  1982. is blocked.")
  1983. (defvar org-trigger-hook nil
  1984. "Hook for functions that are triggered by a state change.
  1985. Each function gets as its single argument a property list with at least
  1986. the following elements:
  1987. (:type type-of-change :position pos-at-entry-start
  1988. :from old-state :to new-state)
  1989. Depending on the type, more properties may be present.
  1990. This mechanism is currently implemented for:
  1991. TODO state changes
  1992. ------------------
  1993. :type todo-state-change
  1994. :from previous state (keyword as a string), or nil, or a symbol
  1995. 'todo' or 'done', to indicate the general type of state.
  1996. :to new state, like in :from")
  1997. (defcustom org-enforce-todo-dependencies nil
  1998. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1999. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  2000. be blocked if any prior sibling is not yet done.
  2001. Finally, if the parent is blocked because of ordered siblings of its own,
  2002. the child will also be blocked."
  2003. :set (lambda (var val)
  2004. (set var val)
  2005. (if val
  2006. (add-hook 'org-blocker-hook
  2007. 'org-block-todo-from-children-or-siblings-or-parent)
  2008. (remove-hook 'org-blocker-hook
  2009. 'org-block-todo-from-children-or-siblings-or-parent)))
  2010. :group 'org-todo
  2011. :type 'boolean)
  2012. (defcustom org-enforce-todo-checkbox-dependencies nil
  2013. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2014. When this is nil, checkboxes have no influence on switching TODO states.
  2015. When non-nil, you first need to check off all check boxes before the TODO
  2016. entry can be switched to DONE.
  2017. This variable needs to be set before org.el is loaded, and you need to
  2018. restart Emacs after a change to make the change effective. The only way
  2019. to change is while Emacs is running is through the customize interface."
  2020. :set (lambda (var val)
  2021. (set var val)
  2022. (if val
  2023. (add-hook 'org-blocker-hook
  2024. 'org-block-todo-from-checkboxes)
  2025. (remove-hook 'org-blocker-hook
  2026. 'org-block-todo-from-checkboxes)))
  2027. :group 'org-todo
  2028. :type 'boolean)
  2029. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2030. "Non-nil means inserting a TODO heading is treated as state change.
  2031. So when the command \\[org-insert-todo-heading] is used, state change
  2032. logging will apply if appropriate. When nil, the new TODO item will
  2033. be inserted directly, and no logging will take place."
  2034. :group 'org-todo
  2035. :type 'boolean)
  2036. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2037. "Non-nil means switching TODO states with S-cursor counts as state change.
  2038. This is the default behavior. However, setting this to nil allows a
  2039. convenient way to select a TODO state and bypass any logging associated
  2040. with that."
  2041. :group 'org-todo
  2042. :type 'boolean)
  2043. (defcustom org-todo-state-tags-triggers nil
  2044. "Tag changes that should be triggered by TODO state changes.
  2045. This is a list. Each entry is
  2046. (state-change (tag . flag) .......)
  2047. State-change can be a string with a state, and empty string to indicate the
  2048. state that has no TODO keyword, or it can be one of the symbols `todo'
  2049. or `done', meaning any not-done or done state, respectively."
  2050. :group 'org-todo
  2051. :group 'org-tags
  2052. :type '(repeat
  2053. (cons (choice :tag "When changing to"
  2054. (const :tag "Not-done state" todo)
  2055. (const :tag "Done state" done)
  2056. (string :tag "State"))
  2057. (repeat
  2058. (cons :tag "Tag action"
  2059. (string :tag "Tag")
  2060. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2061. (defcustom org-log-done nil
  2062. "Information to record when a task moves to the DONE state.
  2063. Possible values are:
  2064. nil Don't add anything, just change the keyword
  2065. time Add a time stamp to the task
  2066. note Prompt for a note and add it with template `org-log-note-headings'
  2067. This option can also be set with on a per-file-basis with
  2068. #+STARTUP: nologdone
  2069. #+STARTUP: logdone
  2070. #+STARTUP: lognotedone
  2071. You can have local logging settings for a subtree by setting the LOGGING
  2072. property to one or more of these keywords."
  2073. :group 'org-todo
  2074. :group 'org-progress
  2075. :type '(choice
  2076. (const :tag "No logging" nil)
  2077. (const :tag "Record CLOSED timestamp" time)
  2078. (const :tag "Record CLOSED timestamp with note." note)))
  2079. ;; Normalize old uses of org-log-done.
  2080. (cond
  2081. ((eq org-log-done t) (setq org-log-done 'time))
  2082. ((and (listp org-log-done) (memq 'done org-log-done))
  2083. (setq org-log-done 'note)))
  2084. (defcustom org-log-reschedule nil
  2085. "Information to record when the scheduling date of a tasks is modified.
  2086. Possible values are:
  2087. nil Don't add anything, just change the date
  2088. time Add a time stamp to the task
  2089. note Prompt for a note and add it with template `org-log-note-headings'
  2090. This option can also be set with on a per-file-basis with
  2091. #+STARTUP: nologreschedule
  2092. #+STARTUP: logreschedule
  2093. #+STARTUP: lognotereschedule"
  2094. :group 'org-todo
  2095. :group 'org-progress
  2096. :type '(choice
  2097. (const :tag "No logging" nil)
  2098. (const :tag "Record timestamp" time)
  2099. (const :tag "Record timestamp with note." note)))
  2100. (defcustom org-log-redeadline nil
  2101. "Information to record when the deadline date of a tasks is modified.
  2102. Possible values are:
  2103. nil Don't add anything, just change the date
  2104. time Add a time stamp to the task
  2105. note Prompt for a note and add it with template `org-log-note-headings'
  2106. This option can also be set with on a per-file-basis with
  2107. #+STARTUP: nologredeadline
  2108. #+STARTUP: logredeadline
  2109. #+STARTUP: lognoteredeadline
  2110. You can have local logging settings for a subtree by setting the LOGGING
  2111. property to one or more of these keywords."
  2112. :group 'org-todo
  2113. :group 'org-progress
  2114. :type '(choice
  2115. (const :tag "No logging" nil)
  2116. (const :tag "Record timestamp" time)
  2117. (const :tag "Record timestamp with note." note)))
  2118. (defcustom org-log-note-clock-out nil
  2119. "Non-nil means record a note when clocking out of an item.
  2120. This can also be configured on a per-file basis by adding one of
  2121. the following lines anywhere in the buffer:
  2122. #+STARTUP: lognoteclock-out
  2123. #+STARTUP: nolognoteclock-out"
  2124. :group 'org-todo
  2125. :group 'org-progress
  2126. :type 'boolean)
  2127. (defcustom org-log-done-with-time t
  2128. "Non-nil means the CLOSED time stamp will contain date and time.
  2129. When nil, only the date will be recorded."
  2130. :group 'org-progress
  2131. :type 'boolean)
  2132. (defcustom org-log-note-headings
  2133. '((done . "CLOSING NOTE %t")
  2134. (state . "State %-12s from %-12S %t")
  2135. (note . "Note taken on %t")
  2136. (reschedule . "Rescheduled from %S on %t")
  2137. (delschedule . "Not scheduled, was %S on %t")
  2138. (redeadline . "New deadline from %S on %t")
  2139. (deldeadline . "Removed deadline, was %S on %t")
  2140. (refile . "Refiled on %t")
  2141. (clock-out . ""))
  2142. "Headings for notes added to entries.
  2143. The value is an alist, with the car being a symbol indicating the note
  2144. context, and the cdr is the heading to be used. The heading may also be the
  2145. empty string.
  2146. %t in the heading will be replaced by a time stamp.
  2147. %T will be an active time stamp instead the default inactive one
  2148. %d will be replaced by a short-format time stamp.
  2149. %D will be replaced by an active short-format time stamp.
  2150. %s will be replaced by the new TODO state, in double quotes.
  2151. %S will be replaced by the old TODO state, in double quotes.
  2152. %u will be replaced by the user name.
  2153. %U will be replaced by the full user name.
  2154. In fact, it is not a good idea to change the `state' entry, because
  2155. agenda log mode depends on the format of these entries."
  2156. :group 'org-todo
  2157. :group 'org-progress
  2158. :type '(list :greedy t
  2159. (cons (const :tag "Heading when closing an item" done) string)
  2160. (cons (const :tag
  2161. "Heading when changing todo state (todo sequence only)"
  2162. state) string)
  2163. (cons (const :tag "Heading when just taking a note" note) string)
  2164. (cons (const :tag "Heading when clocking out" clock-out) string)
  2165. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2166. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2167. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2168. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2169. (cons (const :tag "Heading when refiling" refile) string)))
  2170. (unless (assq 'note org-log-note-headings)
  2171. (push '(note . "%t") org-log-note-headings))
  2172. (defcustom org-log-into-drawer nil
  2173. "Non-nil means insert state change notes and time stamps into a drawer.
  2174. When nil, state changes notes will be inserted after the headline and
  2175. any scheduling and clock lines, but not inside a drawer.
  2176. The value of this variable should be the name of the drawer to use.
  2177. LOGBOOK is proposed as the default drawer for this purpose, you can
  2178. also set this to a string to define the drawer of your choice.
  2179. A value of t is also allowed, representing \"LOGBOOK\".
  2180. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2181. will be ignored.
  2182. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2183. a subtree."
  2184. :group 'org-todo
  2185. :group 'org-progress
  2186. :type '(choice
  2187. (const :tag "Not into a drawer" nil)
  2188. (const :tag "LOGBOOK" t)
  2189. (string :tag "Other")))
  2190. (if (fboundp 'defvaralias)
  2191. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  2192. (defun org-log-into-drawer ()
  2193. "Return the value of `org-log-into-drawer', but let properties overrule.
  2194. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2195. used instead of the default value."
  2196. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
  2197. (cond
  2198. ((or (not p) (equal p "nil")) org-log-into-drawer)
  2199. ((equal p "t") "LOGBOOK")
  2200. (t p))))
  2201. (defcustom org-log-state-notes-insert-after-drawers nil
  2202. "Non-nil means insert state change notes after any drawers in entry.
  2203. Only the drawers that *immediately* follow the headline and the
  2204. deadline/scheduled line are skipped.
  2205. When nil, insert notes right after the heading and perhaps the line
  2206. with deadline/scheduling if present.
  2207. This variable will have no effect if `org-log-into-drawer' is
  2208. set."
  2209. :group 'org-todo
  2210. :group 'org-progress
  2211. :type 'boolean)
  2212. (defcustom org-log-states-order-reversed t
  2213. "Non-nil means the latest state note will be directly after heading.
  2214. When nil, the state change notes will be ordered according to time."
  2215. :group 'org-todo
  2216. :group 'org-progress
  2217. :type 'boolean)
  2218. (defcustom org-todo-repeat-to-state nil
  2219. "The TODO state to which a repeater should return the repeating task.
  2220. By default this is the first task in a TODO sequence, or the previous state
  2221. in a TODO_TYP set. But you can specify another task here.
  2222. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2223. :group 'org-todo
  2224. :version "24.1"
  2225. :type '(choice (const :tag "Head of sequence" nil)
  2226. (string :tag "Specific state")))
  2227. (defcustom org-log-repeat 'time
  2228. "Non-nil means record moving through the DONE state when triggering repeat.
  2229. An auto-repeating task is immediately switched back to TODO when
  2230. marked DONE. If you are not logging state changes (by adding \"@\"
  2231. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2232. record a closing note, there will be no record of the task moving
  2233. through DONE. This variable forces taking a note anyway.
  2234. nil Don't force a record
  2235. time Record a time stamp
  2236. note Prompt for a note and add it with template `org-log-note-headings'
  2237. This option can also be set with on a per-file-basis with
  2238. #+STARTUP: nologrepeat
  2239. #+STARTUP: logrepeat
  2240. #+STARTUP: lognoterepeat
  2241. You can have local logging settings for a subtree by setting the LOGGING
  2242. property to one or more of these keywords."
  2243. :group 'org-todo
  2244. :group 'org-progress
  2245. :type '(choice
  2246. (const :tag "Don't force a record" nil)
  2247. (const :tag "Force recording the DONE state" time)
  2248. (const :tag "Force recording a note with the DONE state" note)))
  2249. (defgroup org-priorities nil
  2250. "Priorities in Org-mode."
  2251. :tag "Org Priorities"
  2252. :group 'org-todo)
  2253. (defcustom org-enable-priority-commands t
  2254. "Non-nil means priority commands are active.
  2255. When nil, these commands will be disabled, so that you never accidentally
  2256. set a priority."
  2257. :group 'org-priorities
  2258. :type 'boolean)
  2259. (defcustom org-highest-priority ?A
  2260. "The highest priority of TODO items. A character like ?A, ?B etc.
  2261. Must have a smaller ASCII number than `org-lowest-priority'."
  2262. :group 'org-priorities
  2263. :type 'character)
  2264. (defcustom org-lowest-priority ?C
  2265. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2266. Must have a larger ASCII number than `org-highest-priority'."
  2267. :group 'org-priorities
  2268. :type 'character)
  2269. (defcustom org-default-priority ?B
  2270. "The default priority of TODO items.
  2271. This is the priority an item gets if no explicit priority is given.
  2272. When starting to cycle on an empty priority the first step in the cycle
  2273. depends on `org-priority-start-cycle-with-default'. The resulting first
  2274. step priority must not exceed the range from `org-highest-priority' to
  2275. `org-lowest-priority' which means that `org-default-priority' has to be
  2276. in this range exclusive or inclusive the range boundaries. Else the
  2277. first step refuses to set the default and the second will fall back
  2278. to (depending on the command used) the highest or lowest priority."
  2279. :group 'org-priorities
  2280. :type 'character)
  2281. (defcustom org-priority-start-cycle-with-default t
  2282. "Non-nil means start with default priority when starting to cycle.
  2283. When this is nil, the first step in the cycle will be (depending on the
  2284. command used) one higher or lower than the default priority.
  2285. See also `org-default-priority'."
  2286. :group 'org-priorities
  2287. :type 'boolean)
  2288. (defcustom org-get-priority-function nil
  2289. "Function to extract the priority from a string.
  2290. The string is normally the headline. If this is nil Org computes the
  2291. priority from the priority cookie like [#A] in the headline. It returns
  2292. an integer, increasing by 1000 for each priority level.
  2293. The user can set a different function here, which should take a string
  2294. as an argument and return the numeric priority."
  2295. :group 'org-priorities
  2296. :version "24.1"
  2297. :type 'function)
  2298. (defgroup org-time nil
  2299. "Options concerning time stamps and deadlines in Org-mode."
  2300. :tag "Org Time"
  2301. :group 'org)
  2302. (defcustom org-insert-labeled-timestamps-at-point nil
  2303. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2304. When nil, these labeled time stamps are forces into the second line of an
  2305. entry, just after the headline. When scheduling from the global TODO list,
  2306. the time stamp will always be forced into the second line."
  2307. :group 'org-time
  2308. :type 'boolean)
  2309. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2310. "Formats for `format-time-string' which are used for time stamps.
  2311. It is not recommended to change this constant.")
  2312. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2313. "Number of minutes to round time stamps to.
  2314. These are two values, the first applies when first creating a time stamp.
  2315. The second applies when changing it with the commands `S-up' and `S-down'.
  2316. When changing the time stamp, this means that it will change in steps
  2317. of N minutes, as given by the second value.
  2318. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2319. numbers should be factors of 60, so for example 5, 10, 15.
  2320. When this is larger than 1, you can still force an exact time stamp by using
  2321. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2322. and by using a prefix arg to `S-up/down' to specify the exact number
  2323. of minutes to shift."
  2324. :group 'org-time
  2325. :get #'(lambda (var) ; Make sure both elements are there
  2326. (if (integerp (default-value var))
  2327. (list (default-value var) 5)
  2328. (default-value var)))
  2329. :type '(list
  2330. (integer :tag "when inserting times")
  2331. (integer :tag "when modifying times")))
  2332. ;; Normalize old customizations of this variable.
  2333. (when (integerp org-time-stamp-rounding-minutes)
  2334. (setq org-time-stamp-rounding-minutes
  2335. (list org-time-stamp-rounding-minutes
  2336. org-time-stamp-rounding-minutes)))
  2337. (defcustom org-display-custom-times nil
  2338. "Non-nil means overlay custom formats over all time stamps.
  2339. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2340. To turn this on on a per-file basis, insert anywhere in the file:
  2341. #+STARTUP: customtime"
  2342. :group 'org-time
  2343. :set 'set-default
  2344. :type 'sexp)
  2345. (make-variable-buffer-local 'org-display-custom-times)
  2346. (defcustom org-time-stamp-custom-formats
  2347. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2348. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2349. These are overlaid over the default ISO format if the variable
  2350. `org-display-custom-times' is set. Time like %H:%M should be at the
  2351. end of the second format. The custom formats are also honored by export
  2352. commands, if custom time display is turned on at the time of export."
  2353. :group 'org-time
  2354. :type 'sexp)
  2355. (defun org-time-stamp-format (&optional long inactive)
  2356. "Get the right format for a time string."
  2357. (let ((f (if long (cdr org-time-stamp-formats)
  2358. (car org-time-stamp-formats))))
  2359. (if inactive
  2360. (concat "[" (substring f 1 -1) "]")
  2361. f)))
  2362. (defcustom org-time-clocksum-format "%d:%02d"
  2363. "The format string used when creating CLOCKSUM lines.
  2364. This is also used when org-mode generates a time duration."
  2365. :group 'org-time
  2366. :type 'string)
  2367. (defcustom org-time-clocksum-use-fractional nil
  2368. "If non-nil, \\[org-clock-display] uses fractional times.
  2369. org-mode generates a time duration."
  2370. :group 'org-time
  2371. :type 'boolean)
  2372. (defcustom org-time-clocksum-fractional-format "%.2f"
  2373. "The format string used when creating CLOCKSUM lines, or when
  2374. org-mode generates a time duration."
  2375. :group 'org-time
  2376. :type 'string)
  2377. (defcustom org-deadline-warning-days 14
  2378. "No. of days before expiration during which a deadline becomes active.
  2379. This variable governs the display in sparse trees and in the agenda.
  2380. When 0 or negative, it means use this number (the absolute value of it)
  2381. even if a deadline has a different individual lead time specified.
  2382. Custom commands can set this variable in the options section."
  2383. :group 'org-time
  2384. :group 'org-agenda-daily/weekly
  2385. :type 'integer)
  2386. (defcustom org-read-date-prefer-future t
  2387. "Non-nil means assume future for incomplete date input from user.
  2388. This affects the following situations:
  2389. 1. The user gives a month but not a year.
  2390. For example, if it is April and you enter \"feb 2\", this will be read
  2391. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2392. 2. The user gives a day, but no month.
  2393. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2394. read this as the third of *next* month. However, if you enter \"17\",
  2395. it will be considered as *this* month.
  2396. If you set this variable to the symbol `time', then also the following
  2397. will work:
  2398. 3. If the user gives a time.
  2399. If the time is before now, it will be interpreted as tomorrow.
  2400. Currently none of this works for ISO week specifications.
  2401. When this option is nil, the current day, month and year will always be
  2402. used as defaults.
  2403. See also `org-agenda-jump-prefer-future'."
  2404. :group 'org-time
  2405. :type '(choice
  2406. (const :tag "Never" nil)
  2407. (const :tag "Check month and day" t)
  2408. (const :tag "Check month, day, and time" time)))
  2409. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2410. "Should the agenda jump command prefer the future for incomplete dates?
  2411. The default is to do the same as configured in `org-read-date-prefer-future'.
  2412. But you can also set a deviating value here.
  2413. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2414. :group 'org-agenda
  2415. :group 'org-time
  2416. :version "24.1"
  2417. :type '(choice
  2418. (const :tag "Use org-read-date-prefer-future"
  2419. org-read-date-prefer-future)
  2420. (const :tag "Never" nil)
  2421. (const :tag "Always" t)))
  2422. (defcustom org-read-date-force-compatible-dates t
  2423. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2424. Depending on the system Emacs is running on, certain dates cannot
  2425. be represented with the type used internally to represent time.
  2426. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2427. correctly. Some systems allow for earlier dates, some for later,
  2428. some for both. One way to find out it to insert any date into an
  2429. Org buffer, putting the cursor on the year and hitting S-up and
  2430. S-down to test the range.
  2431. When this variable is set to t, the date/time prompt will not let
  2432. you specify dates outside the 1970-2037 range, so it is certain that
  2433. these dates will work in whatever version of Emacs you are
  2434. running, and also that you can move a file from one Emacs implementation
  2435. to another. WHenever Org is forcing the year for you, it will display
  2436. a message and beep.
  2437. When this variable is nil, Org will check if the date is
  2438. representable in the specific Emacs implementation you are using.
  2439. If not, it will force a year, usually the current year, and beep
  2440. to remind you. Currently this setting is not recommended because
  2441. the likelihood that you will open your Org files in an Emacs that
  2442. has limited date range is not negligible.
  2443. A workaround for this problem is to use diary sexp dates for time
  2444. stamps outside of this range."
  2445. :group 'org-time
  2446. :version "24.1"
  2447. :type 'boolean)
  2448. (defcustom org-read-date-display-live t
  2449. "Non-nil means display current interpretation of date prompt live.
  2450. This display will be in an overlay, in the minibuffer."
  2451. :group 'org-time
  2452. :type 'boolean)
  2453. (defcustom org-read-date-popup-calendar t
  2454. "Non-nil means pop up a calendar when prompting for a date.
  2455. In the calendar, the date can be selected with mouse-1. However, the
  2456. minibuffer will also be active, and you can simply enter the date as well.
  2457. When nil, only the minibuffer will be available."
  2458. :group 'org-time
  2459. :type 'boolean)
  2460. (if (fboundp 'defvaralias)
  2461. (defvaralias 'org-popup-calendar-for-date-prompt
  2462. 'org-read-date-popup-calendar))
  2463. (defcustom org-read-date-minibuffer-setup-hook nil
  2464. "Hook to be used to set up keys for the date/time interface.
  2465. Add key definitions to `minibuffer-local-map', which will be a temporary
  2466. copy."
  2467. :group 'org-time
  2468. :type 'hook)
  2469. (defcustom org-extend-today-until 0
  2470. "The hour when your day really ends. Must be an integer.
  2471. This has influence for the following applications:
  2472. - When switching the agenda to \"today\". It it is still earlier than
  2473. the time given here, the day recognized as TODAY is actually yesterday.
  2474. - When a date is read from the user and it is still before the time given
  2475. here, the current date and time will be assumed to be yesterday, 23:59.
  2476. Also, timestamps inserted in remember templates follow this rule.
  2477. IMPORTANT: This is a feature whose implementation is and likely will
  2478. remain incomplete. Really, it is only here because past midnight seems to
  2479. be the favorite working time of John Wiegley :-)"
  2480. :group 'org-time
  2481. :type 'integer)
  2482. (defcustom org-use-effective-time nil
  2483. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2484. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2485. \"effective time\" of any timestamps between midnight and 8am will be
  2486. 23:59 of the previous day."
  2487. :group 'org-time
  2488. :version "24.1"
  2489. :type 'boolean)
  2490. (defcustom org-edit-timestamp-down-means-later nil
  2491. "Non-nil means S-down will increase the time in a time stamp.
  2492. When nil, S-up will increase."
  2493. :group 'org-time
  2494. :type 'boolean)
  2495. (defcustom org-calendar-follow-timestamp-change t
  2496. "Non-nil means make the calendar window follow timestamp changes.
  2497. When a timestamp is modified and the calendar window is visible, it will be
  2498. moved to the new date."
  2499. :group 'org-time
  2500. :type 'boolean)
  2501. (defgroup org-tags nil
  2502. "Options concerning tags in Org-mode."
  2503. :tag "Org Tags"
  2504. :group 'org)
  2505. (defcustom org-tag-alist nil
  2506. "List of tags allowed in Org-mode files.
  2507. When this list is nil, Org-mode will base TAG input on what is already in the
  2508. buffer.
  2509. The value of this variable is an alist, the car of each entry must be a
  2510. keyword as a string, the cdr may be a character that is used to select
  2511. that tag through the fast-tag-selection interface.
  2512. See the manual for details."
  2513. :group 'org-tags
  2514. :type '(repeat
  2515. (choice
  2516. (cons (string :tag "Tag name")
  2517. (character :tag "Access char"))
  2518. (list :tag "Start radio group"
  2519. (const :startgroup)
  2520. (option (string :tag "Group description")))
  2521. (list :tag "End radio group"
  2522. (const :endgroup)
  2523. (option (string :tag "Group description")))
  2524. (const :tag "New line" (:newline)))))
  2525. (defcustom org-tag-persistent-alist nil
  2526. "List of tags that will always appear in all Org-mode files.
  2527. This is in addition to any in buffer settings or customizations
  2528. of `org-tag-alist'.
  2529. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2530. The value of this variable is an alist, the car of each entry must be a
  2531. keyword as a string, the cdr may be a character that is used to select
  2532. that tag through the fast-tag-selection interface.
  2533. See the manual for details.
  2534. To disable these tags on a per-file basis, insert anywhere in the file:
  2535. #+STARTUP: noptag"
  2536. :group 'org-tags
  2537. :type '(repeat
  2538. (choice
  2539. (cons (string :tag "Tag name")
  2540. (character :tag "Access char"))
  2541. (const :tag "Start radio group" (:startgroup))
  2542. (const :tag "End radio group" (:endgroup))
  2543. (const :tag "New line" (:newline)))))
  2544. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2545. "If non-nil, always offer completion for all tags of all agenda files.
  2546. Instead of customizing this variable directly, you might want to
  2547. set it locally for capture buffers, because there no list of
  2548. tags in that file can be created dynamically (there are none).
  2549. (add-hook 'org-capture-mode-hook
  2550. (lambda ()
  2551. (set (make-local-variable
  2552. 'org-complete-tags-always-offer-all-agenda-tags)
  2553. t)))"
  2554. :group 'org-tags
  2555. :version "24.1"
  2556. :type 'boolean)
  2557. (defvar org-file-tags nil
  2558. "List of tags that can be inherited by all entries in the file.
  2559. The tags will be inherited if the variable `org-use-tag-inheritance'
  2560. says they should be.
  2561. This variable is populated from #+FILETAGS lines.")
  2562. (defcustom org-use-fast-tag-selection 'auto
  2563. "Non-nil means use fast tag selection scheme.
  2564. This is a special interface to select and deselect tags with single keys.
  2565. When nil, fast selection is never used.
  2566. When the symbol `auto', fast selection is used if and only if selection
  2567. characters for tags have been configured, either through the variable
  2568. `org-tag-alist' or through a #+TAGS line in the buffer.
  2569. When t, fast selection is always used and selection keys are assigned
  2570. automatically if necessary."
  2571. :group 'org-tags
  2572. :type '(choice
  2573. (const :tag "Always" t)
  2574. (const :tag "Never" nil)
  2575. (const :tag "When selection characters are configured" 'auto)))
  2576. (defcustom org-fast-tag-selection-single-key nil
  2577. "Non-nil means fast tag selection exits after first change.
  2578. When nil, you have to press RET to exit it.
  2579. During fast tag selection, you can toggle this flag with `C-c'.
  2580. This variable can also have the value `expert'. In this case, the window
  2581. displaying the tags menu is not even shown, until you press C-c again."
  2582. :group 'org-tags
  2583. :type '(choice
  2584. (const :tag "No" nil)
  2585. (const :tag "Yes" t)
  2586. (const :tag "Expert" expert)))
  2587. (defvar org-fast-tag-selection-include-todo nil
  2588. "Non-nil means fast tags selection interface will also offer TODO states.
  2589. This is an undocumented feature, you should not rely on it.")
  2590. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2591. "The column to which tags should be indented in a headline.
  2592. If this number is positive, it specifies the column. If it is negative,
  2593. it means that the tags should be flushright to that column. For example,
  2594. -80 works well for a normal 80 character screen.
  2595. When 0, place tags directly after headline text, with only one space in
  2596. between."
  2597. :group 'org-tags
  2598. :type 'integer)
  2599. (defcustom org-auto-align-tags t
  2600. "Non-nil keeps tags aligned when modifying headlines.
  2601. Some operations (i.e. demoting) change the length of a headline and
  2602. therefore shift the tags around. With this option turned on, after
  2603. each such operation the tags are again aligned to `org-tags-column'."
  2604. :group 'org-tags
  2605. :type 'boolean)
  2606. (defcustom org-use-tag-inheritance t
  2607. "Non-nil means tags in levels apply also for sublevels.
  2608. When nil, only the tags directly given in a specific line apply there.
  2609. This may also be a list of tags that should be inherited, or a regexp that
  2610. matches tags that should be inherited. Additional control is possible
  2611. with the variable `org-tags-exclude-from-inheritance' which gives an
  2612. explicit list of tags to be excluded from inheritance., even if the value of
  2613. `org-use-tag-inheritance' would select it for inheritance.
  2614. If this option is t, a match early-on in a tree can lead to a large
  2615. number of matches in the subtree when constructing the agenda or creating
  2616. a sparse tree. If you only want to see the first match in a tree during
  2617. a search, check out the variable `org-tags-match-list-sublevels'."
  2618. :group 'org-tags
  2619. :type '(choice
  2620. (const :tag "Not" nil)
  2621. (const :tag "Always" t)
  2622. (repeat :tag "Specific tags" (string :tag "Tag"))
  2623. (regexp :tag "Tags matched by regexp")))
  2624. (defcustom org-tags-exclude-from-inheritance nil
  2625. "List of tags that should never be inherited.
  2626. This is a way to exclude a few tags from inheritance. For way to do
  2627. the opposite, to actively allow inheritance for selected tags,
  2628. see the variable `org-use-tag-inheritance'."
  2629. :group 'org-tags
  2630. :type '(repeat (string :tag "Tag")))
  2631. (defun org-tag-inherit-p (tag)
  2632. "Check if TAG is one that should be inherited."
  2633. (cond
  2634. ((member tag org-tags-exclude-from-inheritance) nil)
  2635. ((eq org-use-tag-inheritance t) t)
  2636. ((not org-use-tag-inheritance) nil)
  2637. ((stringp org-use-tag-inheritance)
  2638. (string-match org-use-tag-inheritance tag))
  2639. ((listp org-use-tag-inheritance)
  2640. (member tag org-use-tag-inheritance))
  2641. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2642. (defcustom org-tags-match-list-sublevels t
  2643. "Non-nil means list also sublevels of headlines matching a search.
  2644. This variable applies to tags/property searches, and also to stuck
  2645. projects because this search is based on a tags match as well.
  2646. When set to the symbol `indented', sublevels are indented with
  2647. leading dots.
  2648. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2649. the sublevels of a headline matching a tag search often also match
  2650. the same search. Listing all of them can create very long lists.
  2651. Setting this variable to nil causes subtrees of a match to be skipped.
  2652. This variable is semi-obsolete and probably should always be true. It
  2653. is better to limit inheritance to certain tags using the variables
  2654. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2655. :group 'org-tags
  2656. :type '(choice
  2657. (const :tag "No, don't list them" nil)
  2658. (const :tag "Yes, do list them" t)
  2659. (const :tag "List them, indented with leading dots" indented)))
  2660. (defcustom org-tags-sort-function nil
  2661. "When set, tags are sorted using this function as a comparator."
  2662. :group 'org-tags
  2663. :type '(choice
  2664. (const :tag "No sorting" nil)
  2665. (const :tag "Alphabetical" string<)
  2666. (const :tag "Reverse alphabetical" string>)
  2667. (function :tag "Custom function" nil)))
  2668. (defvar org-tags-history nil
  2669. "History of minibuffer reads for tags.")
  2670. (defvar org-last-tags-completion-table nil
  2671. "The last used completion table for tags.")
  2672. (defvar org-after-tags-change-hook nil
  2673. "Hook that is run after the tags in a line have changed.")
  2674. (defgroup org-properties nil
  2675. "Options concerning properties in Org-mode."
  2676. :tag "Org Properties"
  2677. :group 'org)
  2678. (defcustom org-property-format "%-10s %s"
  2679. "How property key/value pairs should be formatted by `indent-line'.
  2680. When `indent-line' hits a property definition, it will format the line
  2681. according to this format, mainly to make sure that the values are
  2682. lined-up with respect to each other."
  2683. :group 'org-properties
  2684. :type 'string)
  2685. (defcustom org-properties-postprocess-alist nil
  2686. "Alist of properties and functions to adjust inserted values.
  2687. Elements of this alist must be of the form
  2688. ([string] [function])
  2689. where [string] must be a property name and [function] must be a
  2690. lambda expression: this lambda expression must take one argument,
  2691. the value to adjust, and return the new value as a string.
  2692. For example, this element will allow the property \"Remaining\"
  2693. to be updated wrt the relation between the \"Effort\" property
  2694. and the clock summary:
  2695. ((\"Remaining\" (lambda(value)
  2696. (let ((clocksum (org-clock-sum-current-item))
  2697. (effort (org-duration-string-to-minutes
  2698. (org-entry-get (point) \"Effort\"))))
  2699. (org-minutes-to-hh:mm-string (- effort clocksum))))))"
  2700. :group 'org-properties
  2701. :version "24.1"
  2702. :type '(alist :key-type (string :tag "Property")
  2703. :value-type (function :tag "Function")))
  2704. (defcustom org-use-property-inheritance nil
  2705. "Non-nil means properties apply also for sublevels.
  2706. This setting is chiefly used during property searches. Turning it on can
  2707. cause significant overhead when doing a search, which is why it is not
  2708. on by default.
  2709. When nil, only the properties directly given in the current entry count.
  2710. When t, every property is inherited. The value may also be a list of
  2711. properties that should have inheritance, or a regular expression matching
  2712. properties that should be inherited.
  2713. However, note that some special properties use inheritance under special
  2714. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2715. and the properties ending in \"_ALL\" when they are used as descriptor
  2716. for valid values of a property.
  2717. Note for programmers:
  2718. When querying an entry with `org-entry-get', you can control if inheritance
  2719. should be used. By default, `org-entry-get' looks only at the local
  2720. properties. You can request inheritance by setting the inherit argument
  2721. to t (to force inheritance) or to `selective' (to respect the setting
  2722. in this variable)."
  2723. :group 'org-properties
  2724. :type '(choice
  2725. (const :tag "Not" nil)
  2726. (const :tag "Always" t)
  2727. (repeat :tag "Specific properties" (string :tag "Property"))
  2728. (regexp :tag "Properties matched by regexp")))
  2729. (defun org-property-inherit-p (property)
  2730. "Check if PROPERTY is one that should be inherited."
  2731. (cond
  2732. ((eq org-use-property-inheritance t) t)
  2733. ((not org-use-property-inheritance) nil)
  2734. ((stringp org-use-property-inheritance)
  2735. (string-match org-use-property-inheritance property))
  2736. ((listp org-use-property-inheritance)
  2737. (member property org-use-property-inheritance))
  2738. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2739. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2740. "The default column format, if no other format has been defined.
  2741. This variable can be set on the per-file basis by inserting a line
  2742. #+COLUMNS: %25ITEM ....."
  2743. :group 'org-properties
  2744. :type 'string)
  2745. (defcustom org-columns-ellipses ".."
  2746. "The ellipses to be used when a field in column view is truncated.
  2747. When this is the empty string, as many characters as possible are shown,
  2748. but then there will be no visual indication that the field has been truncated.
  2749. When this is a string of length N, the last N characters of a truncated
  2750. field are replaced by this string. If the column is narrower than the
  2751. ellipses string, only part of the ellipses string will be shown."
  2752. :group 'org-properties
  2753. :type 'string)
  2754. (defcustom org-columns-modify-value-for-display-function nil
  2755. "Function that modifies values for display in column view.
  2756. For example, it can be used to cut out a certain part from a time stamp.
  2757. The function must take 2 arguments:
  2758. column-title The title of the column (*not* the property name)
  2759. value The value that should be modified.
  2760. The function should return the value that should be displayed,
  2761. or nil if the normal value should be used."
  2762. :group 'org-properties
  2763. :type 'function)
  2764. (defcustom org-effort-property "Effort"
  2765. "The property that is being used to keep track of effort estimates.
  2766. Effort estimates given in this property need to have the format H:MM."
  2767. :group 'org-properties
  2768. :group 'org-progress
  2769. :type '(string :tag "Property"))
  2770. (defconst org-global-properties-fixed
  2771. '(("VISIBILITY_ALL" . "folded children content all")
  2772. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2773. "List of property/value pairs that can be inherited by any entry.
  2774. These are fixed values, for the preset properties. The user variable
  2775. that can be used to add to this list is `org-global-properties'.
  2776. The entries in this list are cons cells where the car is a property
  2777. name and cdr is a string with the value. If the value represents
  2778. multiple items like an \"_ALL\" property, separate the items by
  2779. spaces.")
  2780. (defcustom org-global-properties nil
  2781. "List of property/value pairs that can be inherited by any entry.
  2782. This list will be combined with the constant `org-global-properties-fixed'.
  2783. The entries in this list are cons cells where the car is a property
  2784. name and cdr is a string with the value.
  2785. You can set buffer-local values for the same purpose in the variable
  2786. `org-file-properties' this by adding lines like
  2787. #+PROPERTY: NAME VALUE"
  2788. :group 'org-properties
  2789. :type '(repeat
  2790. (cons (string :tag "Property")
  2791. (string :tag "Value"))))
  2792. (defvar org-file-properties nil
  2793. "List of property/value pairs that can be inherited by any entry.
  2794. Valid for the current buffer.
  2795. This variable is populated from #+PROPERTY lines.")
  2796. (make-variable-buffer-local 'org-file-properties)
  2797. (defgroup org-agenda nil
  2798. "Options concerning agenda views in Org-mode."
  2799. :tag "Org Agenda"
  2800. :group 'org)
  2801. (defvar org-category nil
  2802. "Variable used by org files to set a category for agenda display.
  2803. Such files should use a file variable to set it, for example
  2804. # -*- mode: org; org-category: \"ELisp\"
  2805. or contain a special line
  2806. #+CATEGORY: ELisp
  2807. If the file does not specify a category, then file's base name
  2808. is used instead.")
  2809. (make-variable-buffer-local 'org-category)
  2810. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  2811. (defcustom org-agenda-files nil
  2812. "The files to be used for agenda display.
  2813. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2814. \\[org-remove-file]. You can also use customize to edit the list.
  2815. If an entry is a directory, all files in that directory that are matched by
  2816. `org-agenda-file-regexp' will be part of the file list.
  2817. If the value of the variable is not a list but a single file name, then
  2818. the list of agenda files is actually stored and maintained in that file, one
  2819. agenda file per line. In this file paths can be given relative to
  2820. `org-directory'. Tilde expansion and environment variable substitution
  2821. are also made."
  2822. :group 'org-agenda
  2823. :type '(choice
  2824. (repeat :tag "List of files and directories" file)
  2825. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2826. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2827. "Regular expression to match files for `org-agenda-files'.
  2828. If any element in the list in that variable contains a directory instead
  2829. of a normal file, all files in that directory that are matched by this
  2830. regular expression will be included."
  2831. :group 'org-agenda
  2832. :type 'regexp)
  2833. (defcustom org-agenda-text-search-extra-files nil
  2834. "List of extra files to be searched by text search commands.
  2835. These files will be search in addition to the agenda files by the
  2836. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2837. Note that these files will only be searched for text search commands,
  2838. not for the other agenda views like todo lists, tag searches or the weekly
  2839. agenda. This variable is intended to list notes and possibly archive files
  2840. that should also be searched by these two commands.
  2841. In fact, if the first element in the list is the symbol `agenda-archives',
  2842. than all archive files of all agenda files will be added to the search
  2843. scope."
  2844. :group 'org-agenda
  2845. :type '(set :greedy t
  2846. (const :tag "Agenda Archives" agenda-archives)
  2847. (repeat :inline t (file))))
  2848. (if (fboundp 'defvaralias)
  2849. (defvaralias 'org-agenda-multi-occur-extra-files
  2850. 'org-agenda-text-search-extra-files))
  2851. (defcustom org-agenda-skip-unavailable-files nil
  2852. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2853. A nil value means to remove them, after a query, from the list."
  2854. :group 'org-agenda
  2855. :type 'boolean)
  2856. (defcustom org-calendar-to-agenda-key [?c]
  2857. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2858. The command `org-calendar-goto-agenda' will be bound to this key. The
  2859. default is the character `c' because then `c' can be used to switch back and
  2860. forth between agenda and calendar."
  2861. :group 'org-agenda
  2862. :type 'sexp)
  2863. (defcustom org-calendar-agenda-action-key [?k]
  2864. "The key to be installed in `calendar-mode-map' for agenda-action.
  2865. The command `org-agenda-action' will be bound to this key. The
  2866. default is the character `k' because we use the same key in the agenda."
  2867. :group 'org-agenda
  2868. :type 'sexp)
  2869. (defcustom org-calendar-insert-diary-entry-key [?i]
  2870. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2871. This option is irrelevant until `org-agenda-diary-file' has been configured
  2872. to point to an Org-mode file. When that is the case, the command
  2873. `org-agenda-diary-entry' will be bound to the key given here, by default
  2874. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2875. if you want to continue doing this, you need to change this to a different
  2876. key."
  2877. :group 'org-agenda
  2878. :type 'sexp)
  2879. (defcustom org-agenda-diary-file 'diary-file
  2880. "File to which to add new entries with the `i' key in agenda and calendar.
  2881. When this is the symbol `diary-file', the functionality in the Emacs
  2882. calendar will be used to add entries to the `diary-file'. But when this
  2883. points to a file, `org-agenda-diary-entry' will be used instead."
  2884. :group 'org-agenda
  2885. :type '(choice
  2886. (const :tag "The standard Emacs diary file" diary-file)
  2887. (file :tag "Special Org file diary entries")))
  2888. (eval-after-load "calendar"
  2889. '(progn
  2890. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2891. 'org-calendar-goto-agenda)
  2892. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2893. 'org-agenda-action)
  2894. (add-hook 'calendar-mode-hook
  2895. (lambda ()
  2896. (unless (eq org-agenda-diary-file 'diary-file)
  2897. (define-key calendar-mode-map
  2898. org-calendar-insert-diary-entry-key
  2899. 'org-agenda-diary-entry))))))
  2900. (defgroup org-latex nil
  2901. "Options for embedding LaTeX code into Org-mode."
  2902. :tag "Org LaTeX"
  2903. :group 'org)
  2904. (defcustom org-format-latex-options
  2905. '(:foreground default :background default :scale 1.0
  2906. :html-foreground "Black" :html-background "Transparent"
  2907. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2908. "Options for creating images from LaTeX fragments.
  2909. This is a property list with the following properties:
  2910. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2911. `default' means use the foreground of the default face.
  2912. :background the background color, or \"Transparent\".
  2913. `default' means use the background of the default face.
  2914. :scale a scaling factor for the size of the images, to get more pixels
  2915. :html-foreground, :html-background, :html-scale
  2916. the same numbers for HTML export.
  2917. :matchers a list indicating which matchers should be used to
  2918. find LaTeX fragments. Valid members of this list are:
  2919. \"begin\" find environments
  2920. \"$1\" find single characters surrounded by $.$
  2921. \"$\" find math expressions surrounded by $...$
  2922. \"$$\" find math expressions surrounded by $$....$$
  2923. \"\\(\" find math expressions surrounded by \\(...\\)
  2924. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2925. :group 'org-latex
  2926. :type 'plist)
  2927. (defcustom org-format-latex-signal-error t
  2928. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2929. When nil, just push out a message."
  2930. :group 'org-latex
  2931. :version "24.1"
  2932. :type 'boolean)
  2933. (defcustom org-latex-to-mathml-jar-file nil
  2934. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  2935. Use this to specify additional executable file say a jar file.
  2936. When using MathToWeb as the converter, specify the full-path to
  2937. your mathtoweb.jar file."
  2938. :group 'org-latex
  2939. :version "24.1"
  2940. :type '(choice
  2941. (const :tag "None" nil)
  2942. (file :tag "JAR file" :must-match t)))
  2943. (defcustom org-latex-to-mathml-convert-command nil
  2944. "Command to convert LaTeX fragments to MathML.
  2945. Replace format-specifiers in the command as noted below and use
  2946. `shell-command' to convert LaTeX to MathML.
  2947. %j: Executable file in fully expanded form as specified by
  2948. `org-latex-to-mathml-jar-file'.
  2949. %I: Input LaTeX file in fully expanded form
  2950. %o: Output MathML file
  2951. This command is used by `org-create-math-formula'.
  2952. When using MathToWeb as the converter, set this to
  2953. \"java -jar %j -unicode -force -df %o %I\"."
  2954. :group 'org-latex
  2955. :version "24.1"
  2956. :type '(choice
  2957. (const :tag "None" nil)
  2958. (string :tag "\nShell command")))
  2959. (defcustom org-latex-create-formula-image-program 'dvipng
  2960. "Program to convert LaTeX fragments with.
  2961. dvipng Process the LaTeX fragments to dvi file, then convert
  2962. dvi files to png files using dvipng.
  2963. This will also include processing of non-math environments.
  2964. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  2965. to convert pdf files to png files"
  2966. :group 'org-latex
  2967. :version "24.1"
  2968. :type '(choice
  2969. (const :tag "dvipng" dvipng)
  2970. (const :tag "imagemagick" imagemagick)))
  2971. (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
  2972. "Path to store latex preview images. A relative path here creates many
  2973. directories relative to the processed org files paths. An absolute path
  2974. puts all preview images at the same place."
  2975. :group 'org-latex
  2976. ;; :version "24.3"
  2977. :type 'string)
  2978. (defun org-format-latex-mathml-available-p ()
  2979. "Return t if `org-latex-to-mathml-convert-command' is usable."
  2980. (save-match-data
  2981. (when (and (boundp 'org-latex-to-mathml-convert-command)
  2982. org-latex-to-mathml-convert-command)
  2983. (let ((executable (car (split-string
  2984. org-latex-to-mathml-convert-command))))
  2985. (when (executable-find executable)
  2986. (if (string-match
  2987. "%j" org-latex-to-mathml-convert-command)
  2988. (file-readable-p org-latex-to-mathml-jar-file)
  2989. t))))))
  2990. (defcustom org-format-latex-header "\\documentclass{article}
  2991. \\usepackage[usenames]{color}
  2992. \\usepackage{amsmath}
  2993. \\usepackage[mathscr]{eucal}
  2994. \\pagestyle{empty} % do not remove
  2995. \[PACKAGES]
  2996. \[DEFAULT-PACKAGES]
  2997. % The settings below are copied from fullpage.sty
  2998. \\setlength{\\textwidth}{\\paperwidth}
  2999. \\addtolength{\\textwidth}{-3cm}
  3000. \\setlength{\\oddsidemargin}{1.5cm}
  3001. \\addtolength{\\oddsidemargin}{-2.54cm}
  3002. \\setlength{\\evensidemargin}{\\oddsidemargin}
  3003. \\setlength{\\textheight}{\\paperheight}
  3004. \\addtolength{\\textheight}{-\\headheight}
  3005. \\addtolength{\\textheight}{-\\headsep}
  3006. \\addtolength{\\textheight}{-\\footskip}
  3007. \\addtolength{\\textheight}{-3cm}
  3008. \\setlength{\\topmargin}{1.5cm}
  3009. \\addtolength{\\topmargin}{-2.54cm}"
  3010. "The document header used for processing LaTeX fragments.
  3011. It is imperative that this header make sure that no page number
  3012. appears on the page. The package defined in the variables
  3013. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  3014. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  3015. will be appended."
  3016. :group 'org-latex
  3017. :type 'string)
  3018. (defvar org-format-latex-header-extra nil)
  3019. (defun org-set-packages-alist (var val)
  3020. "Set the packages alist and make sure it has 3 elements per entry."
  3021. (set var (mapcar (lambda (x)
  3022. (if (and (consp x) (= (length x) 2))
  3023. (list (car x) (nth 1 x) t)
  3024. x))
  3025. val)))
  3026. (defun org-get-packages-alist (var)
  3027. "Get the packages alist and make sure it has 3 elements per entry."
  3028. (mapcar (lambda (x)
  3029. (if (and (consp x) (= (length x) 2))
  3030. (list (car x) (nth 1 x) t)
  3031. x))
  3032. (default-value var)))
  3033. ;; The following variables are defined here because is it also used
  3034. ;; when formatting latex fragments. Originally it was part of the
  3035. ;; LaTeX exporter, which is why the name includes "export".
  3036. (defcustom org-export-latex-default-packages-alist
  3037. '(("AUTO" "inputenc" t)
  3038. ("T1" "fontenc" t)
  3039. ("" "fixltx2e" nil)
  3040. ("" "graphicx" t)
  3041. ("" "longtable" nil)
  3042. ("" "float" nil)
  3043. ("" "wrapfig" nil)
  3044. ("" "soul" t)
  3045. ("" "textcomp" t)
  3046. ("" "marvosym" t)
  3047. ("" "wasysym" t)
  3048. ("" "latexsym" t)
  3049. ("" "amssymb" t)
  3050. ("" "hyperref" nil)
  3051. "\\tolerance=1000"
  3052. )
  3053. "Alist of default packages to be inserted in the header.
  3054. Change this only if one of the packages here causes an incompatibility
  3055. with another package you are using.
  3056. The packages in this list are needed by one part or another of Org-mode
  3057. to function properly.
  3058. - inputenc, fontenc: for basic font and character selection
  3059. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  3060. for interpreting the entities in `org-entities'. You can skip some of these
  3061. packages if you don't use any of the symbols in it.
  3062. - graphicx: for including images
  3063. - float, wrapfig: for figure placement
  3064. - longtable: for long tables
  3065. - hyperref: for cross references
  3066. Therefore you should not modify this variable unless you know what you
  3067. are doing. The one reason to change it anyway is that you might be loading
  3068. some other package that conflicts with one of the default packages.
  3069. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  3070. If SNIPPET-FLAG is t, the package also needs to be included when
  3071. compiling LaTeX snippets into images for inclusion into HTML."
  3072. :group 'org-export-latex
  3073. :set 'org-set-packages-alist
  3074. :get 'org-get-packages-alist
  3075. :version "24.1"
  3076. :type '(repeat
  3077. (choice
  3078. (list :tag "options/package pair"
  3079. (string :tag "options")
  3080. (string :tag "package")
  3081. (boolean :tag "Snippet"))
  3082. (string :tag "A line of LaTeX"))))
  3083. (defcustom org-export-latex-packages-alist nil
  3084. "Alist of packages to be inserted in every LaTeX header.
  3085. These will be inserted after `org-export-latex-default-packages-alist'.
  3086. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  3087. SNIPPET-FLAG, when t, indicates that this package is also needed when
  3088. turning LaTeX snippets into images for inclusion into HTML.
  3089. Make sure that you only list packages here which:
  3090. - you want in every file
  3091. - do not conflict with the default packages in
  3092. `org-export-latex-default-packages-alist'
  3093. - do not conflict with the setup in `org-format-latex-header'."
  3094. :group 'org-export-latex
  3095. :set 'org-set-packages-alist
  3096. :get 'org-get-packages-alist
  3097. :type '(repeat
  3098. (choice
  3099. (list :tag "options/package pair"
  3100. (string :tag "options")
  3101. (string :tag "package")
  3102. (boolean :tag "Snippet"))
  3103. (string :tag "A line of LaTeX"))))
  3104. (defgroup org-appearance nil
  3105. "Settings for Org-mode appearance."
  3106. :tag "Org Appearance"
  3107. :group 'org)
  3108. (defcustom org-level-color-stars-only nil
  3109. "Non-nil means fontify only the stars in each headline.
  3110. When nil, the entire headline is fontified.
  3111. Changing it requires restart of `font-lock-mode' to become effective
  3112. also in regions already fontified."
  3113. :group 'org-appearance
  3114. :type 'boolean)
  3115. (defcustom org-hide-leading-stars nil
  3116. "Non-nil means hide the first N-1 stars in a headline.
  3117. This works by using the face `org-hide' for these stars. This
  3118. face is white for a light background, and black for a dark
  3119. background. You may have to customize the face `org-hide' to
  3120. make this work.
  3121. Changing it requires restart of `font-lock-mode' to become effective
  3122. also in regions already fontified.
  3123. You may also set this on a per-file basis by adding one of the following
  3124. lines to the buffer:
  3125. #+STARTUP: hidestars
  3126. #+STARTUP: showstars"
  3127. :group 'org-appearance
  3128. :type 'boolean)
  3129. (defcustom org-hidden-keywords nil
  3130. "List of symbols corresponding to keywords to be hidden the org buffer.
  3131. For example, a value '(title) for this list will make the document's title
  3132. appear in the buffer without the initial #+TITLE: keyword."
  3133. :group 'org-appearance
  3134. :version "24.1"
  3135. :type '(set (const :tag "#+AUTHOR" author)
  3136. (const :tag "#+DATE" date)
  3137. (const :tag "#+EMAIL" email)
  3138. (const :tag "#+TITLE" title)))
  3139. (defcustom org-custom-properties nil
  3140. "List of properties (as strings) with a special meaning.
  3141. The default use of these custom properties is to let the user
  3142. hide them with `org-toggle-custom-properties-visibility'."
  3143. :group 'org-properties
  3144. :group 'org-appearance
  3145. ;; :version "24.3"
  3146. :type '(repeat (string :tag "Property Name")))
  3147. (defcustom org-fontify-done-headline nil
  3148. "Non-nil means change the face of a headline if it is marked DONE.
  3149. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3150. When this is non-nil, the headline after the keyword is set to the
  3151. `org-headline-done' as an additional indication."
  3152. :group 'org-appearance
  3153. :type 'boolean)
  3154. (defcustom org-fontify-emphasized-text t
  3155. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3156. Changing this variable requires a restart of Emacs to take effect."
  3157. :group 'org-appearance
  3158. :type 'boolean)
  3159. (defcustom org-fontify-whole-heading-line nil
  3160. "Non-nil means fontify the whole line for headings.
  3161. This is useful when setting a background color for the
  3162. org-level-* faces."
  3163. :group 'org-appearance
  3164. :type 'boolean)
  3165. (defcustom org-highlight-latex-fragments-and-specials nil
  3166. "Non-nil means fontify what is treated specially by the exporters."
  3167. :group 'org-appearance
  3168. :type 'boolean)
  3169. (defcustom org-hide-emphasis-markers nil
  3170. "Non-nil mean font-lock should hide the emphasis marker characters."
  3171. :group 'org-appearance
  3172. :type 'boolean)
  3173. (defcustom org-pretty-entities nil
  3174. "Non-nil means show entities as UTF8 characters.
  3175. When nil, the \\name form remains in the buffer."
  3176. :group 'org-appearance
  3177. :version "24.1"
  3178. :type 'boolean)
  3179. (defcustom org-pretty-entities-include-sub-superscripts t
  3180. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3181. :group 'org-appearance
  3182. :version "24.1"
  3183. :type 'boolean)
  3184. (defvar org-emph-re nil
  3185. "Regular expression for matching emphasis.
  3186. After a match, the match groups contain these elements:
  3187. 0 The match of the full regular expression, including the characters
  3188. before and after the proper match
  3189. 1 The character before the proper match, or empty at beginning of line
  3190. 2 The proper match, including the leading and trailing markers
  3191. 3 The leading marker like * or /, indicating the type of highlighting
  3192. 4 The text between the emphasis markers, not including the markers
  3193. 5 The character after the match, empty at the end of a line")
  3194. (defvar org-verbatim-re nil
  3195. "Regular expression for matching verbatim text.")
  3196. (defvar org-emphasis-regexp-components) ; defined just below
  3197. (defvar org-emphasis-alist) ; defined just below
  3198. (defun org-set-emph-re (var val)
  3199. "Set variable and compute the emphasis regular expression."
  3200. (set var val)
  3201. (when (and (boundp 'org-emphasis-alist)
  3202. (boundp 'org-emphasis-regexp-components)
  3203. org-emphasis-alist org-emphasis-regexp-components)
  3204. (let* ((e org-emphasis-regexp-components)
  3205. (pre (car e))
  3206. (post (nth 1 e))
  3207. (border (nth 2 e))
  3208. (body (nth 3 e))
  3209. (nl (nth 4 e))
  3210. (body1 (concat body "*?"))
  3211. (markers (mapconcat 'car org-emphasis-alist ""))
  3212. (vmarkers (mapconcat
  3213. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  3214. org-emphasis-alist "")))
  3215. ;; make sure special characters appear at the right position in the class
  3216. (if (string-match "\\^" markers)
  3217. (setq markers (concat (replace-match "" t t markers) "^")))
  3218. (if (string-match "-" markers)
  3219. (setq markers (concat (replace-match "" t t markers) "-")))
  3220. (if (string-match "\\^" vmarkers)
  3221. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3222. (if (string-match "-" vmarkers)
  3223. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3224. (if (> nl 0)
  3225. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3226. (int-to-string nl) "\\}")))
  3227. ;; Make the regexp
  3228. (setq org-emph-re
  3229. (concat "\\([" pre "]\\|^\\)"
  3230. "\\("
  3231. "\\([" markers "]\\)"
  3232. "\\("
  3233. "[^" border "]\\|"
  3234. "[^" border "]"
  3235. body1
  3236. "[^" border "]"
  3237. "\\)"
  3238. "\\3\\)"
  3239. "\\([" post "]\\|$\\)"))
  3240. (setq org-verbatim-re
  3241. (concat "\\([" pre "]\\|^\\)"
  3242. "\\("
  3243. "\\([" vmarkers "]\\)"
  3244. "\\("
  3245. "[^" border "]\\|"
  3246. "[^" border "]"
  3247. body1
  3248. "[^" border "]"
  3249. "\\)"
  3250. "\\3\\)"
  3251. "\\([" post "]\\|$\\)")))))
  3252. (defcustom org-emphasis-regexp-components
  3253. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3254. "Components used to build the regular expression for emphasis.
  3255. This is a list with five entries. Terminology: In an emphasis string
  3256. like \" *strong word* \", we call the initial space PREMATCH, the final
  3257. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3258. and \"trong wor\" is the body. The different components in this variable
  3259. specify what is allowed/forbidden in each part:
  3260. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3261. post Chars allowed as postmatch. End of line will be allowed too.
  3262. border The chars *forbidden* as border characters.
  3263. body-regexp A regexp like \".\" to match a body character. Don't use
  3264. non-shy groups here, and don't allow newline here.
  3265. newline The maximum number of newlines allowed in an emphasis exp.
  3266. Use customize to modify this, or restart Emacs after changing it."
  3267. :group 'org-appearance
  3268. :set 'org-set-emph-re
  3269. :type '(list
  3270. (sexp :tag "Allowed chars in pre ")
  3271. (sexp :tag "Allowed chars in post ")
  3272. (sexp :tag "Forbidden chars in border ")
  3273. (sexp :tag "Regexp for body ")
  3274. (integer :tag "number of newlines allowed")
  3275. (option (boolean :tag "Please ignore this button"))))
  3276. (defcustom org-emphasis-alist
  3277. `(("*" bold "<b>" "</b>")
  3278. ("/" italic "<i>" "</i>")
  3279. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  3280. ("=" org-code "<code>" "</code>" verbatim)
  3281. ("~" org-verbatim "<code>" "</code>" verbatim)
  3282. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  3283. "<del>" "</del>")
  3284. )
  3285. "Special syntax for emphasized text.
  3286. Text starting and ending with a special character will be emphasized, for
  3287. example *bold*, _underlined_ and /italic/. This variable sets the marker
  3288. characters, the face to be used by font-lock for highlighting in Org-mode
  3289. Emacs buffers, and the HTML tags to be used for this.
  3290. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  3291. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  3292. Use customize to modify this, or restart Emacs after changing it."
  3293. :group 'org-appearance
  3294. :set 'org-set-emph-re
  3295. :type '(repeat
  3296. (list
  3297. (string :tag "Marker character")
  3298. (choice
  3299. (face :tag "Font-lock-face")
  3300. (plist :tag "Face property list"))
  3301. (string :tag "HTML start tag")
  3302. (string :tag "HTML end tag")
  3303. (option (const verbatim)))))
  3304. (defvar org-protecting-blocks
  3305. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  3306. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3307. This is needed for font-lock setup.")
  3308. ;;; Miscellaneous options
  3309. (defgroup org-completion nil
  3310. "Completion in Org-mode."
  3311. :tag "Org Completion"
  3312. :group 'org)
  3313. (defcustom org-completion-use-ido nil
  3314. "Non-nil means use ido completion wherever possible.
  3315. Note that `ido-mode' must be active for this variable to be relevant.
  3316. If you decide to turn this variable on, you might well want to turn off
  3317. `org-outline-path-complete-in-steps'.
  3318. See also `org-completion-use-iswitchb'."
  3319. :group 'org-completion
  3320. :type 'boolean)
  3321. (defcustom org-completion-use-iswitchb nil
  3322. "Non-nil means use iswitchb completion wherever possible.
  3323. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3324. If you decide to turn this variable on, you might well want to turn off
  3325. `org-outline-path-complete-in-steps'.
  3326. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3327. :group 'org-completion
  3328. :type 'boolean)
  3329. (defcustom org-completion-fallback-command 'hippie-expand
  3330. "The expansion command called by \\[pcomplete] in normal context.
  3331. Normal means, no org-mode-specific context."
  3332. :group 'org-completion
  3333. :type 'function)
  3334. ;;; Functions and variables from their packages
  3335. ;; Declared here to avoid compiler warnings
  3336. ;; XEmacs only
  3337. (defvar outline-mode-menu-heading)
  3338. (defvar outline-mode-menu-show)
  3339. (defvar outline-mode-menu-hide)
  3340. (defvar zmacs-regions) ; XEmacs regions
  3341. ;; Emacs only
  3342. (defvar mark-active)
  3343. ;; Various packages
  3344. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3345. (declare-function calendar-forward-day "cal-move" (arg))
  3346. (declare-function calendar-goto-date "cal-move" (date))
  3347. (declare-function calendar-goto-today "cal-move" ())
  3348. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3349. (defvar calc-embedded-close-formula)
  3350. (defvar calc-embedded-open-formula)
  3351. (declare-function cdlatex-tab "ext:cdlatex" ())
  3352. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3353. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3354. (defvar font-lock-unfontify-region-function)
  3355. (declare-function iswitchb-read-buffer "iswitchb"
  3356. (prompt &optional default require-match start matches-set))
  3357. (defvar iswitchb-temp-buflist)
  3358. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3359. (defvar org-agenda-tags-todo-honor-ignore-options)
  3360. (declare-function org-agenda-skip "org-agenda" ())
  3361. (declare-function
  3362. org-agenda-format-item "org-agenda"
  3363. (extra txt &optional category tags dotime noprefix remove-re habitp))
  3364. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3365. (declare-function org-agenda-change-all-lines "org-agenda"
  3366. (newhead hdmarker &optional fixface just-this))
  3367. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3368. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3369. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3370. (beg end))
  3371. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3372. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3373. "org-agenda" (&optional end))
  3374. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3375. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3376. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3377. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3378. (declare-function org-indent-mode "org-indent" (&optional arg))
  3379. (declare-function parse-time-string "parse-time" (string))
  3380. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3381. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3382. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3383. (defvar remember-data-file)
  3384. (defvar texmathp-why)
  3385. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3386. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3387. (defvar w3m-current-url)
  3388. (defvar w3m-current-title)
  3389. (defvar org-latex-regexps)
  3390. ;;; Autoload and prepare some org modules
  3391. ;; Some table stuff that needs to be defined here, because it is used
  3392. ;; by the functions setting up org-mode or checking for table context.
  3393. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3394. "Detect an org-type or table-type table.")
  3395. (defconst org-table-line-regexp "^[ \t]*|"
  3396. "Detect an org-type table line.")
  3397. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3398. "Detect an org-type table line.")
  3399. (defconst org-table-hline-regexp "^[ \t]*|-"
  3400. "Detect an org-type table hline.")
  3401. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3402. "Detect a table-type table hline.")
  3403. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3404. "Detect the first line outside a table when searching from within it.
  3405. This works for both table types.")
  3406. ;; Autoload the functions in org-table.el that are needed by functions here.
  3407. (eval-and-compile
  3408. (org-autoload "org-table"
  3409. '(org-table-align org-table-begin org-table-blank-field
  3410. org-table-convert org-table-convert-region org-table-copy-down
  3411. org-table-copy-region org-table-create
  3412. org-table-create-or-convert-from-region
  3413. org-table-create-with-table.el org-table-current-dline
  3414. org-table-cut-region org-table-delete-column org-table-edit-field
  3415. org-table-edit-formulas org-table-end org-table-eval-formula
  3416. org-table-export org-table-field-info
  3417. org-table-get-stored-formulas org-table-goto-column
  3418. org-table-hline-and-move org-table-import org-table-insert-column
  3419. org-table-insert-hline org-table-insert-row org-table-iterate
  3420. org-table-justify-field-maybe org-table-kill-row
  3421. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  3422. org-table-move-column org-table-move-column-left
  3423. org-table-move-column-right org-table-move-row
  3424. org-table-move-row-down org-table-move-row-up
  3425. org-table-next-field org-table-next-row org-table-paste-rectangle
  3426. org-table-previous-field org-table-recalculate
  3427. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  3428. org-table-toggle-coordinate-overlays
  3429. org-table-toggle-formula-debugger org-table-wrap-region
  3430. orgtbl-mode turn-on-orgtbl org-table-to-lisp
  3431. orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
  3432. orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
  3433. (defun org-at-table-p (&optional table-type)
  3434. "Return t if the cursor is inside an org-type table.
  3435. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3436. (if org-enable-table-editor
  3437. (save-excursion
  3438. (beginning-of-line 1)
  3439. (looking-at (if table-type org-table-any-line-regexp
  3440. org-table-line-regexp)))
  3441. nil))
  3442. (defsubst org-table-p () (org-at-table-p))
  3443. (defun org-at-table.el-p ()
  3444. "Return t if and only if we are at a table.el table."
  3445. (and (org-at-table-p 'any)
  3446. (save-excursion
  3447. (goto-char (org-table-begin 'any))
  3448. (looking-at org-table1-hline-regexp))))
  3449. (defun org-table-recognize-table.el ()
  3450. "If there is a table.el table nearby, recognize it and move into it."
  3451. (if org-table-tab-recognizes-table.el
  3452. (if (org-at-table.el-p)
  3453. (progn
  3454. (beginning-of-line 1)
  3455. (if (looking-at org-table-dataline-regexp)
  3456. nil
  3457. (if (looking-at org-table1-hline-regexp)
  3458. (progn
  3459. (beginning-of-line 2)
  3460. (if (looking-at org-table-any-border-regexp)
  3461. (beginning-of-line -1)))))
  3462. (if (re-search-forward "|" (org-table-end t) t)
  3463. (progn
  3464. (require 'table)
  3465. (if (table--at-cell-p (point))
  3466. t
  3467. (message "recognizing table.el table...")
  3468. (table-recognize-table)
  3469. (message "recognizing table.el table...done")))
  3470. (error "This should not happen"))
  3471. t)
  3472. nil)
  3473. nil))
  3474. (defun org-at-table-hline-p ()
  3475. "Return t if the cursor is inside a hline in a table."
  3476. (if org-enable-table-editor
  3477. (save-excursion
  3478. (beginning-of-line 1)
  3479. (looking-at org-table-hline-regexp))
  3480. nil))
  3481. (defvar org-table-clean-did-remove-column nil)
  3482. (defun org-table-map-tables (function &optional quietly)
  3483. "Apply FUNCTION to the start of all tables in the buffer."
  3484. (save-excursion
  3485. (save-restriction
  3486. (widen)
  3487. (goto-char (point-min))
  3488. (while (re-search-forward org-table-any-line-regexp nil t)
  3489. (unless quietly
  3490. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3491. (beginning-of-line 1)
  3492. (when (and (looking-at org-table-line-regexp)
  3493. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3494. (not (org-in-block-p '("src" "example"))))
  3495. (save-excursion (funcall function))
  3496. (or (looking-at org-table-line-regexp)
  3497. (forward-char 1)))
  3498. (re-search-forward org-table-any-border-regexp nil 1))))
  3499. (unless quietly (message "Mapping tables: done")))
  3500. ;; Declare and autoload functions from org-exp.el & Co
  3501. (declare-function org-default-export-plist "org-exp")
  3502. (declare-function org-infile-export-plist "org-exp")
  3503. (declare-function org-get-current-options "org-exp")
  3504. (eval-and-compile
  3505. (org-autoload "org-exp"
  3506. '(org-export org-export-visible
  3507. org-insert-export-options-template
  3508. org-table-clean-before-export))
  3509. (org-autoload "org-ascii"
  3510. '(org-export-as-ascii org-export-ascii-preprocess
  3511. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3512. org-export-region-as-ascii))
  3513. (org-autoload "org-latex"
  3514. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3515. org-replace-region-by-latex org-export-region-as-latex
  3516. org-export-as-latex org-export-as-pdf
  3517. org-export-as-pdf-and-open))
  3518. (org-autoload "org-html"
  3519. '(org-export-as-html-and-open
  3520. org-export-as-html-batch org-export-as-html-to-buffer
  3521. org-replace-region-by-html org-export-region-as-html
  3522. org-export-as-html))
  3523. (org-autoload "org-docbook"
  3524. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3525. org-replace-region-by-docbook org-export-region-as-docbook
  3526. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3527. org-export-as-docbook))
  3528. (org-autoload "org-icalendar"
  3529. '(org-export-icalendar-this-file
  3530. org-export-icalendar-all-agenda-files
  3531. org-export-icalendar-combine-agenda-files))
  3532. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3533. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3534. ;; Declare and autoload functions from org-agenda.el
  3535. (eval-and-compile
  3536. (org-autoload "org-agenda"
  3537. '(org-agenda org-agenda-list org-search-view
  3538. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3539. org-diary org-agenda-to-appt
  3540. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3541. ;; Autoload org-remember
  3542. (eval-and-compile
  3543. (org-autoload "org-remember"
  3544. '(org-remember-insinuate org-remember-annotation
  3545. org-remember-apply-template org-remember org-remember-handler)))
  3546. (eval-and-compile
  3547. (org-autoload "org-capture"
  3548. '(org-capture org-capture-insert-template-here
  3549. org-capture-import-remember-templates)))
  3550. ;; Autoload org-clock.el
  3551. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3552. (beg end))
  3553. (declare-function org-clock-update-mode-line "org-clock" ())
  3554. (declare-function org-resolve-clocks "org-clock"
  3555. (&optional also-non-dangling-p prompt last-valid))
  3556. (defvar org-clock-start-time)
  3557. (defvar org-clock-marker (make-marker)
  3558. "Marker recording the last clock-in.")
  3559. (defvar org-clock-hd-marker (make-marker)
  3560. "Marker recording the last clock-in, but the headline position.")
  3561. (defvar org-clock-heading ""
  3562. "The heading of the current clock entry.")
  3563. (defun org-clock-is-active ()
  3564. "Return non-nil if clock is currently running.
  3565. The return value is actually the clock marker."
  3566. (marker-buffer org-clock-marker))
  3567. (eval-and-compile
  3568. (org-autoload
  3569. "org-clock"
  3570. '(org-clock-in org-clock-out org-clock-cancel
  3571. org-clock-goto org-clock-sum org-clock-display
  3572. org-clock-remove-overlays org-clock-report
  3573. org-clocktable-shift org-dblock-write:clocktable
  3574. org-get-clocktable org-resolve-clocks)))
  3575. (defun org-clock-update-time-maybe ()
  3576. "If this is a CLOCK line, update it and return t.
  3577. Otherwise, return nil."
  3578. (interactive)
  3579. (save-excursion
  3580. (beginning-of-line 1)
  3581. (skip-chars-forward " \t")
  3582. (when (looking-at org-clock-string)
  3583. (let ((re (concat "[ \t]*" org-clock-string
  3584. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3585. "\\([ \t]*=>.*\\)?\\)?"))
  3586. ts te h m s neg)
  3587. (cond
  3588. ((not (looking-at re))
  3589. nil)
  3590. ((not (match-end 2))
  3591. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3592. (> org-clock-marker (point))
  3593. (<= org-clock-marker (point-at-eol)))
  3594. ;; The clock is running here
  3595. (setq org-clock-start-time
  3596. (apply 'encode-time
  3597. (org-parse-time-string (match-string 1))))
  3598. (org-clock-update-mode-line)))
  3599. (t
  3600. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3601. (end-of-line 1)
  3602. (setq ts (match-string 1)
  3603. te (match-string 3))
  3604. (setq s (- (org-float-time
  3605. (apply 'encode-time (org-parse-time-string te)))
  3606. (org-float-time
  3607. (apply 'encode-time (org-parse-time-string ts))))
  3608. neg (< s 0)
  3609. s (abs s)
  3610. h (floor (/ s 3600))
  3611. s (- s (* 3600 h))
  3612. m (floor (/ s 60))
  3613. s (- s (* 60 s)))
  3614. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3615. t))))))
  3616. (defun org-check-running-clock ()
  3617. "Check if the current buffer contains the running clock.
  3618. If yes, offer to stop it and to save the buffer with the changes."
  3619. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3620. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3621. (buffer-name))))
  3622. (org-clock-out)
  3623. (when (y-or-n-p "Save changed buffer?")
  3624. (save-buffer))))
  3625. (defun org-clocktable-try-shift (dir n)
  3626. "Check if this line starts a clock table, if yes, shift the time block."
  3627. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3628. (org-clocktable-shift dir n)))
  3629. ;; Autoload org-timer.el
  3630. (eval-and-compile
  3631. (org-autoload
  3632. "org-timer"
  3633. '(org-timer-start org-timer org-timer-item
  3634. org-timer-change-times-in-region
  3635. org-timer-set-timer
  3636. org-timer-reset-timers
  3637. org-timer-show-remaining-time)))
  3638. ;; Autoload org-feed.el
  3639. (eval-and-compile
  3640. (org-autoload
  3641. "org-feed"
  3642. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3643. ;; Autoload org-indent.el
  3644. ;; Define the variable already here, to make sure we have it.
  3645. (defvar org-indent-mode nil
  3646. "Non-nil if Org-Indent mode is enabled.
  3647. Use the command `org-indent-mode' to change this variable.")
  3648. (eval-and-compile
  3649. (org-autoload
  3650. "org-indent"
  3651. '(org-indent-mode)))
  3652. ;; Autoload org-mobile.el
  3653. (eval-and-compile
  3654. (org-autoload
  3655. "org-mobile"
  3656. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3657. ;; Autoload archiving code
  3658. ;; The stuff that is needed for cycling and tags has to be defined here.
  3659. (defgroup org-archive nil
  3660. "Options concerning archiving in Org-mode."
  3661. :tag "Org Archive"
  3662. :group 'org-structure)
  3663. (defcustom org-archive-location "%s_archive::"
  3664. "The location where subtrees should be archived.
  3665. The value of this variable is a string, consisting of two parts,
  3666. separated by a double-colon. The first part is a filename and
  3667. the second part is a headline.
  3668. When the filename is omitted, archiving happens in the same file.
  3669. %s in the filename will be replaced by the current file
  3670. name (without the directory part). Archiving to a different file
  3671. is useful to keep archived entries from contributing to the
  3672. Org-mode Agenda.
  3673. The archived entries will be filed as subtrees of the specified
  3674. headline. When the headline is omitted, the subtrees are simply
  3675. filed away at the end of the file, as top-level entries. Also in
  3676. the heading you can use %s to represent the file name, this can be
  3677. useful when using the same archive for a number of different files.
  3678. Here are a few examples:
  3679. \"%s_archive::\"
  3680. If the current file is Projects.org, archive in file
  3681. Projects.org_archive, as top-level trees. This is the default.
  3682. \"::* Archived Tasks\"
  3683. Archive in the current file, under the top-level headline
  3684. \"* Archived Tasks\".
  3685. \"~/org/archive.org::\"
  3686. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3687. \"~/org/archive.org::* From %s\"
  3688. Archive in file ~/org/archive.org (absolute path), under headlines
  3689. \"From FILENAME\" where file name is the current file name.
  3690. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3691. The \"datetree/\" string is special, signifying to archive
  3692. items to the datetree. Items are placed in either the CLOSED
  3693. date of the item, or the current date if there is no CLOSED date.
  3694. The heading will be a subentry to the current date. There doesn't
  3695. need to be a heading, but there always needs to be a slash after
  3696. datetree. For example, to store archived items directly in the
  3697. datetree, use \"~/org/datetree.org::datetree/\".
  3698. \"basement::** Finished Tasks\"
  3699. Archive in file ./basement (relative path), as level 3 trees
  3700. below the level 2 heading \"** Finished Tasks\".
  3701. You may set this option on a per-file basis by adding to the buffer a
  3702. line like
  3703. #+ARCHIVE: basement::** Finished Tasks
  3704. You may also define it locally for a subtree by setting an ARCHIVE property
  3705. in the entry. If such a property is found in an entry, or anywhere up
  3706. the hierarchy, it will be used."
  3707. :group 'org-archive
  3708. :type 'string)
  3709. (defcustom org-archive-tag "ARCHIVE"
  3710. "The tag that marks a subtree as archived.
  3711. An archived subtree does not open during visibility cycling, and does
  3712. not contribute to the agenda listings.
  3713. After changing this, font-lock must be restarted in the relevant buffers to
  3714. get the proper fontification."
  3715. :group 'org-archive
  3716. :group 'org-keywords
  3717. :type 'string)
  3718. (defcustom org-agenda-skip-archived-trees t
  3719. "Non-nil means the agenda will skip any items located in archived trees.
  3720. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3721. variable is no longer recommended, you should leave it at the value t.
  3722. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3723. :group 'org-archive
  3724. :group 'org-agenda-skip
  3725. :type 'boolean)
  3726. (defcustom org-columns-skip-archived-trees t
  3727. "Non-nil means ignore archived trees when creating column view."
  3728. :group 'org-archive
  3729. :group 'org-properties
  3730. :type 'boolean)
  3731. (defcustom org-cycle-open-archived-trees nil
  3732. "Non-nil means `org-cycle' will open archived trees.
  3733. An archived tree is a tree marked with the tag ARCHIVE.
  3734. When nil, archived trees will stay folded. You can still open them with
  3735. normal outline commands like `show-all', but not with the cycling commands."
  3736. :group 'org-archive
  3737. :group 'org-cycle
  3738. :type 'boolean)
  3739. (defcustom org-sparse-tree-open-archived-trees nil
  3740. "Non-nil means sparse tree construction shows matches in archived trees.
  3741. When nil, matches in these trees are highlighted, but the trees are kept in
  3742. collapsed state."
  3743. :group 'org-archive
  3744. :group 'org-sparse-trees
  3745. :type 'boolean)
  3746. (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
  3747. "The default date type when building a sparse tree.
  3748. When this is nil, a date is a scheduled or a deadline timestamp.
  3749. Otherwise, these types are allowed:
  3750. all: all timestamps
  3751. active: only active timestamps (<...>)
  3752. inactive: only inactive timestamps (<...)
  3753. scheduled: only scheduled timestamps
  3754. deadline: only deadline timestamps"
  3755. :type '(choice (const :tag "Scheduled or deadline" 'scheduled-or-deadline)
  3756. (const :tag "All timestamps" all)
  3757. (const :tag "Only active timestamps" active)
  3758. (const :tag "Only inactive timestamps" inactive)
  3759. (const :tag "Only scheduled timestamps" scheduled)
  3760. (const :tag "Only deadline timestamps" deadline))
  3761. ;; :version "24.3"
  3762. :group 'org-sparse-trees)
  3763. (defun org-cycle-hide-archived-subtrees (state)
  3764. "Re-hide all archived subtrees after a visibility state change."
  3765. (when (and (not org-cycle-open-archived-trees)
  3766. (not (memq state '(overview folded))))
  3767. (save-excursion
  3768. (let* ((globalp (memq state '(contents all)))
  3769. (beg (if globalp (point-min) (point)))
  3770. (end (if globalp (point-max) (org-end-of-subtree t))))
  3771. (org-hide-archived-subtrees beg end)
  3772. (goto-char beg)
  3773. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3774. (message "%s" (substitute-command-keys
  3775. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3776. (defun org-force-cycle-archived ()
  3777. "Cycle subtree even if it is archived."
  3778. (interactive)
  3779. (setq this-command 'org-cycle)
  3780. (let ((org-cycle-open-archived-trees t))
  3781. (call-interactively 'org-cycle)))
  3782. (defun org-hide-archived-subtrees (beg end)
  3783. "Re-hide all archived subtrees after a visibility state change."
  3784. (save-excursion
  3785. (let* ((re (concat ":" org-archive-tag ":")))
  3786. (goto-char beg)
  3787. (while (re-search-forward re end t)
  3788. (when (org-at-heading-p)
  3789. (org-flag-subtree t)
  3790. (org-end-of-subtree t))))))
  3791. (declare-function outline-end-of-heading "outline" ())
  3792. (declare-function outline-flag-region "outline" (from to flag))
  3793. (defun org-flag-subtree (flag)
  3794. (save-excursion
  3795. (org-back-to-heading t)
  3796. (outline-end-of-heading)
  3797. (outline-flag-region (point)
  3798. (progn (org-end-of-subtree t) (point))
  3799. flag)))
  3800. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3801. (eval-and-compile
  3802. (org-autoload "org-archive"
  3803. '(org-add-archive-files org-archive-subtree
  3804. org-archive-to-archive-sibling org-toggle-archive-tag
  3805. org-archive-subtree-default
  3806. org-archive-subtree-default-with-confirmation)))
  3807. ;; Autoload Column View Code
  3808. (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
  3809. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  3810. (declare-function org-columns-compute "org-colview" (property))
  3811. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3812. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3813. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3814. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3815. ;; Autoload ID code
  3816. (declare-function org-id-store-link "org-id")
  3817. (declare-function org-id-locations-load "org-id")
  3818. (declare-function org-id-locations-save "org-id")
  3819. (defvar org-id-track-globally)
  3820. (org-autoload "org-id"
  3821. '(org-id-get-create org-id-new org-id-copy org-id-get
  3822. org-id-get-with-outline-path-completion
  3823. org-id-get-with-outline-drilling org-id-store-link
  3824. org-id-goto org-id-find org-id-store-link))
  3825. ;; Autoload Plotting Code
  3826. (org-autoload "org-plot"
  3827. '(org-plot/gnuplot))
  3828. ;;; Variables for pre-computed regular expressions, all buffer local
  3829. (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
  3830. "Matches first line of a hidden block.")
  3831. (make-variable-buffer-local 'org-drawer-regexp)
  3832. (defvar org-todo-regexp nil
  3833. "Matches any of the TODO state keywords.")
  3834. (make-variable-buffer-local 'org-todo-regexp)
  3835. (defvar org-not-done-regexp nil
  3836. "Matches any of the TODO state keywords except the last one.")
  3837. (make-variable-buffer-local 'org-not-done-regexp)
  3838. (defvar org-not-done-heading-regexp nil
  3839. "Matches a TODO headline that is not done.")
  3840. (make-variable-buffer-local 'org-not-done-regexp)
  3841. (defvar org-todo-line-regexp nil
  3842. "Matches a headline and puts TODO state into group 2 if present.")
  3843. (make-variable-buffer-local 'org-todo-line-regexp)
  3844. (defvar org-complex-heading-regexp nil
  3845. "Matches a headline and puts everything into groups:
  3846. group 1: the stars
  3847. group 2: The todo keyword, maybe
  3848. group 3: Priority cookie
  3849. group 4: True headline
  3850. group 5: Tags")
  3851. (make-variable-buffer-local 'org-complex-heading-regexp)
  3852. (defvar org-complex-heading-regexp-format nil
  3853. "Printf format to make regexp to match an exact headline.
  3854. This regexp will match the headline of any node which has the
  3855. exact headline text that is put into the format, but may have any
  3856. TODO state, priority and tags.")
  3857. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3858. (defvar org-todo-line-tags-regexp nil
  3859. "Matches a headline and puts TODO state into group 2 if present.
  3860. Also put tags into group 4 if tags are present.")
  3861. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3862. (defvar org-ds-keyword-length 12
  3863. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  3864. (make-variable-buffer-local 'org-ds-keyword-length)
  3865. (defvar org-deadline-regexp nil
  3866. "Matches the DEADLINE keyword.")
  3867. (make-variable-buffer-local 'org-deadline-regexp)
  3868. (defvar org-deadline-time-regexp nil
  3869. "Matches the DEADLINE keyword together with a time stamp.")
  3870. (make-variable-buffer-local 'org-deadline-time-regexp)
  3871. (defvar org-deadline-line-regexp nil
  3872. "Matches the DEADLINE keyword and the rest of the line.")
  3873. (make-variable-buffer-local 'org-deadline-line-regexp)
  3874. (defvar org-scheduled-regexp nil
  3875. "Matches the SCHEDULED keyword.")
  3876. (make-variable-buffer-local 'org-scheduled-regexp)
  3877. (defvar org-scheduled-time-regexp nil
  3878. "Matches the SCHEDULED keyword together with a time stamp.")
  3879. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3880. (defvar org-closed-time-regexp nil
  3881. "Matches the CLOSED keyword together with a time stamp.")
  3882. (make-variable-buffer-local 'org-closed-time-regexp)
  3883. (defvar org-keyword-time-regexp nil
  3884. "Matches any of the 4 keywords, together with the time stamp.")
  3885. (make-variable-buffer-local 'org-keyword-time-regexp)
  3886. (defvar org-keyword-time-not-clock-regexp nil
  3887. "Matches any of the 3 keywords, together with the time stamp.")
  3888. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3889. (defvar org-maybe-keyword-time-regexp nil
  3890. "Matches a timestamp, possibly preceded by a keyword.")
  3891. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3892. (defvar org-all-time-keywords nil
  3893. "List of time keywords.")
  3894. (make-variable-buffer-local 'org-all-time-keywords)
  3895. (defconst org-plain-time-of-day-regexp
  3896. (concat
  3897. "\\(\\<[012]?[0-9]"
  3898. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3899. "\\(--?"
  3900. "\\(\\<[012]?[0-9]"
  3901. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3902. "\\)?")
  3903. "Regular expression to match a plain time or time range.
  3904. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3905. groups carry important information:
  3906. 0 the full match
  3907. 1 the first time, range or not
  3908. 8 the second time, if it is a range.")
  3909. (defconst org-plain-time-extension-regexp
  3910. (concat
  3911. "\\(\\<[012]?[0-9]"
  3912. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3913. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3914. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3915. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3916. groups carry important information:
  3917. 0 the full match
  3918. 7 hours of duration
  3919. 9 minutes of duration")
  3920. (defconst org-stamp-time-of-day-regexp
  3921. (concat
  3922. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3923. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3924. "\\(--?"
  3925. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3926. "Regular expression to match a timestamp time or time range.
  3927. After a match, the following groups carry important information:
  3928. 0 the full match
  3929. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3930. 2 the first time, range or not
  3931. 4 the second time, if it is a range.")
  3932. (defconst org-startup-options
  3933. '(("fold" org-startup-folded t)
  3934. ("overview" org-startup-folded t)
  3935. ("nofold" org-startup-folded nil)
  3936. ("showall" org-startup-folded nil)
  3937. ("showeverything" org-startup-folded showeverything)
  3938. ("content" org-startup-folded content)
  3939. ("indent" org-startup-indented t)
  3940. ("noindent" org-startup-indented nil)
  3941. ("hidestars" org-hide-leading-stars t)
  3942. ("showstars" org-hide-leading-stars nil)
  3943. ("odd" org-odd-levels-only t)
  3944. ("oddeven" org-odd-levels-only nil)
  3945. ("align" org-startup-align-all-tables t)
  3946. ("noalign" org-startup-align-all-tables nil)
  3947. ("inlineimages" org-startup-with-inline-images t)
  3948. ("noinlineimages" org-startup-with-inline-images nil)
  3949. ("customtime" org-display-custom-times t)
  3950. ("logdone" org-log-done time)
  3951. ("lognotedone" org-log-done note)
  3952. ("nologdone" org-log-done nil)
  3953. ("lognoteclock-out" org-log-note-clock-out t)
  3954. ("nolognoteclock-out" org-log-note-clock-out nil)
  3955. ("logrepeat" org-log-repeat state)
  3956. ("lognoterepeat" org-log-repeat note)
  3957. ("nologrepeat" org-log-repeat nil)
  3958. ("logreschedule" org-log-reschedule time)
  3959. ("lognotereschedule" org-log-reschedule note)
  3960. ("nologreschedule" org-log-reschedule nil)
  3961. ("logredeadline" org-log-redeadline time)
  3962. ("lognoteredeadline" org-log-redeadline note)
  3963. ("nologredeadline" org-log-redeadline nil)
  3964. ("logrefile" org-log-refile time)
  3965. ("lognoterefile" org-log-refile note)
  3966. ("nologrefile" org-log-refile nil)
  3967. ("fninline" org-footnote-define-inline t)
  3968. ("nofninline" org-footnote-define-inline nil)
  3969. ("fnlocal" org-footnote-section nil)
  3970. ("fnauto" org-footnote-auto-label t)
  3971. ("fnprompt" org-footnote-auto-label nil)
  3972. ("fnconfirm" org-footnote-auto-label confirm)
  3973. ("fnplain" org-footnote-auto-label plain)
  3974. ("fnadjust" org-footnote-auto-adjust t)
  3975. ("nofnadjust" org-footnote-auto-adjust nil)
  3976. ("constcgs" constants-unit-system cgs)
  3977. ("constSI" constants-unit-system SI)
  3978. ("noptag" org-tag-persistent-alist nil)
  3979. ("hideblocks" org-hide-block-startup t)
  3980. ("nohideblocks" org-hide-block-startup nil)
  3981. ("beamer" org-startup-with-beamer-mode t)
  3982. ("entitiespretty" org-pretty-entities t)
  3983. ("entitiesplain" org-pretty-entities nil))
  3984. "Variable associated with STARTUP options for org-mode.
  3985. Each element is a list of three items: the startup options (as written
  3986. in the #+STARTUP line), the corresponding variable, and the value to set
  3987. this variable to if the option is found. An optional forth element PUSH
  3988. means to push this value onto the list in the variable.")
  3989. (defun org-update-property-plist (key val props)
  3990. "Update PROPS with KEY and VAL."
  3991. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  3992. (key (if appending (substring key 0 (- (length key) 1)) key))
  3993. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  3994. (previous (cdr (assoc key props))))
  3995. (if appending
  3996. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  3997. (cons (cons key val) remainder))))
  3998. (defconst org-block-regexp
  3999. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  4000. "Regular expression for hiding blocks.")
  4001. (defconst org-heading-keyword-regexp-format
  4002. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4003. "Printf format for a regexp matching an headline with some keyword.
  4004. This regexp will match the headline of any node which has the
  4005. exact keyword that is put into the format. The keyword isn't in
  4006. any group by default, but the stars and the body are.")
  4007. (defconst org-heading-keyword-maybe-regexp-format
  4008. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4009. "Printf format for a regexp matching an headline, possibly with some keyword.
  4010. This regexp can match any headline with the specified keyword, or
  4011. without a keyword. The keyword isn't in any group by default,
  4012. but the stars and the body are.")
  4013. (defun org-set-regexps-and-options ()
  4014. "Precompute regular expressions for current buffer."
  4015. (when (derived-mode-p 'org-mode)
  4016. (org-set-local 'org-todo-kwd-alist nil)
  4017. (org-set-local 'org-todo-key-alist nil)
  4018. (org-set-local 'org-todo-key-trigger nil)
  4019. (org-set-local 'org-todo-keywords-1 nil)
  4020. (org-set-local 'org-done-keywords nil)
  4021. (org-set-local 'org-todo-heads nil)
  4022. (org-set-local 'org-todo-sets nil)
  4023. (org-set-local 'org-todo-log-states nil)
  4024. (org-set-local 'org-file-properties nil)
  4025. (org-set-local 'org-file-tags nil)
  4026. (let ((re (org-make-options-regexp
  4027. '("CATEGORY" "TODO" "COLUMNS"
  4028. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  4029. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  4030. "OPTIONS")
  4031. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  4032. (splitre "[ \t]+")
  4033. (scripts org-use-sub-superscripts)
  4034. kwds kws0 kwsa key log value cat arch tags const links hw dws
  4035. tail sep kws1 prio props ftags drawers beamer-p
  4036. ext-setup-or-nil setup-contents (start 0))
  4037. (save-excursion
  4038. (save-restriction
  4039. (widen)
  4040. (goto-char (point-min))
  4041. (while (or (and ext-setup-or-nil
  4042. (string-match re ext-setup-or-nil start)
  4043. (setq start (match-end 0)))
  4044. (and (setq ext-setup-or-nil nil start 0)
  4045. (re-search-forward re nil t)))
  4046. (setq key (upcase (match-string 1 ext-setup-or-nil))
  4047. value (org-match-string-no-properties 2 ext-setup-or-nil))
  4048. (if (stringp value) (setq value (org-trim value)))
  4049. (cond
  4050. ((equal key "CATEGORY")
  4051. (setq cat value))
  4052. ((member key '("SEQ_TODO" "TODO"))
  4053. (push (cons 'sequence (org-split-string value splitre)) kwds))
  4054. ((equal key "TYP_TODO")
  4055. (push (cons 'type (org-split-string value splitre)) kwds))
  4056. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  4057. ;; general TODO-like setup
  4058. (push (cons (intern (downcase (match-string 1 key)))
  4059. (org-split-string value splitre)) kwds))
  4060. ((equal key "TAGS")
  4061. (setq tags (append tags (if tags '("\\n") nil)
  4062. (org-split-string value splitre))))
  4063. ((equal key "COLUMNS")
  4064. (org-set-local 'org-columns-default-format value))
  4065. ((equal key "LINK")
  4066. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4067. (push (cons (match-string 1 value)
  4068. (org-trim (match-string 2 value)))
  4069. links)))
  4070. ((equal key "PRIORITIES")
  4071. (setq prio (org-split-string value " +")))
  4072. ((equal key "PROPERTY")
  4073. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4074. (setq props (org-update-property-plist (match-string 1 value)
  4075. (match-string 2 value)
  4076. props))))
  4077. ((equal key "FILETAGS")
  4078. (when (string-match "\\S-" value)
  4079. (setq ftags
  4080. (append
  4081. ftags
  4082. (apply 'append
  4083. (mapcar (lambda (x) (org-split-string x ":"))
  4084. (org-split-string value)))))))
  4085. ((equal key "DRAWERS")
  4086. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  4087. ((equal key "CONSTANTS")
  4088. (setq const (append const (org-split-string value splitre))))
  4089. ((equal key "STARTUP")
  4090. (let ((opts (org-split-string value splitre))
  4091. l var val)
  4092. (while (setq l (pop opts))
  4093. (when (setq l (assoc l org-startup-options))
  4094. (setq var (nth 1 l) val (nth 2 l))
  4095. (if (not (nth 3 l))
  4096. (set (make-local-variable var) val)
  4097. (if (not (listp (symbol-value var)))
  4098. (set (make-local-variable var) nil))
  4099. (set (make-local-variable var) (symbol-value var))
  4100. (add-to-list var val))))))
  4101. ((equal key "ARCHIVE")
  4102. (setq arch value)
  4103. (remove-text-properties 0 (length arch)
  4104. '(face t fontified t) arch))
  4105. ((equal key "LATEX_CLASS")
  4106. (setq beamer-p (equal value "beamer")))
  4107. ((equal key "OPTIONS")
  4108. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  4109. (setq scripts (read (match-string 2 value)))))
  4110. ((equal key "SETUPFILE")
  4111. (setq setup-contents (org-file-contents
  4112. (expand-file-name
  4113. (org-remove-double-quotes value))
  4114. 'noerror))
  4115. (if (not ext-setup-or-nil)
  4116. (setq ext-setup-or-nil setup-contents start 0)
  4117. (setq ext-setup-or-nil
  4118. (concat (substring ext-setup-or-nil 0 start)
  4119. "\n" setup-contents "\n"
  4120. (substring ext-setup-or-nil start)))))))
  4121. ;; search for property blocks
  4122. (goto-char (point-min))
  4123. (while (re-search-forward org-block-regexp nil t)
  4124. (when (equal "PROPERTY" (upcase (match-string 1)))
  4125. (setq value (replace-regexp-in-string
  4126. "[\n\r]" " " (match-string 4)))
  4127. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4128. (setq props (org-update-property-plist (match-string 1 value)
  4129. (match-string 2 value)
  4130. props)))))))
  4131. (org-set-local 'org-use-sub-superscripts scripts)
  4132. (when cat
  4133. (org-set-local 'org-category (intern cat))
  4134. (push (cons "CATEGORY" cat) props))
  4135. (when prio
  4136. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  4137. (setq prio (mapcar 'string-to-char prio))
  4138. (org-set-local 'org-highest-priority (nth 0 prio))
  4139. (org-set-local 'org-lowest-priority (nth 1 prio))
  4140. (org-set-local 'org-default-priority (nth 2 prio)))
  4141. (and props (org-set-local 'org-file-properties (nreverse props)))
  4142. (and ftags (org-set-local 'org-file-tags
  4143. (mapcar 'org-add-prop-inherited ftags)))
  4144. (and drawers (org-set-local 'org-drawers drawers))
  4145. (and arch (org-set-local 'org-archive-location arch))
  4146. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4147. ;; Process the TODO keywords
  4148. (unless kwds
  4149. ;; Use the global values as if they had been given locally.
  4150. (setq kwds (default-value 'org-todo-keywords))
  4151. (if (stringp (car kwds))
  4152. (setq kwds (list (cons org-todo-interpretation
  4153. (default-value 'org-todo-keywords)))))
  4154. (setq kwds (reverse kwds)))
  4155. (setq kwds (nreverse kwds))
  4156. (let (inter kws kw)
  4157. (while (setq kws (pop kwds))
  4158. (let ((kws (or
  4159. (run-hook-with-args-until-success
  4160. 'org-todo-setup-filter-hook kws)
  4161. kws)))
  4162. (setq inter (pop kws) sep (member "|" kws)
  4163. kws0 (delete "|" (copy-sequence kws))
  4164. kwsa nil
  4165. kws1 (mapcar
  4166. (lambda (x)
  4167. ;; 1 2
  4168. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4169. (progn
  4170. (setq kw (match-string 1 x)
  4171. key (and (match-end 2) (match-string 2 x))
  4172. log (org-extract-log-state-settings x))
  4173. (push (cons kw (and key (string-to-char key))) kwsa)
  4174. (and log (push log org-todo-log-states))
  4175. kw)
  4176. (error "Invalid TODO keyword %s" x)))
  4177. kws0)
  4178. kwsa (if kwsa (append '((:startgroup))
  4179. (nreverse kwsa)
  4180. '((:endgroup))))
  4181. hw (car kws1)
  4182. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4183. tail (list inter hw (car dws) (org-last dws))))
  4184. (add-to-list 'org-todo-heads hw 'append)
  4185. (push kws1 org-todo-sets)
  4186. (setq org-done-keywords (append org-done-keywords dws nil))
  4187. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4188. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4189. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4190. (setq org-todo-sets (nreverse org-todo-sets)
  4191. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4192. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4193. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4194. ;; Process the constants
  4195. (when const
  4196. (let (e cst)
  4197. (while (setq e (pop const))
  4198. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  4199. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  4200. (setq org-table-formula-constants-local cst)))
  4201. ;; Process the tags.
  4202. (when tags
  4203. (let (e tgs)
  4204. (while (setq e (pop tags))
  4205. (cond
  4206. ((equal e "{") (push '(:startgroup) tgs))
  4207. ((equal e "}") (push '(:endgroup) tgs))
  4208. ((equal e "\\n") (push '(:newline) tgs))
  4209. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4210. (push (cons (match-string 1 e)
  4211. (string-to-char (match-string 2 e)))
  4212. tgs))
  4213. (t (push (list e) tgs))))
  4214. (org-set-local 'org-tag-alist nil)
  4215. (while (setq e (pop tgs))
  4216. (or (and (stringp (car e))
  4217. (assoc (car e) org-tag-alist))
  4218. (push e org-tag-alist)))))
  4219. ;; Compute the regular expressions and other local variables.
  4220. ;; Using `org-outline-regexp-bol' would complicate them much,
  4221. ;; because of the fixed white space at the end of that string.
  4222. (if (not org-done-keywords)
  4223. (setq org-done-keywords (and org-todo-keywords-1
  4224. (list (org-last org-todo-keywords-1)))))
  4225. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4226. (length org-scheduled-string)
  4227. (length org-clock-string)
  4228. (length org-closed-string)))
  4229. org-drawer-regexp
  4230. (concat "^[ \t]*:\\("
  4231. (mapconcat 'regexp-quote org-drawers "\\|")
  4232. "\\):[ \t]*$")
  4233. org-not-done-keywords
  4234. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4235. org-todo-regexp
  4236. (concat "\\("
  4237. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4238. "\\)")
  4239. org-not-done-regexp
  4240. (concat "\\("
  4241. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4242. "\\)")
  4243. org-not-done-heading-regexp
  4244. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4245. org-todo-line-regexp
  4246. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4247. org-complex-heading-regexp
  4248. (concat "^\\(\\*+\\)"
  4249. "\\(?: +" org-todo-regexp "\\)?"
  4250. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4251. "\\(?: +\\(.*?\\)\\)?"
  4252. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4253. "[ \t]*$")
  4254. org-complex-heading-regexp-format
  4255. (concat "^\\(\\*+\\)"
  4256. "\\(?: +" org-todo-regexp "\\)?"
  4257. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4258. "\\(?: +"
  4259. ;; Stats cookies can be stuck to body.
  4260. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4261. "\\(%s\\)"
  4262. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4263. "\\)"
  4264. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4265. "[ \t]*$")
  4266. org-todo-line-tags-regexp
  4267. (concat "^\\(\\*+\\)"
  4268. "\\(?: +" org-todo-regexp "\\)?"
  4269. "\\(?: +\\(.*?\\)\\)?"
  4270. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4271. "[ \t]*$")
  4272. org-deadline-regexp (concat "\\<" org-deadline-string)
  4273. org-deadline-time-regexp
  4274. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4275. org-deadline-line-regexp
  4276. (concat "\\<\\(" org-deadline-string "\\).*")
  4277. org-scheduled-regexp
  4278. (concat "\\<" org-scheduled-string)
  4279. org-scheduled-time-regexp
  4280. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4281. org-closed-time-regexp
  4282. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4283. org-keyword-time-regexp
  4284. (concat "\\<\\(" org-scheduled-string
  4285. "\\|" org-deadline-string
  4286. "\\|" org-closed-string
  4287. "\\|" org-clock-string "\\)"
  4288. " *[[<]\\([^]>]+\\)[]>]")
  4289. org-keyword-time-not-clock-regexp
  4290. (concat "\\<\\(" org-scheduled-string
  4291. "\\|" org-deadline-string
  4292. "\\|" org-closed-string
  4293. "\\)"
  4294. " *[[<]\\([^]>]+\\)[]>]")
  4295. org-maybe-keyword-time-regexp
  4296. (concat "\\(\\<\\(" org-scheduled-string
  4297. "\\|" org-deadline-string
  4298. "\\|" org-closed-string
  4299. "\\|" org-clock-string "\\)\\)?"
  4300. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4301. org-all-time-keywords
  4302. (mapcar (lambda (w) (substring w 0 -1))
  4303. (list org-scheduled-string org-deadline-string
  4304. org-clock-string org-closed-string))
  4305. )
  4306. (org-compute-latex-and-specials-regexp)
  4307. (org-set-font-lock-defaults))))
  4308. (defun org-file-contents (file &optional noerror)
  4309. "Return the contents of FILE, as a string."
  4310. (if (or (not file)
  4311. (not (file-readable-p file)))
  4312. (if noerror
  4313. (progn
  4314. (message "Cannot read file \"%s\"" file)
  4315. (ding) (sit-for 2)
  4316. "")
  4317. (error "Cannot read file \"%s\"" file))
  4318. (with-temp-buffer
  4319. (insert-file-contents file)
  4320. (buffer-string))))
  4321. (defun org-extract-log-state-settings (x)
  4322. "Extract the log state setting from a TODO keyword string.
  4323. This will extract info from a string like \"WAIT(w@/!)\"."
  4324. (let (kw key log1 log2)
  4325. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4326. (setq kw (match-string 1 x)
  4327. key (and (match-end 2) (match-string 2 x))
  4328. log1 (and (match-end 3) (match-string 3 x))
  4329. log2 (and (match-end 4) (match-string 4 x)))
  4330. (and (or log1 log2)
  4331. (list kw
  4332. (and log1 (if (equal log1 "!") 'time 'note))
  4333. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4334. (defun org-remove-keyword-keys (list)
  4335. "Remove a pair of parenthesis at the end of each string in LIST."
  4336. (mapcar (lambda (x)
  4337. (if (string-match "(.*)$" x)
  4338. (substring x 0 (match-beginning 0))
  4339. x))
  4340. list))
  4341. (defun org-assign-fast-keys (alist)
  4342. "Assign fast keys to a keyword-key alist.
  4343. Respect keys that are already there."
  4344. (let (new e (alt ?0))
  4345. (while (setq e (pop alist))
  4346. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  4347. (cdr e)) ;; Key already assigned.
  4348. (push e new)
  4349. (let ((clist (string-to-list (downcase (car e))))
  4350. (used (append new alist)))
  4351. (when (= (car clist) ?@)
  4352. (pop clist))
  4353. (while (and clist (rassoc (car clist) used))
  4354. (pop clist))
  4355. (unless clist
  4356. (while (rassoc alt used)
  4357. (incf alt)))
  4358. (push (cons (car e) (or (car clist) alt)) new))))
  4359. (nreverse new)))
  4360. ;;; Some variables used in various places
  4361. (defvar org-window-configuration nil
  4362. "Used in various places to store a window configuration.")
  4363. (defvar org-selected-window nil
  4364. "Used in various places to store a window configuration.")
  4365. (defvar org-finish-function nil
  4366. "Function to be called when `C-c C-c' is used.
  4367. This is for getting out of special buffers like remember.")
  4368. ;; FIXME: Occasionally check by commenting these, to make sure
  4369. ;; no other functions uses these, forgetting to let-bind them.
  4370. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4371. (defvar org-last-state)
  4372. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4373. ;; Defined somewhere in this file, but used before definition.
  4374. (defvar org-entities) ;; defined in org-entities.el
  4375. (defvar org-struct-menu)
  4376. (defvar org-org-menu)
  4377. (defvar org-tbl-menu)
  4378. ;;;; Define the Org-mode
  4379. ;; We use a before-change function to check if a table might need
  4380. ;; an update.
  4381. (defvar org-table-may-need-update t
  4382. "Indicates that a table might need an update.
  4383. This variable is set by `org-before-change-function'.
  4384. `org-table-align' sets it back to nil.")
  4385. (defun org-before-change-function (beg end)
  4386. "Every change indicates that a table might need an update."
  4387. (setq org-table-may-need-update t))
  4388. (defvar org-mode-map)
  4389. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4390. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4391. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4392. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4393. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4394. (defvar org-table-buffer-is-an nil)
  4395. (defvar bidi-paragraph-direction)
  4396. (defvar buffer-face-mode-face)
  4397. (require 'outline)
  4398. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4399. (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"))
  4400. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  4401. ;; Other stuff we need.
  4402. (require 'time-date)
  4403. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4404. (require 'easymenu)
  4405. (require 'overlay)
  4406. (require 'org-macs)
  4407. (require 'org-entities)
  4408. ;; (require 'org-compat) moved higher up in the file before it is first used
  4409. (require 'org-faces)
  4410. (require 'org-list)
  4411. (require 'org-pcomplete)
  4412. (require 'org-src)
  4413. (require 'org-footnote)
  4414. ;; babel
  4415. (require 'ob)
  4416. (require 'ob-table)
  4417. (require 'ob-lob)
  4418. (require 'ob-ref)
  4419. (require 'ob-tangle)
  4420. (require 'ob-comint)
  4421. (require 'ob-keys)
  4422. ;;;###autoload
  4423. (define-derived-mode org-mode outline-mode "Org"
  4424. "Outline-based notes management and organizer, alias
  4425. \"Carsten's outline-mode for keeping track of everything.\"
  4426. Org-mode develops organizational tasks around a NOTES file which
  4427. contains information about projects as plain text. Org-mode is
  4428. implemented on top of outline-mode, which is ideal to keep the content
  4429. of large files well structured. It supports ToDo items, deadlines and
  4430. time stamps, which magically appear in the diary listing of the Emacs
  4431. calendar. Tables are easily created with a built-in table editor.
  4432. Plain text URL-like links connect to websites, emails (VM), Usenet
  4433. messages (Gnus), BBDB entries, and any files related to the project.
  4434. For printing and sharing of notes, an Org-mode file (or a part of it)
  4435. can be exported as a structured ASCII or HTML file.
  4436. The following commands are available:
  4437. \\{org-mode-map}"
  4438. ;; Get rid of Outline menus, they are not needed
  4439. ;; Need to do this here because define-derived-mode sets up
  4440. ;; the keymap so late. Still, it is a waste to call this each time
  4441. ;; we switch another buffer into org-mode.
  4442. (if (featurep 'xemacs)
  4443. (when (boundp 'outline-mode-menu-heading)
  4444. ;; Assume this is Greg's port, it uses easymenu
  4445. (easy-menu-remove outline-mode-menu-heading)
  4446. (easy-menu-remove outline-mode-menu-show)
  4447. (easy-menu-remove outline-mode-menu-hide))
  4448. (define-key org-mode-map [menu-bar headings] 'undefined)
  4449. (define-key org-mode-map [menu-bar hide] 'undefined)
  4450. (define-key org-mode-map [menu-bar show] 'undefined))
  4451. (org-load-modules-maybe)
  4452. (easy-menu-add org-org-menu)
  4453. (easy-menu-add org-tbl-menu)
  4454. (org-install-agenda-files-menu)
  4455. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4456. (add-to-invisibility-spec '(org-cwidth))
  4457. (add-to-invisibility-spec '(org-hide-block . t))
  4458. (when (featurep 'xemacs)
  4459. (org-set-local 'line-move-ignore-invisible t))
  4460. (org-set-local 'outline-regexp org-outline-regexp)
  4461. (org-set-local 'outline-level 'org-outline-level)
  4462. (setq bidi-paragraph-direction 'left-to-right)
  4463. (when (and org-ellipsis
  4464. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4465. (fboundp 'make-glyph-code))
  4466. (unless org-display-table
  4467. (setq org-display-table (make-display-table)))
  4468. (set-display-table-slot
  4469. org-display-table 4
  4470. (vconcat (mapcar
  4471. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4472. org-ellipsis)))
  4473. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4474. (setq buffer-display-table org-display-table))
  4475. (org-set-regexps-and-options)
  4476. (when (and org-tag-faces (not org-tags-special-faces-re))
  4477. ;; tag faces set outside customize.... force initialization.
  4478. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4479. ;; Calc embedded
  4480. (org-set-local 'calc-embedded-open-mode "# ")
  4481. (modify-syntax-entry ?@ "w")
  4482. (if org-startup-truncated (setq truncate-lines t))
  4483. (org-set-local 'font-lock-unfontify-region-function
  4484. 'org-unfontify-region)
  4485. ;; Activate before-change-function
  4486. (org-set-local 'org-table-may-need-update t)
  4487. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4488. 'local)
  4489. ;; Check for running clock before killing a buffer
  4490. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4491. ;; Indentation.
  4492. (org-set-local 'indent-line-function 'org-indent-line)
  4493. (org-set-local 'indent-region-function 'org-indent-region)
  4494. ;; Initialize radio targets.
  4495. (org-update-radio-target-regexp)
  4496. ;; Filling and auto-filling.
  4497. (org-setup-filling)
  4498. ;; Comments.
  4499. (org-setup-comments-handling)
  4500. ;; Beginning/end of defun
  4501. (org-set-local 'beginning-of-defun-function 'org-back-to-heading)
  4502. (org-set-local 'end-of-defun-function (lambda () (interactive) (org-end-of-subtree nil t)))
  4503. ;; Next error for sparse trees
  4504. (org-set-local 'next-error-function 'org-occur-next-match)
  4505. ;; Make sure dependence stuff works reliably, even for users who set it
  4506. ;; too late :-(
  4507. (if org-enforce-todo-dependencies
  4508. (add-hook 'org-blocker-hook
  4509. 'org-block-todo-from-children-or-siblings-or-parent)
  4510. (remove-hook 'org-blocker-hook
  4511. 'org-block-todo-from-children-or-siblings-or-parent))
  4512. (if org-enforce-todo-checkbox-dependencies
  4513. (add-hook 'org-blocker-hook
  4514. 'org-block-todo-from-checkboxes)
  4515. (remove-hook 'org-blocker-hook
  4516. 'org-block-todo-from-checkboxes))
  4517. ;; Align options lines
  4518. (org-set-local
  4519. 'align-mode-rules-list
  4520. '((org-in-buffer-settings
  4521. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4522. (modes . '(org-mode)))))
  4523. ;; Imenu
  4524. (org-set-local 'imenu-create-index-function
  4525. 'org-imenu-get-tree)
  4526. ;; Make isearch reveal context
  4527. (if (or (featurep 'xemacs)
  4528. (not (boundp 'outline-isearch-open-invisible-function)))
  4529. ;; Emacs 21 and XEmacs make use of the hook
  4530. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4531. ;; Emacs 22 deals with this through a special variable
  4532. (org-set-local 'outline-isearch-open-invisible-function
  4533. (lambda (&rest ignore) (org-show-context 'isearch))))
  4534. ;; Turn on org-beamer-mode?
  4535. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  4536. ;; Setup the pcomplete hooks
  4537. (set (make-local-variable 'pcomplete-command-completion-function)
  4538. 'org-pcomplete-initial)
  4539. (set (make-local-variable 'pcomplete-command-name-function)
  4540. 'org-command-at-point)
  4541. (set (make-local-variable 'pcomplete-default-completion-function)
  4542. 'ignore)
  4543. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4544. 'org-parse-arguments)
  4545. (set (make-local-variable 'pcomplete-termination-string) "")
  4546. (when (>= emacs-major-version 23)
  4547. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4548. ;; If empty file that did not turn on org-mode automatically, make it to.
  4549. (if (and org-insert-mode-line-in-empty-file
  4550. (org-called-interactively-p 'any)
  4551. (= (point-min) (point-max)))
  4552. (insert "# -*- mode: org -*-\n\n"))
  4553. (unless org-inhibit-startup
  4554. (when org-startup-align-all-tables
  4555. (let ((bmp (buffer-modified-p)))
  4556. (org-table-map-tables 'org-table-align 'quietly)
  4557. (set-buffer-modified-p bmp)))
  4558. (when org-startup-with-inline-images
  4559. (org-display-inline-images))
  4560. (when org-startup-indented
  4561. (require 'org-indent)
  4562. (org-indent-mode 1))
  4563. (unless org-inhibit-startup-visibility-stuff
  4564. (org-set-startup-visibility))))
  4565. (when (fboundp 'abbrev-table-put)
  4566. (abbrev-table-put org-mode-abbrev-table
  4567. :parents (list text-mode-abbrev-table)))
  4568. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4569. (defun org-current-time ()
  4570. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4571. (if (> (car org-time-stamp-rounding-minutes) 1)
  4572. (let ((r (car org-time-stamp-rounding-minutes))
  4573. (time (decode-time)))
  4574. (apply 'encode-time
  4575. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4576. (nthcdr 2 time))))
  4577. (current-time)))
  4578. (defun org-today ()
  4579. "Return today date, considering `org-extend-today-until'."
  4580. (time-to-days
  4581. (time-subtract (current-time)
  4582. (list 0 (* 3600 org-extend-today-until) 0))))
  4583. ;;;; Font-Lock stuff, including the activators
  4584. (defvar org-mouse-map (make-sparse-keymap))
  4585. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4586. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4587. (when org-mouse-1-follows-link
  4588. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4589. (when org-tab-follows-link
  4590. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4591. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4592. (require 'font-lock)
  4593. (defconst org-non-link-chars "]\t\n\r<>")
  4594. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4595. "shell" "elisp" "doi" "message"))
  4596. (defvar org-link-types-re nil
  4597. "Matches a link that has a url-like prefix like \"http:\"")
  4598. (defvar org-link-re-with-space nil
  4599. "Matches a link with spaces, optional angular brackets around it.")
  4600. (defvar org-link-re-with-space2 nil
  4601. "Matches a link with spaces, optional angular brackets around it.")
  4602. (defvar org-link-re-with-space3 nil
  4603. "Matches a link with spaces, only for internal part in bracket links.")
  4604. (defvar org-angle-link-re nil
  4605. "Matches link with angular brackets, spaces are allowed.")
  4606. (defvar org-plain-link-re nil
  4607. "Matches plain link, without spaces.")
  4608. (defvar org-bracket-link-regexp nil
  4609. "Matches a link in double brackets.")
  4610. (defvar org-bracket-link-analytic-regexp nil
  4611. "Regular expression used to analyze links.
  4612. Here is what the match groups contain after a match:
  4613. 1: http:
  4614. 2: http
  4615. 3: path
  4616. 4: [desc]
  4617. 5: desc")
  4618. (defvar org-bracket-link-analytic-regexp++ nil
  4619. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4620. (defvar org-any-link-re nil
  4621. "Regular expression matching any link.")
  4622. (defcustom org-match-sexp-depth 3
  4623. "Number of stacked braces for sub/superscript matching.
  4624. This has to be set before loading org.el to be effective."
  4625. :group 'org-export-translation ; ??????????????????????????/
  4626. :type 'integer)
  4627. (defun org-create-multibrace-regexp (left right n)
  4628. "Create a regular expression which will match a balanced sexp.
  4629. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4630. as single character strings.
  4631. The regexp returned will match the entire expression including the
  4632. delimiters. It will also define a single group which contains the
  4633. match except for the outermost delimiters. The maximum depth of
  4634. stacked delimiters is N. Escaping delimiters is not possible."
  4635. (let* ((nothing (concat "[^" left right "]*?"))
  4636. (or "\\|")
  4637. (re nothing)
  4638. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4639. (while (> n 1)
  4640. (setq n (1- n)
  4641. re (concat re or next)
  4642. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4643. (concat left "\\(" re "\\)" right)))
  4644. (defvar org-match-substring-regexp
  4645. (concat
  4646. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4647. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4648. "\\|"
  4649. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4650. "\\|"
  4651. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4652. "The regular expression matching a sub- or superscript.")
  4653. (defvar org-match-substring-with-braces-regexp
  4654. (concat
  4655. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4656. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4657. "\\)")
  4658. "The regular expression matching a sub- or superscript, forcing braces.")
  4659. (defun org-make-link-regexps ()
  4660. "Update the link regular expressions.
  4661. This should be called after the variable `org-link-types' has changed."
  4662. (setq org-link-types-re
  4663. (concat
  4664. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4665. org-link-re-with-space
  4666. (concat
  4667. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4668. "\\([^" org-non-link-chars " ]"
  4669. "[^" org-non-link-chars "]*"
  4670. "[^" org-non-link-chars " ]\\)>?")
  4671. org-link-re-with-space2
  4672. (concat
  4673. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4674. "\\([^" org-non-link-chars " ]"
  4675. "[^\t\n\r]*"
  4676. "[^" org-non-link-chars " ]\\)>?")
  4677. org-link-re-with-space3
  4678. (concat
  4679. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4680. "\\([^" org-non-link-chars " ]"
  4681. "[^\t\n\r]*\\)")
  4682. org-angle-link-re
  4683. (concat
  4684. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4685. "\\([^" org-non-link-chars " ]"
  4686. "[^" org-non-link-chars "]*"
  4687. "\\)>")
  4688. org-plain-link-re
  4689. (concat
  4690. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4691. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4692. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4693. org-bracket-link-regexp
  4694. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4695. org-bracket-link-analytic-regexp
  4696. (concat
  4697. "\\[\\["
  4698. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4699. "\\([^]]+\\)"
  4700. "\\]"
  4701. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4702. "\\]")
  4703. org-bracket-link-analytic-regexp++
  4704. (concat
  4705. "\\[\\["
  4706. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4707. "\\([^]]+\\)"
  4708. "\\]"
  4709. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4710. "\\]")
  4711. org-any-link-re
  4712. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4713. org-angle-link-re "\\)\\|\\("
  4714. org-plain-link-re "\\)")))
  4715. (org-make-link-regexps)
  4716. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  4717. "Regular expression for fast time stamp matching.")
  4718. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  4719. "Regular expression for fast time stamp matching.")
  4720. (defconst org-ts-regexp0
  4721. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4722. "Regular expression matching time strings for analysis.
  4723. This one does not require the space after the date, so it can be used
  4724. on a string that terminates immediately after the date.")
  4725. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4726. "Regular expression matching time strings for analysis.")
  4727. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4728. "Regular expression matching time stamps, with groups.")
  4729. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4730. "Regular expression matching time stamps (also [..]), with groups.")
  4731. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4732. "Regular expression matching a time stamp range.")
  4733. (defconst org-tr-regexp-both
  4734. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4735. "Regular expression matching a time stamp range.")
  4736. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4737. org-ts-regexp "\\)?")
  4738. "Regular expression matching a time stamp or time stamp range.")
  4739. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4740. org-ts-regexp-both "\\)?")
  4741. "Regular expression matching a time stamp or time stamp range.
  4742. The time stamps may be either active or inactive.")
  4743. (defvar org-emph-face nil)
  4744. (defun org-do-emphasis-faces (limit)
  4745. "Run through the buffer and add overlays to emphasized strings."
  4746. (let (rtn a)
  4747. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4748. (if (not (= (char-after (match-beginning 3))
  4749. (char-after (match-beginning 4))))
  4750. (progn
  4751. (setq rtn t)
  4752. (setq a (assoc (match-string 3) org-emphasis-alist))
  4753. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4754. 'face
  4755. (nth 1 a))
  4756. (and (nth 4 a)
  4757. (org-remove-flyspell-overlays-in
  4758. (match-beginning 0) (match-end 0)))
  4759. (add-text-properties (match-beginning 2) (match-end 2)
  4760. '(font-lock-multiline t org-emphasis t))
  4761. (when org-hide-emphasis-markers
  4762. (add-text-properties (match-end 4) (match-beginning 5)
  4763. '(invisible org-link))
  4764. (add-text-properties (match-beginning 3) (match-end 3)
  4765. '(invisible org-link)))))
  4766. (backward-char 1))
  4767. rtn))
  4768. (defun org-emphasize (&optional char)
  4769. "Insert or change an emphasis, i.e. a font like bold or italic.
  4770. If there is an active region, change that region to a new emphasis.
  4771. If there is no region, just insert the marker characters and position
  4772. the cursor between them.
  4773. CHAR should be either the marker character, or the first character of the
  4774. HTML tag associated with that emphasis. If CHAR is a space, the means
  4775. to remove the emphasis of the selected region.
  4776. If char is not given (for example in an interactive call) it
  4777. will be prompted for."
  4778. (interactive)
  4779. (let ((eal org-emphasis-alist) e det
  4780. (erc org-emphasis-regexp-components)
  4781. (prompt "")
  4782. (string "") beg end move tag c s)
  4783. (if (org-region-active-p)
  4784. (setq beg (region-beginning) end (region-end)
  4785. string (buffer-substring beg end))
  4786. (setq move t))
  4787. (while (setq e (pop eal))
  4788. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4789. c (aref tag 0))
  4790. (push (cons c (string-to-char (car e))) det)
  4791. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4792. (substring tag 1)))))
  4793. (setq det (nreverse det))
  4794. (unless char
  4795. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4796. (setq char (read-char-exclusive)))
  4797. (setq char (or (cdr (assoc char det)) char))
  4798. (if (equal char ?\ )
  4799. (setq s "" move nil)
  4800. (unless (assoc (char-to-string char) org-emphasis-alist)
  4801. (error "No such emphasis marker: \"%c\"" char))
  4802. (setq s (char-to-string char)))
  4803. (while (and (> (length string) 1)
  4804. (equal (substring string 0 1) (substring string -1))
  4805. (assoc (substring string 0 1) org-emphasis-alist))
  4806. (setq string (substring string 1 -1)))
  4807. (setq string (concat s string s))
  4808. (if beg (delete-region beg end))
  4809. (unless (or (bolp)
  4810. (string-match (concat "[" (nth 0 erc) "\n]")
  4811. (char-to-string (char-before (point)))))
  4812. (insert " "))
  4813. (unless (or (eobp)
  4814. (string-match (concat "[" (nth 1 erc) "\n]")
  4815. (char-to-string (char-after (point)))))
  4816. (insert " ") (backward-char 1))
  4817. (insert string)
  4818. (and move (backward-char 1))))
  4819. (defconst org-nonsticky-props
  4820. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4821. (defsubst org-rear-nonsticky-at (pos)
  4822. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4823. (defun org-activate-plain-links (limit)
  4824. "Run through the buffer and add overlays to links."
  4825. (catch 'exit
  4826. (let (f)
  4827. (if (and (re-search-forward (concat org-plain-link-re) limit t)
  4828. (or (not (member 'bracket org-activate-links))
  4829. (save-excursion
  4830. (save-match-data
  4831. (goto-char (match-beginning 0))
  4832. (not (looking-back "\\[\\["))))))
  4833. (progn
  4834. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4835. (setq f (get-text-property (match-beginning 0) 'face))
  4836. (if (or (eq f 'org-tag)
  4837. (and (listp f) (memq 'org-tag f)))
  4838. nil
  4839. (add-text-properties (match-beginning 0) (match-end 0)
  4840. (list 'mouse-face 'highlight
  4841. 'face 'org-link
  4842. 'keymap org-mouse-map))
  4843. (org-rear-nonsticky-at (match-end 0)))
  4844. t)))))
  4845. (defun org-activate-code (limit)
  4846. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  4847. (progn
  4848. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4849. (remove-text-properties (match-beginning 0) (match-end 0)
  4850. '(display t invisible t intangible t))
  4851. t)))
  4852. (defcustom org-src-fontify-natively nil
  4853. "When non-nil, fontify code in code blocks."
  4854. :type 'boolean
  4855. :version "24.1"
  4856. :group 'org-appearance
  4857. :group 'org-babel)
  4858. (defcustom org-allow-promoting-top-level-subtree nil
  4859. "When non-nil, allow promoting a top level subtree.
  4860. The leading star of the top level headline will be replaced
  4861. by a #."
  4862. :type 'boolean
  4863. :version "24.1"
  4864. :group 'org-appearance)
  4865. (defun org-fontify-meta-lines-and-blocks (limit)
  4866. (condition-case nil
  4867. (org-fontify-meta-lines-and-blocks-1 limit)
  4868. (error (message "org-mode fontification error"))))
  4869. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  4870. "Fontify #+ lines and blocks, in the correct ways."
  4871. (let ((case-fold-search t))
  4872. (if (re-search-forward
  4873. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  4874. limit t)
  4875. (let ((beg (match-beginning 0))
  4876. (block-start (match-end 0))
  4877. (block-end nil)
  4878. (lang (match-string 7))
  4879. (beg1 (line-beginning-position 2))
  4880. (dc1 (downcase (match-string 2)))
  4881. (dc3 (downcase (match-string 3)))
  4882. end end1 quoting block-type ovl)
  4883. (cond
  4884. ((member dc1 '("+html:" "+ascii:" "+latex:" "+docbook:"))
  4885. ;; a single line of backend-specific content
  4886. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4887. (remove-text-properties (match-beginning 0) (match-end 0)
  4888. '(display t invisible t intangible t))
  4889. (add-text-properties (match-beginning 1) (match-end 3)
  4890. '(font-lock-fontified t face org-meta-line))
  4891. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  4892. '(font-lock-fontified t face org-block))
  4893. ; for backend-specific code
  4894. t)
  4895. ((and (match-end 4) (equal dc3 "+begin"))
  4896. ;; Truly a block
  4897. (setq block-type (downcase (match-string 5))
  4898. quoting (member block-type org-protecting-blocks))
  4899. (when (re-search-forward
  4900. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4901. nil t) ;; on purpose, we look further than LIMIT
  4902. (setq end (min (point-max) (match-end 0))
  4903. end1 (min (point-max) (1- (match-beginning 0))))
  4904. (setq block-end (match-beginning 0))
  4905. (when quoting
  4906. (remove-text-properties beg end
  4907. '(display t invisible t intangible t)))
  4908. (add-text-properties
  4909. beg end
  4910. '(font-lock-fontified t font-lock-multiline t))
  4911. (add-text-properties beg beg1 '(face org-meta-line))
  4912. (add-text-properties end1 (min (point-max) (1+ end))
  4913. '(face org-meta-line)) ; for end_src
  4914. (cond
  4915. ((and lang (not (string= lang "")) org-src-fontify-natively)
  4916. (org-src-font-lock-fontify-block lang block-start block-end)
  4917. ;; remove old background overlays
  4918. (mapc (lambda (ov)
  4919. (if (eq (overlay-get ov 'face) 'org-block-background)
  4920. (delete-overlay ov)))
  4921. (overlays-at (/ (+ beg1 block-end) 2)))
  4922. ;; add a background overlay
  4923. (setq ovl (make-overlay beg1 block-end))
  4924. (overlay-put ovl 'face 'org-block-background)
  4925. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  4926. (quoting
  4927. (add-text-properties beg1 (min (point-max) (1+ end1))
  4928. '(face org-block))) ; end of source block
  4929. ((not org-fontify-quote-and-verse-blocks))
  4930. ((string= block-type "quote")
  4931. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  4932. ((string= block-type "verse")
  4933. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  4934. (add-text-properties beg beg1 '(face org-block-begin-line))
  4935. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  4936. '(face org-block-end-line))
  4937. t))
  4938. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  4939. (add-text-properties
  4940. beg (match-end 3)
  4941. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4942. '(font-lock-fontified t invisible t)
  4943. '(font-lock-fontified t face org-document-info-keyword)))
  4944. (add-text-properties
  4945. (match-beginning 6) (match-end 6)
  4946. (if (string-equal dc1 "+title:")
  4947. '(font-lock-fontified t face org-document-title)
  4948. '(font-lock-fontified t face org-document-info))))
  4949. ((or (equal dc1 "+results")
  4950. (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
  4951. "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
  4952. "+call:" "+header:" "+headers:" "+name:"))
  4953. (and (match-end 4) (equal dc3 "+attr")))
  4954. (add-text-properties
  4955. beg (match-end 0)
  4956. '(font-lock-fontified t face org-meta-line))
  4957. t)
  4958. ((member dc3 '(" " ""))
  4959. (add-text-properties
  4960. beg (match-end 0)
  4961. '(font-lock-fontified t face font-lock-comment-face)))
  4962. ((not (member (char-after beg) '(?\ ?\t)))
  4963. ;; just any other in-buffer setting, but not indented
  4964. (add-text-properties
  4965. beg (match-end 0)
  4966. '(font-lock-fontified t face org-meta-line))
  4967. t)
  4968. (t nil))))))
  4969. (defun org-strip-protective-commas (beg end)
  4970. "Strip protective commas between BEG and END in the current buffer."
  4971. (interactive "r")
  4972. (save-excursion
  4973. (save-match-data
  4974. (goto-char beg)
  4975. (let ((front-line (save-excursion
  4976. (re-search-forward
  4977. "[^[:space:]]" end t)
  4978. (goto-char (match-beginning 0))
  4979. (current-column))))
  4980. (while (re-search-forward "^[ \t]*\\(,\\)\\([*]\\|#\\)" end t)
  4981. (goto-char (match-beginning 1))
  4982. (when (= (current-column) front-line)
  4983. (replace-match "" nil nil nil 1)))))))
  4984. (defun org-activate-angle-links (limit)
  4985. "Run through the buffer and add overlays to links."
  4986. (if (re-search-forward org-angle-link-re limit t)
  4987. (progn
  4988. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4989. (add-text-properties (match-beginning 0) (match-end 0)
  4990. (list 'mouse-face 'highlight
  4991. 'keymap org-mouse-map))
  4992. (org-rear-nonsticky-at (match-end 0))
  4993. t)))
  4994. (defun org-activate-footnote-links (limit)
  4995. "Run through the buffer and add overlays to footnotes."
  4996. (let ((fn (org-footnote-next-reference-or-definition limit)))
  4997. (when fn
  4998. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  4999. (org-remove-flyspell-overlays-in beg end)
  5000. (add-text-properties beg end
  5001. (list 'mouse-face 'highlight
  5002. 'keymap org-mouse-map
  5003. 'help-echo
  5004. (if (= (point-at-bol) beg)
  5005. "Footnote definition"
  5006. "Footnote reference")
  5007. 'font-lock-fontified t
  5008. 'font-lock-multiline t
  5009. 'face 'org-footnote))))))
  5010. (defun org-activate-bracket-links (limit)
  5011. "Run through the buffer and add overlays to bracketed links."
  5012. (if (re-search-forward org-bracket-link-regexp limit t)
  5013. (let* ((help (concat "LINK: "
  5014. (org-match-string-no-properties 1)))
  5015. ;; FIXME: above we should remove the escapes.
  5016. ;; but that requires another match, protecting match data,
  5017. ;; a lot of overhead for font-lock.
  5018. (ip (org-maybe-intangible
  5019. (list 'invisible 'org-link
  5020. 'keymap org-mouse-map 'mouse-face 'highlight
  5021. 'font-lock-multiline t 'help-echo help)))
  5022. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  5023. 'font-lock-multiline t 'help-echo help)))
  5024. ;; We need to remove the invisible property here. Table narrowing
  5025. ;; may have made some of this invisible.
  5026. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5027. (remove-text-properties (match-beginning 0) (match-end 0)
  5028. '(invisible nil))
  5029. (if (match-end 3)
  5030. (progn
  5031. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  5032. (org-rear-nonsticky-at (match-beginning 3))
  5033. (add-text-properties (match-beginning 3) (match-end 3) vp)
  5034. (org-rear-nonsticky-at (match-end 3))
  5035. (add-text-properties (match-end 3) (match-end 0) ip)
  5036. (org-rear-nonsticky-at (match-end 0)))
  5037. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  5038. (org-rear-nonsticky-at (match-beginning 1))
  5039. (add-text-properties (match-beginning 1) (match-end 1) vp)
  5040. (org-rear-nonsticky-at (match-end 1))
  5041. (add-text-properties (match-end 1) (match-end 0) ip)
  5042. (org-rear-nonsticky-at (match-end 0)))
  5043. t)))
  5044. (defun org-activate-dates (limit)
  5045. "Run through the buffer and add overlays to dates."
  5046. (if (re-search-forward org-tsr-regexp-both limit t)
  5047. (progn
  5048. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5049. (add-text-properties (match-beginning 0) (match-end 0)
  5050. (list 'mouse-face 'highlight
  5051. 'keymap org-mouse-map))
  5052. (org-rear-nonsticky-at (match-end 0))
  5053. (when org-display-custom-times
  5054. (if (match-end 3)
  5055. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5056. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5057. t)))
  5058. (defvar org-target-link-regexp nil
  5059. "Regular expression matching radio targets in plain text.")
  5060. (make-variable-buffer-local 'org-target-link-regexp)
  5061. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  5062. "Regular expression matching a link target.")
  5063. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  5064. "Regular expression matching a radio target.")
  5065. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  5066. "Regular expression matching any target.")
  5067. (defun org-activate-target-links (limit)
  5068. "Run through the buffer and add overlays to target matches."
  5069. (when org-target-link-regexp
  5070. (let ((case-fold-search t))
  5071. (if (re-search-forward org-target-link-regexp limit t)
  5072. (progn
  5073. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5074. (add-text-properties (match-beginning 0) (match-end 0)
  5075. (list 'mouse-face 'highlight
  5076. 'keymap org-mouse-map
  5077. 'help-echo "Radio target link"
  5078. 'org-linked-text t))
  5079. (org-rear-nonsticky-at (match-end 0))
  5080. t)))))
  5081. (defun org-update-radio-target-regexp ()
  5082. "Find all radio targets in this file and update the regular expression."
  5083. (interactive)
  5084. (when (memq 'radio org-activate-links)
  5085. (setq org-target-link-regexp
  5086. (org-make-target-link-regexp (org-all-targets 'radio)))
  5087. (org-restart-font-lock)))
  5088. (defun org-hide-wide-columns (limit)
  5089. (let (s e)
  5090. (setq s (text-property-any (point) (or limit (point-max))
  5091. 'org-cwidth t))
  5092. (when s
  5093. (setq e (next-single-property-change s 'org-cwidth))
  5094. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5095. (goto-char e)
  5096. t)))
  5097. (defvar org-latex-and-specials-regexp nil
  5098. "Regular expression for highlighting export special stuff.")
  5099. (defvar org-match-substring-regexp)
  5100. (defvar org-match-substring-with-braces-regexp)
  5101. ;; This should be with the exporter code, but we also use if for font-locking
  5102. (defconst org-export-html-special-string-regexps
  5103. '(("\\\\-" . "&shy;")
  5104. ("---\\([^-]\\)" . "&mdash;\\1")
  5105. ("--\\([^-]\\)" . "&ndash;\\1")
  5106. ("\\.\\.\\." . "&hellip;"))
  5107. "Regular expressions for special string conversion.")
  5108. (defun org-compute-latex-and-specials-regexp ()
  5109. "Compute regular expression for stuff treated specially by exporters."
  5110. (if (not org-highlight-latex-fragments-and-specials)
  5111. (org-set-local 'org-latex-and-specials-regexp nil)
  5112. (require 'org-exp)
  5113. (let*
  5114. ((matchers (plist-get org-format-latex-options :matchers))
  5115. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  5116. org-latex-regexps)))
  5117. (org-export-allow-BIND nil)
  5118. (options (org-combine-plists (org-default-export-plist)
  5119. (org-infile-export-plist)))
  5120. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  5121. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  5122. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  5123. (org-export-html-expand (plist-get options :expand-quoted-html))
  5124. (org-export-with-special-strings (plist-get options :special-strings))
  5125. (re-sub
  5126. (cond
  5127. ((equal org-export-with-sub-superscripts '{})
  5128. (list org-match-substring-with-braces-regexp))
  5129. (org-export-with-sub-superscripts
  5130. (list org-match-substring-regexp))))
  5131. (re-latex
  5132. (if org-export-with-LaTeX-fragments
  5133. (mapcar (lambda (x) (nth 1 x)) latexs)))
  5134. (re-macros
  5135. (if org-export-with-TeX-macros
  5136. (list (concat "\\\\"
  5137. (regexp-opt
  5138. (append
  5139. (delq nil
  5140. (mapcar 'car-safe
  5141. (append org-entities-user
  5142. org-entities)))
  5143. (if (boundp 'org-latex-entities)
  5144. (mapcar (lambda (x)
  5145. (or (car-safe x) x))
  5146. org-latex-entities)
  5147. nil))
  5148. 'words))) ; FIXME
  5149. ))
  5150. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  5151. (re-special (if org-export-with-special-strings
  5152. (mapcar (lambda (x) (car x))
  5153. org-export-html-special-string-regexps)))
  5154. (re-rest
  5155. (delq nil
  5156. (list
  5157. (if org-export-html-expand "@<[^>\n]+>")
  5158. ))))
  5159. (org-set-local
  5160. 'org-latex-and-specials-regexp
  5161. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  5162. re-rest) "\\|")))))
  5163. (defun org-do-latex-and-special-faces (limit)
  5164. "Run through the buffer and add overlays to links."
  5165. (when org-latex-and-specials-regexp
  5166. (let (rtn d)
  5167. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  5168. limit t))
  5169. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5170. 'face))
  5171. '(org-code org-verbatim underline)))
  5172. (progn
  5173. (setq rtn t
  5174. d (cond ((member (char-after (1+ (match-beginning 0)))
  5175. '(?_ ?^)) 1)
  5176. (t 0)))
  5177. (font-lock-prepend-text-property
  5178. (+ d (match-beginning 0)) (match-end 0)
  5179. 'face 'org-latex-and-export-specials)
  5180. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  5181. '(font-lock-multiline t)))))
  5182. rtn)))
  5183. (defun org-restart-font-lock ()
  5184. "Restart `font-lock-mode', to force refontification."
  5185. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5186. (font-lock-mode -1)
  5187. (font-lock-mode 1)))
  5188. (defun org-all-targets (&optional radio)
  5189. "Return a list of all targets in this file.
  5190. With optional argument RADIO, only find radio targets."
  5191. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  5192. rtn)
  5193. (save-excursion
  5194. (goto-char (point-min))
  5195. (while (re-search-forward re nil t)
  5196. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  5197. rtn)))
  5198. (defun org-make-target-link-regexp (targets)
  5199. "Make regular expression matching all strings in TARGETS.
  5200. The regular expression finds the targets also if there is a line break
  5201. between words."
  5202. (and targets
  5203. (concat
  5204. "\\<\\("
  5205. (mapconcat
  5206. (lambda (x)
  5207. (setq x (regexp-quote x))
  5208. (while (string-match " +" x)
  5209. (setq x (replace-match "\\s-+" t t x)))
  5210. x)
  5211. targets
  5212. "\\|")
  5213. "\\)\\>")))
  5214. (defun org-activate-tags (limit)
  5215. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5216. (progn
  5217. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5218. (add-text-properties (match-beginning 1) (match-end 1)
  5219. (list 'mouse-face 'highlight
  5220. 'keymap org-mouse-map))
  5221. (org-rear-nonsticky-at (match-end 1))
  5222. t)))
  5223. (defun org-outline-level ()
  5224. "Compute the outline level of the heading at point.
  5225. This function assumes that the cursor is at the beginning of a line matched
  5226. by `outline-regexp'. Otherwise it returns garbage.
  5227. If this is called at a normal headline, the level is the number of stars.
  5228. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5229. (save-excursion
  5230. (looking-at org-outline-regexp)
  5231. (1- (- (match-end 0) (match-beginning 0)))))
  5232. (defvar org-font-lock-keywords nil)
  5233. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  5234. "Regular expression matching a property line.")
  5235. (defvar org-font-lock-hook nil
  5236. "Functions to be called for special font lock stuff.")
  5237. (defvar org-font-lock-set-keywords-hook nil
  5238. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5239. This is called after `org-font-lock-extra-keywords' is defined, but before
  5240. it is installed to be used by font lock. This can be useful if something
  5241. needs to be inserted at a specific position in the font-lock sequence.")
  5242. (defun org-font-lock-hook (limit)
  5243. (run-hook-with-args 'org-font-lock-hook limit))
  5244. (defun org-set-font-lock-defaults ()
  5245. (let* ((em org-fontify-emphasized-text)
  5246. (lk org-activate-links)
  5247. (org-font-lock-extra-keywords
  5248. (list
  5249. ;; Call the hook
  5250. '(org-font-lock-hook)
  5251. ;; Headlines
  5252. `(,(if org-fontify-whole-heading-line
  5253. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5254. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5255. (1 (org-get-level-face 1))
  5256. (2 (org-get-level-face 2))
  5257. (3 (org-get-level-face 3)))
  5258. ;; Table lines
  5259. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5260. (1 'org-table t))
  5261. ;; Table internals
  5262. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5263. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5264. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5265. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5266. ;; Drawers
  5267. (list org-drawer-regexp '(0 'org-special-keyword t))
  5268. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5269. ;; Properties
  5270. (list org-property-re
  5271. '(1 'org-special-keyword t)
  5272. '(3 'org-property-value t))
  5273. ;; Links
  5274. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5275. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5276. (if (memq 'plain lk) '(org-activate-plain-links))
  5277. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5278. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5279. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5280. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5281. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5282. '(org-hide-wide-columns (0 nil append))
  5283. ;; TODO keyword
  5284. (list (format org-heading-keyword-regexp-format
  5285. org-todo-regexp)
  5286. '(2 (org-get-todo-face 2) t))
  5287. ;; DONE
  5288. (if org-fontify-done-headline
  5289. (list (format org-heading-keyword-regexp-format
  5290. (concat
  5291. "\\(?:"
  5292. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5293. "\\)"))
  5294. '(2 'org-headline-done t))
  5295. nil)
  5296. ;; Priorities
  5297. '(org-font-lock-add-priority-faces)
  5298. ;; Tags
  5299. '(org-font-lock-add-tag-faces)
  5300. ;; Special keywords
  5301. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5302. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5303. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5304. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5305. ;; Emphasis
  5306. (if em
  5307. (if (featurep 'xemacs)
  5308. '(org-do-emphasis-faces (0 nil append))
  5309. '(org-do-emphasis-faces)))
  5310. ;; Checkboxes
  5311. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5312. 1 'org-checkbox prepend)
  5313. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5314. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5315. (0 (org-get-checkbox-statistics-face) t)))
  5316. ;; Description list items
  5317. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5318. 1 'org-list-dt prepend)
  5319. ;; ARCHIVEd headings
  5320. (list (concat
  5321. org-outline-regexp-bol
  5322. "\\(.*:" org-archive-tag ":.*\\)")
  5323. '(1 'org-archived prepend))
  5324. ;; Specials
  5325. '(org-do-latex-and-special-faces)
  5326. '(org-fontify-entities)
  5327. '(org-raise-scripts)
  5328. ;; Code
  5329. '(org-activate-code (1 'org-code t))
  5330. ;; COMMENT
  5331. (list (format org-heading-keyword-regexp-format
  5332. (concat "\\("
  5333. org-comment-string "\\|" org-quote-string
  5334. "\\)"))
  5335. '(2 'org-special-keyword t))
  5336. ;; Blocks and meta lines
  5337. '(org-fontify-meta-lines-and-blocks)
  5338. )))
  5339. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5340. (run-hooks 'org-font-lock-set-keywords-hook)
  5341. ;; Now set the full font-lock-keywords
  5342. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5343. (org-set-local 'font-lock-defaults
  5344. '(org-font-lock-keywords t nil nil backward-paragraph))
  5345. (kill-local-variable 'font-lock-keywords) nil))
  5346. (defun org-toggle-pretty-entities ()
  5347. "Toggle the composition display of entities as UTF8 characters."
  5348. (interactive)
  5349. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5350. (org-restart-font-lock)
  5351. (if org-pretty-entities
  5352. (message "Entities are displayed as UTF8 characters")
  5353. (save-restriction
  5354. (widen)
  5355. (org-decompose-region (point-min) (point-max))
  5356. (message "Entities are displayed plain"))))
  5357. (defvar org-custom-properties-overlays nil
  5358. "List of overlays used for custom properties.")
  5359. (make-variable-buffer-local 'org-custom-properties-overlays)
  5360. (defun org-toggle-custom-properties-visibility ()
  5361. "Display or hide properties in `org-custom-properties'."
  5362. (interactive)
  5363. (if org-custom-properties-overlays
  5364. (progn (mapc 'delete-overlay org-custom-properties-overlays)
  5365. (setq org-custom-properties-overlays nil))
  5366. (unless (not org-custom-properties)
  5367. (save-excursion
  5368. (save-restriction
  5369. (widen)
  5370. (goto-char (point-min))
  5371. (while (re-search-forward org-property-re nil t)
  5372. (mapc (lambda(p)
  5373. (when (equal p (substring (match-string 1) 1 -1))
  5374. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5375. (overlay-put o 'invisible t)
  5376. (overlay-put o 'org-custom-property t)
  5377. (push o org-custom-properties-overlays))))
  5378. org-custom-properties)))))))
  5379. (defun org-fontify-entities (limit)
  5380. "Find an entity to fontify."
  5381. (let (ee)
  5382. (when org-pretty-entities
  5383. (catch 'match
  5384. (while (re-search-forward
  5385. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5386. limit t)
  5387. (if (and (not (org-in-indented-comment-line))
  5388. (setq ee (org-entity-get (match-string 1)))
  5389. (= (length (nth 6 ee)) 1))
  5390. (let*
  5391. ((end (if (equal (match-string 2) "{}")
  5392. (match-end 2)
  5393. (match-end 1))))
  5394. (add-text-properties
  5395. (match-beginning 0) end
  5396. (list 'font-lock-fontified t))
  5397. (compose-region (match-beginning 0) end
  5398. (nth 6 ee) nil)
  5399. (backward-char 1)
  5400. (throw 'match t))))
  5401. nil))))
  5402. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5403. "Fontify string S like in Org-mode."
  5404. (with-temp-buffer
  5405. (insert s)
  5406. (let ((org-odd-levels-only odd-levels))
  5407. (org-mode)
  5408. (font-lock-fontify-buffer)
  5409. (buffer-string))))
  5410. (defvar org-m nil)
  5411. (defvar org-l nil)
  5412. (defvar org-f nil)
  5413. (defun org-get-level-face (n)
  5414. "Get the right face for match N in font-lock matching of headlines."
  5415. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5416. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5417. (if org-cycle-level-faces
  5418. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5419. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5420. (cond
  5421. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5422. ((eq n 2) org-f)
  5423. (t (if org-level-color-stars-only nil org-f))))
  5424. (defun org-get-todo-face (kwd)
  5425. "Get the right face for a TODO keyword KWD.
  5426. If KWD is a number, get the corresponding match group."
  5427. (if (numberp kwd) (setq kwd (match-string kwd)))
  5428. (or (org-face-from-face-or-color
  5429. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5430. (and (member kwd org-done-keywords) 'org-done)
  5431. 'org-todo))
  5432. (defun org-face-from-face-or-color (context inherit face-or-color)
  5433. "Create a face list that inherits INHERIT, but sets the foreground color.
  5434. When FACE-OR-COLOR is not a string, just return it."
  5435. (if (stringp face-or-color)
  5436. (list :inherit inherit
  5437. (cdr (assoc context org-faces-easy-properties))
  5438. face-or-color)
  5439. face-or-color))
  5440. (defun org-font-lock-add-tag-faces (limit)
  5441. "Add the special tag faces."
  5442. (when (and org-tag-faces org-tags-special-faces-re)
  5443. (while (re-search-forward org-tags-special-faces-re limit t)
  5444. (add-text-properties (match-beginning 1) (match-end 1)
  5445. (list 'face (org-get-tag-face 1)
  5446. 'font-lock-fontified t))
  5447. (backward-char 1))))
  5448. (defun org-font-lock-add-priority-faces (limit)
  5449. "Add the special priority faces."
  5450. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5451. (when (save-match-data (org-at-heading-p))
  5452. (add-text-properties
  5453. (match-beginning 0) (match-end 0)
  5454. (list 'face (or (org-face-from-face-or-color
  5455. 'priority 'org-special-keyword
  5456. (cdr (assoc (char-after (match-beginning 1))
  5457. org-priority-faces)))
  5458. 'org-special-keyword)
  5459. 'font-lock-fontified t)))))
  5460. (defun org-get-tag-face (kwd)
  5461. "Get the right face for a TODO keyword KWD.
  5462. If KWD is a number, get the corresponding match group."
  5463. (if (numberp kwd) (setq kwd (match-string kwd)))
  5464. (or (org-face-from-face-or-color
  5465. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5466. 'org-tag))
  5467. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5468. "Remove fontification and activation overlays from links."
  5469. (font-lock-default-unfontify-region beg end)
  5470. (let* ((buffer-undo-list t)
  5471. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5472. (inhibit-modification-hooks t)
  5473. deactivate-mark buffer-file-name buffer-file-truename)
  5474. (org-decompose-region beg end)
  5475. (remove-text-properties beg end
  5476. '(mouse-face t keymap t org-linked-text t
  5477. invisible t intangible t
  5478. org-no-flyspell t org-emphasis t))
  5479. (org-remove-font-lock-display-properties beg end)))
  5480. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5481. ((raise 0.3) (height 0.7))
  5482. ((raise -0.5))
  5483. ((raise 0.5)))
  5484. "Display properties for showing superscripts and subscripts.")
  5485. (defun org-remove-font-lock-display-properties (beg end)
  5486. "Remove specific display properties that have been added by font lock.
  5487. The will remove the raise properties that are used to show superscripts
  5488. and subscripts."
  5489. (let (next prop)
  5490. (while (< beg end)
  5491. (setq next (next-single-property-change beg 'display nil end)
  5492. prop (get-text-property beg 'display))
  5493. (if (member prop org-script-display)
  5494. (put-text-property beg next 'display nil))
  5495. (setq beg next))))
  5496. (defun org-raise-scripts (limit)
  5497. "Add raise properties to sub/superscripts."
  5498. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5499. (if (re-search-forward
  5500. (if (eq org-use-sub-superscripts t)
  5501. org-match-substring-regexp
  5502. org-match-substring-with-braces-regexp)
  5503. limit t)
  5504. (let* ((pos (point)) table-p comment-p
  5505. (mpos (match-beginning 3))
  5506. (emph-p (get-text-property mpos 'org-emphasis))
  5507. (link-p (get-text-property mpos 'mouse-face))
  5508. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5509. (goto-char (point-at-bol))
  5510. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5511. comment-p (org-looking-at-p "[ \t]*#"))
  5512. (goto-char pos)
  5513. ;; FIXME: Should we go back one character here, for a_b^c
  5514. ;; (goto-char (1- pos)) ;????????????????????
  5515. (if (or comment-p emph-p link-p keyw-p)
  5516. t
  5517. (put-text-property (match-beginning 3) (match-end 0)
  5518. 'display
  5519. (if (equal (char-after (match-beginning 2)) ?^)
  5520. (nth (if table-p 3 1) org-script-display)
  5521. (nth (if table-p 2 0) org-script-display)))
  5522. (add-text-properties (match-beginning 2) (match-end 2)
  5523. (list 'invisible t
  5524. 'org-dwidth t 'org-dwidth-n 1))
  5525. (if (and (eq (char-after (match-beginning 3)) ?{)
  5526. (eq (char-before (match-end 3)) ?}))
  5527. (progn
  5528. (add-text-properties
  5529. (match-beginning 3) (1+ (match-beginning 3))
  5530. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5531. (add-text-properties
  5532. (1- (match-end 3)) (match-end 3)
  5533. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5534. t)))))
  5535. ;;;; Visibility cycling, including org-goto and indirect buffer
  5536. ;;; Cycling
  5537. (defvar org-cycle-global-status nil)
  5538. (make-variable-buffer-local 'org-cycle-global-status)
  5539. (defvar org-cycle-subtree-status nil)
  5540. (make-variable-buffer-local 'org-cycle-subtree-status)
  5541. ;;;###autoload
  5542. (defvar org-inlinetask-min-level)
  5543. (defun org-cycle (&optional arg)
  5544. "TAB-action and visibility cycling for Org-mode.
  5545. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5546. is outline visibility cycling, but it also invokes other actions
  5547. in special contexts.
  5548. - When this function is called with a prefix argument, rotate the entire
  5549. buffer through 3 states (global cycling)
  5550. 1. OVERVIEW: Show only top-level headlines.
  5551. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5552. 3. SHOW ALL: Show everything.
  5553. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5554. determined by the variable `org-startup-folded', and by any VISIBILITY
  5555. properties in the buffer.
  5556. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5557. including any drawers.
  5558. - When inside a table, re-align the table and move to the next field.
  5559. - When point is at the beginning of a headline, rotate the subtree started
  5560. by this line through 3 different states (local cycling)
  5561. 1. FOLDED: Only the main headline is shown.
  5562. 2. CHILDREN: The main headline and the direct children are shown.
  5563. From this state, you can move to one of the children
  5564. and zoom in further.
  5565. 3. SUBTREE: Show the entire subtree, including body text.
  5566. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5567. - When point is at the beginning of an empty headline and the variable
  5568. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5569. of the headline by demoting and promoting it to likely levels. This
  5570. speeds up creation document structure by pressing TAB once or several
  5571. times right after creating a new headline.
  5572. - When there is a numeric prefix, go up to a heading with level ARG, do
  5573. a `show-subtree' and return to the previous cursor position. If ARG
  5574. is negative, go up that many levels.
  5575. - When point is not at the beginning of a headline, execute the global
  5576. binding for TAB, which is re-indenting the line. See the option
  5577. `org-cycle-emulate-tab' for details.
  5578. - Special case: if point is at the beginning of the buffer and there is
  5579. no headline in line 1, this function will act as if called with prefix arg
  5580. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5581. But only if also the variable `org-cycle-global-at-bob' is t."
  5582. (interactive "P")
  5583. (org-load-modules-maybe)
  5584. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5585. (and org-cycle-level-after-item/entry-creation
  5586. (or (org-cycle-level)
  5587. (org-cycle-item-indentation))))
  5588. (let* ((limit-level
  5589. (or org-cycle-max-level
  5590. (and (boundp 'org-inlinetask-min-level)
  5591. org-inlinetask-min-level
  5592. (1- org-inlinetask-min-level))))
  5593. (nstars (and limit-level
  5594. (if org-odd-levels-only
  5595. (and limit-level (1- (* limit-level 2)))
  5596. limit-level)))
  5597. (org-outline-regexp
  5598. (if (not (derived-mode-p 'org-mode))
  5599. outline-regexp
  5600. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5601. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5602. (not (looking-at org-outline-regexp))))
  5603. (org-cycle-hook
  5604. (if bob-special
  5605. (delq 'org-optimize-window-after-visibility-change
  5606. (copy-sequence org-cycle-hook))
  5607. org-cycle-hook))
  5608. (pos (point)))
  5609. (if (or bob-special (equal arg '(4)))
  5610. ;; special case: use global cycling
  5611. (setq arg t))
  5612. (cond
  5613. ((equal arg '(16))
  5614. (setq last-command 'dummy)
  5615. (org-set-startup-visibility)
  5616. (message "Startup visibility, plus VISIBILITY properties"))
  5617. ((equal arg '(64))
  5618. (show-all)
  5619. (message "Entire buffer visible, including drawers"))
  5620. ;; Table: enter it or move to the next field.
  5621. ((org-at-table-p 'any)
  5622. (if (org-at-table.el-p)
  5623. (message "Use C-c ' to edit table.el tables")
  5624. (if arg (org-table-edit-field t)
  5625. (org-table-justify-field-maybe)
  5626. (call-interactively 'org-table-next-field))))
  5627. ((run-hook-with-args-until-success
  5628. 'org-tab-after-check-for-table-hook))
  5629. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5630. ((eq arg t) (org-cycle-internal-global))
  5631. ;; Drawers: delegate to `org-flag-drawer'.
  5632. ((and org-drawers org-drawer-regexp
  5633. (save-excursion
  5634. (beginning-of-line 1)
  5635. (looking-at org-drawer-regexp)))
  5636. (org-flag-drawer ; toggle block visibility
  5637. (not (get-char-property (match-end 0) 'invisible))))
  5638. ;; Show-subtree, ARG levels up from here.
  5639. ((integerp arg)
  5640. (save-excursion
  5641. (org-back-to-heading)
  5642. (outline-up-heading (if (< arg 0) (- arg)
  5643. (- (funcall outline-level) arg)))
  5644. (org-show-subtree)))
  5645. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5646. ((and (featurep 'org-inlinetask)
  5647. (org-inlinetask-at-task-p)
  5648. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5649. (org-inlinetask-toggle-visibility))
  5650. ((org-try-cdlatex-tab))
  5651. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5652. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5653. (save-excursion (beginning-of-line 1)
  5654. (looking-at org-outline-regexp)))
  5655. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5656. (org-cycle-internal-local))
  5657. ;; From there: TAB emulation and template completion.
  5658. (buffer-read-only (org-back-to-heading))
  5659. ((run-hook-with-args-until-success
  5660. 'org-tab-after-check-for-cycling-hook))
  5661. ((org-try-structure-completion))
  5662. ((run-hook-with-args-until-success
  5663. 'org-tab-before-tab-emulation-hook))
  5664. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5665. (or (not (bolp))
  5666. (not (looking-at org-outline-regexp))))
  5667. (call-interactively (global-key-binding "\t")))
  5668. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5669. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5670. (or (and (eq org-cycle-emulate-tab 'white)
  5671. (= (match-end 0) (point-at-eol)))
  5672. (and (eq org-cycle-emulate-tab 'whitestart)
  5673. (>= (match-end 0) pos))))
  5674. t
  5675. (eq org-cycle-emulate-tab t))
  5676. (call-interactively (global-key-binding "\t")))
  5677. (t (save-excursion
  5678. (org-back-to-heading)
  5679. (org-cycle)))))))
  5680. (defun org-cycle-internal-global ()
  5681. "Do the global cycling action."
  5682. ;; Hack to avoid display of messages for .org attachments in Gnus
  5683. (let ((ga (string-match "\\*fontification" (buffer-name))))
  5684. (cond
  5685. ((and (eq last-command this-command)
  5686. (eq org-cycle-global-status 'overview))
  5687. ;; We just created the overview - now do table of contents
  5688. ;; This can be slow in very large buffers, so indicate action
  5689. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5690. (unless ga (message "CONTENTS..."))
  5691. (org-content)
  5692. (unless ga (message "CONTENTS...done"))
  5693. (setq org-cycle-global-status 'contents)
  5694. (run-hook-with-args 'org-cycle-hook 'contents))
  5695. ((and (eq last-command this-command)
  5696. (eq org-cycle-global-status 'contents))
  5697. ;; We just showed the table of contents - now show everything
  5698. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5699. (show-all)
  5700. (unless ga (message "SHOW ALL"))
  5701. (setq org-cycle-global-status 'all)
  5702. (run-hook-with-args 'org-cycle-hook 'all))
  5703. (t
  5704. ;; Default action: go to overview
  5705. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5706. (org-overview)
  5707. (unless ga (message "OVERVIEW"))
  5708. (setq org-cycle-global-status 'overview)
  5709. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5710. (defun org-cycle-internal-local ()
  5711. "Do the local cycling action."
  5712. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5713. ;; First, determine end of headline (EOH), end of subtree or item
  5714. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5715. (save-excursion
  5716. (if (org-at-item-p)
  5717. (progn
  5718. (beginning-of-line)
  5719. (setq struct (org-list-struct))
  5720. (setq eoh (point-at-eol))
  5721. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5722. (setq has-children (org-list-has-child-p (point) struct)))
  5723. (org-back-to-heading)
  5724. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5725. (setq eos (save-excursion
  5726. (org-end-of-subtree t)
  5727. (unless (eobp)
  5728. (skip-chars-forward " \t\n"))
  5729. (if (eobp) (point) (1- (point)))))
  5730. (setq has-children
  5731. (or (save-excursion
  5732. (let ((level (funcall outline-level)))
  5733. (outline-next-heading)
  5734. (and (org-at-heading-p t)
  5735. (> (funcall outline-level) level))))
  5736. (save-excursion
  5737. (org-list-search-forward (org-item-beginning-re) eos t)))))
  5738. ;; Determine end invisible part of buffer (EOL)
  5739. (beginning-of-line 2)
  5740. ;; XEmacs doesn't have `next-single-char-property-change'
  5741. (if (featurep 'xemacs)
  5742. (while (and (not (eobp)) ;; this is like `next-line'
  5743. (get-char-property (1- (point)) 'invisible))
  5744. (beginning-of-line 2))
  5745. (while (and (not (eobp)) ;; this is like `next-line'
  5746. (get-char-property (1- (point)) 'invisible))
  5747. (goto-char (next-single-char-property-change (point) 'invisible))
  5748. (and (eolp) (beginning-of-line 2))))
  5749. (setq eol (point)))
  5750. ;; Find out what to do next and set `this-command'
  5751. (cond
  5752. ((= eos eoh)
  5753. ;; Nothing is hidden behind this heading
  5754. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5755. (message "EMPTY ENTRY")
  5756. (setq org-cycle-subtree-status nil)
  5757. (save-excursion
  5758. (goto-char eos)
  5759. (outline-next-heading)
  5760. (if (outline-invisible-p) (org-flag-heading nil))))
  5761. ((and (or (>= eol eos)
  5762. (not (string-match "\\S-" (buffer-substring eol eos))))
  5763. (or has-children
  5764. (not (setq children-skipped
  5765. org-cycle-skip-children-state-if-no-children))))
  5766. ;; Entire subtree is hidden in one line: children view
  5767. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5768. (if (org-at-item-p)
  5769. (org-list-set-item-visibility (point-at-bol) struct 'children)
  5770. (org-show-entry)
  5771. (org-with-limited-levels (show-children))
  5772. ;; FIXME: This slows down the func way too much.
  5773. ;; How keep drawers hidden in subtree anyway?
  5774. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  5775. ;; (org-cycle-hide-drawers 'subtree))
  5776. ;; Fold every list in subtree to top-level items.
  5777. (when (eq org-cycle-include-plain-lists 'integrate)
  5778. (save-excursion
  5779. (org-back-to-heading)
  5780. (while (org-list-search-forward (org-item-beginning-re) eos t)
  5781. (beginning-of-line 1)
  5782. (let* ((struct (org-list-struct))
  5783. (prevs (org-list-prevs-alist struct))
  5784. (end (org-list-get-bottom-point struct)))
  5785. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  5786. (org-list-get-all-items (point) struct prevs))
  5787. (goto-char end))))))
  5788. (message "CHILDREN")
  5789. (save-excursion
  5790. (goto-char eos)
  5791. (outline-next-heading)
  5792. (if (outline-invisible-p) (org-flag-heading nil)))
  5793. (setq org-cycle-subtree-status 'children)
  5794. (run-hook-with-args 'org-cycle-hook 'children))
  5795. ((or children-skipped
  5796. (and (eq last-command this-command)
  5797. (eq org-cycle-subtree-status 'children)))
  5798. ;; We just showed the children, or no children are there,
  5799. ;; now show everything.
  5800. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5801. (outline-flag-region eoh eos nil)
  5802. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5803. (setq org-cycle-subtree-status 'subtree)
  5804. (run-hook-with-args 'org-cycle-hook 'subtree))
  5805. (t
  5806. ;; Default action: hide the subtree.
  5807. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5808. (outline-flag-region eoh eos t)
  5809. (message "FOLDED")
  5810. (setq org-cycle-subtree-status 'folded)
  5811. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5812. ;;;###autoload
  5813. (defun org-global-cycle (&optional arg)
  5814. "Cycle the global visibility. For details see `org-cycle'.
  5815. With \\[universal-argument] prefix arg, switch to startup visibility.
  5816. With a numeric prefix, show all headlines up to that level."
  5817. (interactive "P")
  5818. (let ((org-cycle-include-plain-lists
  5819. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  5820. (cond
  5821. ((integerp arg)
  5822. (show-all)
  5823. (hide-sublevels arg)
  5824. (setq org-cycle-global-status 'contents))
  5825. ((equal arg '(4))
  5826. (org-set-startup-visibility)
  5827. (message "Startup visibility, plus VISIBILITY properties."))
  5828. (t
  5829. (org-cycle '(4))))))
  5830. (defun org-set-startup-visibility ()
  5831. "Set the visibility required by startup options and properties."
  5832. (cond
  5833. ((eq org-startup-folded t)
  5834. (org-cycle '(4)))
  5835. ((eq org-startup-folded 'content)
  5836. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5837. (org-cycle '(4)) (org-cycle '(4)))))
  5838. (unless (eq org-startup-folded 'showeverything)
  5839. (if org-hide-block-startup (org-hide-block-all))
  5840. (org-set-visibility-according-to-property 'no-cleanup)
  5841. (org-cycle-hide-archived-subtrees 'all)
  5842. (org-cycle-hide-drawers 'all)
  5843. (org-cycle-show-empty-lines t)))
  5844. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5845. "Switch subtree visibilities according to :VISIBILITY: property."
  5846. (interactive)
  5847. (let (org-show-entry-below state)
  5848. (save-excursion
  5849. (goto-char (point-min))
  5850. (while (re-search-forward
  5851. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5852. nil t)
  5853. (setq state (match-string 1))
  5854. (save-excursion
  5855. (org-back-to-heading t)
  5856. (hide-subtree)
  5857. (org-reveal)
  5858. (cond
  5859. ((equal state '("fold" "folded"))
  5860. (hide-subtree))
  5861. ((equal state "children")
  5862. (org-show-hidden-entry)
  5863. (show-children))
  5864. ((equal state "content")
  5865. (save-excursion
  5866. (save-restriction
  5867. (org-narrow-to-subtree)
  5868. (org-content))))
  5869. ((member state '("all" "showall"))
  5870. (show-subtree)))))
  5871. (unless no-cleanup
  5872. (org-cycle-hide-archived-subtrees 'all)
  5873. (org-cycle-hide-drawers 'all)
  5874. (org-cycle-show-empty-lines 'all)))))
  5875. ;; This function uses outline-regexp instead of the more fundamental
  5876. ;; org-outline-regexp so that org-cycle-global works outside of Org
  5877. ;; buffers, where outline-regexp is needed.
  5878. (defun org-overview ()
  5879. "Switch to overview mode, showing only top-level headlines.
  5880. Really, this shows all headlines with level equal or greater than the level
  5881. of the first headline in the buffer. This is important, because if the
  5882. first headline is not level one, then (hide-sublevels 1) gives confusing
  5883. results."
  5884. (interactive)
  5885. (let ((level (save-excursion
  5886. (goto-char (point-min))
  5887. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5888. (progn
  5889. (goto-char (match-beginning 0))
  5890. (funcall outline-level))))))
  5891. (and level (hide-sublevels level))))
  5892. (defun org-content (&optional arg)
  5893. "Show all headlines in the buffer, like a table of contents.
  5894. With numerical argument N, show content up to level N."
  5895. (interactive "P")
  5896. (save-excursion
  5897. ;; Visit all headings and show their offspring
  5898. (and (integerp arg) (org-overview))
  5899. (goto-char (point-max))
  5900. (catch 'exit
  5901. (while (and (progn (condition-case nil
  5902. (outline-previous-visible-heading 1)
  5903. (error (goto-char (point-min))))
  5904. t)
  5905. (looking-at org-outline-regexp))
  5906. (if (integerp arg)
  5907. (show-children (1- arg))
  5908. (show-branches))
  5909. (if (bobp) (throw 'exit nil))))))
  5910. (defun org-optimize-window-after-visibility-change (state)
  5911. "Adjust the window after a change in outline visibility.
  5912. This function is the default value of the hook `org-cycle-hook'."
  5913. (when (get-buffer-window (current-buffer))
  5914. (cond
  5915. ((eq state 'content) nil)
  5916. ((eq state 'all) nil)
  5917. ((eq state 'folded) nil)
  5918. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5919. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5920. (defun org-remove-empty-overlays-at (pos)
  5921. "Remove outline overlays that do not contain non-white stuff."
  5922. (mapc
  5923. (lambda (o)
  5924. (and (eq 'outline (overlay-get o 'invisible))
  5925. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5926. (overlay-end o))))
  5927. (delete-overlay o)))
  5928. (overlays-at pos)))
  5929. (defun org-clean-visibility-after-subtree-move ()
  5930. "Fix visibility issues after moving a subtree."
  5931. ;; First, find a reasonable region to look at:
  5932. ;; Start two siblings above, end three below
  5933. (let* ((beg (save-excursion
  5934. (and (org-get-last-sibling)
  5935. (org-get-last-sibling))
  5936. (point)))
  5937. (end (save-excursion
  5938. (and (org-get-next-sibling)
  5939. (org-get-next-sibling)
  5940. (org-get-next-sibling))
  5941. (if (org-at-heading-p)
  5942. (point-at-eol)
  5943. (point))))
  5944. (level (looking-at "\\*+"))
  5945. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5946. (save-excursion
  5947. (save-restriction
  5948. (narrow-to-region beg end)
  5949. (when re
  5950. ;; Properly fold already folded siblings
  5951. (goto-char (point-min))
  5952. (while (re-search-forward re nil t)
  5953. (if (and (not (outline-invisible-p))
  5954. (save-excursion
  5955. (goto-char (point-at-eol)) (outline-invisible-p)))
  5956. (hide-entry))))
  5957. (org-cycle-show-empty-lines 'overview)
  5958. (org-cycle-hide-drawers 'overview)))))
  5959. (defun org-cycle-show-empty-lines (state)
  5960. "Show empty lines above all visible headlines.
  5961. The region to be covered depends on STATE when called through
  5962. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5963. entire buffer covered. Note that an empty line is only shown if there
  5964. are at least `org-cycle-separator-lines' empty lines before the headline."
  5965. (when (not (= org-cycle-separator-lines 0))
  5966. (save-excursion
  5967. (let* ((n (abs org-cycle-separator-lines))
  5968. (re (cond
  5969. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5970. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5971. (t (let ((ns (number-to-string (- n 2))))
  5972. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5973. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5974. beg end b e)
  5975. (cond
  5976. ((memq state '(overview contents t))
  5977. (setq beg (point-min) end (point-max)))
  5978. ((memq state '(children folded))
  5979. (setq beg (point) end (progn (org-end-of-subtree t t)
  5980. (beginning-of-line 2)
  5981. (point)))))
  5982. (when beg
  5983. (goto-char beg)
  5984. (while (re-search-forward re end t)
  5985. (unless (get-char-property (match-end 1) 'invisible)
  5986. (setq e (match-end 1))
  5987. (if (< org-cycle-separator-lines 0)
  5988. (setq b (save-excursion
  5989. (goto-char (match-beginning 0))
  5990. (org-back-over-empty-lines)
  5991. (if (save-excursion
  5992. (goto-char (max (point-min) (1- (point))))
  5993. (org-at-heading-p))
  5994. (1- (point))
  5995. (point))))
  5996. (setq b (match-beginning 1)))
  5997. (outline-flag-region b e nil)))))))
  5998. ;; Never hide empty lines at the end of the file.
  5999. (save-excursion
  6000. (goto-char (point-max))
  6001. (outline-previous-heading)
  6002. (outline-end-of-heading)
  6003. (if (and (looking-at "[ \t\n]+")
  6004. (= (match-end 0) (point-max)))
  6005. (outline-flag-region (point) (match-end 0) nil))))
  6006. (defun org-show-empty-lines-in-parent ()
  6007. "Move to the parent and re-show empty lines before visible headlines."
  6008. (save-excursion
  6009. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  6010. (org-cycle-show-empty-lines context))))
  6011. (defun org-files-list ()
  6012. "Return `org-agenda-files' list, plus all open org-mode files.
  6013. This is useful for operations that need to scan all of a user's
  6014. open and agenda-wise Org files."
  6015. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  6016. (dolist (buf (buffer-list))
  6017. (with-current-buffer buf
  6018. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  6019. (let ((file (expand-file-name (buffer-file-name))))
  6020. (unless (member file files)
  6021. (push file files))))))
  6022. files))
  6023. (defsubst org-entry-beginning-position ()
  6024. "Return the beginning position of the current entry."
  6025. (save-excursion (outline-back-to-heading t) (point)))
  6026. (defsubst org-entry-end-position ()
  6027. "Return the end position of the current entry."
  6028. (save-excursion (outline-next-heading) (point)))
  6029. (defun org-cycle-hide-drawers (state)
  6030. "Re-hide all drawers after a visibility state change."
  6031. (when (and (derived-mode-p 'org-mode)
  6032. (not (memq state '(overview folded contents))))
  6033. (save-excursion
  6034. (let* ((globalp (memq state '(contents all)))
  6035. (beg (if globalp (point-min) (point)))
  6036. (end (if globalp (point-max)
  6037. (if (eq state 'children)
  6038. (save-excursion (outline-next-heading) (point))
  6039. (org-end-of-subtree t)))))
  6040. (goto-char beg)
  6041. (while (re-search-forward org-drawer-regexp end t)
  6042. (org-flag-drawer t))))))
  6043. (defun org-flag-drawer (flag)
  6044. "When FLAG is non-nil, hide the drawer we are within.
  6045. Otherwise make it visible."
  6046. (save-excursion
  6047. (beginning-of-line 1)
  6048. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  6049. (let ((b (match-end 0)))
  6050. (if (re-search-forward
  6051. "^[ \t]*:END:"
  6052. (save-excursion (outline-next-heading) (point)) t)
  6053. (outline-flag-region b (point-at-eol) flag)
  6054. (error ":END: line missing at position %s" b))))))
  6055. (defun org-subtree-end-visible-p ()
  6056. "Is the end of the current subtree visible?"
  6057. (pos-visible-in-window-p
  6058. (save-excursion (org-end-of-subtree t) (point))))
  6059. (defun org-first-headline-recenter (&optional N)
  6060. "Move cursor to the first headline and recenter the headline.
  6061. Optional argument N means put the headline into the Nth line of the window."
  6062. (goto-char (point-min))
  6063. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6064. (beginning-of-line)
  6065. (recenter (prefix-numeric-value N))))
  6066. ;;; Saving and restoring visibility
  6067. (defun org-outline-overlay-data (&optional use-markers)
  6068. "Return a list of the locations of all outline overlays.
  6069. These are overlays with the `invisible' property value `outline'.
  6070. The return value is a list of cons cells, with start and stop
  6071. positions for each overlay.
  6072. If USE-MARKERS is set, return the positions as markers."
  6073. (let (beg end)
  6074. (save-excursion
  6075. (save-restriction
  6076. (widen)
  6077. (delq nil
  6078. (mapcar (lambda (o)
  6079. (when (eq (overlay-get o 'invisible) 'outline)
  6080. (setq beg (overlay-start o)
  6081. end (overlay-end o))
  6082. (and beg end (> end beg)
  6083. (if use-markers
  6084. (cons (move-marker (make-marker) beg)
  6085. (move-marker (make-marker) end))
  6086. (cons beg end)))))
  6087. (overlays-in (point-min) (point-max))))))))
  6088. (defun org-set-outline-overlay-data (data)
  6089. "Create visibility overlays for all positions in DATA.
  6090. DATA should have been made by `org-outline-overlay-data'."
  6091. (let (o)
  6092. (save-excursion
  6093. (save-restriction
  6094. (widen)
  6095. (show-all)
  6096. (mapc (lambda (c)
  6097. (outline-flag-region (car c) (cdr c) t))
  6098. data)))))
  6099. ;;; Folding of blocks
  6100. (defvar org-hide-block-overlays nil
  6101. "Overlays hiding blocks.")
  6102. (make-variable-buffer-local 'org-hide-block-overlays)
  6103. (defun org-block-map (function &optional start end)
  6104. "Call FUNCTION at the head of all source blocks in the current buffer.
  6105. Optional arguments START and END can be used to limit the range."
  6106. (let ((start (or start (point-min)))
  6107. (end (or end (point-max))))
  6108. (save-excursion
  6109. (goto-char start)
  6110. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6111. (save-excursion
  6112. (save-match-data
  6113. (goto-char (match-beginning 0))
  6114. (funcall function)))))))
  6115. (defun org-hide-block-toggle-all ()
  6116. "Toggle the visibility of all blocks in the current buffer."
  6117. (org-block-map #'org-hide-block-toggle))
  6118. (defun org-hide-block-all ()
  6119. "Fold all blocks in the current buffer."
  6120. (interactive)
  6121. (org-show-block-all)
  6122. (org-block-map #'org-hide-block-toggle-maybe))
  6123. (defun org-show-block-all ()
  6124. "Unfold all blocks in the current buffer."
  6125. (interactive)
  6126. (mapc 'delete-overlay org-hide-block-overlays)
  6127. (setq org-hide-block-overlays nil))
  6128. (defun org-hide-block-toggle-maybe ()
  6129. "Toggle visibility of block at point."
  6130. (interactive)
  6131. (let ((case-fold-search t))
  6132. (if (save-excursion
  6133. (beginning-of-line 1)
  6134. (looking-at org-block-regexp))
  6135. (progn (org-hide-block-toggle)
  6136. t) ;; to signal that we took action
  6137. nil))) ;; to signal that we did not
  6138. (defun org-hide-block-toggle (&optional force)
  6139. "Toggle the visibility of the current block."
  6140. (interactive)
  6141. (save-excursion
  6142. (beginning-of-line)
  6143. (if (re-search-forward org-block-regexp nil t)
  6144. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6145. (end (match-end 0)) ;; end of entire body
  6146. ov)
  6147. (if (memq t (mapcar (lambda (overlay)
  6148. (eq (overlay-get overlay 'invisible)
  6149. 'org-hide-block))
  6150. (overlays-at start)))
  6151. (if (or (not force) (eq force 'off))
  6152. (mapc (lambda (ov)
  6153. (when (member ov org-hide-block-overlays)
  6154. (setq org-hide-block-overlays
  6155. (delq ov org-hide-block-overlays)))
  6156. (when (eq (overlay-get ov 'invisible)
  6157. 'org-hide-block)
  6158. (delete-overlay ov)))
  6159. (overlays-at start)))
  6160. (setq ov (make-overlay start end))
  6161. (overlay-put ov 'invisible 'org-hide-block)
  6162. ;; make the block accessible to isearch
  6163. (overlay-put
  6164. ov 'isearch-open-invisible
  6165. (lambda (ov)
  6166. (when (member ov org-hide-block-overlays)
  6167. (setq org-hide-block-overlays
  6168. (delq ov org-hide-block-overlays)))
  6169. (when (eq (overlay-get ov 'invisible)
  6170. 'org-hide-block)
  6171. (delete-overlay ov))))
  6172. (push ov org-hide-block-overlays)))
  6173. (error "Not looking at a source block"))))
  6174. ;; org-tab-after-check-for-cycling-hook
  6175. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6176. ;; Remove overlays when changing major mode
  6177. (add-hook 'org-mode-hook
  6178. (lambda () (org-add-hook 'change-major-mode-hook
  6179. 'org-show-block-all 'append 'local)))
  6180. ;;; Org-goto
  6181. (defvar org-goto-window-configuration nil)
  6182. (defvar org-goto-marker nil)
  6183. (defvar org-goto-map
  6184. (let ((map (make-sparse-keymap)))
  6185. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  6186. (while (setq cmd (pop cmds))
  6187. (substitute-key-definition cmd cmd map global-map)))
  6188. (suppress-keymap map)
  6189. (org-defkey map "\C-m" 'org-goto-ret)
  6190. (org-defkey map [(return)] 'org-goto-ret)
  6191. (org-defkey map [(left)] 'org-goto-left)
  6192. (org-defkey map [(right)] 'org-goto-right)
  6193. (org-defkey map [(control ?g)] 'org-goto-quit)
  6194. (org-defkey map "\C-i" 'org-cycle)
  6195. (org-defkey map [(tab)] 'org-cycle)
  6196. (org-defkey map [(down)] 'outline-next-visible-heading)
  6197. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6198. (if org-goto-auto-isearch
  6199. (if (fboundp 'define-key-after)
  6200. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6201. nil)
  6202. (org-defkey map "q" 'org-goto-quit)
  6203. (org-defkey map "n" 'outline-next-visible-heading)
  6204. (org-defkey map "p" 'outline-previous-visible-heading)
  6205. (org-defkey map "f" 'outline-forward-same-level)
  6206. (org-defkey map "b" 'outline-backward-same-level)
  6207. (org-defkey map "u" 'outline-up-heading))
  6208. (org-defkey map "/" 'org-occur)
  6209. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6210. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6211. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6212. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6213. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6214. map))
  6215. (defconst org-goto-help
  6216. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  6217. RET=jump to location [Q]uit and return to previous location
  6218. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6219. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6220. ;; FIXME: Docstring does not mention both interfaces
  6221. (defun org-goto (&optional alternative-interface)
  6222. "Look up a different location in the current file, keeping current visibility.
  6223. When you want look-up or go to a different location in a
  6224. document, the fastest way is often to fold the entire buffer and
  6225. then dive into the tree. This method has the disadvantage, that
  6226. the previous location will be folded, which may not be what you
  6227. want.
  6228. This command works around this by showing a copy of the current
  6229. buffer in an indirect buffer, in overview mode. You can dive
  6230. into the tree in that copy, use org-occur and incremental search
  6231. to find a location. When pressing RET or `Q', the command
  6232. returns to the original buffer in which the visibility is still
  6233. unchanged. After RET it will also jump to the location selected
  6234. in the indirect buffer and expose the headline hierarchy above.
  6235. With a prefix argument, use the alternative interface: e.g. if
  6236. `org-goto-interface' is 'outline use 'outline-path-completion."
  6237. (interactive "P")
  6238. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6239. (org-refile-use-outline-path t)
  6240. (org-refile-target-verify-function nil)
  6241. (interface
  6242. (if (not alternative-interface)
  6243. org-goto-interface
  6244. (if (eq org-goto-interface 'outline)
  6245. 'outline-path-completion
  6246. 'outline)))
  6247. (org-goto-start-pos (point))
  6248. (selected-point
  6249. (if (eq interface 'outline)
  6250. (car (org-get-location (current-buffer) org-goto-help))
  6251. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6252. (org-refile-check-position pa)
  6253. (nth 3 pa)))))
  6254. (if selected-point
  6255. (progn
  6256. (org-mark-ring-push org-goto-start-pos)
  6257. (goto-char selected-point)
  6258. (if (or (outline-invisible-p) (org-invisible-p2))
  6259. (org-show-context 'org-goto)))
  6260. (message "Quit"))))
  6261. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6262. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6263. (defvar org-goto-local-auto-isearch-map) ; defined below
  6264. (defun org-get-location (buf help)
  6265. "Let the user select a location in the Org-mode buffer BUF.
  6266. This function uses a recursive edit. It returns the selected position
  6267. or nil."
  6268. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6269. (isearch-hide-immediately nil)
  6270. (isearch-search-fun-function
  6271. (lambda () 'org-goto-local-search-headings))
  6272. (org-goto-selected-point org-goto-exit-command)
  6273. (pop-up-frames nil)
  6274. (special-display-buffer-names nil)
  6275. (special-display-regexps nil)
  6276. (special-display-function nil))
  6277. (save-excursion
  6278. (save-window-excursion
  6279. (delete-other-windows)
  6280. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6281. (org-pop-to-buffer-same-window
  6282. (condition-case nil
  6283. (make-indirect-buffer (current-buffer) "*org-goto*")
  6284. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6285. (with-output-to-temp-buffer "*Help*"
  6286. (princ help))
  6287. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  6288. (setq buffer-read-only nil)
  6289. (let ((org-startup-truncated t)
  6290. (org-startup-folded nil)
  6291. (org-startup-align-all-tables nil))
  6292. (org-mode)
  6293. (org-overview))
  6294. (setq buffer-read-only t)
  6295. (if (and (boundp 'org-goto-start-pos)
  6296. (integer-or-marker-p org-goto-start-pos))
  6297. (let ((org-show-hierarchy-above t)
  6298. (org-show-siblings t)
  6299. (org-show-following-heading t))
  6300. (goto-char org-goto-start-pos)
  6301. (and (outline-invisible-p) (org-show-context)))
  6302. (goto-char (point-min)))
  6303. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6304. (message "Select location and press RET")
  6305. (use-local-map org-goto-map)
  6306. (recursive-edit)
  6307. ))
  6308. (kill-buffer "*org-goto*")
  6309. (cons org-goto-selected-point org-goto-exit-command)))
  6310. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6311. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6312. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6313. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6314. (defun org-goto-local-search-headings (string bound noerror)
  6315. "Search and make sure that any matches are in headlines."
  6316. (catch 'return
  6317. (while (if isearch-forward
  6318. (search-forward string bound noerror)
  6319. (search-backward string bound noerror))
  6320. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6321. (and (member :headline context)
  6322. (not (member :tags context))))
  6323. (throw 'return (point))))))
  6324. (defun org-goto-local-auto-isearch ()
  6325. "Start isearch."
  6326. (interactive)
  6327. (goto-char (point-min))
  6328. (let ((keys (this-command-keys)))
  6329. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6330. (isearch-mode t)
  6331. (isearch-process-search-char (string-to-char keys)))))
  6332. (defun org-goto-ret (&optional arg)
  6333. "Finish `org-goto' by going to the new location."
  6334. (interactive "P")
  6335. (setq org-goto-selected-point (point)
  6336. org-goto-exit-command 'return)
  6337. (throw 'exit nil))
  6338. (defun org-goto-left ()
  6339. "Finish `org-goto' by going to the new location."
  6340. (interactive)
  6341. (if (org-at-heading-p)
  6342. (progn
  6343. (beginning-of-line 1)
  6344. (setq org-goto-selected-point (point)
  6345. org-goto-exit-command 'left)
  6346. (throw 'exit nil))
  6347. (error "Not on a heading")))
  6348. (defun org-goto-right ()
  6349. "Finish `org-goto' by going to the new location."
  6350. (interactive)
  6351. (if (org-at-heading-p)
  6352. (progn
  6353. (setq org-goto-selected-point (point)
  6354. org-goto-exit-command 'right)
  6355. (throw 'exit nil))
  6356. (error "Not on a heading")))
  6357. (defun org-goto-quit ()
  6358. "Finish `org-goto' without cursor motion."
  6359. (interactive)
  6360. (setq org-goto-selected-point nil)
  6361. (setq org-goto-exit-command 'quit)
  6362. (throw 'exit nil))
  6363. ;;; Indirect buffer display of subtrees
  6364. (defvar org-indirect-dedicated-frame nil
  6365. "This is the frame being used for indirect tree display.")
  6366. (defvar org-last-indirect-buffer nil)
  6367. (defun org-tree-to-indirect-buffer (&optional arg)
  6368. "Create indirect buffer and narrow it to current subtree.
  6369. With numerical prefix ARG, go up to this level and then take that tree.
  6370. If ARG is negative, go up that many levels.
  6371. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6372. indirect buffer previously made with this command, to avoid proliferation of
  6373. indirect buffers. However, when you call the command with a \
  6374. \\[universal-argument] prefix, or
  6375. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6376. is kept so that you can work with several indirect buffers at the same time.
  6377. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6378. \\[universal-argument] prefix also
  6379. requests that a new frame be made for the new buffer, so that the dedicated
  6380. frame is not changed."
  6381. (interactive "P")
  6382. (let ((cbuf (current-buffer))
  6383. (cwin (selected-window))
  6384. (pos (point))
  6385. beg end level heading ibuf)
  6386. (save-excursion
  6387. (org-back-to-heading t)
  6388. (when (numberp arg)
  6389. (setq level (org-outline-level))
  6390. (if (< arg 0) (setq arg (+ level arg)))
  6391. (while (> (setq level (org-outline-level)) arg)
  6392. (outline-up-heading 1 t)))
  6393. (setq beg (point)
  6394. heading (org-get-heading))
  6395. (org-end-of-subtree t t)
  6396. (if (org-at-heading-p) (backward-char 1))
  6397. (setq end (point)))
  6398. (if (and (buffer-live-p org-last-indirect-buffer)
  6399. (not (eq org-indirect-buffer-display 'new-frame))
  6400. (not arg))
  6401. (kill-buffer org-last-indirect-buffer))
  6402. (setq ibuf (org-get-indirect-buffer cbuf)
  6403. org-last-indirect-buffer ibuf)
  6404. (cond
  6405. ((or (eq org-indirect-buffer-display 'new-frame)
  6406. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6407. (select-frame (make-frame))
  6408. (delete-other-windows)
  6409. (org-pop-to-buffer-same-window ibuf)
  6410. (org-set-frame-title heading))
  6411. ((eq org-indirect-buffer-display 'dedicated-frame)
  6412. (raise-frame
  6413. (select-frame (or (and org-indirect-dedicated-frame
  6414. (frame-live-p org-indirect-dedicated-frame)
  6415. org-indirect-dedicated-frame)
  6416. (setq org-indirect-dedicated-frame (make-frame)))))
  6417. (delete-other-windows)
  6418. (org-pop-to-buffer-same-window ibuf)
  6419. (org-set-frame-title (concat "Indirect: " heading)))
  6420. ((eq org-indirect-buffer-display 'current-window)
  6421. (org-pop-to-buffer-same-window ibuf))
  6422. ((eq org-indirect-buffer-display 'other-window)
  6423. (pop-to-buffer ibuf))
  6424. (t (error "Invalid value")))
  6425. (if (featurep 'xemacs)
  6426. (save-excursion (org-mode) (turn-on-font-lock)))
  6427. (narrow-to-region beg end)
  6428. (show-all)
  6429. (goto-char pos)
  6430. (run-hook-with-args 'org-cycle-hook 'all)
  6431. (and (window-live-p cwin) (select-window cwin))))
  6432. (defun org-get-indirect-buffer (&optional buffer)
  6433. (setq buffer (or buffer (current-buffer)))
  6434. (let ((n 1) (base (buffer-name buffer)) bname)
  6435. (while (buffer-live-p
  6436. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6437. (setq n (1+ n)))
  6438. (condition-case nil
  6439. (make-indirect-buffer buffer bname 'clone)
  6440. (error (make-indirect-buffer buffer bname)))))
  6441. (defun org-set-frame-title (title)
  6442. "Set the title of the current frame to the string TITLE."
  6443. ;; FIXME: how to name a single frame in XEmacs???
  6444. (unless (featurep 'xemacs)
  6445. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6446. ;;;; Structure editing
  6447. ;;; Inserting headlines
  6448. (defun org-previous-line-empty-p ()
  6449. (save-excursion
  6450. (and (not (bobp))
  6451. (or (beginning-of-line 0) t)
  6452. (save-match-data
  6453. (looking-at "[ \t]*$")))))
  6454. (defun org-insert-heading (&optional force-heading invisible-ok)
  6455. "Insert a new heading or item with same depth at point.
  6456. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  6457. If point is at the beginning of a headline, insert a sibling before the
  6458. current headline. If point is not at the beginning, split the line,
  6459. create the new headline with the text in the current line after point
  6460. \(but see also the variable `org-M-RET-may-split-line').
  6461. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6462. This is important for non-interactive uses of the command."
  6463. (interactive "P")
  6464. (if (or (= (buffer-size) 0)
  6465. (and (not (save-excursion
  6466. (and (ignore-errors (org-back-to-heading invisible-ok))
  6467. (org-at-heading-p))))
  6468. (or force-heading (not (org-in-item-p)))))
  6469. (progn
  6470. (insert "\n* ")
  6471. (run-hooks 'org-insert-heading-hook))
  6472. (when (or force-heading (not (org-insert-item)))
  6473. (let* ((empty-line-p nil)
  6474. (level nil)
  6475. (on-heading (org-at-heading-p))
  6476. (head (save-excursion
  6477. (condition-case nil
  6478. (progn
  6479. (org-back-to-heading invisible-ok)
  6480. (when (and (not on-heading)
  6481. (featurep 'org-inlinetask)
  6482. (integerp org-inlinetask-min-level)
  6483. (>= (length (match-string 0))
  6484. org-inlinetask-min-level))
  6485. ;; Find a heading level before the inline task
  6486. (while (and (setq level (org-up-heading-safe))
  6487. (>= level org-inlinetask-min-level)))
  6488. (if (org-at-heading-p)
  6489. (org-back-to-heading invisible-ok)
  6490. (error "This should not happen")))
  6491. (setq empty-line-p (org-previous-line-empty-p))
  6492. (match-string 0))
  6493. (error "*"))))
  6494. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6495. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6496. pos hide-previous previous-pos)
  6497. (cond
  6498. ((and (org-at-heading-p) (bolp)
  6499. (or (bobp)
  6500. (save-excursion (backward-char 1) (not (outline-invisible-p)))))
  6501. ;; insert before the current line
  6502. (open-line (if blank 2 1)))
  6503. ((and (bolp)
  6504. (not org-insert-heading-respect-content)
  6505. (or (bobp)
  6506. (save-excursion
  6507. (backward-char 1) (not (outline-invisible-p)))))
  6508. ;; insert right here
  6509. nil)
  6510. (t
  6511. ;; somewhere in the line
  6512. (save-excursion
  6513. (setq previous-pos (point-at-bol))
  6514. (end-of-line)
  6515. (setq hide-previous (outline-invisible-p)))
  6516. (and org-insert-heading-respect-content (org-show-subtree))
  6517. (let ((split
  6518. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  6519. (save-excursion
  6520. (let ((p (point)))
  6521. (goto-char (point-at-bol))
  6522. (and (looking-at org-complex-heading-regexp)
  6523. (match-beginning 4)
  6524. (> p (match-beginning 4)))))))
  6525. tags pos)
  6526. (cond
  6527. (org-insert-heading-respect-content
  6528. (org-end-of-subtree nil t)
  6529. (when (featurep 'org-inlinetask)
  6530. (while (and (not (eobp))
  6531. (looking-at "\\(\\*+\\)[ \t]+")
  6532. (>= (length (match-string 1))
  6533. org-inlinetask-min-level))
  6534. (org-end-of-subtree nil t)))
  6535. (or (bolp) (newline))
  6536. (or (org-previous-line-empty-p)
  6537. (and blank (newline)))
  6538. (open-line 1))
  6539. ((org-at-heading-p)
  6540. (when hide-previous
  6541. (show-children)
  6542. (org-show-entry))
  6543. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  6544. (setq tags (and (match-end 2) (match-string 2)))
  6545. (and (match-end 1)
  6546. (delete-region (match-beginning 1) (match-end 1)))
  6547. (setq pos (point-at-bol))
  6548. (or split (end-of-line 1))
  6549. (delete-horizontal-space)
  6550. (if (string-match "\\`\\*+\\'"
  6551. (buffer-substring (point-at-bol) (point)))
  6552. (insert " "))
  6553. (newline (if blank 2 1))
  6554. (when tags
  6555. (save-excursion
  6556. (goto-char pos)
  6557. (end-of-line 1)
  6558. (insert " " tags)
  6559. (org-set-tags nil 'align))))
  6560. (t
  6561. (or split (end-of-line 1))
  6562. (newline (if blank 2 1)))))))
  6563. (insert head) (just-one-space)
  6564. (setq pos (point))
  6565. (end-of-line 1)
  6566. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  6567. (when (and org-insert-heading-respect-content hide-previous)
  6568. (save-excursion
  6569. (goto-char previous-pos)
  6570. (hide-subtree)))
  6571. (run-hooks 'org-insert-heading-hook)))))
  6572. (defun org-get-heading (&optional no-tags no-todo)
  6573. "Return the heading of the current entry, without the stars.
  6574. When NO-TAGS is non-nil, don't include tags.
  6575. When NO-TODO is non-nil, don't include TODO keywords."
  6576. (save-excursion
  6577. (org-back-to-heading t)
  6578. (cond
  6579. ((and no-tags no-todo)
  6580. (looking-at org-complex-heading-regexp)
  6581. (match-string 4))
  6582. (no-tags
  6583. (looking-at (concat org-outline-regexp
  6584. "\\(.*?\\)"
  6585. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6586. (match-string 1))
  6587. (no-todo
  6588. (looking-at org-todo-line-regexp)
  6589. (match-string 3))
  6590. (t (looking-at org-heading-regexp)
  6591. (match-string 2)))))
  6592. (defun org-heading-components ()
  6593. "Return the components of the current heading.
  6594. This is a list with the following elements:
  6595. - the level as an integer
  6596. - the reduced level, different if `org-odd-levels-only' is set.
  6597. - the TODO keyword, or nil
  6598. - the priority character, like ?A, or nil if no priority is given
  6599. - the headline text itself, or the tags string if no headline text
  6600. - the tags string, or nil."
  6601. (save-excursion
  6602. (org-back-to-heading t)
  6603. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  6604. (list (length (match-string 1))
  6605. (org-reduced-level (length (match-string 1)))
  6606. (org-match-string-no-properties 2)
  6607. (and (match-end 3) (aref (match-string 3) 2))
  6608. (org-match-string-no-properties 4)
  6609. (org-match-string-no-properties 5)))))
  6610. (defun org-get-entry ()
  6611. "Get the entry text, after heading, entire subtree."
  6612. (save-excursion
  6613. (org-back-to-heading t)
  6614. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6615. (defun org-insert-heading-after-current ()
  6616. "Insert a new heading with same level as current, after current subtree."
  6617. (interactive)
  6618. (org-back-to-heading)
  6619. (org-insert-heading)
  6620. (org-move-subtree-down)
  6621. (end-of-line 1))
  6622. (defun org-insert-heading-respect-content ()
  6623. (interactive)
  6624. (let ((org-insert-heading-respect-content t))
  6625. (org-insert-heading t)))
  6626. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6627. (interactive "P")
  6628. (let ((org-insert-heading-respect-content t))
  6629. (org-insert-todo-heading force-state t)))
  6630. (defun org-insert-todo-heading (arg &optional force-heading)
  6631. "Insert a new heading with the same level and TODO state as current heading.
  6632. If the heading has no TODO state, or if the state is DONE, use the first
  6633. state (TODO by default). Also with prefix arg, force first state."
  6634. (interactive "P")
  6635. (when (or force-heading (not (org-insert-item 'checkbox)))
  6636. (org-insert-heading force-heading)
  6637. (save-excursion
  6638. (org-back-to-heading)
  6639. (outline-previous-heading)
  6640. (looking-at org-todo-line-regexp))
  6641. (let*
  6642. ((new-mark-x
  6643. (if (or arg
  6644. (not (match-beginning 2))
  6645. (member (match-string 2) org-done-keywords))
  6646. (car org-todo-keywords-1)
  6647. (match-string 2)))
  6648. (new-mark
  6649. (or
  6650. (run-hook-with-args-until-success
  6651. 'org-todo-get-default-hook new-mark-x nil)
  6652. new-mark-x)))
  6653. (beginning-of-line 1)
  6654. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6655. (if org-treat-insert-todo-heading-as-state-change
  6656. (org-todo new-mark)
  6657. (insert new-mark " "))))
  6658. (when org-provide-todo-statistics
  6659. (org-update-parent-todo-statistics))))
  6660. (defun org-insert-subheading (arg)
  6661. "Insert a new subheading and demote it.
  6662. Works for outline headings and for plain lists alike."
  6663. (interactive "P")
  6664. (org-insert-heading arg)
  6665. (cond
  6666. ((org-at-heading-p) (org-do-demote))
  6667. ((org-at-item-p) (org-indent-item))))
  6668. (defun org-insert-todo-subheading (arg)
  6669. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6670. Works for outline headings and for plain lists alike."
  6671. (interactive "P")
  6672. (org-insert-todo-heading arg)
  6673. (cond
  6674. ((org-at-heading-p) (org-do-demote))
  6675. ((org-at-item-p) (org-indent-item))))
  6676. ;;; Promotion and Demotion
  6677. (defvar org-after-demote-entry-hook nil
  6678. "Hook run after an entry has been demoted.
  6679. The cursor will be at the beginning of the entry.
  6680. When a subtree is being demoted, the hook will be called for each node.")
  6681. (defvar org-after-promote-entry-hook nil
  6682. "Hook run after an entry has been promoted.
  6683. The cursor will be at the beginning of the entry.
  6684. When a subtree is being promoted, the hook will be called for each node.")
  6685. (defun org-promote-subtree ()
  6686. "Promote the entire subtree.
  6687. See also `org-promote'."
  6688. (interactive)
  6689. (save-excursion
  6690. (org-with-limited-levels (org-map-tree 'org-promote)))
  6691. (org-fix-position-after-promote))
  6692. (defun org-demote-subtree ()
  6693. "Demote the entire subtree. See `org-demote'.
  6694. See also `org-promote'."
  6695. (interactive)
  6696. (save-excursion
  6697. (org-with-limited-levels (org-map-tree 'org-demote)))
  6698. (org-fix-position-after-promote))
  6699. (defun org-do-promote ()
  6700. "Promote the current heading higher up the tree.
  6701. If the region is active in `transient-mark-mode', promote all headings
  6702. in the region."
  6703. (interactive)
  6704. (save-excursion
  6705. (if (org-region-active-p)
  6706. (org-map-region 'org-promote (region-beginning) (region-end))
  6707. (org-promote)))
  6708. (org-fix-position-after-promote))
  6709. (defun org-do-demote ()
  6710. "Demote the current heading lower down the tree.
  6711. If the region is active in `transient-mark-mode', demote all headings
  6712. in the region."
  6713. (interactive)
  6714. (save-excursion
  6715. (if (org-region-active-p)
  6716. (org-map-region 'org-demote (region-beginning) (region-end))
  6717. (org-demote)))
  6718. (org-fix-position-after-promote))
  6719. (defun org-fix-position-after-promote ()
  6720. "Make sure that after pro/demotion cursor position is right."
  6721. (let ((pos (point)))
  6722. (when (save-excursion
  6723. (beginning-of-line 1)
  6724. (looking-at org-todo-line-regexp)
  6725. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6726. (cond ((eobp) (insert " "))
  6727. ((eolp) (insert " "))
  6728. ((equal (char-after) ?\ ) (forward-char 1))))))
  6729. (defun org-current-level ()
  6730. "Return the level of the current entry, or nil if before the first headline.
  6731. The level is the number of stars at the beginning of the headline."
  6732. (save-excursion
  6733. (org-with-limited-levels
  6734. (if (ignore-errors (org-back-to-heading t))
  6735. (funcall outline-level)))))
  6736. (defun org-get-previous-line-level ()
  6737. "Return the outline depth of the last headline before the current line.
  6738. Returns 0 for the first headline in the buffer, and nil if before the
  6739. first headline."
  6740. (let ((current-level (org-current-level))
  6741. (prev-level (when (> (line-number-at-pos) 1)
  6742. (save-excursion
  6743. (beginning-of-line 0)
  6744. (org-current-level)))))
  6745. (cond ((null current-level) nil) ; Before first headline
  6746. ((null prev-level) 0) ; At first headline
  6747. (prev-level))))
  6748. (defun org-reduced-level (l)
  6749. "Compute the effective level of a heading.
  6750. This takes into account the setting of `org-odd-levels-only'."
  6751. (cond
  6752. ((zerop l) 0)
  6753. (org-odd-levels-only (1+ (floor (/ l 2))))
  6754. (t l)))
  6755. (defun org-level-increment ()
  6756. "Return the number of stars that will be added or removed at a
  6757. time to headlines when structure editing, based on the value of
  6758. `org-odd-levels-only'."
  6759. (if org-odd-levels-only 2 1))
  6760. (defun org-get-valid-level (level &optional change)
  6761. "Rectify a level change under the influence of `org-odd-levels-only'
  6762. LEVEL is a current level, CHANGE is by how much the level should be
  6763. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6764. even level numbers will become the next higher odd number."
  6765. (if org-odd-levels-only
  6766. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6767. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6768. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6769. (max 1 (+ level (or change 0)))))
  6770. (if (boundp 'define-obsolete-function-alias)
  6771. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6772. (define-obsolete-function-alias 'org-get-legal-level
  6773. 'org-get-valid-level)
  6774. (define-obsolete-function-alias 'org-get-legal-level
  6775. 'org-get-valid-level "23.1")))
  6776. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  6777. ;; ̀org-with-limited-levels'
  6778. (defun org-promote ()
  6779. "Promote the current heading higher up the tree.
  6780. If the region is active in `transient-mark-mode', promote all headings
  6781. in the region."
  6782. (org-back-to-heading t)
  6783. (let* ((level (save-match-data (funcall outline-level)))
  6784. (after-change-functions (remove 'flyspell-after-change-function
  6785. after-change-functions))
  6786. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6787. (diff (abs (- level (length up-head) -1))))
  6788. (cond ((and (= level 1) org-called-with-limited-levels
  6789. org-allow-promoting-top-level-subtree)
  6790. (replace-match "# " nil t))
  6791. ((= level 1)
  6792. (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6793. (t (replace-match up-head nil t)))
  6794. ;; Fixup tag positioning
  6795. (unless (= level 1)
  6796. (and org-auto-align-tags (org-set-tags nil t))
  6797. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  6798. (run-hooks 'org-after-promote-entry-hook)))
  6799. (defun org-demote ()
  6800. "Demote the current heading lower down the tree.
  6801. If the region is active in `transient-mark-mode', demote all headings
  6802. in the region."
  6803. (org-back-to-heading t)
  6804. (let* ((level (save-match-data (funcall outline-level)))
  6805. (after-change-functions (remove 'flyspell-after-change-function
  6806. after-change-functions))
  6807. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6808. (diff (abs (- level (length down-head) -1))))
  6809. (replace-match down-head nil t)
  6810. ;; Fixup tag positioning
  6811. (and org-auto-align-tags (org-set-tags nil t))
  6812. (if org-adapt-indentation (org-fixup-indentation diff))
  6813. (run-hooks 'org-after-demote-entry-hook)))
  6814. (defun org-cycle-level ()
  6815. "Cycle the level of an empty headline through possible states.
  6816. This goes first to child, then to parent, level, then up the hierarchy.
  6817. After top level, it switches back to sibling level."
  6818. (interactive)
  6819. (let ((org-adapt-indentation nil))
  6820. (when (org-point-at-end-of-empty-headline)
  6821. (setq this-command 'org-cycle-level) ; Only needed for caching
  6822. (let ((cur-level (org-current-level))
  6823. (prev-level (org-get-previous-line-level)))
  6824. (cond
  6825. ;; If first headline in file, promote to top-level.
  6826. ((= prev-level 0)
  6827. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6828. do (org-do-promote)))
  6829. ;; If same level as prev, demote one.
  6830. ((= prev-level cur-level)
  6831. (org-do-demote))
  6832. ;; If parent is top-level, promote to top level if not already.
  6833. ((= prev-level 1)
  6834. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6835. do (org-do-promote)))
  6836. ;; If top-level, return to prev-level.
  6837. ((= cur-level 1)
  6838. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6839. do (org-do-demote)))
  6840. ;; If less than prev-level, promote one.
  6841. ((< cur-level prev-level)
  6842. (org-do-promote))
  6843. ;; If deeper than prev-level, promote until higher than
  6844. ;; prev-level.
  6845. ((> cur-level prev-level)
  6846. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6847. do (org-do-promote))))
  6848. t))))
  6849. (defun org-map-tree (fun)
  6850. "Call FUN for every heading underneath the current one."
  6851. (org-back-to-heading)
  6852. (let ((level (funcall outline-level)))
  6853. (save-excursion
  6854. (funcall fun)
  6855. (while (and (progn
  6856. (outline-next-heading)
  6857. (> (funcall outline-level) level))
  6858. (not (eobp)))
  6859. (funcall fun)))))
  6860. (defun org-map-region (fun beg end)
  6861. "Call FUN for every heading between BEG and END."
  6862. (let ((org-ignore-region t))
  6863. (save-excursion
  6864. (setq end (copy-marker end))
  6865. (goto-char beg)
  6866. (if (and (re-search-forward org-outline-regexp-bol nil t)
  6867. (< (point) end))
  6868. (funcall fun))
  6869. (while (and (progn
  6870. (outline-next-heading)
  6871. (< (point) end))
  6872. (not (eobp)))
  6873. (funcall fun)))))
  6874. (defvar org-property-end-re) ; silence byte-compiler
  6875. (defun org-fixup-indentation (diff)
  6876. "Change the indentation in the current entry by DIFF.
  6877. However, if any line in the current entry has no indentation, or if it
  6878. would end up with no indentation after the change, nothing at all is done."
  6879. (save-excursion
  6880. (let ((end (save-excursion (outline-next-heading)
  6881. (point-marker)))
  6882. (prohibit (if (> diff 0)
  6883. "^\\S-"
  6884. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6885. col)
  6886. (unless (save-excursion (end-of-line 1)
  6887. (re-search-forward prohibit end t))
  6888. (while (and (< (point) end)
  6889. (re-search-forward "^[ \t]+" end t))
  6890. (goto-char (match-end 0))
  6891. (setq col (current-column))
  6892. (if (< diff 0) (replace-match ""))
  6893. (org-indent-to-column (+ diff col))))
  6894. (move-marker end nil))))
  6895. (defun org-convert-to-odd-levels ()
  6896. "Convert an org-mode file with all levels allowed to one with odd levels.
  6897. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6898. level 5 etc."
  6899. (interactive)
  6900. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6901. (let ((outline-level 'org-outline-level)
  6902. (org-odd-levels-only nil) n)
  6903. (save-excursion
  6904. (goto-char (point-min))
  6905. (while (re-search-forward "^\\*\\*+ " nil t)
  6906. (setq n (- (length (match-string 0)) 2))
  6907. (while (>= (setq n (1- n)) 0)
  6908. (org-demote))
  6909. (end-of-line 1))))))
  6910. (defun org-convert-to-oddeven-levels ()
  6911. "Convert an org-mode file with only odd levels to one with odd/even levels.
  6912. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6913. file contains a section with an even level, conversion would
  6914. destroy the structure of the file. An error is signaled in this
  6915. case."
  6916. (interactive)
  6917. (goto-char (point-min))
  6918. ;; First check if there are no even levels
  6919. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6920. (org-show-context t)
  6921. (error "Not all levels are odd in this file. Conversion not possible"))
  6922. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6923. (let ((outline-regexp org-outline-regexp)
  6924. (outline-level 'org-outline-level)
  6925. (org-odd-levels-only nil) n)
  6926. (save-excursion
  6927. (goto-char (point-min))
  6928. (while (re-search-forward "^\\*\\*+ " nil t)
  6929. (setq n (/ (1- (length (match-string 0))) 2))
  6930. (while (>= (setq n (1- n)) 0)
  6931. (org-promote))
  6932. (end-of-line 1))))))
  6933. (defun org-tr-level (n)
  6934. "Make N odd if required."
  6935. (if org-odd-levels-only (1+ (/ n 2)) n))
  6936. ;;; Vertical tree motion, cutting and pasting of subtrees
  6937. (defun org-move-subtree-up (&optional arg)
  6938. "Move the current subtree up past ARG headlines of the same level."
  6939. (interactive "p")
  6940. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6941. (defun org-move-subtree-down (&optional arg)
  6942. "Move the current subtree down past ARG headlines of the same level."
  6943. (interactive "p")
  6944. (setq arg (prefix-numeric-value arg))
  6945. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6946. 'org-get-last-sibling))
  6947. (ins-point (make-marker))
  6948. (cnt (abs arg))
  6949. (col (current-column))
  6950. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6951. ;; Select the tree
  6952. (org-back-to-heading)
  6953. (setq beg0 (point))
  6954. (save-excursion
  6955. (setq ne-beg (org-back-over-empty-lines))
  6956. (setq beg (point)))
  6957. (save-match-data
  6958. (save-excursion (outline-end-of-heading)
  6959. (setq folded (outline-invisible-p)))
  6960. (outline-end-of-subtree))
  6961. (outline-next-heading)
  6962. (setq ne-end (org-back-over-empty-lines))
  6963. (setq end (point))
  6964. (goto-char beg0)
  6965. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6966. ;; include less whitespace
  6967. (save-excursion
  6968. (goto-char beg)
  6969. (forward-line (- ne-beg ne-end))
  6970. (setq beg (point))))
  6971. ;; Find insertion point, with error handling
  6972. (while (> cnt 0)
  6973. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  6974. (progn (goto-char beg0)
  6975. (error "Cannot move past superior level or buffer limit")))
  6976. (setq cnt (1- cnt)))
  6977. (if (> arg 0)
  6978. ;; Moving forward - still need to move over subtree
  6979. (progn (org-end-of-subtree t t)
  6980. (save-excursion
  6981. (org-back-over-empty-lines)
  6982. (or (bolp) (newline)))))
  6983. (setq ne-ins (org-back-over-empty-lines))
  6984. (move-marker ins-point (point))
  6985. (setq txt (buffer-substring beg end))
  6986. (org-save-markers-in-region beg end)
  6987. (delete-region beg end)
  6988. (org-remove-empty-overlays-at beg)
  6989. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6990. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6991. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6992. (let ((bbb (point)))
  6993. (insert-before-markers txt)
  6994. (org-reinstall-markers-in-region bbb)
  6995. (move-marker ins-point bbb))
  6996. (or (bolp) (insert "\n"))
  6997. (setq ins-end (point))
  6998. (goto-char ins-point)
  6999. (org-skip-whitespace)
  7000. (when (and (< arg 0)
  7001. (org-first-sibling-p)
  7002. (> ne-ins ne-beg))
  7003. ;; Move whitespace back to beginning
  7004. (save-excursion
  7005. (goto-char ins-end)
  7006. (let ((kill-whole-line t))
  7007. (kill-line (- ne-ins ne-beg)) (point)))
  7008. (insert (make-string (- ne-ins ne-beg) ?\n)))
  7009. (move-marker ins-point nil)
  7010. (if folded
  7011. (hide-subtree)
  7012. (org-show-entry)
  7013. (show-children)
  7014. (org-cycle-hide-drawers 'children))
  7015. (org-clean-visibility-after-subtree-move)
  7016. ;; move back to the initial column we were at
  7017. (move-to-column col)))
  7018. (defvar org-subtree-clip ""
  7019. "Clipboard for cut and paste of subtrees.
  7020. This is actually only a copy of the kill, because we use the normal kill
  7021. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  7022. (defvar org-subtree-clip-folded nil
  7023. "Was the last copied subtree folded?
  7024. This is used to fold the tree back after pasting.")
  7025. (defun org-cut-subtree (&optional n)
  7026. "Cut the current subtree into the clipboard.
  7027. With prefix arg N, cut this many sequential subtrees.
  7028. This is a short-hand for marking the subtree and then cutting it."
  7029. (interactive "p")
  7030. (org-copy-subtree n 'cut))
  7031. (defun org-copy-subtree (&optional n cut force-store-markers)
  7032. "Cut the current subtree into the clipboard.
  7033. With prefix arg N, cut this many sequential subtrees.
  7034. This is a short-hand for marking the subtree and then copying it.
  7035. If CUT is non-nil, actually cut the subtree.
  7036. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  7037. of some markers in the region, even if CUT is non-nil. This is
  7038. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  7039. (interactive "p")
  7040. (let (beg end folded (beg0 (point)))
  7041. (if (org-called-interactively-p 'any)
  7042. (org-back-to-heading nil) ; take what looks like a subtree
  7043. (org-back-to-heading t)) ; take what is really there
  7044. (org-back-over-empty-lines)
  7045. (setq beg (point))
  7046. (skip-chars-forward " \t\r\n")
  7047. (save-match-data
  7048. (save-excursion (outline-end-of-heading)
  7049. (setq folded (outline-invisible-p)))
  7050. (condition-case nil
  7051. (org-forward-heading-same-level (1- n) t)
  7052. (error nil))
  7053. (org-end-of-subtree t t))
  7054. (org-back-over-empty-lines)
  7055. (setq end (point))
  7056. (goto-char beg0)
  7057. (when (> end beg)
  7058. (setq org-subtree-clip-folded folded)
  7059. (when (or cut force-store-markers)
  7060. (org-save-markers-in-region beg end))
  7061. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7062. (setq org-subtree-clip (current-kill 0))
  7063. (message "%s: Subtree(s) with %d characters"
  7064. (if cut "Cut" "Copied")
  7065. (length org-subtree-clip)))))
  7066. (defun org-paste-subtree (&optional level tree for-yank)
  7067. "Paste the clipboard as a subtree, with modification of headline level.
  7068. The entire subtree is promoted or demoted in order to match a new headline
  7069. level.
  7070. If the cursor is at the beginning of a headline, the same level as
  7071. that headline is used to paste the tree
  7072. If not, the new level is derived from the *visible* headings
  7073. before and after the insertion point, and taken to be the inferior headline
  7074. level of the two. So if the previous visible heading is level 3 and the
  7075. next is level 4 (or vice versa), level 4 will be used for insertion.
  7076. This makes sure that the subtree remains an independent subtree and does
  7077. not swallow low level entries.
  7078. You can also force a different level, either by using a numeric prefix
  7079. argument, or by inserting the heading marker by hand. For example, if the
  7080. cursor is after \"*****\", then the tree will be shifted to level 5.
  7081. If optional TREE is given, use this text instead of the kill ring.
  7082. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7083. move back over whitespace before inserting, and move point to the end of
  7084. the inserted text when done."
  7085. (interactive "P")
  7086. (setq tree (or tree (and kill-ring (current-kill 0))))
  7087. (unless (org-kill-is-subtree-p tree)
  7088. (error "%s"
  7089. (substitute-command-keys
  7090. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7091. (org-with-limited-levels
  7092. (let* ((visp (not (outline-invisible-p)))
  7093. (txt tree)
  7094. (^re_ "\\(\\*+\\)[ \t]*")
  7095. (old-level (if (string-match org-outline-regexp-bol txt)
  7096. (- (match-end 0) (match-beginning 0) 1)
  7097. -1))
  7098. (force-level (cond (level (prefix-numeric-value level))
  7099. ((and (looking-at "[ \t]*$")
  7100. (string-match
  7101. "^\\*+$" (buffer-substring
  7102. (point-at-bol) (point))))
  7103. (- (match-end 1) (match-beginning 1)))
  7104. ((and (bolp)
  7105. (looking-at org-outline-regexp))
  7106. (- (match-end 0) (point) 1))))
  7107. (previous-level (save-excursion
  7108. (condition-case nil
  7109. (progn
  7110. (outline-previous-visible-heading 1)
  7111. (if (looking-at ^re_)
  7112. (- (match-end 0) (match-beginning 0) 1)
  7113. 1))
  7114. (error 1))))
  7115. (next-level (save-excursion
  7116. (condition-case nil
  7117. (progn
  7118. (or (looking-at org-outline-regexp)
  7119. (outline-next-visible-heading 1))
  7120. (if (looking-at ^re_)
  7121. (- (match-end 0) (match-beginning 0) 1)
  7122. 1))
  7123. (error 1))))
  7124. (new-level (or force-level (max previous-level next-level)))
  7125. (shift (if (or (= old-level -1)
  7126. (= new-level -1)
  7127. (= old-level new-level))
  7128. 0
  7129. (- new-level old-level)))
  7130. (delta (if (> shift 0) -1 1))
  7131. (func (if (> shift 0) 'org-demote 'org-promote))
  7132. (org-odd-levels-only nil)
  7133. beg end newend)
  7134. ;; Remove the forced level indicator
  7135. (if force-level
  7136. (delete-region (point-at-bol) (point)))
  7137. ;; Paste
  7138. (beginning-of-line (if (bolp) 1 2))
  7139. (unless for-yank (org-back-over-empty-lines))
  7140. (setq beg (point))
  7141. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7142. (insert-before-markers txt)
  7143. (unless (string-match "\n\\'" txt) (insert "\n"))
  7144. (setq newend (point))
  7145. (org-reinstall-markers-in-region beg)
  7146. (setq end (point))
  7147. (goto-char beg)
  7148. (skip-chars-forward " \t\n\r")
  7149. (setq beg (point))
  7150. (if (and (outline-invisible-p) visp)
  7151. (save-excursion (outline-show-heading)))
  7152. ;; Shift if necessary
  7153. (unless (= shift 0)
  7154. (save-restriction
  7155. (narrow-to-region beg end)
  7156. (while (not (= shift 0))
  7157. (org-map-region func (point-min) (point-max))
  7158. (setq shift (+ delta shift)))
  7159. (goto-char (point-min))
  7160. (setq newend (point-max))))
  7161. (when (or (org-called-interactively-p 'interactive) for-yank)
  7162. (message "Clipboard pasted as level %d subtree" new-level))
  7163. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7164. kill-ring
  7165. (eq org-subtree-clip (current-kill 0))
  7166. org-subtree-clip-folded)
  7167. ;; The tree was folded before it was killed/copied
  7168. (hide-subtree))
  7169. (and for-yank (goto-char newend)))))
  7170. (defun org-kill-is-subtree-p (&optional txt)
  7171. "Check if the current kill is an outline subtree, or a set of trees.
  7172. Returns nil if kill does not start with a headline, or if the first
  7173. headline level is not the largest headline level in the tree.
  7174. So this will actually accept several entries of equal levels as well,
  7175. which is OK for `org-paste-subtree'.
  7176. If optional TXT is given, check this string instead of the current kill."
  7177. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7178. (re (org-get-limited-outline-regexp))
  7179. (^re (concat "^" re))
  7180. (start-level (and kill
  7181. (string-match
  7182. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7183. kill)
  7184. (- (match-end 2) (match-beginning 2) 1)))
  7185. (start (1+ (or (match-beginning 2) -1))))
  7186. (if (not start-level)
  7187. (progn
  7188. nil) ;; does not even start with a heading
  7189. (catch 'exit
  7190. (while (setq start (string-match ^re kill (1+ start)))
  7191. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7192. (throw 'exit nil)))
  7193. t))))
  7194. (defvar org-markers-to-move nil
  7195. "Markers that should be moved with a cut-and-paste operation.
  7196. Those markers are stored together with their positions relative to
  7197. the start of the region.")
  7198. (defun org-save-markers-in-region (beg end)
  7199. "Check markers in region.
  7200. If these markers are between BEG and END, record their position relative
  7201. to BEG, so that after moving the block of text, we can put the markers back
  7202. into place.
  7203. This function gets called just before an entry or tree gets cut from the
  7204. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7205. called immediately, to move the markers with the entries."
  7206. (setq org-markers-to-move nil)
  7207. (when (featurep 'org-clock)
  7208. (org-clock-save-markers-for-cut-and-paste beg end))
  7209. (when (featurep 'org-agenda)
  7210. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7211. (defun org-check-and-save-marker (marker beg end)
  7212. "Check if MARKER is between BEG and END.
  7213. If yes, remember the marker and the distance to BEG."
  7214. (when (and (marker-buffer marker)
  7215. (equal (marker-buffer marker) (current-buffer)))
  7216. (if (and (>= marker beg) (< marker end))
  7217. (push (cons marker (- marker beg)) org-markers-to-move))))
  7218. (defun org-reinstall-markers-in-region (beg)
  7219. "Move all remembered markers to their position relative to BEG."
  7220. (mapc (lambda (x)
  7221. (move-marker (car x) (+ beg (cdr x))))
  7222. org-markers-to-move)
  7223. (setq org-markers-to-move nil))
  7224. (defun org-narrow-to-subtree ()
  7225. "Narrow buffer to the current subtree."
  7226. (interactive)
  7227. (save-excursion
  7228. (save-match-data
  7229. (org-with-limited-levels
  7230. (narrow-to-region
  7231. (progn (org-back-to-heading t) (point))
  7232. (progn (org-end-of-subtree t t)
  7233. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7234. (point)))))))
  7235. (defun org-narrow-to-block ()
  7236. "Narrow buffer to the current block."
  7237. (interactive)
  7238. (let* ((case-fold-search t)
  7239. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7240. "^[ \t]*#\\+end_.*")))
  7241. (if blockp
  7242. (narrow-to-region (car blockp) (cdr blockp))
  7243. (error "Not in a block"))))
  7244. (eval-when-compile
  7245. (defvar org-property-drawer-re))
  7246. (defvar org-property-start-re) ;; defined below
  7247. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7248. "Clone the task (subtree) at point N times.
  7249. The clones will be inserted as siblings.
  7250. In interactive use, the user will be prompted for the number of
  7251. clones to be produced, and for a time SHIFT, which may be a
  7252. repeater as used in time stamps, for example `+3d'.
  7253. When a valid repeater is given and the entry contains any time
  7254. stamps, the clones will become a sequence in time, with time
  7255. stamps in the subtree shifted for each clone produced. If SHIFT
  7256. is nil or the empty string, time stamps will be left alone. The
  7257. ID property of the original subtree is removed.
  7258. If the original subtree did contain time stamps with a repeater,
  7259. the following will happen:
  7260. - the repeater will be removed in each clone
  7261. - an additional clone will be produced, with the current, unshifted
  7262. date(s) in the entry.
  7263. - the original entry will be placed *after* all the clones, with
  7264. repeater intact.
  7265. - the start days in the repeater in the original entry will be shifted
  7266. to past the last clone.
  7267. In this way you can spell out a number of instances of a repeating task,
  7268. and still retain the repeater to cover future instances of the task."
  7269. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  7270. (let (beg end template task idprop
  7271. shift-n shift-what doshift nmin nmax (n-no-remove -1)
  7272. (drawer-re org-drawer-regexp))
  7273. (if (not (and (integerp n) (> n 0)))
  7274. (error "Invalid number of replications %s" n))
  7275. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7276. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7277. shift)))
  7278. (error "Invalid shift specification %s" shift))
  7279. (when doshift
  7280. (setq shift-n (string-to-number (match-string 1 shift))
  7281. shift-what (cdr (assoc (match-string 2 shift)
  7282. '(("d" . day) ("w" . week)
  7283. ("m" . month) ("y" . year))))))
  7284. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7285. (setq nmin 1 nmax n)
  7286. (org-back-to-heading t)
  7287. (setq beg (point))
  7288. (setq idprop (org-entry-get nil "ID"))
  7289. (org-end-of-subtree t t)
  7290. (or (bolp) (insert "\n"))
  7291. (setq end (point))
  7292. (setq template (buffer-substring beg end))
  7293. (when (and doshift
  7294. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7295. (delete-region beg end)
  7296. (setq end beg)
  7297. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7298. (goto-char end)
  7299. (loop for n from nmin to nmax do
  7300. ;; prepare clone
  7301. (with-temp-buffer
  7302. (insert template)
  7303. (org-mode)
  7304. (goto-char (point-min))
  7305. (org-show-subtree)
  7306. (and idprop (if org-clone-delete-id
  7307. (org-entry-delete nil "ID")
  7308. (org-id-get-create t)))
  7309. (unless (= n 0)
  7310. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7311. (kill-whole-line))
  7312. (goto-char (point-min))
  7313. (while (re-search-forward drawer-re nil t)
  7314. (mapc (lambda (d)
  7315. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7316. (goto-char (point-min))
  7317. (when doshift
  7318. (while (re-search-forward org-ts-regexp-both nil t)
  7319. (org-timestamp-change (* n shift-n) shift-what))
  7320. (unless (= n n-no-remove)
  7321. (goto-char (point-min))
  7322. (while (re-search-forward org-ts-regexp nil t)
  7323. (save-excursion
  7324. (goto-char (match-beginning 0))
  7325. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7326. (delete-region (match-beginning 1) (match-end 1)))))))
  7327. (setq task (buffer-string)))
  7328. (insert task))
  7329. (goto-char beg)))
  7330. ;;; Outline Sorting
  7331. (defun org-sort (with-case)
  7332. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7333. Optional argument WITH-CASE means sort case-sensitively."
  7334. (interactive "P")
  7335. (cond
  7336. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7337. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7338. (t
  7339. (org-call-with-arg 'org-sort-entries with-case))))
  7340. (defun org-sort-remove-invisible (s)
  7341. (remove-text-properties 0 (length s) org-rm-props s)
  7342. (while (string-match org-bracket-link-regexp s)
  7343. (setq s (replace-match (if (match-end 2)
  7344. (match-string 3 s)
  7345. (match-string 1 s)) t t s)))
  7346. s)
  7347. (defvar org-priority-regexp) ; defined later in the file
  7348. (defvar org-after-sorting-entries-or-items-hook nil
  7349. "Hook that is run after a bunch of entries or items have been sorted.
  7350. When children are sorted, the cursor is in the parent line when this
  7351. hook gets called. When a region or a plain list is sorted, the cursor
  7352. will be in the first entry of the sorted region/list.")
  7353. (defun org-sort-entries
  7354. (&optional with-case sorting-type getkey-func compare-func property)
  7355. "Sort entries on a certain level of an outline tree.
  7356. If there is an active region, the entries in the region are sorted.
  7357. Else, if the cursor is before the first entry, sort the top-level items.
  7358. Else, the children of the entry at point are sorted.
  7359. Sorting can be alphabetically, numerically, by date/time as given by
  7360. a time stamp, by a property or by priority.
  7361. The command prompts for the sorting type unless it has been given to the
  7362. function through the SORTING-TYPE argument, which needs to be a character,
  7363. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  7364. precise meaning of each character:
  7365. n Numerically, by converting the beginning of the entry/item to a number.
  7366. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7367. t By date/time, either the first active time stamp in the entry, or, if
  7368. none exist, by the first inactive one.
  7369. s By the scheduled date/time.
  7370. d By deadline date/time.
  7371. c By creation time, which is assumed to be the first inactive time stamp
  7372. at the beginning of a line.
  7373. p By priority according to the cookie.
  7374. r By the value of a property.
  7375. Capital letters will reverse the sort order.
  7376. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7377. called with point at the beginning of the record. It must return either
  7378. a string or a number that should serve as the sorting key for that record.
  7379. Comparing entries ignores case by default. However, with an optional argument
  7380. WITH-CASE, the sorting considers case as well."
  7381. (interactive "P")
  7382. (let ((case-func (if with-case 'identity 'downcase))
  7383. start beg end stars re re2
  7384. txt what tmp)
  7385. ;; Find beginning and end of region to sort
  7386. (cond
  7387. ((org-region-active-p)
  7388. ;; we will sort the region
  7389. (setq end (region-end)
  7390. what "region")
  7391. (goto-char (region-beginning))
  7392. (if (not (org-at-heading-p)) (outline-next-heading))
  7393. (setq start (point)))
  7394. ((or (org-at-heading-p)
  7395. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7396. ;; we will sort the children of the current headline
  7397. (org-back-to-heading)
  7398. (setq start (point)
  7399. end (progn (org-end-of-subtree t t)
  7400. (or (bolp) (insert "\n"))
  7401. (org-back-over-empty-lines)
  7402. (point))
  7403. what "children")
  7404. (goto-char start)
  7405. (show-subtree)
  7406. (outline-next-heading))
  7407. (t
  7408. ;; we will sort the top-level entries in this file
  7409. (goto-char (point-min))
  7410. (or (org-at-heading-p) (outline-next-heading))
  7411. (setq start (point))
  7412. (goto-char (point-max))
  7413. (beginning-of-line 1)
  7414. (when (looking-at ".*?\\S-")
  7415. ;; File ends in a non-white line
  7416. (end-of-line 1)
  7417. (insert "\n"))
  7418. (setq end (point-max))
  7419. (setq what "top-level")
  7420. (goto-char start)
  7421. (show-all)))
  7422. (setq beg (point))
  7423. (if (>= beg end) (error "Nothing to sort"))
  7424. (looking-at "\\(\\*+\\)")
  7425. (setq stars (match-string 1)
  7426. re (concat "^" (regexp-quote stars) " +")
  7427. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7428. txt (buffer-substring beg end))
  7429. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7430. (if (and (not (equal stars "*")) (string-match re2 txt))
  7431. (error "Region to sort contains a level above the first entry"))
  7432. (unless sorting-type
  7433. (message
  7434. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7435. [t]ime [s]cheduled [d]eadline [c]reated
  7436. A/N/T/S/D/C/P/O/F means reversed:"
  7437. what)
  7438. (setq sorting-type (read-char-exclusive))
  7439. (and (= (downcase sorting-type) ?f)
  7440. (setq getkey-func
  7441. (org-icompleting-read "Sort using function: "
  7442. obarray 'fboundp t nil nil))
  7443. (setq getkey-func (intern getkey-func)))
  7444. (and (= (downcase sorting-type) ?r)
  7445. (setq property
  7446. (org-icompleting-read "Property: "
  7447. (mapcar 'list (org-buffer-property-keys t))
  7448. nil t))))
  7449. (message "Sorting entries...")
  7450. (save-restriction
  7451. (narrow-to-region start end)
  7452. (let ((dcst (downcase sorting-type))
  7453. (case-fold-search nil)
  7454. (now (current-time)))
  7455. (sort-subr
  7456. (/= dcst sorting-type)
  7457. ;; This function moves to the beginning character of the "record" to
  7458. ;; be sorted.
  7459. (lambda nil
  7460. (if (re-search-forward re nil t)
  7461. (goto-char (match-beginning 0))
  7462. (goto-char (point-max))))
  7463. ;; This function moves to the last character of the "record" being
  7464. ;; sorted.
  7465. (lambda nil
  7466. (save-match-data
  7467. (condition-case nil
  7468. (outline-forward-same-level 1)
  7469. (error
  7470. (goto-char (point-max))))))
  7471. ;; This function returns the value that gets sorted against.
  7472. (lambda nil
  7473. (cond
  7474. ((= dcst ?n)
  7475. (if (looking-at org-complex-heading-regexp)
  7476. (string-to-number (match-string 4))
  7477. nil))
  7478. ((= dcst ?a)
  7479. (if (looking-at org-complex-heading-regexp)
  7480. (funcall case-func (match-string 4))
  7481. nil))
  7482. ((= dcst ?t)
  7483. (let ((end (save-excursion (outline-next-heading) (point))))
  7484. (if (or (re-search-forward org-ts-regexp end t)
  7485. (re-search-forward org-ts-regexp-both end t))
  7486. (org-time-string-to-seconds (match-string 0))
  7487. (org-float-time now))))
  7488. ((= dcst ?c)
  7489. (let ((end (save-excursion (outline-next-heading) (point))))
  7490. (if (re-search-forward
  7491. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7492. end t)
  7493. (org-time-string-to-seconds (match-string 0))
  7494. (org-float-time now))))
  7495. ((= dcst ?s)
  7496. (let ((end (save-excursion (outline-next-heading) (point))))
  7497. (if (re-search-forward org-scheduled-time-regexp end t)
  7498. (org-time-string-to-seconds (match-string 1))
  7499. (org-float-time now))))
  7500. ((= dcst ?d)
  7501. (let ((end (save-excursion (outline-next-heading) (point))))
  7502. (if (re-search-forward org-deadline-time-regexp end t)
  7503. (org-time-string-to-seconds (match-string 1))
  7504. (org-float-time now))))
  7505. ((= dcst ?p)
  7506. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7507. (string-to-char (match-string 2))
  7508. org-default-priority))
  7509. ((= dcst ?r)
  7510. (or (org-entry-get nil property) ""))
  7511. ((= dcst ?o)
  7512. (if (looking-at org-complex-heading-regexp)
  7513. (- 9999 (length (member (match-string 2)
  7514. org-todo-keywords-1)))))
  7515. ((= dcst ?f)
  7516. (if getkey-func
  7517. (progn
  7518. (setq tmp (funcall getkey-func))
  7519. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7520. tmp)
  7521. (error "Invalid key function `%s'" getkey-func)))
  7522. (t (error "Invalid sorting type `%c'" sorting-type))))
  7523. nil
  7524. (cond
  7525. ((= dcst ?a) 'string<)
  7526. ((= dcst ?f) compare-func)
  7527. ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
  7528. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7529. (message "Sorting entries...done")))
  7530. (defun org-do-sort (table what &optional with-case sorting-type)
  7531. "Sort TABLE of WHAT according to SORTING-TYPE.
  7532. The user will be prompted for the SORTING-TYPE if the call to this
  7533. function does not specify it. WHAT is only for the prompt, to indicate
  7534. what is being sorted. The sorting key will be extracted from
  7535. the car of the elements of the table.
  7536. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7537. (unless sorting-type
  7538. (message
  7539. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  7540. what)
  7541. (setq sorting-type (read-char-exclusive)))
  7542. (let ((dcst (downcase sorting-type))
  7543. extractfun comparefun)
  7544. ;; Define the appropriate functions
  7545. (cond
  7546. ((= dcst ?n)
  7547. (setq extractfun 'string-to-number
  7548. comparefun (if (= dcst sorting-type) '< '>)))
  7549. ((= dcst ?a)
  7550. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7551. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7552. comparefun (if (= dcst sorting-type)
  7553. 'string<
  7554. (lambda (a b) (and (not (string< a b))
  7555. (not (string= a b)))))))
  7556. ((= dcst ?t)
  7557. (setq extractfun
  7558. (lambda (x)
  7559. (if (or (string-match org-ts-regexp x)
  7560. (string-match org-ts-regexp-both x))
  7561. (org-float-time
  7562. (org-time-string-to-time (match-string 0 x)))
  7563. 0))
  7564. comparefun (if (= dcst sorting-type) '< '>)))
  7565. (t (error "Invalid sorting type `%c'" sorting-type)))
  7566. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7567. table)
  7568. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7569. ;;; The orgstruct minor mode
  7570. ;; Define a minor mode which can be used in other modes in order to
  7571. ;; integrate the org-mode structure editing commands.
  7572. ;; This is really a hack, because the org-mode structure commands use
  7573. ;; keys which normally belong to the major mode. Here is how it
  7574. ;; works: The minor mode defines all the keys necessary to operate the
  7575. ;; structure commands, but wraps the commands into a function which
  7576. ;; tests if the cursor is currently at a headline or a plain list
  7577. ;; item. If that is the case, the structure command is used,
  7578. ;; temporarily setting many Org-mode variables like regular
  7579. ;; expressions for filling etc. However, when any of those keys is
  7580. ;; used at a different location, function uses `key-binding' to look
  7581. ;; up if the key has an associated command in another currently active
  7582. ;; keymap (minor modes, major mode, global), and executes that
  7583. ;; command. There might be problems if any of the keys is otherwise
  7584. ;; used as a prefix key.
  7585. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  7586. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  7587. ;; addresses this by checking explicitly for both bindings.
  7588. (defvar orgstruct-mode-map (make-sparse-keymap)
  7589. "Keymap for the minor `orgstruct-mode'.")
  7590. (defvar org-local-vars nil
  7591. "List of local variables, for use by `orgstruct-mode'.")
  7592. ;;;###autoload
  7593. (define-minor-mode orgstruct-mode
  7594. "Toggle the minor mode `orgstruct-mode'.
  7595. This mode is for using Org-mode structure commands in other
  7596. modes. The following keys behave as if Org-mode were active, if
  7597. the cursor is on a headline, or on a plain list item (both as
  7598. defined by Org-mode).
  7599. M-up Move entry/item up
  7600. M-down Move entry/item down
  7601. M-left Promote
  7602. M-right Demote
  7603. M-S-up Move entry/item up
  7604. M-S-down Move entry/item down
  7605. M-S-left Promote subtree
  7606. M-S-right Demote subtree
  7607. M-q Fill paragraph and items like in Org-mode
  7608. C-c ^ Sort entries
  7609. C-c - Cycle list bullet
  7610. TAB Cycle item visibility
  7611. M-RET Insert new heading/item
  7612. S-M-RET Insert new TODO heading / Checkbox item
  7613. C-c C-c Set tags / toggle checkbox"
  7614. nil " OrgStruct" nil
  7615. (org-load-modules-maybe)
  7616. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7617. ;;;###autoload
  7618. (defun turn-on-orgstruct ()
  7619. "Unconditionally turn on `orgstruct-mode'."
  7620. (orgstruct-mode 1))
  7621. (defvar org-fb-vars nil)
  7622. (make-variable-buffer-local 'org-fb-vars)
  7623. (defun orgstruct++-mode (&optional arg)
  7624. "Toggle `orgstruct-mode', the enhanced version of it.
  7625. In addition to setting orgstruct-mode, this also exports all
  7626. indentation and autofilling variables from org-mode into the
  7627. buffer. It will also recognize item context in multiline items."
  7628. (interactive "P")
  7629. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7630. (if (< arg 1)
  7631. (progn (orgstruct-mode -1)
  7632. (mapc (lambda(v)
  7633. (org-set-local (car v)
  7634. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  7635. org-fb-vars))
  7636. (orgstruct-mode 1)
  7637. (setq org-fb-vars nil)
  7638. (let (var val)
  7639. (mapc
  7640. (lambda (x)
  7641. (when (string-match
  7642. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
  7643. (symbol-name (car x)))
  7644. (setq var (car x) val (nth 1 x))
  7645. (push (list var `(quote ,(eval var))) org-fb-vars)
  7646. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7647. org-local-vars)
  7648. (org-set-local 'orgstruct-is-++ t))))
  7649. (defvar orgstruct-is-++ nil
  7650. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  7651. (make-variable-buffer-local 'orgstruct-is-++)
  7652. ;;;###autoload
  7653. (defun turn-on-orgstruct++ ()
  7654. "Unconditionally turn on `orgstruct++-mode'."
  7655. (orgstruct++-mode 1))
  7656. (defun orgstruct-error ()
  7657. "Error when there is no default binding for a structure key."
  7658. (interactive)
  7659. (error "This key has no function outside structure elements"))
  7660. (defun orgstruct-setup ()
  7661. "Setup orgstruct keymaps."
  7662. (let ((nfunc 0)
  7663. (bindings
  7664. (list
  7665. '([(meta up)] org-metaup)
  7666. '([(meta down)] org-metadown)
  7667. '([(meta left)] org-metaleft)
  7668. '([(meta right)] org-metaright)
  7669. '([(meta shift up)] org-shiftmetaup)
  7670. '([(meta shift down)] org-shiftmetadown)
  7671. '([(meta shift left)] org-shiftmetaleft)
  7672. '([(meta shift right)] org-shiftmetaright)
  7673. '([?\e (up)] org-metaup)
  7674. '([?\e (down)] org-metadown)
  7675. '([?\e (left)] org-metaleft)
  7676. '([?\e (right)] org-metaright)
  7677. '([?\e (shift up)] org-shiftmetaup)
  7678. '([?\e (shift down)] org-shiftmetadown)
  7679. '([?\e (shift left)] org-shiftmetaleft)
  7680. '([?\e (shift right)] org-shiftmetaright)
  7681. '([(shift up)] org-shiftup)
  7682. '([(shift down)] org-shiftdown)
  7683. '([(shift left)] org-shiftleft)
  7684. '([(shift right)] org-shiftright)
  7685. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7686. '("\M-q" fill-paragraph)
  7687. '("\C-c^" org-sort)
  7688. '("\C-c-" org-cycle-list-bullet)))
  7689. elt key fun cmd)
  7690. (while (setq elt (pop bindings))
  7691. (setq nfunc (1+ nfunc))
  7692. (setq key (org-key (car elt))
  7693. fun (nth 1 elt)
  7694. cmd (orgstruct-make-binding fun nfunc key))
  7695. (org-defkey orgstruct-mode-map key cmd))
  7696. ;; Prevent an error for users who forgot to make autoloads
  7697. (require 'org-element)
  7698. ;; Special treatment needed for TAB and RET
  7699. (org-defkey orgstruct-mode-map [(tab)]
  7700. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7701. (org-defkey orgstruct-mode-map "\C-i"
  7702. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7703. (org-defkey orgstruct-mode-map "\M-\C-m"
  7704. (orgstruct-make-binding 'org-insert-heading 105
  7705. "\M-\C-m" [(meta return)]))
  7706. (org-defkey orgstruct-mode-map [(meta return)]
  7707. (orgstruct-make-binding 'org-insert-heading 106
  7708. [(meta return)] "\M-\C-m"))
  7709. (org-defkey orgstruct-mode-map [(shift meta return)]
  7710. (orgstruct-make-binding 'org-insert-todo-heading 107
  7711. [(meta return)] "\M-\C-m"))
  7712. (org-defkey orgstruct-mode-map "\e\C-m"
  7713. (orgstruct-make-binding 'org-insert-heading 108
  7714. "\e\C-m" [?\e (return)]))
  7715. (org-defkey orgstruct-mode-map [?\e (return)]
  7716. (orgstruct-make-binding 'org-insert-heading 109
  7717. [?\e (return)] "\e\C-m"))
  7718. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7719. (orgstruct-make-binding 'org-insert-todo-heading 110
  7720. [?\e (return)] "\e\C-m"))
  7721. (unless org-local-vars
  7722. (setq org-local-vars (org-get-local-variables)))
  7723. t))
  7724. (defun orgstruct-make-binding (fun n &rest keys)
  7725. "Create a function for binding in the structure minor mode.
  7726. FUN is the command to call inside a table. N is used to create a unique
  7727. command name. KEYS are keys that should be checked in for a command
  7728. to execute outside of tables."
  7729. (eval
  7730. (list 'defun
  7731. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7732. '(arg)
  7733. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7734. "Outside of structure, run the binding of `"
  7735. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7736. "'.")
  7737. '(interactive "p")
  7738. (list 'if
  7739. `(org-context-p 'headline 'item
  7740. (and orgstruct-is-++
  7741. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7742. 'item-body))
  7743. (list 'org-run-like-in-org-mode (list 'quote fun))
  7744. (list 'let '(orgstruct-mode)
  7745. (list 'call-interactively
  7746. (append '(or)
  7747. (mapcar (lambda (k)
  7748. (list 'key-binding k))
  7749. keys)
  7750. '('orgstruct-error))))))))
  7751. (defun org-contextualize-keys (alist contexts)
  7752. "Return valid elements in ALIST depending on CONTEXTS.
  7753. `org-agenda-custom-commands' or `org-capture-templates' are the
  7754. values used for ALIST, and `org-agenda-custom-commands-contexts'
  7755. or `org-capture-templates-contexts' are the associated contexts
  7756. definitions."
  7757. (let ((contexts
  7758. ;; normalize contexts
  7759. (mapcar
  7760. (lambda(c) (cond ((listp (cadr c))
  7761. (list (car c) (car c) (cadr c)))
  7762. ((string= "" (cadr c))
  7763. (list (car c) (car c) (caddr c)))
  7764. (t c))) contexts))
  7765. (a alist) c r s)
  7766. ;; loop over all commands or templates
  7767. (while (setq c (pop a))
  7768. (let (vrules repl)
  7769. (cond
  7770. ((not (assoc (car c) contexts))
  7771. (push c r))
  7772. ((and (assoc (car c) contexts)
  7773. (setq vrules (org-contextualize-validate-key
  7774. (car c) contexts)))
  7775. (mapc (lambda (vr)
  7776. (when (not (equal (car vr) (cadr vr)))
  7777. (setq repl vr))) vrules)
  7778. (if (not repl) (push c r)
  7779. (push (cadr repl) s)
  7780. (push
  7781. (cons (car c)
  7782. (cdr (or (assoc (cadr repl) alist)
  7783. (error "Undefined key `%s' as contextual replacement for `%s'"
  7784. (cadr repl) (car c)))))
  7785. r))))))
  7786. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  7787. (delq
  7788. nil
  7789. (delete-dups
  7790. (mapcar (lambda (x)
  7791. (let ((tpl (car x)))
  7792. (when (not (delq
  7793. nil
  7794. (mapcar (lambda(y)
  7795. (equal y tpl)) s))) x)))
  7796. (reverse r))))))
  7797. (defun org-contextualize-validate-key (key contexts)
  7798. "Check CONTEXTS for agenda or capture KEY."
  7799. (let (r rr res)
  7800. (while (setq r (pop contexts))
  7801. (mapc
  7802. (lambda (rr)
  7803. (when
  7804. (and (equal key (car r))
  7805. (if (functionp rr) (funcall rr)
  7806. (or (and (eq (car rr) 'in-file)
  7807. (buffer-file-name)
  7808. (string-match (cdr rr) (buffer-file-name)))
  7809. (and (eq (car rr) 'in-mode)
  7810. (string-match (cdr rr) (symbol-name major-mode)))
  7811. (when (and (eq (car rr) 'not-in-file)
  7812. (buffer-file-name))
  7813. (not (string-match (cdr rr) (buffer-file-name))))
  7814. (when (eq (car rr) 'not-in-mode)
  7815. (not (string-match (cdr rr) (symbol-name major-mode)))))))
  7816. (push r res)))
  7817. (car (last r))))
  7818. (delete-dups (delq nil res))))
  7819. (defun org-context-p (&rest contexts)
  7820. "Check if local context is any of CONTEXTS.
  7821. Possible values in the list of contexts are `table', `headline', and `item'."
  7822. (let ((pos (point)))
  7823. (goto-char (point-at-bol))
  7824. (prog1 (or (and (memq 'table contexts)
  7825. (looking-at "[ \t]*|"))
  7826. (and (memq 'headline contexts)
  7827. (looking-at org-outline-regexp))
  7828. (and (memq 'item contexts)
  7829. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7830. (and (memq 'item-body contexts)
  7831. (org-in-item-p)))
  7832. (goto-char pos))))
  7833. (defun org-get-local-variables ()
  7834. "Return a list of all local variables in an Org mode buffer."
  7835. (let (varlist)
  7836. (with-current-buffer (get-buffer-create "*Org tmp*")
  7837. (erase-buffer)
  7838. (org-mode)
  7839. (setq varlist (buffer-local-variables)))
  7840. (kill-buffer "*Org tmp*")
  7841. (delq nil
  7842. (mapcar
  7843. (lambda (x)
  7844. (setq x
  7845. (if (symbolp x)
  7846. (list x)
  7847. (list (car x) (list 'quote (cdr x)))))
  7848. (if (string-match
  7849. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  7850. (symbol-name (car x)))
  7851. x nil))
  7852. varlist))))
  7853. (defun org-clone-local-variables (from-buffer &optional regexp)
  7854. "Clone local variables from FROM-BUFFER.
  7855. Optional argument REGEXP selects variables to clone."
  7856. (mapc
  7857. (lambda (pair)
  7858. (and (symbolp (car pair))
  7859. (or (null regexp)
  7860. (string-match regexp (symbol-name (car pair))))
  7861. (set (make-local-variable (car pair))
  7862. (cdr pair))))
  7863. (buffer-local-variables from-buffer)))
  7864. ;;;###autoload
  7865. (defun org-run-like-in-org-mode (cmd)
  7866. "Run a command, pretending that the current buffer is in Org-mode.
  7867. This will temporarily bind local variables that are typically bound in
  7868. Org-mode to the values they have in Org-mode, and then interactively
  7869. call CMD."
  7870. (org-load-modules-maybe)
  7871. (unless org-local-vars
  7872. (setq org-local-vars (org-get-local-variables)))
  7873. (eval (list 'let org-local-vars
  7874. (list 'call-interactively (list 'quote cmd)))))
  7875. ;;;; Archiving
  7876. (defun org-get-category (&optional pos force-refresh)
  7877. "Get the category applying to position POS."
  7878. (save-match-data
  7879. (if force-refresh (org-refresh-category-properties))
  7880. (let ((pos (or pos (point))))
  7881. (or (get-text-property pos 'org-category)
  7882. (progn (org-refresh-category-properties)
  7883. (get-text-property pos 'org-category))))))
  7884. (defun org-refresh-category-properties ()
  7885. "Refresh category text properties in the buffer."
  7886. (let ((case-fold-search t)
  7887. (inhibit-read-only t)
  7888. (def-cat (cond
  7889. ((null org-category)
  7890. (if buffer-file-name
  7891. (file-name-sans-extension
  7892. (file-name-nondirectory buffer-file-name))
  7893. "???"))
  7894. ((symbolp org-category) (symbol-name org-category))
  7895. (t org-category)))
  7896. beg end cat pos optionp)
  7897. (org-unmodified
  7898. (save-excursion
  7899. (save-restriction
  7900. (widen)
  7901. (goto-char (point-min))
  7902. (put-text-property (point) (point-max) 'org-category def-cat)
  7903. (while (re-search-forward
  7904. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7905. (setq pos (match-end 0)
  7906. optionp (equal (char-after (match-beginning 0)) ?#)
  7907. cat (org-trim (match-string 2)))
  7908. (if optionp
  7909. (setq beg (point-at-bol) end (point-max))
  7910. (org-back-to-heading t)
  7911. (setq beg (point) end (org-end-of-subtree t t)))
  7912. (put-text-property beg end 'org-category cat)
  7913. (put-text-property beg end 'org-category-position beg)
  7914. (goto-char pos)))))))
  7915. ;;;; Link Stuff
  7916. ;;; Link abbreviations
  7917. (defun org-link-expand-abbrev (link)
  7918. "Apply replacements as defined in `org-link-abbrev-alist'."
  7919. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  7920. (let* ((key (match-string 1 link))
  7921. (as (or (assoc key org-link-abbrev-alist-local)
  7922. (assoc key org-link-abbrev-alist)))
  7923. (tag (and (match-end 2) (match-string 3 link)))
  7924. rpl)
  7925. (if (not as)
  7926. link
  7927. (setq rpl (cdr as))
  7928. (cond
  7929. ((symbolp rpl) (funcall rpl tag))
  7930. ((string-match "%(\\([^)]+\\))" rpl)
  7931. (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
  7932. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7933. ((string-match "%h" rpl)
  7934. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7935. (t (concat rpl tag)))))
  7936. link))
  7937. ;;; Storing and inserting links
  7938. (defvar org-insert-link-history nil
  7939. "Minibuffer history for links inserted with `org-insert-link'.")
  7940. (defvar org-stored-links nil
  7941. "Contains the links stored with `org-store-link'.")
  7942. (defvar org-store-link-plist nil
  7943. "Plist with info about the most recently link created with `org-store-link'.")
  7944. (defvar org-link-protocols nil
  7945. "Link protocols added to Org-mode using `org-add-link-type'.")
  7946. (defvar org-store-link-functions nil
  7947. "List of functions that are called to create and store a link.
  7948. Each function will be called in turn until one returns a non-nil
  7949. value. Each function should check if it is responsible for creating
  7950. this link (for example by looking at the major mode).
  7951. If not, it must exit and return nil.
  7952. If yes, it should return a non-nil value after a calling
  7953. `org-store-link-props' with a list of properties and values.
  7954. Special properties are:
  7955. :type The link prefix, like \"http\". This must be given.
  7956. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7957. This is obligatory as well.
  7958. :description Optional default description for the second pair
  7959. of brackets in an Org-mode link. The user can still change
  7960. this when inserting this link into an Org-mode buffer.
  7961. In addition to these, any additional properties can be specified
  7962. and then used in remember templates.")
  7963. (defun org-add-link-type (type &optional follow export)
  7964. "Add TYPE to the list of `org-link-types'.
  7965. Re-compute all regular expressions depending on `org-link-types'
  7966. FOLLOW and EXPORT are two functions.
  7967. FOLLOW should take the link path as the single argument and do whatever
  7968. is necessary to follow the link, for example find a file or display
  7969. a mail message.
  7970. EXPORT should format the link path for export to one of the export formats.
  7971. It should be a function accepting three arguments:
  7972. path the path of the link, the text after the prefix (like \"http:\")
  7973. desc the description of the link, if any, or a description added by
  7974. org-export-normalize-links if there is none
  7975. format the export format, a symbol like `html' or `latex' or `ascii'..
  7976. The function may use the FORMAT information to return different values
  7977. depending on the format. The return value will be put literally into
  7978. the exported file. If the return value is nil, this means Org should
  7979. do what it normally does with links which do not have EXPORT defined.
  7980. Org-mode has a built-in default for exporting links. If you are happy with
  7981. this default, there is no need to define an export function for the link
  7982. type. For a simple example of an export function, see `org-bbdb.el'."
  7983. (add-to-list 'org-link-types type t)
  7984. (org-make-link-regexps)
  7985. (if (assoc type org-link-protocols)
  7986. (setcdr (assoc type org-link-protocols) (list follow export))
  7987. (push (list type follow export) org-link-protocols)))
  7988. (defvar org-agenda-buffer-name)
  7989. ;;;###autoload
  7990. (defun org-store-link (arg)
  7991. "\\<org-mode-map>Store an org-link to the current location.
  7992. This link is added to `org-stored-links' and can later be inserted
  7993. into an org-buffer with \\[org-insert-link].
  7994. For some link types, a prefix arg is interpreted:
  7995. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  7996. For file links, arg negates `org-context-in-file-links'."
  7997. (interactive "P")
  7998. (org-load-modules-maybe)
  7999. (setq org-store-link-plist nil) ; reset
  8000. (org-with-limited-levels
  8001. (let (link cpltxt desc description search txt custom-id agenda-link)
  8002. (cond
  8003. ((run-hook-with-args-until-success 'org-store-link-functions)
  8004. (setq link (plist-get org-store-link-plist :link)
  8005. desc (or (plist-get org-store-link-plist :description) link)))
  8006. ((org-src-edit-buffer-p)
  8007. (let (label gc)
  8008. (while (or (not label)
  8009. (save-excursion
  8010. (save-restriction
  8011. (widen)
  8012. (goto-char (point-min))
  8013. (re-search-forward
  8014. (regexp-quote (format org-coderef-label-format label))
  8015. nil t))))
  8016. (when label (message "Label exists already") (sit-for 2))
  8017. (setq label (read-string "Code line label: " label)))
  8018. (end-of-line 1)
  8019. (setq link (format org-coderef-label-format label))
  8020. (setq gc (- 79 (length link)))
  8021. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  8022. (insert link)
  8023. (setq link (concat "(" label ")") desc nil)))
  8024. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  8025. ;; We are in the agenda, link to referenced location
  8026. (let ((m (or (get-text-property (point) 'org-hd-marker)
  8027. (get-text-property (point) 'org-marker))))
  8028. (when m
  8029. (org-with-point-at m
  8030. (setq agenda-link
  8031. (if (org-called-interactively-p 'any)
  8032. (call-interactively 'org-store-link)
  8033. (org-store-link nil)))))))
  8034. ((eq major-mode 'calendar-mode)
  8035. (let ((cd (calendar-cursor-to-date)))
  8036. (setq link
  8037. (format-time-string
  8038. (car org-time-stamp-formats)
  8039. (apply 'encode-time
  8040. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  8041. nil nil nil))))
  8042. (org-store-link-props :type "calendar" :date cd)))
  8043. ((eq major-mode 'help-mode)
  8044. (setq link (concat "help:" (save-excursion
  8045. (goto-char (point-min))
  8046. (looking-at "^[^ ]+")
  8047. (match-string 0))))
  8048. (org-store-link-props :type "help"))
  8049. ((eq major-mode 'w3-mode)
  8050. (setq cpltxt (if (and (buffer-name)
  8051. (not (string-match "Untitled" (buffer-name))))
  8052. (buffer-name)
  8053. (url-view-url t))
  8054. link (url-view-url t))
  8055. (org-store-link-props :type "w3" :url (url-view-url t)))
  8056. ((eq major-mode 'w3m-mode)
  8057. (setq cpltxt (or w3m-current-title w3m-current-url)
  8058. link w3m-current-url)
  8059. (org-store-link-props :type "w3m" :url (url-view-url t)))
  8060. ((setq search (run-hook-with-args-until-success
  8061. 'org-create-file-search-functions))
  8062. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  8063. "::" search))
  8064. (setq cpltxt (or description link)))
  8065. ((eq major-mode 'image-mode)
  8066. (setq cpltxt (concat "file:"
  8067. (abbreviate-file-name buffer-file-name))
  8068. link cpltxt)
  8069. (org-store-link-props :type "image" :file buffer-file-name))
  8070. ((eq major-mode 'dired-mode)
  8071. ;; link to the file in the current line
  8072. (let ((file (dired-get-filename nil t)))
  8073. (setq file (if file
  8074. (abbreviate-file-name
  8075. (expand-file-name (dired-get-filename nil t)))
  8076. ;; otherwise, no file so use current directory.
  8077. default-directory))
  8078. (setq cpltxt (concat "file:" file)
  8079. link cpltxt)))
  8080. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  8081. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  8082. (cond
  8083. ((org-in-regexp "<<\\(.*?\\)>>")
  8084. (setq cpltxt
  8085. (concat "file:"
  8086. (abbreviate-file-name
  8087. (buffer-file-name (buffer-base-buffer)))
  8088. "::" (match-string 1))
  8089. link cpltxt))
  8090. ((and (featurep 'org-id)
  8091. (or (eq org-link-to-org-use-id t)
  8092. (and (org-called-interactively-p 'any)
  8093. (or (eq org-link-to-org-use-id 'create-if-interactive)
  8094. (and (eq org-link-to-org-use-id
  8095. 'create-if-interactive-and-no-custom-id)
  8096. (not custom-id))))
  8097. (and org-link-to-org-use-id (org-entry-get nil "ID"))))
  8098. ;; We can make a link using the ID.
  8099. (setq link (condition-case nil
  8100. (prog1 (org-id-store-link)
  8101. (setq desc (plist-get org-store-link-plist :description)))
  8102. (error
  8103. ;; probably before first headline, link to file only
  8104. (concat "file:"
  8105. (abbreviate-file-name
  8106. (buffer-file-name (buffer-base-buffer))))))))
  8107. (t
  8108. ;; Just link to current headline
  8109. (setq cpltxt (concat "file:"
  8110. (abbreviate-file-name
  8111. (buffer-file-name (buffer-base-buffer)))))
  8112. ;; Add a context search string
  8113. (when (org-xor org-context-in-file-links arg)
  8114. (setq txt (cond
  8115. ((org-at-heading-p) nil)
  8116. ((org-region-active-p)
  8117. (buffer-substring (region-beginning) (region-end)))))
  8118. (when (or (null txt) (string-match "\\S-" txt))
  8119. (setq cpltxt
  8120. (concat cpltxt "::"
  8121. (condition-case nil
  8122. (org-make-org-heading-search-string txt)
  8123. (error "")))
  8124. desc (or (nth 4 (ignore-errors
  8125. (org-heading-components))) "NONE"))))
  8126. (if (string-match "::\\'" cpltxt)
  8127. (setq cpltxt (substring cpltxt 0 -2)))
  8128. (setq link cpltxt))))
  8129. ((buffer-file-name (buffer-base-buffer))
  8130. ;; Just link to this file here.
  8131. (setq cpltxt (concat "file:"
  8132. (abbreviate-file-name
  8133. (buffer-file-name (buffer-base-buffer)))))
  8134. ;; Add a context string
  8135. (when (org-xor org-context-in-file-links arg)
  8136. (setq txt (if (org-region-active-p)
  8137. (buffer-substring (region-beginning) (region-end))
  8138. (buffer-substring (point-at-bol) (point-at-eol))))
  8139. ;; Only use search option if there is some text.
  8140. (when (string-match "\\S-" txt)
  8141. (setq cpltxt
  8142. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8143. desc "NONE")))
  8144. (setq link cpltxt))
  8145. ((org-called-interactively-p 'interactive)
  8146. (error "Cannot link to a buffer which is not visiting a file"))
  8147. (t (setq link nil)))
  8148. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8149. (setq link (or link cpltxt)
  8150. desc (or desc cpltxt))
  8151. (if (equal desc "NONE") (setq desc nil))
  8152. (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
  8153. (progn
  8154. (setq org-stored-links
  8155. (cons (list link desc) org-stored-links))
  8156. (message "Stored: %s" (or desc link))
  8157. (when custom-id
  8158. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  8159. "::#" custom-id))
  8160. (setq org-stored-links
  8161. (cons (list link desc) org-stored-links))))
  8162. (or agenda-link (and link (org-make-link-string link desc)))))))
  8163. (defun org-store-link-props (&rest plist)
  8164. "Store link properties, extract names and addresses."
  8165. (let (x adr)
  8166. (when (setq x (plist-get plist :from))
  8167. (setq adr (mail-extract-address-components x))
  8168. (setq plist (plist-put plist :fromname (car adr)))
  8169. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8170. (when (setq x (plist-get plist :to))
  8171. (setq adr (mail-extract-address-components x))
  8172. (setq plist (plist-put plist :toname (car adr)))
  8173. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8174. (let ((from (plist-get plist :from))
  8175. (to (plist-get plist :to)))
  8176. (when (and from to org-from-is-user-regexp)
  8177. (setq plist
  8178. (plist-put plist :fromto
  8179. (if (string-match org-from-is-user-regexp from)
  8180. (concat "to %t")
  8181. (concat "from %f"))))))
  8182. (setq org-store-link-plist plist))
  8183. (defun org-add-link-props (&rest plist)
  8184. "Add these properties to the link property list."
  8185. (let (key value)
  8186. (while plist
  8187. (setq key (pop plist) value (pop plist))
  8188. (setq org-store-link-plist
  8189. (plist-put org-store-link-plist key value)))))
  8190. (defun org-email-link-description (&optional fmt)
  8191. "Return the description part of an email link.
  8192. This takes information from `org-store-link-plist' and formats it
  8193. according to FMT (default from `org-email-link-description-format')."
  8194. (setq fmt (or fmt org-email-link-description-format))
  8195. (let* ((p org-store-link-plist)
  8196. (to (plist-get p :toaddress))
  8197. (from (plist-get p :fromaddress))
  8198. (table
  8199. (list
  8200. (cons "%c" (plist-get p :fromto))
  8201. (cons "%F" (plist-get p :from))
  8202. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8203. (cons "%T" (plist-get p :to))
  8204. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8205. (cons "%s" (plist-get p :subject))
  8206. (cons "%d" (plist-get p :date))
  8207. (cons "%m" (plist-get p :message-id)))))
  8208. (when (string-match "%c" fmt)
  8209. ;; Check if the user wrote this message
  8210. (if (and org-from-is-user-regexp from to
  8211. (save-match-data (string-match org-from-is-user-regexp from)))
  8212. (setq fmt (replace-match "to %t" t t fmt))
  8213. (setq fmt (replace-match "from %f" t t fmt))))
  8214. (org-replace-escapes fmt table)))
  8215. (defun org-make-org-heading-search-string (&optional string heading)
  8216. "Make search string for STRING or current headline."
  8217. (interactive)
  8218. (let ((s (or string (org-get-heading)))
  8219. (lines org-context-in-file-links))
  8220. (unless (and string (not heading))
  8221. ;; We are using a headline, clean up garbage in there.
  8222. (if (string-match org-todo-regexp s)
  8223. (setq s (replace-match "" t t s)))
  8224. (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
  8225. (setq s (replace-match "" t t s)))
  8226. (setq s (org-trim s))
  8227. (if (string-match (concat "^\\(" org-quote-string "\\|"
  8228. org-comment-string "\\)") s)
  8229. (setq s (replace-match "" t t s)))
  8230. (while (string-match org-ts-regexp s)
  8231. (setq s (replace-match "" t t s))))
  8232. (or string (setq s (concat "*" s))) ; Add * for headlines
  8233. (when (and string (integerp lines) (> lines 0))
  8234. (let ((slines (org-split-string s "\n")))
  8235. (when (< lines (length slines))
  8236. (setq s (mapconcat
  8237. 'identity
  8238. (reverse (nthcdr (- (length slines) lines)
  8239. (reverse slines))) "\n")))))
  8240. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8241. (defun org-make-link-string (link &optional description)
  8242. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8243. (unless (string-match "\\S-" link)
  8244. (error "Empty link"))
  8245. (when (and description
  8246. (stringp description)
  8247. (not (string-match "\\S-" description)))
  8248. (setq description nil))
  8249. (when (stringp description)
  8250. ;; Remove brackets from the description, they are fatal.
  8251. (while (string-match "\\[" description)
  8252. (setq description (replace-match "{" t t description)))
  8253. (while (string-match "\\]" description)
  8254. (setq description (replace-match "}" t t description))))
  8255. (when (equal link description)
  8256. ;; No description needed, it is identical
  8257. (setq description nil))
  8258. (when (and (not description)
  8259. (not (string-match (org-image-file-name-regexp) link))
  8260. (not (equal link (org-link-escape link))))
  8261. (setq description (org-extract-attributes link)))
  8262. (setq link
  8263. (cond ((string-match (org-image-file-name-regexp) link) link)
  8264. ((string-match org-link-types-re link)
  8265. (concat (match-string 1 link)
  8266. (org-link-escape (substring link (match-end 1)))))
  8267. (t (org-link-escape link))))
  8268. (concat "[[" link "]"
  8269. (if description (concat "[" description "]") "")
  8270. "]"))
  8271. (defconst org-link-escape-chars
  8272. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  8273. "List of characters that should be escaped in link.
  8274. This is the list that is used for internal purposes.")
  8275. (defconst org-link-escape-chars-browser
  8276. '(?\ )
  8277. "List of escapes for characters that are problematic in links.
  8278. This is the list that is used before handing over to the browser.")
  8279. (defun org-link-escape (text &optional table merge)
  8280. "Return percent escaped representation of TEXT.
  8281. TEXT is a string with the text to escape.
  8282. Optional argument TABLE is a list with characters that should be
  8283. escaped. When nil, `org-link-escape-chars' is used.
  8284. If optional argument MERGE is set, merge TABLE into
  8285. `org-link-escape-chars'."
  8286. (cond
  8287. ((and table merge)
  8288. (mapc (lambda (defchr)
  8289. (unless (member defchr table)
  8290. (setq table (cons defchr table)))) org-link-escape-chars))
  8291. ((null table)
  8292. (setq table org-link-escape-chars)))
  8293. (mapconcat
  8294. (lambda (char)
  8295. (if (or (member char table)
  8296. (and (or (< char 32) (= char 37) (> char 126))
  8297. org-url-hexify-p))
  8298. (mapconcat (lambda (sequence-element)
  8299. (format "%%%.2X" sequence-element))
  8300. (or (encode-coding-char char 'utf-8)
  8301. (error "Unable to percent escape character: %s"
  8302. (char-to-string char))) "")
  8303. (char-to-string char))) text ""))
  8304. (defun org-link-unescape (str)
  8305. "Unhex hexified Unicode strings as returned from the JavaScript function
  8306. encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
  8307. (unless (and (null str) (string= "" str))
  8308. (let ((pos 0) (case-fold-search t) unhexed)
  8309. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8310. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8311. (setq str (replace-match unhexed t t str))
  8312. (setq pos (+ pos (length unhexed))))))
  8313. str)
  8314. (defun org-link-unescape-compound (hex)
  8315. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
  8316. Note: this function also decodes single byte encodings like
  8317. `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
  8318. (save-match-data
  8319. (let* ((bytes (cdr (split-string hex "%")))
  8320. (ret "")
  8321. (eat 0)
  8322. (sum 0))
  8323. (while bytes
  8324. (let* ((val (string-to-number (pop bytes) 16))
  8325. (shift-xor
  8326. (if (= 0 eat)
  8327. (cond
  8328. ((>= val 252) (cons 6 252))
  8329. ((>= val 248) (cons 5 248))
  8330. ((>= val 240) (cons 4 240))
  8331. ((>= val 224) (cons 3 224))
  8332. ((>= val 192) (cons 2 192))
  8333. (t (cons 0 0)))
  8334. (cons 6 128))))
  8335. (if (>= val 192) (setq eat (car shift-xor)))
  8336. (setq val (logxor val (cdr shift-xor)))
  8337. (setq sum (+ (lsh sum (car shift-xor)) val))
  8338. (if (> eat 0) (setq eat (- eat 1)))
  8339. (cond
  8340. ((= 0 eat) ;multi byte
  8341. (setq ret (concat ret (org-char-to-string sum)))
  8342. (setq sum 0))
  8343. ((not bytes) ; single byte(s)
  8344. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8345. )) ;; end (while bytes
  8346. ret )))
  8347. (defun org-link-unescape-single-byte-sequence (hex)
  8348. "Unhexify hex-encoded single byte character sequences."
  8349. (mapconcat (lambda (byte)
  8350. (char-to-string (string-to-number byte 16)))
  8351. (cdr (split-string hex "%")) ""))
  8352. (defun org-xor (a b)
  8353. "Exclusive or."
  8354. (if a (not b) b))
  8355. (defun org-fixup-message-id-for-http (s)
  8356. "Replace special characters in a message id, so it can be used in an http query."
  8357. (when (string-match "%" s)
  8358. (setq s (mapconcat (lambda (c)
  8359. (if (eq c ?%)
  8360. "%25"
  8361. (char-to-string c)))
  8362. s "")))
  8363. (while (string-match "<" s)
  8364. (setq s (replace-match "%3C" t t s)))
  8365. (while (string-match ">" s)
  8366. (setq s (replace-match "%3E" t t s)))
  8367. (while (string-match "@" s)
  8368. (setq s (replace-match "%40" t t s)))
  8369. s)
  8370. (defun org-link-prettify (link)
  8371. "Return a human-readable representation of LINK.
  8372. The car of LINK must be a raw link the cdr of LINK must be either
  8373. a link description or nil."
  8374. (let ((desc (or (cadr link) "<no description>")))
  8375. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8376. "<" (car link) ">")))
  8377. ;;;###autoload
  8378. (defun org-insert-link-global ()
  8379. "Insert a link like Org-mode does.
  8380. This command can be called in any mode to insert a link in Org-mode syntax."
  8381. (interactive)
  8382. (org-load-modules-maybe)
  8383. (org-run-like-in-org-mode 'org-insert-link))
  8384. (defun org-insert-all-links (&optional keep)
  8385. "Insert all links in `org-stored-links'."
  8386. (interactive "P")
  8387. (let ((links (copy-sequence org-stored-links)) l)
  8388. (while (setq l (if keep (pop links) (pop org-stored-links)))
  8389. (insert "- ")
  8390. (org-insert-link nil (car l) (cadr l))
  8391. (insert "\n"))))
  8392. (defun org-link-fontify-links-to-this-file ()
  8393. "Fontify links to the current file in `org-stored-links'."
  8394. (let ((f (buffer-file-name)) a b)
  8395. (setq a (mapcar (lambda(l)
  8396. (let ((ll (car l)))
  8397. (when (and (string-match "^file:\\(.+\\)::" ll)
  8398. (equal f (expand-file-name (match-string 1 ll))))
  8399. ll)))
  8400. org-stored-links))
  8401. (when (featurep 'org-id)
  8402. (setq b (mapcar (lambda(l)
  8403. (let ((ll (car l)))
  8404. (when (and (string-match "^id:\\(.+\\)$" ll)
  8405. (equal f (expand-file-name
  8406. (or (org-id-find-id-file
  8407. (match-string 1 ll)) ""))))
  8408. ll)))
  8409. org-stored-links)))
  8410. (mapcar (lambda(l)
  8411. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  8412. (delq nil (append a b)))))
  8413. (defvar org-link-links-in-this-file nil)
  8414. (defun org-insert-link (&optional complete-file link-location default-description)
  8415. "Insert a link. At the prompt, enter the link.
  8416. Completion can be used to insert any of the link protocol prefixes like
  8417. http or ftp in use.
  8418. The history can be used to select a link previously stored with
  8419. `org-store-link'. When the empty string is entered (i.e. if you just
  8420. press RET at the prompt), the link defaults to the most recently
  8421. stored link. As SPC triggers completion in the minibuffer, you need to
  8422. use M-SPC or C-q SPC to force the insertion of a space character.
  8423. You will also be prompted for a description, and if one is given, it will
  8424. be displayed in the buffer instead of the link.
  8425. If there is already a link at point, this command will allow you to edit link
  8426. and description parts.
  8427. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8428. be selected using completion. The path to the file will be relative to the
  8429. current directory if the file is in the current directory or a subdirectory.
  8430. Otherwise, the link will be the absolute path as completed in the minibuffer
  8431. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8432. option `org-link-file-path-type'.
  8433. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8434. the current directory or below.
  8435. With three \\[universal-argument] prefixes, negate the meaning of
  8436. `org-keep-stored-link-after-insertion'.
  8437. If `org-make-link-description-function' is non-nil, this function will be
  8438. called with the link target, and the result will be the default
  8439. link description.
  8440. If the LINK-LOCATION parameter is non-nil, this value will be
  8441. used as the link location instead of reading one interactively.
  8442. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8443. be used as the default description."
  8444. (interactive "P")
  8445. (let* ((wcf (current-window-configuration))
  8446. (region (if (org-region-active-p)
  8447. (buffer-substring (region-beginning) (region-end))))
  8448. (remove (and region (list (region-beginning) (region-end))))
  8449. (desc region)
  8450. tmphist ; byte-compile incorrectly complains about this
  8451. (link link-location)
  8452. (abbrevs org-link-abbrev-alist-local)
  8453. entry file all-prefixes auto-desc)
  8454. (cond
  8455. (link-location) ; specified by arg, just use it.
  8456. ((org-in-regexp org-bracket-link-regexp 1)
  8457. ;; We do have a link at point, and we are going to edit it.
  8458. (setq remove (list (match-beginning 0) (match-end 0)))
  8459. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8460. (setq link (read-string "Link: "
  8461. (org-link-unescape
  8462. (org-match-string-no-properties 1)))))
  8463. ((or (org-in-regexp org-angle-link-re)
  8464. (org-in-regexp org-plain-link-re))
  8465. ;; Convert to bracket link
  8466. (setq remove (list (match-beginning 0) (match-end 0))
  8467. link (read-string "Link: "
  8468. (org-remove-angle-brackets (match-string 0)))))
  8469. ((member complete-file '((4) (16)))
  8470. ;; Completing read for file names.
  8471. (setq link (org-file-complete-link complete-file)))
  8472. (t
  8473. ;; Read link, with completion for stored links.
  8474. (org-link-fontify-links-to-this-file)
  8475. (org-switch-to-buffer-other-window "*Org Links*")
  8476. (with-current-buffer "*Org Links*"
  8477. (erase-buffer)
  8478. (insert "Insert a link.
  8479. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  8480. (when org-stored-links
  8481. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  8482. (insert (mapconcat 'org-link-prettify
  8483. (reverse org-stored-links) "\n")))
  8484. (goto-char (point-min)))
  8485. (let ((cw (selected-window)))
  8486. (select-window (get-buffer-window "*Org Links*" 'visible))
  8487. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  8488. (unless (pos-visible-in-window-p (point-max))
  8489. (org-fit-window-to-buffer))
  8490. (and (window-live-p cw) (select-window cw)))
  8491. ;; Fake a link history, containing the stored links.
  8492. (setq tmphist (append (mapcar 'car org-stored-links)
  8493. org-insert-link-history))
  8494. (setq all-prefixes (append (mapcar 'car abbrevs)
  8495. (mapcar 'car org-link-abbrev-alist)
  8496. org-link-types))
  8497. (unwind-protect
  8498. (progn
  8499. (setq link
  8500. (let ((org-completion-use-ido nil)
  8501. (org-completion-use-iswitchb nil))
  8502. (org-completing-read
  8503. "Link: "
  8504. (append
  8505. (mapcar (lambda (x) (list (concat x ":")))
  8506. all-prefixes)
  8507. (mapcar 'car org-stored-links)
  8508. (mapcar 'cadr org-stored-links))
  8509. nil nil nil
  8510. 'tmphist
  8511. (caar org-stored-links))))
  8512. (if (not (string-match "\\S-" link))
  8513. (error "No link selected"))
  8514. (mapc (lambda(l)
  8515. (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
  8516. org-stored-links)
  8517. (if (or (member link all-prefixes)
  8518. (and (equal ":" (substring link -1))
  8519. (member (substring link 0 -1) all-prefixes)
  8520. (setq link (substring link 0 -1))))
  8521. (setq link (org-link-try-special-completion link))))
  8522. (set-window-configuration wcf)
  8523. (kill-buffer "*Org Links*"))
  8524. (setq entry (assoc link org-stored-links))
  8525. (or entry (push link org-insert-link-history))
  8526. (setq desc (or desc (nth 1 entry)))))
  8527. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  8528. (not org-keep-stored-link-after-insertion))
  8529. (setq org-stored-links (delq (assoc link org-stored-links)
  8530. org-stored-links)))
  8531. (if (string-match org-plain-link-re link)
  8532. ;; URL-like link, normalize the use of angular brackets.
  8533. (setq link (org-remove-angle-brackets link)))
  8534. ;; Check if we are linking to the current file with a search option
  8535. ;; If yes, simplify the link by using only the search option.
  8536. (when (and buffer-file-name
  8537. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  8538. (let* ((path (match-string 1 link))
  8539. (case-fold-search nil)
  8540. (search (match-string 2 link)))
  8541. (save-match-data
  8542. (if (equal (file-truename buffer-file-name) (file-truename path))
  8543. ;; We are linking to this same file, with a search option
  8544. (setq link search)))))
  8545. ;; Check if we can/should use a relative path. If yes, simplify the link
  8546. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  8547. (let* ((type (match-string 1 link))
  8548. (path (match-string 2 link))
  8549. (origpath path)
  8550. (case-fold-search nil))
  8551. (cond
  8552. ((or (eq org-link-file-path-type 'absolute)
  8553. (equal complete-file '(16)))
  8554. (setq path (abbreviate-file-name (expand-file-name path))))
  8555. ((eq org-link-file-path-type 'noabbrev)
  8556. (setq path (expand-file-name path)))
  8557. ((eq org-link-file-path-type 'relative)
  8558. (setq path (file-relative-name path)))
  8559. (t
  8560. (save-match-data
  8561. (if (string-match (concat "^" (regexp-quote
  8562. (expand-file-name
  8563. (file-name-as-directory
  8564. default-directory))))
  8565. (expand-file-name path))
  8566. ;; We are linking a file with relative path name.
  8567. (setq path (substring (expand-file-name path)
  8568. (match-end 0)))
  8569. (setq path (abbreviate-file-name (expand-file-name path)))))))
  8570. (setq link (concat type path))
  8571. (if (equal desc origpath)
  8572. (setq desc path))))
  8573. (if org-make-link-description-function
  8574. (setq desc (funcall org-make-link-description-function link desc))
  8575. (if default-description (setq desc default-description)
  8576. (setq desc (or (and auto-desc desc)
  8577. (read-string "Description: " desc)))))
  8578. (unless (string-match "\\S-" desc) (setq desc nil))
  8579. (if remove (apply 'delete-region remove))
  8580. (insert (org-make-link-string link desc))))
  8581. (defun org-link-try-special-completion (type)
  8582. "If there is completion support for link type TYPE, offer it."
  8583. (let ((fun (intern (concat "org-" type "-complete-link"))))
  8584. (if (functionp fun)
  8585. (funcall fun)
  8586. (read-string "Link (no completion support): " (concat type ":")))))
  8587. (defun org-file-complete-link (&optional arg)
  8588. "Create a file link using completion."
  8589. (let (file link)
  8590. (setq file (read-file-name "File: "))
  8591. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  8592. (pwd1 (file-name-as-directory (abbreviate-file-name
  8593. (expand-file-name ".")))))
  8594. (cond
  8595. ((equal arg '(16))
  8596. (setq link (concat
  8597. "file:"
  8598. (abbreviate-file-name (expand-file-name file)))))
  8599. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  8600. (setq link (concat "file:" (match-string 1 file))))
  8601. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  8602. (expand-file-name file))
  8603. (setq link (concat
  8604. "file:" (match-string 1 (expand-file-name file)))))
  8605. (t (setq link (concat "file:" file)))))
  8606. link))
  8607. (defun org-completing-read (&rest args)
  8608. "Completing-read with SPACE being a normal character."
  8609. (let ((enable-recursive-minibuffers t)
  8610. (minibuffer-local-completion-map
  8611. (copy-keymap minibuffer-local-completion-map)))
  8612. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  8613. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  8614. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  8615. (apply 'org-icompleting-read args)))
  8616. (defun org-completing-read-no-i (&rest args)
  8617. (let (org-completion-use-ido org-completion-use-iswitchb)
  8618. (apply 'org-completing-read args)))
  8619. (defun org-iswitchb-completing-read (prompt choices &rest args)
  8620. "Use iswitch as a completing-read replacement to choose from choices.
  8621. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  8622. from."
  8623. (let* ((iswitchb-use-virtual-buffers nil)
  8624. (iswitchb-make-buflist-hook
  8625. (lambda ()
  8626. (setq iswitchb-temp-buflist choices))))
  8627. (iswitchb-read-buffer prompt)))
  8628. (defun org-icompleting-read (&rest args)
  8629. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  8630. (org-without-partial-completion
  8631. (if (and org-completion-use-ido
  8632. (fboundp 'ido-completing-read)
  8633. (boundp 'ido-mode) ido-mode
  8634. (listp (second args)))
  8635. (let ((ido-enter-matching-directory nil))
  8636. (apply 'ido-completing-read (concat (car args))
  8637. (if (consp (car (nth 1 args)))
  8638. (mapcar 'car (nth 1 args))
  8639. (nth 1 args))
  8640. (cddr args)))
  8641. (if (and org-completion-use-iswitchb
  8642. (boundp 'iswitchb-mode) iswitchb-mode
  8643. (listp (second args)))
  8644. (apply 'org-iswitchb-completing-read (concat (car args))
  8645. (if (consp (car (nth 1 args)))
  8646. (mapcar 'car (nth 1 args))
  8647. (nth 1 args))
  8648. (cddr args))
  8649. (apply 'completing-read args)))))
  8650. (defun org-extract-attributes (s)
  8651. "Extract the attributes cookie from a string and set as text property."
  8652. (let (a attr (start 0) key value)
  8653. (save-match-data
  8654. (when (string-match "{{\\([^}]+\\)}}$" s)
  8655. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  8656. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  8657. (setq key (match-string 1 a) value (match-string 2 a)
  8658. start (match-end 0)
  8659. attr (plist-put attr (intern key) value))))
  8660. (org-add-props s nil 'org-attr attr))
  8661. s))
  8662. (defun org-extract-attributes-from-string (tag)
  8663. (let (key value attr)
  8664. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  8665. (setq key (match-string 1 tag) value (match-string 2 tag)
  8666. tag (replace-match "" t t tag)
  8667. attr (plist-put attr (intern key) value)))
  8668. (cons tag attr)))
  8669. (defun org-attributes-to-string (plist)
  8670. "Format a property list into an HTML attribute list."
  8671. (let ((s "") key value)
  8672. (while plist
  8673. (setq key (pop plist) value (pop plist))
  8674. (and value
  8675. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  8676. s))
  8677. ;;; Opening/following a link
  8678. (defvar org-link-search-failed nil)
  8679. (defvar org-open-link-functions nil
  8680. "Hook for functions finding a plain text link.
  8681. These functions must take a single argument, the link content.
  8682. They will be called for links that look like [[link text][description]]
  8683. when LINK TEXT does not have a protocol like \"http:\" and does not look
  8684. like a filename (e.g. \"./blue.png\").
  8685. These functions will be called *before* Org attempts to resolve the
  8686. link by doing text searches in the current buffer - so if you want a
  8687. link \"[[target]]\" to still find \"<<target>>\", your function should
  8688. handle this as a special case.
  8689. When the function does handle the link, it must return a non-nil value.
  8690. If it decides that it is not responsible for this link, it must return
  8691. nil to indicate that that Org-mode can continue with other options
  8692. like exact and fuzzy text search.")
  8693. (defun org-next-link ()
  8694. "Move forward to the next link.
  8695. If the link is in hidden text, expose it."
  8696. (interactive)
  8697. (when (and org-link-search-failed (eq this-command last-command))
  8698. (goto-char (point-min))
  8699. (message "Link search wrapped back to beginning of buffer"))
  8700. (setq org-link-search-failed nil)
  8701. (let* ((pos (point))
  8702. (ct (org-context))
  8703. (a (assoc :link ct)))
  8704. (if a (goto-char (nth 2 a)))
  8705. (if (re-search-forward org-any-link-re nil t)
  8706. (progn
  8707. (goto-char (match-beginning 0))
  8708. (if (outline-invisible-p) (org-show-context)))
  8709. (goto-char pos)
  8710. (setq org-link-search-failed t)
  8711. (error "No further link found"))))
  8712. (defun org-previous-link ()
  8713. "Move backward to the previous link.
  8714. If the link is in hidden text, expose it."
  8715. (interactive)
  8716. (when (and org-link-search-failed (eq this-command last-command))
  8717. (goto-char (point-max))
  8718. (message "Link search wrapped back to end of buffer"))
  8719. (setq org-link-search-failed nil)
  8720. (let* ((pos (point))
  8721. (ct (org-context))
  8722. (a (assoc :link ct)))
  8723. (if a (goto-char (nth 1 a)))
  8724. (if (re-search-backward org-any-link-re nil t)
  8725. (progn
  8726. (goto-char (match-beginning 0))
  8727. (if (outline-invisible-p) (org-show-context)))
  8728. (goto-char pos)
  8729. (setq org-link-search-failed t)
  8730. (error "No further link found"))))
  8731. (defun org-translate-link (s)
  8732. "Translate a link string if a translation function has been defined."
  8733. (if (and org-link-translation-function
  8734. (fboundp org-link-translation-function)
  8735. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  8736. (progn
  8737. (setq s (funcall org-link-translation-function
  8738. (match-string 1 s) (match-string 2 s)))
  8739. (concat (car s) ":" (cdr s)))
  8740. s))
  8741. (defun org-translate-link-from-planner (type path)
  8742. "Translate a link from Emacs Planner syntax so that Org can follow it.
  8743. This is still an experimental function, your mileage may vary."
  8744. (cond
  8745. ((member type '("http" "https" "news" "ftp"))
  8746. ;; standard Internet links are the same.
  8747. nil)
  8748. ((and (equal type "irc") (string-match "^//" path))
  8749. ;; Planner has two / at the beginning of an irc link, we have 1.
  8750. ;; We should have zero, actually....
  8751. (setq path (substring path 1)))
  8752. ((and (equal type "lisp") (string-match "^/" path))
  8753. ;; Planner has a slash, we do not.
  8754. (setq type "elisp" path (substring path 1)))
  8755. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  8756. ;; A typical message link. Planner has the id after the final slash,
  8757. ;; we separate it with a hash mark
  8758. (setq path (concat (match-string 1 path) "#"
  8759. (org-remove-angle-brackets (match-string 2 path)))))
  8760. )
  8761. (cons type path))
  8762. (defun org-find-file-at-mouse (ev)
  8763. "Open file link or URL at mouse."
  8764. (interactive "e")
  8765. (mouse-set-point ev)
  8766. (org-open-at-point 'in-emacs))
  8767. (defun org-open-at-mouse (ev)
  8768. "Open file link or URL at mouse.
  8769. See the docstring of `org-open-file' for details."
  8770. (interactive "e")
  8771. (mouse-set-point ev)
  8772. (if (eq major-mode 'org-agenda-mode)
  8773. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  8774. (org-open-at-point))
  8775. (defvar org-window-config-before-follow-link nil
  8776. "The window configuration before following a link.
  8777. This is saved in case the need arises to restore it.")
  8778. (defvar org-open-link-marker (make-marker)
  8779. "Marker pointing to the location where `org-open-at-point; was called.")
  8780. ;;;###autoload
  8781. (defun org-open-at-point-global ()
  8782. "Follow a link like Org-mode does.
  8783. This command can be called in any mode to follow a link that has
  8784. Org-mode syntax."
  8785. (interactive)
  8786. (org-run-like-in-org-mode 'org-open-at-point))
  8787. ;;;###autoload
  8788. (defun org-open-link-from-string (s &optional arg reference-buffer)
  8789. "Open a link in the string S, as if it was in Org-mode."
  8790. (interactive "sLink: \nP")
  8791. (let ((reference-buffer (or reference-buffer (current-buffer))))
  8792. (with-temp-buffer
  8793. (let ((org-inhibit-startup (not reference-buffer)))
  8794. (org-mode)
  8795. (insert s)
  8796. (goto-char (point-min))
  8797. (when reference-buffer
  8798. (setq org-link-abbrev-alist-local
  8799. (with-current-buffer reference-buffer
  8800. org-link-abbrev-alist-local)))
  8801. (org-open-at-point arg reference-buffer)))))
  8802. (defvar org-open-at-point-functions nil
  8803. "Hook that is run when following a link at point.
  8804. Functions in this hook must return t if they identify and follow
  8805. a link at point. If they don't find anything interesting at point,
  8806. they must return nil.")
  8807. (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
  8808. (defun org-open-at-point (&optional arg reference-buffer)
  8809. "Open link at or after point.
  8810. If there is no link at point, this function will search forward up to
  8811. the end of the current line.
  8812. Normally, files will be opened by an appropriate application. If the
  8813. optional prefix argument ARG is non-nil, Emacs will visit the file.
  8814. With a double prefix argument, try to open outside of Emacs, in the
  8815. application the system uses for this file type."
  8816. (interactive "P")
  8817. ;; if in a code block, then open the block's results
  8818. (unless (call-interactively #'org-babel-open-src-block-result)
  8819. (org-load-modules-maybe)
  8820. (move-marker org-open-link-marker (point))
  8821. (setq org-window-config-before-follow-link (current-window-configuration))
  8822. (org-remove-occur-highlights nil nil t)
  8823. (cond
  8824. ((and (org-at-heading-p)
  8825. (not (org-at-timestamp-p t))
  8826. (not (org-in-regexp
  8827. (concat org-plain-link-re "\\|"
  8828. org-bracket-link-regexp "\\|"
  8829. org-angle-link-re "\\|"
  8830. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8831. (not (get-text-property (point) 'org-linked-text)))
  8832. (or (org-offer-links-in-entry arg)
  8833. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8834. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  8835. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  8836. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8837. (not (org-in-regexp org-bracket-link-regexp)))
  8838. (org-footnote-action))
  8839. (t
  8840. (let (type path link line search (pos (point)))
  8841. (catch 'match
  8842. (save-excursion
  8843. (skip-chars-forward "^]\n\r")
  8844. (when (org-in-regexp org-bracket-link-regexp 1)
  8845. (setq link (org-extract-attributes
  8846. (org-link-unescape (org-match-string-no-properties 1))))
  8847. (while (string-match " *\n *" link)
  8848. (setq link (replace-match " " t t link)))
  8849. (setq link (org-link-expand-abbrev link))
  8850. (cond
  8851. ((or (file-name-absolute-p link)
  8852. (string-match "^\\.\\.?/" link))
  8853. (setq type "file" path link))
  8854. ((string-match org-link-re-with-space3 link)
  8855. (setq type (match-string 1 link) path (match-string 2 link)))
  8856. ((string-match "^help:+\\(.+\\)" link)
  8857. (setq type "help" path (match-string 1 link)))
  8858. (t (setq type "thisfile" path link)))
  8859. (throw 'match t)))
  8860. (when (get-text-property (point) 'org-linked-text)
  8861. (setq type "thisfile"
  8862. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8863. (1+ (point)) (point))
  8864. path (buffer-substring
  8865. (or (previous-single-property-change pos 'org-linked-text)
  8866. (point-min))
  8867. (or (next-single-property-change pos 'org-linked-text)
  8868. (point-max))))
  8869. (throw 'match t))
  8870. (save-excursion
  8871. (when (or (org-in-regexp org-angle-link-re)
  8872. (and (goto-char (car (org-in-regexp org-plain-link-re)))
  8873. (save-match-data (not (looking-back "\\[\\[")))))
  8874. (setq type (match-string 1)
  8875. path (org-link-unescape (match-string 2)))
  8876. (throw 'match t)))
  8877. (save-excursion
  8878. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  8879. (setq type "tags"
  8880. path (match-string 1))
  8881. (while (string-match ":" path)
  8882. (setq path (replace-match "+" t t path)))
  8883. (throw 'match t)))
  8884. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8885. (setq type "tree-match"
  8886. path (match-string 1))
  8887. (throw 'match t)))
  8888. (unless path
  8889. (error "No link found"))
  8890. ;; switch back to reference buffer
  8891. ;; needed when if called in a temporary buffer through
  8892. ;; org-open-link-from-string
  8893. (with-current-buffer (or reference-buffer (current-buffer))
  8894. ;; Remove any trailing spaces in path
  8895. (if (string-match " +\\'" path)
  8896. (setq path (replace-match "" t t path)))
  8897. (if (and org-link-translation-function
  8898. (fboundp org-link-translation-function))
  8899. ;; Check if we need to translate the link
  8900. (let ((tmp (funcall org-link-translation-function type path)))
  8901. (setq type (car tmp) path (cdr tmp))))
  8902. (cond
  8903. ((assoc type org-link-protocols)
  8904. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8905. ((equal type "help")
  8906. (let ((f-or-v (intern path)))
  8907. (cond ((fboundp f-or-v)
  8908. (describe-function f-or-v))
  8909. ((boundp f-or-v)
  8910. (describe-variable f-or-v))
  8911. (t (error "Not a known function or variable")))))
  8912. ((equal type "mailto")
  8913. (let ((cmd (car org-link-mailto-program))
  8914. (args (cdr org-link-mailto-program)) args1
  8915. (address path) (subject "") a)
  8916. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8917. (setq address (match-string 1 path)
  8918. subject (org-link-escape (match-string 2 path))))
  8919. (while args
  8920. (cond
  8921. ((not (stringp (car args))) (push (pop args) args1))
  8922. (t (setq a (pop args))
  8923. (if (string-match "%a" a)
  8924. (setq a (replace-match address t t a)))
  8925. (if (string-match "%s" a)
  8926. (setq a (replace-match subject t t a)))
  8927. (push a args1))))
  8928. (apply cmd (nreverse args1))))
  8929. ((member type '("http" "https" "ftp" "news"))
  8930. (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
  8931. (org-link-escape
  8932. path org-link-escape-chars-browser)
  8933. path))))
  8934. ((string= type "doi")
  8935. (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
  8936. (org-link-escape
  8937. path org-link-escape-chars-browser)
  8938. path))))
  8939. ((member type '("message"))
  8940. (browse-url (concat type ":" path)))
  8941. ((string= type "tags")
  8942. (org-tags-view arg path))
  8943. ((string= type "tree-match")
  8944. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8945. ((string= type "file")
  8946. (if (string-match "::\\([0-9]+\\)\\'" path)
  8947. (setq line (string-to-number (match-string 1 path))
  8948. path (substring path 0 (match-beginning 0)))
  8949. (if (string-match "::\\(.+\\)\\'" path)
  8950. (setq search (match-string 1 path)
  8951. path (substring path 0 (match-beginning 0)))))
  8952. (if (string-match "[*?{]" (file-name-nondirectory path))
  8953. (dired path)
  8954. (org-open-file path arg line search)))
  8955. ((string= type "shell")
  8956. (let ((buf (generate-new-buffer "*Org Shell Output"))
  8957. (cmd path))
  8958. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  8959. (string-match org-confirm-shell-link-not-regexp cmd))
  8960. (not org-confirm-shell-link-function)
  8961. (funcall org-confirm-shell-link-function
  8962. (format "Execute \"%s\" in shell? "
  8963. (org-add-props cmd nil
  8964. 'face 'org-warning))))
  8965. (progn
  8966. (message "Executing %s" cmd)
  8967. (shell-command cmd buf)
  8968. (if (featurep 'midnight)
  8969. (setq clean-buffer-list-kill-buffer-names
  8970. (cons buf clean-buffer-list-kill-buffer-names))))
  8971. (error "Abort"))))
  8972. ((string= type "elisp")
  8973. (let ((cmd path))
  8974. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  8975. (string-match org-confirm-elisp-link-not-regexp cmd))
  8976. (not org-confirm-elisp-link-function)
  8977. (funcall org-confirm-elisp-link-function
  8978. (format "Execute \"%s\" as elisp? "
  8979. (org-add-props cmd nil
  8980. 'face 'org-warning))))
  8981. (message "%s => %s" cmd
  8982. (if (equal (string-to-char cmd) ?\()
  8983. (eval (read cmd))
  8984. (call-interactively (read cmd))))
  8985. (error "Abort"))))
  8986. ((and (string= type "thisfile")
  8987. (run-hook-with-args-until-success
  8988. 'org-open-link-functions path)))
  8989. ((string= type "thisfile")
  8990. (if arg
  8991. (switch-to-buffer-other-window
  8992. (org-get-buffer-for-internal-link (current-buffer)))
  8993. (org-mark-ring-push))
  8994. (let ((cmd `(org-link-search
  8995. ,path
  8996. ,(cond ((equal arg '(4)) ''occur)
  8997. ((equal arg '(16)) ''org-occur))
  8998. ,pos)))
  8999. (condition-case nil (let ((org-link-search-inhibit-query t))
  9000. (eval cmd))
  9001. (error (progn (widen) (eval cmd))))))
  9002. (t (browse-url-at-point)))))))
  9003. (move-marker org-open-link-marker nil)
  9004. (run-hook-with-args 'org-follow-link-hook)))
  9005. (defun org-offer-links-in-entry (&optional nth zero)
  9006. "Offer links in the current entry and follow the selected link.
  9007. If there is only one link, follow it immediately as well.
  9008. If NTH is an integer, immediately pick the NTH link found.
  9009. If ZERO is a string, check also this string for a link, and if
  9010. there is one, offer it as link number zero."
  9011. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  9012. "\\(" org-angle-link-re "\\)\\|"
  9013. "\\(" org-plain-link-re "\\)"))
  9014. (cnt ?0)
  9015. (in-emacs (if (integerp nth) nil nth))
  9016. have-zero end links link c)
  9017. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  9018. (push (match-string 0 zero) links)
  9019. (setq cnt (1- cnt) have-zero t))
  9020. (save-excursion
  9021. (org-back-to-heading t)
  9022. (setq end (save-excursion (outline-next-heading) (point)))
  9023. (while (re-search-forward re end t)
  9024. (push (match-string 0) links))
  9025. (setq links (org-uniquify (reverse links))))
  9026. (cond
  9027. ((null links)
  9028. (message "No links"))
  9029. ((equal (length links) 1)
  9030. (setq link (list (car links))))
  9031. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  9032. (setq link (list (nth (if have-zero nth (1- nth)) links))))
  9033. (t ; we have to select a link
  9034. (save-excursion
  9035. (save-window-excursion
  9036. (delete-other-windows)
  9037. (with-output-to-temp-buffer "*Select Link*"
  9038. (mapc (lambda (l)
  9039. (if (not (string-match org-bracket-link-regexp l))
  9040. (princ (format "[%c] %s\n" (incf cnt)
  9041. (org-remove-angle-brackets l)))
  9042. (if (match-end 3)
  9043. (princ (format "[%c] %s (%s)\n" (incf cnt)
  9044. (match-string 3 l) (match-string 1 l)))
  9045. (princ (format "[%c] %s\n" (incf cnt)
  9046. (match-string 1 l))))))
  9047. links))
  9048. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  9049. (message "Select link to open, RET to open all:")
  9050. (setq c (read-char-exclusive))
  9051. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  9052. (when (equal c ?q) (error "Abort"))
  9053. (if (equal c ?\C-m)
  9054. (setq link links)
  9055. (setq nth (- c ?0))
  9056. (if have-zero (setq nth (1+ nth)))
  9057. (unless (and (integerp nth) (>= (length links) nth))
  9058. (error "Invalid link selection"))
  9059. (setq link (list (nth (1- nth) links))))))
  9060. (if link
  9061. (let ((buf (current-buffer)))
  9062. (dolist (l link)
  9063. (org-open-link-from-string l in-emacs buf))
  9064. t)
  9065. nil)))
  9066. ;; Add special file links that specify the way of opening
  9067. (org-add-link-type "file+sys" 'org-open-file-with-system)
  9068. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  9069. (defun org-open-file-with-system (path)
  9070. "Open file at PATH using the system way of opening it."
  9071. (org-open-file path 'system))
  9072. (defun org-open-file-with-emacs (path)
  9073. "Open file at PATH in Emacs."
  9074. (org-open-file path 'emacs))
  9075. (defun org-remove-file-link-modifiers ()
  9076. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  9077. (goto-char (point-min))
  9078. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  9079. (org-if-unprotected
  9080. (replace-match "file:" t t))))
  9081. (eval-after-load "org-exp"
  9082. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  9083. 'org-remove-file-link-modifiers))
  9084. ;;;; Time estimates
  9085. (defun org-get-effort (&optional pom)
  9086. "Get the effort estimate for the current entry."
  9087. (org-entry-get pom org-effort-property))
  9088. ;;; File search
  9089. (defvar org-create-file-search-functions nil
  9090. "List of functions to construct the right search string for a file link.
  9091. These functions are called in turn with point at the location to
  9092. which the link should point.
  9093. A function in the hook should first test if it would like to
  9094. handle this file type, for example by checking the `major-mode'
  9095. or the file extension. If it decides not to handle this file, it
  9096. should just return nil to give other functions a chance. If it
  9097. does handle the file, it must return the search string to be used
  9098. when following the link. The search string will be part of the
  9099. file link, given after a double colon, and `org-open-at-point'
  9100. will automatically search for it. If special measures must be
  9101. taken to make the search successful, another function should be
  9102. added to the companion hook `org-execute-file-search-functions',
  9103. which see.
  9104. A function in this hook may also use `setq' to set the variable
  9105. `description' to provide a suggestion for the descriptive text to
  9106. be used for this link when it gets inserted into an Org-mode
  9107. buffer with \\[org-insert-link].")
  9108. (defvar org-execute-file-search-functions nil
  9109. "List of functions to execute a file search triggered by a link.
  9110. Functions added to this hook must accept a single argument, the
  9111. search string that was part of the file link, the part after the
  9112. double colon. The function must first check if it would like to
  9113. handle this search, for example by checking the `major-mode' or
  9114. the file extension. If it decides not to handle this search, it
  9115. should just return nil to give other functions a chance. If it
  9116. does handle the search, it must return a non-nil value to keep
  9117. other functions from trying.
  9118. Each function can access the current prefix argument through the
  9119. variable `current-prefix-argument'. Note that a single prefix is
  9120. used to force opening a link in Emacs, so it may be good to only
  9121. use a numeric or double prefix to guide the search function.
  9122. In case this is needed, a function in this hook can also restore
  9123. the window configuration before `org-open-at-point' was called using:
  9124. (set-window-configuration org-window-config-before-follow-link)")
  9125. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  9126. (defun org-link-search (s &optional type avoid-pos stealth)
  9127. "Search for a link search option.
  9128. If S is surrounded by forward slashes, it is interpreted as a
  9129. regular expression. In org-mode files, this will create an `org-occur'
  9130. sparse tree. In ordinary files, `occur' will be used to list matches.
  9131. If the current buffer is in `dired-mode', grep will be used to search
  9132. in all files. If AVOID-POS is given, ignore matches near that position.
  9133. When optional argument STEALTH is non-nil, do not modify
  9134. visibility around point, thus ignoring
  9135. `org-show-hierarchy-above', `org-show-following-heading' and
  9136. `org-show-siblings' variables."
  9137. (let ((case-fold-search t)
  9138. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  9139. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  9140. (append '(("") (" ") ("\t") ("\n"))
  9141. org-emphasis-alist)
  9142. "\\|") "\\)"))
  9143. (pos (point))
  9144. (pre nil) (post nil)
  9145. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  9146. (cond
  9147. ;; First check if there are any special search functions
  9148. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9149. ;; Now try the builtin stuff
  9150. ((and (equal (string-to-char s0) ?#)
  9151. (> (length s0) 1)
  9152. (save-excursion
  9153. (goto-char (point-min))
  9154. (and
  9155. (re-search-forward
  9156. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  9157. (setq type 'dedicated
  9158. pos (match-beginning 0))))
  9159. ;; There is an exact target for this
  9160. (goto-char pos)
  9161. (org-back-to-heading t)))
  9162. ((save-excursion
  9163. (goto-char (point-min))
  9164. (and
  9165. (re-search-forward
  9166. (concat "<<" (regexp-quote s0) ">>") nil t)
  9167. (setq type 'dedicated
  9168. pos (match-beginning 0))))
  9169. ;; There is an exact target for this
  9170. (goto-char pos))
  9171. ((save-excursion
  9172. (goto-char (point-min))
  9173. (and
  9174. (re-search-forward
  9175. (format "^[ \t]*#\\+TARGET: %s" (regexp-quote s0)) nil t)
  9176. (setq type 'dedicated pos (match-beginning 0))))
  9177. ;; Found an invisible target.
  9178. (goto-char pos))
  9179. ((save-excursion
  9180. (goto-char (point-min))
  9181. (and
  9182. (re-search-forward
  9183. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9184. (setq type 'dedicated pos (match-beginning 0))))
  9185. ;; Found an element with a matching #+name affiliated keyword.
  9186. (goto-char pos))
  9187. ((and (string-match "^(\\(.*\\))$" s0)
  9188. (save-excursion
  9189. (goto-char (point-min))
  9190. (and
  9191. (re-search-forward
  9192. (concat "[^[]" (regexp-quote
  9193. (format org-coderef-label-format
  9194. (match-string 1 s0))))
  9195. nil t)
  9196. (setq type 'dedicated
  9197. pos (1+ (match-beginning 0))))))
  9198. ;; There is a coderef target for this
  9199. (goto-char pos))
  9200. ((string-match "^/\\(.*\\)/$" s)
  9201. ;; A regular expression
  9202. (cond
  9203. ((derived-mode-p 'org-mode)
  9204. (org-occur (match-string 1 s)))
  9205. ;;((eq major-mode 'dired-mode)
  9206. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  9207. (t (org-do-occur (match-string 1 s)))))
  9208. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9209. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9210. (goto-char (point-min))
  9211. (cond
  9212. ((let (case-fold-search)
  9213. (re-search-forward (format org-complex-heading-regexp-format
  9214. (regexp-quote s))
  9215. nil t))
  9216. ;; OK, found a match
  9217. (setq type 'dedicated)
  9218. (goto-char (match-beginning 0)))
  9219. ((and (not org-link-search-inhibit-query)
  9220. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9221. (y-or-n-p "No match - create this as a new heading? "))
  9222. (goto-char (point-max))
  9223. (or (bolp) (newline))
  9224. (insert "* " s "\n")
  9225. (beginning-of-line 0))
  9226. (t
  9227. (goto-char pos)
  9228. (error "No match"))))
  9229. (t
  9230. ;; A normal search string
  9231. (when (equal (string-to-char s) ?*)
  9232. ;; Anchor on headlines, post may include tags.
  9233. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9234. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9235. s (substring s 1)))
  9236. (remove-text-properties
  9237. 0 (length s)
  9238. '(face nil mouse-face nil keymap nil fontified nil) s)
  9239. ;; Make a series of regular expressions to find a match
  9240. (setq words (org-split-string s "[ \n\r\t]+")
  9241. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9242. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9243. "\\)" markers)
  9244. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  9245. re2a (concat "[ \t\r\n]" re2a_)
  9246. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9247. re4 (concat "[^a-zA-Z_]" re4_)
  9248. re1 (concat pre re2 post)
  9249. re3 (concat pre (if pre re4_ re4) post)
  9250. re5 (concat pre ".*" re4)
  9251. re2 (concat pre re2)
  9252. re2a (concat pre (if pre re2a_ re2a))
  9253. re4 (concat pre (if pre re4_ re4))
  9254. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9255. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9256. re5 "\\)"
  9257. ))
  9258. (cond
  9259. ((eq type 'org-occur) (org-occur reall))
  9260. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9261. (t (goto-char (point-min))
  9262. (setq type 'fuzzy)
  9263. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  9264. (org-search-not-self 1 re1 nil t)
  9265. (org-search-not-self 1 re2 nil t)
  9266. (org-search-not-self 1 re2a nil t)
  9267. (org-search-not-self 1 re3 nil t)
  9268. (org-search-not-self 1 re4 nil t)
  9269. (org-search-not-self 1 re5 nil t)
  9270. )
  9271. (goto-char (match-beginning 1))
  9272. (goto-char pos)
  9273. (error "No match"))))))
  9274. (and (derived-mode-p 'org-mode)
  9275. (not stealth)
  9276. (org-show-context 'link-search))
  9277. type))
  9278. (defun org-search-not-self (group &rest args)
  9279. "Execute `re-search-forward', but only accept matches that do not
  9280. enclose the position of `org-open-link-marker'."
  9281. (let ((m org-open-link-marker))
  9282. (catch 'exit
  9283. (while (apply 're-search-forward args)
  9284. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9285. (goto-char (match-end group))
  9286. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9287. (> (match-beginning 0) (marker-position m))
  9288. (< (match-end 0) (marker-position m)))
  9289. (save-match-data
  9290. (or (not (org-in-regexp
  9291. org-bracket-link-analytic-regexp 1))
  9292. (not (match-end 4)) ; no description
  9293. (and (<= (match-beginning 4) (point))
  9294. (>= (match-end 4) (point))))))
  9295. (throw 'exit (point))))))))
  9296. (defun org-get-buffer-for-internal-link (buffer)
  9297. "Return a buffer to be used for displaying the link target of internal links."
  9298. (cond
  9299. ((not org-display-internal-link-with-indirect-buffer)
  9300. buffer)
  9301. ((string-match "(Clone)$" (buffer-name buffer))
  9302. (message "Buffer is already a clone, not making another one")
  9303. ;; we also do not modify visibility in this case
  9304. buffer)
  9305. (t ; make a new indirect buffer for displaying the link
  9306. (let* ((bn (buffer-name buffer))
  9307. (ibn (concat bn "(Clone)"))
  9308. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9309. (with-current-buffer ib (org-overview))
  9310. ib))))
  9311. (defun org-do-occur (regexp &optional cleanup)
  9312. "Call the Emacs command `occur'.
  9313. If CLEANUP is non-nil, remove the printout of the regular expression
  9314. in the *Occur* buffer. This is useful if the regex is long and not useful
  9315. to read."
  9316. (occur regexp)
  9317. (when cleanup
  9318. (let ((cwin (selected-window)) win beg end)
  9319. (when (setq win (get-buffer-window "*Occur*"))
  9320. (select-window win))
  9321. (goto-char (point-min))
  9322. (when (re-search-forward "match[a-z]+" nil t)
  9323. (setq beg (match-end 0))
  9324. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9325. (setq end (1- (match-beginning 0)))))
  9326. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9327. (goto-char (point-min))
  9328. (select-window cwin))))
  9329. ;;; The mark ring for links jumps
  9330. (defvar org-mark-ring nil
  9331. "Mark ring for positions before jumps in Org-mode.")
  9332. (defvar org-mark-ring-last-goto nil
  9333. "Last position in the mark ring used to go back.")
  9334. ;; Fill and close the ring
  9335. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9336. (loop for i from 1 to org-mark-ring-length do
  9337. (push (make-marker) org-mark-ring))
  9338. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9339. org-mark-ring)
  9340. (defun org-mark-ring-push (&optional pos buffer)
  9341. "Put the current position or POS into the mark ring and rotate it."
  9342. (interactive)
  9343. (setq pos (or pos (point)))
  9344. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9345. (move-marker (car org-mark-ring)
  9346. (or pos (point))
  9347. (or buffer (current-buffer)))
  9348. (message "%s"
  9349. (substitute-command-keys
  9350. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9351. (defun org-mark-ring-goto (&optional n)
  9352. "Jump to the previous position in the mark ring.
  9353. With prefix arg N, jump back that many stored positions. When
  9354. called several times in succession, walk through the entire ring.
  9355. Org-mode commands jumping to a different position in the current file,
  9356. or to another Org-mode file, automatically push the old position
  9357. onto the ring."
  9358. (interactive "p")
  9359. (let (p m)
  9360. (if (eq last-command this-command)
  9361. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9362. (setq p org-mark-ring))
  9363. (setq org-mark-ring-last-goto p)
  9364. (setq m (car p))
  9365. (org-pop-to-buffer-same-window (marker-buffer m))
  9366. (goto-char m)
  9367. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9368. (defun org-remove-angle-brackets (s)
  9369. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9370. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9371. s)
  9372. (defun org-add-angle-brackets (s)
  9373. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9374. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9375. s)
  9376. (defun org-remove-double-quotes (s)
  9377. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9378. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9379. s)
  9380. ;;; Following specific links
  9381. (defun org-follow-timestamp-link ()
  9382. (cond
  9383. ((org-at-date-range-p t)
  9384. (let ((org-agenda-start-on-weekday)
  9385. (t1 (match-string 1))
  9386. (t2 (match-string 2)))
  9387. (setq t1 (time-to-days (org-time-string-to-time t1))
  9388. t2 (time-to-days (org-time-string-to-time t2)))
  9389. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  9390. ((org-at-timestamp-p t)
  9391. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9392. (substring (match-string 1) 0 10)))
  9393. 1))
  9394. (t (error "This should not happen"))))
  9395. ;;; Following file links
  9396. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9397. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9398. (declare-function mailcap-mime-info
  9399. "mailcap" (string &optional request no-decode))
  9400. (defvar org-wait nil)
  9401. (defun org-open-file (path &optional in-emacs line search)
  9402. "Open the file at PATH.
  9403. First, this expands any special file name abbreviations. Then the
  9404. configuration variable `org-file-apps' is checked if it contains an
  9405. entry for this file type, and if yes, the corresponding command is launched.
  9406. If no application is found, Emacs simply visits the file.
  9407. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9408. With a double \\[universal-argument] \\[universal-argument] \
  9409. prefix arg, Org tries to avoid opening in Emacs
  9410. and to use an external application to visit the file.
  9411. Optional LINE specifies a line to go to, optional SEARCH a string
  9412. to search for. If LINE or SEARCH is given, the file will be
  9413. opened in Emacs, unless an entry from org-file-apps that makes
  9414. use of groups in a regexp matches.
  9415. If you want to change the way frames are used when following a
  9416. link, please customize `org-link-frame-setup'.
  9417. If the file does not exist, an error is thrown."
  9418. (let* ((file (if (equal path "")
  9419. buffer-file-name
  9420. (substitute-in-file-name (expand-file-name path))))
  9421. (file-apps (append org-file-apps (org-default-apps)))
  9422. (apps (org-remove-if
  9423. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9424. (apps-dlink (org-remove-if-not
  9425. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9426. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9427. (dirp (if remp nil (file-directory-p file)))
  9428. (file (if (and dirp org-open-directory-means-index-dot-org)
  9429. (concat (file-name-as-directory file) "index.org")
  9430. file))
  9431. (a-m-a-p (assq 'auto-mode apps))
  9432. (dfile (downcase file))
  9433. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9434. (link (cond ((and (eq line nil)
  9435. (eq search nil))
  9436. file)
  9437. (line
  9438. (concat file "::" (number-to-string line)))
  9439. (search
  9440. (concat file "::" search))))
  9441. (dlink (downcase link))
  9442. (old-buffer (current-buffer))
  9443. (old-pos (point))
  9444. (old-mode major-mode)
  9445. ext cmd link-match-data)
  9446. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9447. (setq ext (match-string 1 dfile))
  9448. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9449. (setq ext (match-string 1 dfile))))
  9450. (cond
  9451. ((member in-emacs '((16) system))
  9452. (setq cmd (cdr (assoc 'system apps))))
  9453. (in-emacs (setq cmd 'emacs))
  9454. (t
  9455. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9456. (and dirp (cdr (assoc 'directory apps)))
  9457. ; first, try matching against apps-dlink
  9458. ; if we get a match here, store the match data for later
  9459. (let ((match (assoc-default dlink apps-dlink
  9460. 'string-match)))
  9461. (if match
  9462. (progn (setq link-match-data (match-data))
  9463. match)
  9464. (progn (setq in-emacs (or in-emacs line search))
  9465. nil))) ; if we have no match in apps-dlink,
  9466. ; always open the file in emacs if line or search
  9467. ; is given (for backwards compatibility)
  9468. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9469. 'string-match)
  9470. (cdr (assoc ext apps))
  9471. (cdr (assoc t apps))))))
  9472. (when (eq cmd 'system)
  9473. (setq cmd (cdr (assoc 'system apps))))
  9474. (when (eq cmd 'default)
  9475. (setq cmd (cdr (assoc t apps))))
  9476. (when (eq cmd 'mailcap)
  9477. (require 'mailcap)
  9478. (mailcap-parse-mailcaps)
  9479. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9480. (command (mailcap-mime-info mime-type)))
  9481. (if (stringp command)
  9482. (setq cmd command)
  9483. (setq cmd 'emacs))))
  9484. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  9485. (not (file-exists-p file))
  9486. (not org-open-non-existing-files))
  9487. (error "No such file: %s" file))
  9488. (cond
  9489. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  9490. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  9491. (while (string-match "['\"]%s['\"]" cmd)
  9492. (setq cmd (replace-match "%s" t t cmd)))
  9493. (while (string-match "%s" cmd)
  9494. (setq cmd (replace-match
  9495. (save-match-data
  9496. (shell-quote-argument
  9497. (convert-standard-filename file)))
  9498. t t cmd)))
  9499. ;; Replace "%1", "%2" etc. in command with group matches from regex
  9500. (save-match-data
  9501. (let ((match-index 1)
  9502. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  9503. (set-match-data link-match-data)
  9504. (while (<= match-index number-of-groups)
  9505. (let ((regex (concat "%" (number-to-string match-index)))
  9506. (replace-with (match-string match-index dlink)))
  9507. (while (string-match regex cmd)
  9508. (setq cmd (replace-match replace-with t t cmd))))
  9509. (setq match-index (+ match-index 1)))))
  9510. (save-window-excursion
  9511. (start-process-shell-command cmd nil cmd)
  9512. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  9513. ))
  9514. ((or (stringp cmd)
  9515. (eq cmd 'emacs))
  9516. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  9517. (widen)
  9518. (if line (org-goto-line line)
  9519. (if search (org-link-search search))))
  9520. ((consp cmd)
  9521. (let ((file (convert-standard-filename file)))
  9522. (save-match-data
  9523. (set-match-data link-match-data)
  9524. (eval cmd))))
  9525. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  9526. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  9527. (or (not (equal old-buffer (current-buffer)))
  9528. (not (equal old-pos (point))))
  9529. (org-mark-ring-push old-pos old-buffer))))
  9530. (defun org-file-apps-entry-match-against-dlink-p (entry)
  9531. "This function returns non-nil if `entry' uses a regular
  9532. expression which should be matched against the whole link by
  9533. org-open-file.
  9534. It assumes that is the case when the entry uses a regular
  9535. expression which has at least one grouping construct and the
  9536. action is either a lisp form or a command string containing
  9537. '%1', i.e. using at least one subexpression match as a
  9538. parameter."
  9539. (let ((selector (car entry))
  9540. (action (cdr entry)))
  9541. (if (stringp selector)
  9542. (and (> (regexp-opt-depth selector) 0)
  9543. (or (and (stringp action)
  9544. (string-match "%[0-9]" action))
  9545. (consp action)))
  9546. nil)))
  9547. (defun org-default-apps ()
  9548. "Return the default applications for this operating system."
  9549. (cond
  9550. ((eq system-type 'darwin)
  9551. org-file-apps-defaults-macosx)
  9552. ((eq system-type 'windows-nt)
  9553. org-file-apps-defaults-windowsnt)
  9554. (t org-file-apps-defaults-gnu)))
  9555. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  9556. "Convert extensions to regular expressions in the cars of LIST.
  9557. Also, weed out any non-string entries, because the return value is used
  9558. only for regexp matching.
  9559. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  9560. point to the symbol `emacs', indicating that the file should
  9561. be opened in Emacs."
  9562. (append
  9563. (delq nil
  9564. (mapcar (lambda (x)
  9565. (if (not (stringp (car x)))
  9566. nil
  9567. (if (string-match "\\W" (car x))
  9568. x
  9569. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  9570. list))
  9571. (if add-auto-mode
  9572. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  9573. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  9574. (defun org-file-remote-p (file)
  9575. "Test whether FILE specifies a location on a remote system.
  9576. Return non-nil if the location is indeed remote.
  9577. For example, the filename \"/user@host:/foo\" specifies a location
  9578. on the system \"/user@host:\"."
  9579. (cond ((fboundp 'file-remote-p)
  9580. (file-remote-p file))
  9581. ((fboundp 'tramp-handle-file-remote-p)
  9582. (tramp-handle-file-remote-p file))
  9583. ((and (boundp 'ange-ftp-name-format)
  9584. (string-match (car ange-ftp-name-format) file))
  9585. t)))
  9586. ;;;; Refiling
  9587. (defun org-get-org-file ()
  9588. "Read a filename, with default directory `org-directory'."
  9589. (let ((default (or org-default-notes-file remember-data-file)))
  9590. (read-file-name (format "File name [%s]: " default)
  9591. (file-name-as-directory org-directory)
  9592. default)))
  9593. (defun org-notes-order-reversed-p ()
  9594. "Check if the current file should receive notes in reversed order."
  9595. (cond
  9596. ((not org-reverse-note-order) nil)
  9597. ((eq t org-reverse-note-order) t)
  9598. ((not (listp org-reverse-note-order)) nil)
  9599. (t (catch 'exit
  9600. (let ((all org-reverse-note-order)
  9601. entry)
  9602. (while (setq entry (pop all))
  9603. (if (string-match (car entry) buffer-file-name)
  9604. (throw 'exit (cdr entry))))
  9605. nil)))))
  9606. (defvar org-refile-target-table nil
  9607. "The list of refile targets, created by `org-refile'.")
  9608. (defvar org-agenda-new-buffers nil
  9609. "Buffers created to visit agenda files.")
  9610. (defvar org-refile-cache nil
  9611. "Cache for refile targets.")
  9612. (defvar org-refile-markers nil
  9613. "All the markers used for caching refile locations.")
  9614. (defun org-refile-marker (pos)
  9615. "Get a new refile marker, but only if caching is in use."
  9616. (if (not org-refile-use-cache)
  9617. pos
  9618. (let ((m (make-marker)))
  9619. (move-marker m pos)
  9620. (push m org-refile-markers)
  9621. m)))
  9622. (defun org-refile-cache-clear ()
  9623. "Clear the refile cache and disable all the markers."
  9624. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  9625. (setq org-refile-markers nil)
  9626. (setq org-refile-cache nil)
  9627. (message "Refile cache has been cleared"))
  9628. (defun org-refile-cache-check-set (set)
  9629. "Check if all the markers in the cache still have live buffers."
  9630. (let (marker)
  9631. (catch 'exit
  9632. (while (and set (setq marker (nth 3 (pop set))))
  9633. ;; if org-refile-use-outline-path is 'file, marker may be nil
  9634. (when (and marker (null (marker-buffer marker)))
  9635. (message "not found") (sit-for 3)
  9636. (throw 'exit nil)))
  9637. t)))
  9638. (defun org-refile-cache-put (set &rest identifiers)
  9639. "Push the refile targets SET into the cache, under IDENTIFIERS."
  9640. (let* ((key (sha1 (prin1-to-string identifiers)))
  9641. (entry (assoc key org-refile-cache)))
  9642. (if entry
  9643. (setcdr entry set)
  9644. (push (cons key set) org-refile-cache))))
  9645. (defun org-refile-cache-get (&rest identifiers)
  9646. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  9647. (cond
  9648. ((not org-refile-cache) nil)
  9649. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  9650. (t
  9651. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  9652. org-refile-cache))))
  9653. (and set (org-refile-cache-check-set set) set)))))
  9654. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  9655. "Produce a table with refile targets."
  9656. (let ((case-fold-search nil)
  9657. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  9658. (entries (or org-refile-targets '((nil . (:level . 1)))))
  9659. targets tgs txt re files f desc descre fast-path-p level pos0)
  9660. (message "Getting targets...")
  9661. (with-current-buffer (or default-buffer (current-buffer))
  9662. (while (setq entry (pop entries))
  9663. (setq files (car entry) desc (cdr entry))
  9664. (setq fast-path-p nil)
  9665. (cond
  9666. ((null files) (setq files (list (current-buffer))))
  9667. ((eq files 'org-agenda-files)
  9668. (setq files (org-agenda-files 'unrestricted)))
  9669. ((and (symbolp files) (fboundp files))
  9670. (setq files (funcall files)))
  9671. ((and (symbolp files) (boundp files))
  9672. (setq files (symbol-value files))))
  9673. (if (stringp files) (setq files (list files)))
  9674. (cond
  9675. ((eq (car desc) :tag)
  9676. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  9677. ((eq (car desc) :todo)
  9678. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  9679. ((eq (car desc) :regexp)
  9680. (setq descre (cdr desc)))
  9681. ((eq (car desc) :level)
  9682. (setq descre (concat "^\\*\\{" (number-to-string
  9683. (if org-odd-levels-only
  9684. (1- (* 2 (cdr desc)))
  9685. (cdr desc)))
  9686. "\\}[ \t]")))
  9687. ((eq (car desc) :maxlevel)
  9688. (setq fast-path-p t)
  9689. (setq descre (concat "^\\*\\{1," (number-to-string
  9690. (if org-odd-levels-only
  9691. (1- (* 2 (cdr desc)))
  9692. (cdr desc)))
  9693. "\\}[ \t]")))
  9694. (t (error "Bad refiling target description %s" desc)))
  9695. (while (setq f (pop files))
  9696. (with-current-buffer
  9697. (if (bufferp f) f (org-get-agenda-file-buffer f))
  9698. (or
  9699. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  9700. (progn
  9701. (if (bufferp f) (setq f (buffer-file-name
  9702. (buffer-base-buffer f))))
  9703. (setq f (and f (expand-file-name f)))
  9704. (if (eq org-refile-use-outline-path 'file)
  9705. (push (list (file-name-nondirectory f) f nil nil) tgs))
  9706. (save-excursion
  9707. (save-restriction
  9708. (widen)
  9709. (goto-char (point-min))
  9710. (while (re-search-forward descre nil t)
  9711. (goto-char (setq pos0 (point-at-bol)))
  9712. (catch 'next
  9713. (when org-refile-target-verify-function
  9714. (save-match-data
  9715. (or (funcall org-refile-target-verify-function)
  9716. (throw 'next t))))
  9717. (when (and (looking-at org-complex-heading-regexp)
  9718. (not (member (match-string 4) excluded-entries))
  9719. (match-string 4))
  9720. (setq level (org-reduced-level
  9721. (- (match-end 1) (match-beginning 1)))
  9722. txt (org-link-display-format (match-string 4))
  9723. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  9724. re (format org-complex-heading-regexp-format
  9725. (regexp-quote (match-string 4))))
  9726. (when org-refile-use-outline-path
  9727. (setq txt (mapconcat
  9728. 'org-protect-slash
  9729. (append
  9730. (if (eq org-refile-use-outline-path
  9731. 'file)
  9732. (list (file-name-nondirectory
  9733. (buffer-file-name
  9734. (buffer-base-buffer))))
  9735. (if (eq org-refile-use-outline-path
  9736. 'full-file-path)
  9737. (list (buffer-file-name
  9738. (buffer-base-buffer)))))
  9739. (org-get-outline-path fast-path-p
  9740. level txt)
  9741. (list txt))
  9742. "/")))
  9743. (push (list txt f re (org-refile-marker (point)))
  9744. tgs)))
  9745. (when (= (point) pos0)
  9746. ;; verification function has not moved point
  9747. (goto-char (point-at-eol))))))))
  9748. (when org-refile-use-cache
  9749. (org-refile-cache-put tgs (buffer-file-name) descre))
  9750. (setq targets (append tgs targets))
  9751. ))))
  9752. (message "Getting targets...done")
  9753. (nreverse targets)))
  9754. (defun org-protect-slash (s)
  9755. (while (string-match "/" s)
  9756. (setq s (replace-match "\\" t t s)))
  9757. s)
  9758. (defvar org-olpa (make-vector 20 nil))
  9759. (defun org-get-outline-path (&optional fastp level heading)
  9760. "Return the outline path to the current entry, as a list.
  9761. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  9762. routine which makes outline path derivations for an entire file,
  9763. avoiding backtracing. Refile target collection makes use of that."
  9764. (if fastp
  9765. (progn
  9766. (if (> level 19)
  9767. (error "Outline path failure, more than 19 levels"))
  9768. (loop for i from level upto 19 do
  9769. (aset org-olpa i nil))
  9770. (prog1
  9771. (delq nil (append org-olpa nil))
  9772. (aset org-olpa level heading)))
  9773. (let (rtn case-fold-search)
  9774. (save-excursion
  9775. (save-restriction
  9776. (widen)
  9777. (while (org-up-heading-safe)
  9778. (when (looking-at org-complex-heading-regexp)
  9779. (push (org-match-string-no-properties 4) rtn)))
  9780. rtn)))))
  9781. (defun org-format-outline-path (path &optional width prefix)
  9782. "Format the outline path PATH for display.
  9783. Width is the maximum number of characters that is available.
  9784. Prefix is a prefix to be included in the returned string,
  9785. such as the file name."
  9786. (setq width (or width 79))
  9787. (if prefix (setq width (- width (length prefix))))
  9788. (if (not path)
  9789. (or prefix "")
  9790. (let* ((nsteps (length path))
  9791. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  9792. (maxwidth (if (<= total-width width)
  9793. 10000 ;; everything fits
  9794. ;; we need to shorten the level headings
  9795. (/ (- width nsteps) nsteps)))
  9796. (org-odd-levels-only nil)
  9797. (n 0)
  9798. (total (1+ (length prefix))))
  9799. (setq maxwidth (max maxwidth 10))
  9800. (concat prefix
  9801. (mapconcat
  9802. (lambda (h)
  9803. (setq n (1+ n))
  9804. (if (and (= n nsteps) (< maxwidth 10000))
  9805. (setq maxwidth (- total-width total)))
  9806. (if (< (length h) maxwidth)
  9807. (progn (setq total (+ total (length h) 1)) h)
  9808. (setq h (substring h 0 (- maxwidth 2))
  9809. total (+ total maxwidth 1))
  9810. (if (string-match "[ \t]+\\'" h)
  9811. (setq h (substring h 0 (match-beginning 0))))
  9812. (setq h (concat h "..")))
  9813. (org-add-props h nil 'face
  9814. (nth (% (1- n) org-n-level-faces)
  9815. org-level-faces))
  9816. h)
  9817. path "/")))))
  9818. (defun org-display-outline-path (&optional file current)
  9819. "Display the current outline path in the echo area."
  9820. (interactive "P")
  9821. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  9822. (case-fold-search nil)
  9823. (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
  9824. (if current (setq path (append path
  9825. (save-excursion
  9826. (org-back-to-heading t)
  9827. (if (looking-at org-complex-heading-regexp)
  9828. (list (match-string 4)))))))
  9829. (message "%s"
  9830. (org-format-outline-path
  9831. path
  9832. (1- (frame-width))
  9833. (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
  9834. (defvar org-refile-history nil
  9835. "History for refiling operations.")
  9836. (defvar org-after-refile-insert-hook nil
  9837. "Hook run after `org-refile' has inserted its stuff at the new location.
  9838. Note that this is still *before* the stuff will be removed from
  9839. the *old* location.")
  9840. (defvar org-capture-last-stored-marker)
  9841. (defun org-refile (&optional goto default-buffer rfloc)
  9842. "Move the entry or entries at point to another heading.
  9843. The list of target headings is compiled using the information in
  9844. `org-refile-targets', which see.
  9845. At the target location, the entry is filed as a subitem of the target
  9846. heading. Depending on `org-reverse-note-order', the new subitem will
  9847. either be the first or the last subitem.
  9848. If there is an active region, all entries in that region will be moved.
  9849. However, the region must fulfill the requirement that the first heading
  9850. is the first one sets the top-level of the moved text - at most siblings
  9851. below it are allowed.
  9852. With prefix arg GOTO, the command will only visit the target location
  9853. and not actually move anything.
  9854. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  9855. go to the location where the last refiling operation has put the subtree.
  9856. With a prefix argument of `2', refile to the running clock.
  9857. RFLOC can be a refile location obtained in a different way.
  9858. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  9859. If you are using target caching (see `org-refile-use-cache'),
  9860. you have to clear the target cache in order to find new targets.
  9861. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  9862. prefix argument (`C-u C-u C-u C-c C-w')."
  9863. (interactive "P")
  9864. (if (member goto '(0 (64)))
  9865. (org-refile-cache-clear)
  9866. (let* ((cbuf (current-buffer))
  9867. (regionp (org-region-active-p))
  9868. (region-start (and regionp (region-beginning)))
  9869. (region-end (and regionp (region-end)))
  9870. (region-length (and regionp (- region-end region-start)))
  9871. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9872. pos it nbuf file re level reversed)
  9873. (setq last-command nil)
  9874. (when regionp
  9875. (goto-char region-start)
  9876. (or (bolp) (goto-char (point-at-bol)))
  9877. (setq region-start (point))
  9878. (unless (or (org-kill-is-subtree-p
  9879. (buffer-substring region-start region-end))
  9880. (prog1 org-refile-active-region-within-subtree
  9881. (org-toggle-heading)))
  9882. (error "The region is not a (sequence of) subtree(s)")))
  9883. (if (equal goto '(16))
  9884. (org-refile-goto-last-stored)
  9885. (when (or
  9886. (and (equal goto 2)
  9887. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9888. (prog1
  9889. (setq it (list (or org-clock-heading "running clock")
  9890. (buffer-file-name
  9891. (marker-buffer org-clock-hd-marker))
  9892. ""
  9893. (marker-position org-clock-hd-marker)))
  9894. (setq goto nil)))
  9895. (setq it (or rfloc
  9896. (let (heading-text)
  9897. (save-excursion
  9898. (unless goto
  9899. (org-back-to-heading t)
  9900. (setq heading-text
  9901. (nth 4 (org-heading-components))))
  9902. (org-refile-get-location
  9903. (cond (goto "Goto")
  9904. (regionp "Refile region to")
  9905. (t (concat "Refile subtree \""
  9906. heading-text "\" to")))
  9907. default-buffer
  9908. (and (not (equal '(4) goto))
  9909. org-refile-allow-creating-parent-nodes)
  9910. goto))))))
  9911. (setq file (nth 1 it)
  9912. re (nth 2 it)
  9913. pos (nth 3 it))
  9914. (if (and (not goto)
  9915. pos
  9916. (equal (buffer-file-name) file)
  9917. (if regionp
  9918. (and (>= pos region-start)
  9919. (<= pos region-end))
  9920. (and (>= pos (point))
  9921. (< pos (save-excursion
  9922. (org-end-of-subtree t t))))))
  9923. (error "Cannot refile to position inside the tree or region"))
  9924. (setq nbuf (or (find-buffer-visiting file)
  9925. (find-file-noselect file)))
  9926. (if goto
  9927. (progn
  9928. (org-pop-to-buffer-same-window nbuf)
  9929. (goto-char pos)
  9930. (org-show-context 'org-goto))
  9931. (if regionp
  9932. (progn
  9933. (org-kill-new (buffer-substring region-start region-end))
  9934. (org-save-markers-in-region region-start region-end))
  9935. (org-copy-subtree 1 nil t))
  9936. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9937. (find-file-noselect file)))
  9938. (setq reversed (org-notes-order-reversed-p))
  9939. (save-excursion
  9940. (save-restriction
  9941. (widen)
  9942. (if pos
  9943. (progn
  9944. (goto-char pos)
  9945. (looking-at org-outline-regexp)
  9946. (setq level (org-get-valid-level (funcall outline-level) 1))
  9947. (goto-char
  9948. (if reversed
  9949. (or (outline-next-heading) (point-max))
  9950. (or (save-excursion (org-get-next-sibling))
  9951. (org-end-of-subtree t t)
  9952. (point-max)))))
  9953. (setq level 1)
  9954. (if (not reversed)
  9955. (goto-char (point-max))
  9956. (goto-char (point-min))
  9957. (or (outline-next-heading) (goto-char (point-max)))))
  9958. (if (not (bolp)) (newline))
  9959. (org-paste-subtree level)
  9960. (when org-log-refile
  9961. (org-add-log-setup 'refile nil nil 'findpos
  9962. org-log-refile)
  9963. (unless (eq org-log-refile 'note)
  9964. (save-excursion (org-add-log-note))))
  9965. (and org-auto-align-tags
  9966. (let ((org-loop-over-headlines-in-active-region nil))
  9967. (org-set-tags nil t)))
  9968. (bookmark-set "org-refile-last-stored")
  9969. ;; If we are refiling for capture, make sure that the
  9970. ;; last-capture pointers point here
  9971. (when (org-bound-and-true-p org-refile-for-capture)
  9972. (bookmark-set "org-capture-last-stored-marker")
  9973. (move-marker org-capture-last-stored-marker (point)))
  9974. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9975. (run-hooks 'org-after-refile-insert-hook))))
  9976. (if regionp
  9977. (delete-region (point) (+ (point) region-length))
  9978. (org-cut-subtree))
  9979. (when (featurep 'org-inlinetask)
  9980. (org-inlinetask-remove-END-maybe))
  9981. (setq org-markers-to-move nil)
  9982. (message "Refiled to \"%s\" in file %s" (car it) file)))))))
  9983. (defun org-refile-goto-last-stored ()
  9984. "Go to the location where the last refile was stored."
  9985. (interactive)
  9986. (bookmark-jump "org-refile-last-stored")
  9987. (message "This is the location of the last refile"))
  9988. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  9989. no-exclude)
  9990. "Prompt the user for a refile location, using PROMPT.
  9991. PROMPT should not be suffixed with a colon and a space, because
  9992. this function appends the default value from
  9993. `org-refile-history' automatically, if that is not empty.
  9994. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  9995. this is used for the GOTO interface."
  9996. (let ((org-refile-targets org-refile-targets)
  9997. (org-refile-use-outline-path org-refile-use-outline-path)
  9998. excluded-entries)
  9999. (when (and (derived-mode-p 'org-mode)
  10000. (not org-refile-use-cache)
  10001. (not no-exclude))
  10002. (org-map-tree
  10003. (lambda()
  10004. (setq excluded-entries
  10005. (append excluded-entries (list (org-get-heading t t)))))))
  10006. (setq org-refile-target-table
  10007. (org-refile-get-targets default-buffer excluded-entries)))
  10008. (unless org-refile-target-table
  10009. (error "No refile targets"))
  10010. (let* ((prompt (concat prompt
  10011. (and (car org-refile-history)
  10012. (concat " (default " (car org-refile-history) ")"))
  10013. ": "))
  10014. (cbuf (current-buffer))
  10015. (partial-completion-mode nil)
  10016. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  10017. (cfunc (if (and org-refile-use-outline-path
  10018. org-outline-path-complete-in-steps)
  10019. 'org-olpath-completing-read
  10020. 'org-icompleting-read))
  10021. (extra (if org-refile-use-outline-path "/" ""))
  10022. (filename (and cfn (expand-file-name cfn)))
  10023. (tbl (mapcar
  10024. (lambda (x)
  10025. (if (and (not (member org-refile-use-outline-path
  10026. '(file full-file-path)))
  10027. (not (equal filename (nth 1 x))))
  10028. (cons (concat (car x) extra " ("
  10029. (file-name-nondirectory (nth 1 x)) ")")
  10030. (cdr x))
  10031. (cons (concat (car x) extra) (cdr x))))
  10032. org-refile-target-table))
  10033. (completion-ignore-case t)
  10034. pa answ parent-target child parent old-hist)
  10035. (setq old-hist org-refile-history)
  10036. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  10037. nil 'org-refile-history (car org-refile-history)))
  10038. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  10039. (org-refile-check-position pa)
  10040. (if pa
  10041. (progn
  10042. (when (or (not org-refile-history)
  10043. (not (eq old-hist org-refile-history))
  10044. (not (equal (car pa) (car org-refile-history))))
  10045. (setq org-refile-history
  10046. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  10047. org-refile-history
  10048. (cdr org-refile-history))))
  10049. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  10050. (pop org-refile-history)))
  10051. pa)
  10052. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  10053. (progn
  10054. (setq parent (match-string 1 answ)
  10055. child (match-string 2 answ))
  10056. (setq parent-target (or (assoc parent tbl)
  10057. (assoc (concat parent "/") tbl)))
  10058. (when (and parent-target
  10059. (or (eq new-nodes t)
  10060. (and (eq new-nodes 'confirm)
  10061. (y-or-n-p (format "Create new node \"%s\"? "
  10062. child)))))
  10063. (org-refile-new-child parent-target child)))
  10064. (error "Invalid target location")))))
  10065. (declare-function org-string-nw-p "org-macs.el" (s))
  10066. (defun org-refile-check-position (refile-pointer)
  10067. "Check if the refile pointer matches the readline to which it points."
  10068. (let* ((file (nth 1 refile-pointer))
  10069. (re (nth 2 refile-pointer))
  10070. (pos (nth 3 refile-pointer))
  10071. buffer)
  10072. (when (org-string-nw-p re)
  10073. (setq buffer (if (markerp pos)
  10074. (marker-buffer pos)
  10075. (or (find-buffer-visiting file)
  10076. (find-file-noselect file))))
  10077. (with-current-buffer buffer
  10078. (save-excursion
  10079. (save-restriction
  10080. (widen)
  10081. (goto-char pos)
  10082. (beginning-of-line 1)
  10083. (unless (org-looking-at-p re)
  10084. (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  10085. (defun org-refile-new-child (parent-target child)
  10086. "Use refile target PARENT-TARGET to add new CHILD below it."
  10087. (unless parent-target
  10088. (error "Cannot find parent for new node"))
  10089. (let ((file (nth 1 parent-target))
  10090. (pos (nth 3 parent-target))
  10091. level)
  10092. (with-current-buffer (or (find-buffer-visiting file)
  10093. (find-file-noselect file))
  10094. (save-excursion
  10095. (save-restriction
  10096. (widen)
  10097. (if pos
  10098. (goto-char pos)
  10099. (goto-char (point-max))
  10100. (if (not (bolp)) (newline)))
  10101. (when (looking-at org-outline-regexp)
  10102. (setq level (funcall outline-level))
  10103. (org-end-of-subtree t t))
  10104. (org-back-over-empty-lines)
  10105. (insert "\n" (make-string
  10106. (if pos (org-get-valid-level level 1) 1) ?*)
  10107. " " child "\n")
  10108. (beginning-of-line 0)
  10109. (list (concat (car parent-target) "/" child) file "" (point)))))))
  10110. (defun org-olpath-completing-read (prompt collection &rest args)
  10111. "Read an outline path like a file name."
  10112. (let ((thetable collection)
  10113. (org-completion-use-ido nil) ; does not work with ido.
  10114. (org-completion-use-iswitchb nil)) ; or iswitchb
  10115. (apply
  10116. 'org-icompleting-read prompt
  10117. (lambda (string predicate &optional flag)
  10118. (let (rtn r f (l (length string)))
  10119. (cond
  10120. ((eq flag nil)
  10121. ;; try completion
  10122. (try-completion string thetable))
  10123. ((eq flag t)
  10124. ;; all-completions
  10125. (setq rtn (all-completions string thetable predicate))
  10126. (mapcar
  10127. (lambda (x)
  10128. (setq r (substring x l))
  10129. (if (string-match " ([^)]*)$" x)
  10130. (setq f (match-string 0 x))
  10131. (setq f ""))
  10132. (if (string-match "/" r)
  10133. (concat string (substring r 0 (match-end 0)) f)
  10134. x))
  10135. rtn))
  10136. ((eq flag 'lambda)
  10137. ;; exact match?
  10138. (assoc string thetable)))))
  10139. args)))
  10140. ;;;; Dynamic blocks
  10141. (defun org-find-dblock (name)
  10142. "Find the first dynamic block with name NAME in the buffer.
  10143. If not found, stay at current position and return nil."
  10144. (let ((case-fold-search t) pos)
  10145. (save-excursion
  10146. (goto-char (point-min))
  10147. (setq pos (and (re-search-forward
  10148. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10149. (match-beginning 0))))
  10150. (if pos (goto-char pos))
  10151. pos))
  10152. (defconst org-dblock-start-re
  10153. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  10154. "Matches the start line of a dynamic block, with parameters.")
  10155. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  10156. "Matches the end of a dynamic block.")
  10157. (defun org-create-dblock (plist)
  10158. "Create a dynamic block section, with parameters taken from PLIST.
  10159. PLIST must contain a :name entry which is used as name of the block."
  10160. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10161. (end-of-line 1)
  10162. (newline))
  10163. (let ((col (current-column))
  10164. (name (plist-get plist :name)))
  10165. (insert "#+BEGIN: " name)
  10166. (while plist
  10167. (if (eq (car plist) :name)
  10168. (setq plist (cddr plist))
  10169. (insert " " (prin1-to-string (pop plist)))))
  10170. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10171. (beginning-of-line -2)))
  10172. (defun org-prepare-dblock ()
  10173. "Prepare dynamic block for refresh.
  10174. This empties the block, puts the cursor at the insert position and returns
  10175. the property list including an extra property :name with the block name."
  10176. (unless (looking-at org-dblock-start-re)
  10177. (error "Not at a dynamic block"))
  10178. (let* ((begdel (1+ (match-end 0)))
  10179. (name (org-no-properties (match-string 1)))
  10180. (params (append (list :name name)
  10181. (read (concat "(" (match-string 3) ")")))))
  10182. (save-excursion
  10183. (beginning-of-line 1)
  10184. (skip-chars-forward " \t")
  10185. (setq params (plist-put params :indentation-column (current-column))))
  10186. (unless (re-search-forward org-dblock-end-re nil t)
  10187. (error "Dynamic block not terminated"))
  10188. (setq params
  10189. (append params
  10190. (list :content (buffer-substring
  10191. begdel (match-beginning 0)))))
  10192. (delete-region begdel (match-beginning 0))
  10193. (goto-char begdel)
  10194. (open-line 1)
  10195. params))
  10196. (defun org-map-dblocks (&optional command)
  10197. "Apply COMMAND to all dynamic blocks in the current buffer.
  10198. If COMMAND is not given, use `org-update-dblock'."
  10199. (let ((cmd (or command 'org-update-dblock)))
  10200. (save-excursion
  10201. (goto-char (point-min))
  10202. (while (re-search-forward org-dblock-start-re nil t)
  10203. (goto-char (match-beginning 0))
  10204. (save-excursion
  10205. (condition-case nil
  10206. (funcall cmd)
  10207. (error (message "Error during update of dynamic block"))))
  10208. (unless (re-search-forward org-dblock-end-re nil t)
  10209. (error "Dynamic block not terminated"))))))
  10210. (defun org-dblock-update (&optional arg)
  10211. "User command for updating dynamic blocks.
  10212. Update the dynamic block at point. With prefix ARG, update all dynamic
  10213. blocks in the buffer."
  10214. (interactive "P")
  10215. (if arg
  10216. (org-update-all-dblocks)
  10217. (or (looking-at org-dblock-start-re)
  10218. (org-beginning-of-dblock))
  10219. (org-update-dblock)))
  10220. (defun org-update-dblock ()
  10221. "Update the dynamic block at point.
  10222. This means to empty the block, parse for parameters and then call
  10223. the correct writing function."
  10224. (interactive)
  10225. (save-window-excursion
  10226. (let* ((pos (point))
  10227. (line (org-current-line))
  10228. (params (org-prepare-dblock))
  10229. (name (plist-get params :name))
  10230. (indent (plist-get params :indentation-column))
  10231. (cmd (intern (concat "org-dblock-write:" name))))
  10232. (message "Updating dynamic block `%s' at line %d..." name line)
  10233. (funcall cmd params)
  10234. (message "Updating dynamic block `%s' at line %d...done" name line)
  10235. (goto-char pos)
  10236. (when (and indent (> indent 0))
  10237. (setq indent (make-string indent ?\ ))
  10238. (save-excursion
  10239. (org-beginning-of-dblock)
  10240. (forward-line 1)
  10241. (while (not (looking-at org-dblock-end-re))
  10242. (insert indent)
  10243. (beginning-of-line 2))
  10244. (when (looking-at org-dblock-end-re)
  10245. (and (looking-at "[ \t]+")
  10246. (replace-match ""))
  10247. (insert indent)))))))
  10248. (defun org-beginning-of-dblock ()
  10249. "Find the beginning of the dynamic block at point.
  10250. Error if there is no such block at point."
  10251. (let ((pos (point))
  10252. beg)
  10253. (end-of-line 1)
  10254. (if (and (re-search-backward org-dblock-start-re nil t)
  10255. (setq beg (match-beginning 0))
  10256. (re-search-forward org-dblock-end-re nil t)
  10257. (> (match-end 0) pos))
  10258. (goto-char beg)
  10259. (goto-char pos)
  10260. (error "Not in a dynamic block"))))
  10261. ;;;###autoload
  10262. (defun org-update-all-dblocks ()
  10263. "Update all dynamic blocks in the buffer.
  10264. This function can be used in a hook."
  10265. (interactive)
  10266. (when (derived-mode-p 'org-mode)
  10267. (org-map-dblocks 'org-update-dblock)))
  10268. ;;;; Completion
  10269. (defconst org-additional-option-like-keywords
  10270. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
  10271. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
  10272. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  10273. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
  10274. "BEGIN:" "END:"
  10275. "ORGTBL" "TBLFM:" "TBLNAME:"
  10276. "BEGIN_EXAMPLE" "END_EXAMPLE"
  10277. "BEGIN_VERBATIM" "END_VERBATIM"
  10278. "BEGIN_QUOTE" "END_QUOTE"
  10279. "BEGIN_VERSE" "END_VERSE"
  10280. "BEGIN_CENTER" "END_CENTER"
  10281. "BEGIN_SRC" "END_SRC"
  10282. "BEGIN_RESULT" "END_RESULT"
  10283. "BEGIN_lstlisting" "END_lstlisting"
  10284. "NAME:" "RESULTS:"
  10285. "HEADER:" "HEADERS:"
  10286. "COLUMNS:" "PROPERTY:"
  10287. "CAPTION:" "LABEL:"
  10288. "SETUPFILE:"
  10289. "INCLUDE:"
  10290. "BIND:"
  10291. "MACRO:"))
  10292. (defconst org-options-keywords
  10293. '("TITLE:" "AUTHOR:" "EMAIL:" "DATE:"
  10294. "DESCRIPTION:" "KEYWORDS:" "LANGUAGE:" "OPTIONS:"
  10295. "EXPORT_SELECT_TAGS:" "EXPORT_EXCLUDE_TAGS:"
  10296. "LINK_UP:" "LINK_HOME:" "LINK:" "TODO:"
  10297. "XSLT:" "MATHJAX:" "CATEGORY:" "SEQ_TODO:" "TYP_TODO:"
  10298. "PRIORITIES:" "DRAWERS:" "STARTUP:" "TAGS:"
  10299. "FILETAGS:" "ARCHIVE:" "INFOJS_OPT:"))
  10300. (defconst org-additional-option-like-keywords-for-flyspell
  10301. (delete-dups
  10302. (split-string
  10303. (mapconcat (lambda(k)
  10304. (replace-regexp-in-string
  10305. "_\\|:" " "
  10306. (concat k " " (downcase k) " " (upcase k))))
  10307. (append org-options-keywords org-additional-option-like-keywords)
  10308. " ")
  10309. " +" t)))
  10310. (defcustom org-structure-template-alist
  10311. '(
  10312. ("s" "#+BEGIN_SRC ?\n\n#+END_SRC"
  10313. "<src lang=\"?\">\n\n</src>")
  10314. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE"
  10315. "<example>\n?\n</example>")
  10316. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE"
  10317. "<quote>\n?\n</quote>")
  10318. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE"
  10319. "<verse>\n?\n</verse>")
  10320. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER"
  10321. "<center>\n?\n</center>")
  10322. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10323. "<literal style=\"latex\">\n?\n</literal>")
  10324. ("L" "#+LaTeX: "
  10325. "<literal style=\"latex\">?</literal>")
  10326. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10327. "<literal style=\"html\">\n?\n</literal>")
  10328. ("H" "#+HTML: "
  10329. "<literal style=\"html\">?</literal>")
  10330. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
  10331. ("A" "#+ASCII: ")
  10332. ("i" "#+INDEX: ?"
  10333. "#+INDEX: ?")
  10334. ("I" "#+INCLUDE: %file ?"
  10335. "<include file=%file markup=\"?\">")
  10336. )
  10337. "Structure completion elements.
  10338. This is a list of abbreviation keys and values. The value gets inserted
  10339. if you type `<' followed by the key and then press the completion key,
  10340. usually `M-TAB'. %file will be replaced by a file name after prompting
  10341. for the file using completion. The cursor will be placed at the position
  10342. of the `?` in the template.
  10343. There are two templates for each key, the first uses the original Org syntax,
  10344. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10345. the default when the /org-mtags.el/ module has been loaded. See also the
  10346. variable `org-mtags-prefer-muse-templates'."
  10347. :group 'org-completion
  10348. :type '(repeat
  10349. (string :tag "Key")
  10350. (string :tag "Template")
  10351. (string :tag "Muse Template")))
  10352. (defun org-try-structure-completion ()
  10353. "Try to complete a structure template before point.
  10354. This looks for strings like \"<e\" on an otherwise empty line and
  10355. expands them."
  10356. (let ((l (buffer-substring (point-at-bol) (point)))
  10357. a)
  10358. (when (and (looking-at "[ \t]*$")
  10359. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10360. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10361. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10362. (match-beginning 1)) a)
  10363. t)))
  10364. (defun org-complete-expand-structure-template (start cell)
  10365. "Expand a structure template."
  10366. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10367. (rpl (nth (if musep 2 1) cell))
  10368. (ind ""))
  10369. (delete-region start (point))
  10370. (when (string-match "\\`#\\+" rpl)
  10371. (cond
  10372. ((bolp))
  10373. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10374. (setq ind (buffer-substring (point-at-bol) (point))))
  10375. (t (newline))))
  10376. (setq start (point))
  10377. (if (string-match "%file" rpl)
  10378. (setq rpl (replace-match
  10379. (concat
  10380. "\""
  10381. (save-match-data
  10382. (abbreviate-file-name (read-file-name "Include file: ")))
  10383. "\"")
  10384. t t rpl)))
  10385. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10386. (concat "\n" ind)))
  10387. (insert rpl)
  10388. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10389. ;;;; TODO, DEADLINE, Comments
  10390. (defun org-toggle-comment ()
  10391. "Change the COMMENT state of an entry."
  10392. (interactive)
  10393. (save-excursion
  10394. (org-back-to-heading)
  10395. (let (case-fold-search)
  10396. (cond
  10397. ((looking-at (format org-heading-keyword-regexp-format
  10398. org-comment-string))
  10399. (goto-char (match-end 1))
  10400. (looking-at (concat " +" org-comment-string))
  10401. (replace-match "" t t)
  10402. (when (eolp) (insert " ")))
  10403. ((looking-at org-outline-regexp)
  10404. (goto-char (match-end 0))
  10405. (insert org-comment-string " "))))))
  10406. (defvar org-last-todo-state-is-todo nil
  10407. "This is non-nil when the last TODO state change led to a TODO state.
  10408. If the last change removed the TODO tag or switched to DONE, then
  10409. this is nil.")
  10410. (defvar org-setting-tags nil) ; dynamically skipped
  10411. (defvar org-todo-setup-filter-hook nil
  10412. "Hook for functions that pre-filter todo specs.
  10413. Each function takes a todo spec and returns either nil or the spec
  10414. transformed into canonical form." )
  10415. (defvar org-todo-get-default-hook nil
  10416. "Hook for functions that get a default item for todo.
  10417. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10418. nil or a string to be used for the todo mark." )
  10419. (defvar org-agenda-headline-snapshot-before-repeat)
  10420. (defun org-current-effective-time ()
  10421. "Return current time adjusted for `org-extend-today-until' variable."
  10422. (let* ((ct (org-current-time))
  10423. (dct (decode-time ct))
  10424. (ct1
  10425. (if (and org-use-effective-time
  10426. (< (nth 2 dct) org-extend-today-until))
  10427. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
  10428. ct)))
  10429. ct1))
  10430. (defun org-todo-yesterday (&optional arg)
  10431. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10432. (interactive "P")
  10433. (if (eq major-mode 'org-agenda-mode)
  10434. (apply 'org-agenda-todo-yesterday arg)
  10435. (let* ((hour (third (decode-time
  10436. (org-current-time))))
  10437. (org-extend-today-until (1+ hour)))
  10438. (org-todo arg))))
  10439. (defun org-todo (&optional arg)
  10440. "Change the TODO state of an item.
  10441. The state of an item is given by a keyword at the start of the heading,
  10442. like
  10443. *** TODO Write paper
  10444. *** DONE Call mom
  10445. The different keywords are specified in the variable `org-todo-keywords'.
  10446. By default the available states are \"TODO\" and \"DONE\".
  10447. So for this example: when the item starts with TODO, it is changed to DONE.
  10448. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10449. DONE are present, add TODO at the beginning of the heading.
  10450. With \\[universal-argument] prefix arg, use completion to determine the new \
  10451. state.
  10452. With numeric prefix arg, switch to that state.
  10453. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10454. keywords (nextset).
  10455. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10456. With a numeric prefix arg of 0, inhibit note taking for the change.
  10457. For calling through lisp, arg is also interpreted in the following way:
  10458. 'none -> empty state
  10459. \"\"(empty string) -> switch to empty state
  10460. 'done -> switch to DONE
  10461. 'nextset -> switch to the next set of keywords
  10462. 'previousset -> switch to the previous set of keywords
  10463. \"WAITING\" -> switch to the specified keyword, but only if it
  10464. really is a member of `org-todo-keywords'."
  10465. (interactive "P")
  10466. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10467. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10468. 'region-start-level 'region))
  10469. org-loop-over-headlines-in-active-region)
  10470. (org-map-entries
  10471. `(org-todo ,arg)
  10472. org-loop-over-headlines-in-active-region
  10473. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  10474. (if (equal arg '(16)) (setq arg 'nextset))
  10475. (let ((org-blocker-hook org-blocker-hook)
  10476. (case-fold-search nil))
  10477. (when (equal arg '(64))
  10478. (setq arg nil org-blocker-hook nil))
  10479. (when (and org-blocker-hook
  10480. (or org-inhibit-blocking
  10481. (org-entry-get nil "NOBLOCKING")))
  10482. (setq org-blocker-hook nil))
  10483. (save-excursion
  10484. (catch 'exit
  10485. (org-back-to-heading t)
  10486. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  10487. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  10488. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  10489. (let* ((match-data (match-data))
  10490. (startpos (point-at-bol))
  10491. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  10492. (org-log-done org-log-done)
  10493. (org-log-repeat org-log-repeat)
  10494. (org-todo-log-states org-todo-log-states)
  10495. (org-inhibit-logging
  10496. (if (equal arg 0)
  10497. (progn (setq arg nil) 'note) org-inhibit-logging))
  10498. (this (match-string 1))
  10499. (hl-pos (match-beginning 0))
  10500. (head (org-get-todo-sequence-head this))
  10501. (ass (assoc head org-todo-kwd-alist))
  10502. (interpret (nth 1 ass))
  10503. (done-word (nth 3 ass))
  10504. (final-done-word (nth 4 ass))
  10505. (org-last-state (or this ""))
  10506. (completion-ignore-case t)
  10507. (member (member this org-todo-keywords-1))
  10508. (tail (cdr member))
  10509. (org-state (cond
  10510. ((and org-todo-key-trigger
  10511. (or (and (equal arg '(4))
  10512. (eq org-use-fast-todo-selection 'prefix))
  10513. (and (not arg) org-use-fast-todo-selection
  10514. (not (eq org-use-fast-todo-selection
  10515. 'prefix)))))
  10516. ;; Use fast selection
  10517. (org-fast-todo-selection))
  10518. ((and (equal arg '(4))
  10519. (or (not org-use-fast-todo-selection)
  10520. (not org-todo-key-trigger)))
  10521. ;; Read a state with completion
  10522. (org-icompleting-read
  10523. "State: " (mapcar (lambda(x) (list x))
  10524. org-todo-keywords-1)
  10525. nil t))
  10526. ((eq arg 'right)
  10527. (if this
  10528. (if tail (car tail) nil)
  10529. (car org-todo-keywords-1)))
  10530. ((eq arg 'left)
  10531. (if (equal member org-todo-keywords-1)
  10532. nil
  10533. (if this
  10534. (nth (- (length org-todo-keywords-1)
  10535. (length tail) 2)
  10536. org-todo-keywords-1)
  10537. (org-last org-todo-keywords-1))))
  10538. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  10539. (setq arg nil))) ; hack to fall back to cycling
  10540. (arg
  10541. ;; user or caller requests a specific state
  10542. (cond
  10543. ((equal arg "") nil)
  10544. ((eq arg 'none) nil)
  10545. ((eq arg 'done) (or done-word (car org-done-keywords)))
  10546. ((eq arg 'nextset)
  10547. (or (car (cdr (member head org-todo-heads)))
  10548. (car org-todo-heads)))
  10549. ((eq arg 'previousset)
  10550. (let ((org-todo-heads (reverse org-todo-heads)))
  10551. (or (car (cdr (member head org-todo-heads)))
  10552. (car org-todo-heads))))
  10553. ((car (member arg org-todo-keywords-1)))
  10554. ((stringp arg)
  10555. (error "State `%s' not valid in this file" arg))
  10556. ((nth (1- (prefix-numeric-value arg))
  10557. org-todo-keywords-1))))
  10558. ((null member) (or head (car org-todo-keywords-1)))
  10559. ((equal this final-done-word) nil) ;; -> make empty
  10560. ((null tail) nil) ;; -> first entry
  10561. ((memq interpret '(type priority))
  10562. (if (eq this-command last-command)
  10563. (car tail)
  10564. (if (> (length tail) 0)
  10565. (or done-word (car org-done-keywords))
  10566. nil)))
  10567. (t
  10568. (car tail))))
  10569. (org-state (or
  10570. (run-hook-with-args-until-success
  10571. 'org-todo-get-default-hook org-state org-last-state)
  10572. org-state))
  10573. (next (if org-state (concat " " org-state " ") " "))
  10574. (change-plist (list :type 'todo-state-change :from this :to org-state
  10575. :position startpos))
  10576. dolog now-done-p)
  10577. (when org-blocker-hook
  10578. (setq org-last-todo-state-is-todo
  10579. (not (member this org-done-keywords)))
  10580. (unless (save-excursion
  10581. (save-match-data
  10582. (org-with-wide-buffer
  10583. (run-hook-with-args-until-failure
  10584. 'org-blocker-hook change-plist))))
  10585. (if (org-called-interactively-p 'interactive)
  10586. (error "TODO state change from %s to %s blocked" this org-state)
  10587. ;; fail silently
  10588. (message "TODO state change from %s to %s blocked" this org-state)
  10589. (throw 'exit nil))))
  10590. (store-match-data match-data)
  10591. (replace-match next t t)
  10592. (unless (pos-visible-in-window-p hl-pos)
  10593. (message "TODO state changed to %s" (org-trim next)))
  10594. (unless head
  10595. (setq head (org-get-todo-sequence-head org-state)
  10596. ass (assoc head org-todo-kwd-alist)
  10597. interpret (nth 1 ass)
  10598. done-word (nth 3 ass)
  10599. final-done-word (nth 4 ass)))
  10600. (when (memq arg '(nextset previousset))
  10601. (message "Keyword-Set %d/%d: %s"
  10602. (- (length org-todo-sets) -1
  10603. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  10604. (length org-todo-sets)
  10605. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  10606. (setq org-last-todo-state-is-todo
  10607. (not (member org-state org-done-keywords)))
  10608. (setq now-done-p (and (member org-state org-done-keywords)
  10609. (not (member this org-done-keywords))))
  10610. (and logging (org-local-logging logging))
  10611. (when (and (or org-todo-log-states org-log-done)
  10612. (not (eq org-inhibit-logging t))
  10613. (not (memq arg '(nextset previousset))))
  10614. ;; we need to look at recording a time and note
  10615. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  10616. (nth 2 (assoc this org-todo-log-states))))
  10617. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  10618. (setq dolog 'time))
  10619. (when (and org-state
  10620. (member org-state org-not-done-keywords)
  10621. (not (member this org-not-done-keywords)))
  10622. ;; This is now a todo state and was not one before
  10623. ;; If there was a CLOSED time stamp, get rid of it.
  10624. (org-add-planning-info nil nil 'closed))
  10625. (when (and now-done-p org-log-done)
  10626. ;; It is now done, and it was not done before
  10627. (org-add-planning-info 'closed (org-current-effective-time))
  10628. (if (and (not dolog) (eq 'note org-log-done))
  10629. (org-add-log-setup 'done org-state this 'findpos 'note)))
  10630. (when (and org-state dolog)
  10631. ;; This is a non-nil state, and we need to log it
  10632. (org-add-log-setup 'state org-state this 'findpos dolog)))
  10633. ;; Fixup tag positioning
  10634. (org-todo-trigger-tag-changes org-state)
  10635. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  10636. (when org-provide-todo-statistics
  10637. (org-update-parent-todo-statistics))
  10638. (run-hooks 'org-after-todo-state-change-hook)
  10639. (if (and arg (not (member org-state org-done-keywords)))
  10640. (setq head (org-get-todo-sequence-head org-state)))
  10641. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  10642. ;; Do we need to trigger a repeat?
  10643. (when now-done-p
  10644. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  10645. ;; This is for the agenda, take a snapshot of the headline.
  10646. (save-match-data
  10647. (setq org-agenda-headline-snapshot-before-repeat
  10648. (org-get-heading))))
  10649. (org-auto-repeat-maybe org-state))
  10650. ;; Fixup cursor location if close to the keyword
  10651. (if (and (outline-on-heading-p)
  10652. (not (bolp))
  10653. (save-excursion (beginning-of-line 1)
  10654. (looking-at org-todo-line-regexp))
  10655. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  10656. (progn
  10657. (goto-char (or (match-end 2) (match-end 1)))
  10658. (and (looking-at " ") (just-one-space))))
  10659. (when org-trigger-hook
  10660. (save-excursion
  10661. (run-hook-with-args 'org-trigger-hook change-plist)))))))))
  10662. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  10663. "Block turning an entry into a TODO, using the hierarchy.
  10664. This checks whether the current task should be blocked from state
  10665. changes. Such blocking occurs when:
  10666. 1. The task has children which are not all in a completed state.
  10667. 2. A task has a parent with the property :ORDERED:, and there
  10668. are siblings prior to the current task with incomplete
  10669. status.
  10670. 3. The parent of the task is blocked because it has siblings that should
  10671. be done first, or is child of a block grandparent TODO entry."
  10672. (if (not org-enforce-todo-dependencies)
  10673. t ; if locally turned off don't block
  10674. (catch 'dont-block
  10675. ;; If this is not a todo state change, or if this entry is already DONE,
  10676. ;; do not block
  10677. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10678. (member (plist-get change-plist :from)
  10679. (cons 'done org-done-keywords))
  10680. (member (plist-get change-plist :to)
  10681. (cons 'todo org-not-done-keywords))
  10682. (not (plist-get change-plist :to)))
  10683. (throw 'dont-block t))
  10684. ;; If this task has children, and any are undone, it's blocked
  10685. (save-excursion
  10686. (org-back-to-heading t)
  10687. (let ((this-level (funcall outline-level)))
  10688. (outline-next-heading)
  10689. (let ((child-level (funcall outline-level)))
  10690. (while (and (not (eobp))
  10691. (> child-level this-level))
  10692. ;; this todo has children, check whether they are all
  10693. ;; completed
  10694. (if (and (not (org-entry-is-done-p))
  10695. (org-entry-is-todo-p))
  10696. (throw 'dont-block nil))
  10697. (outline-next-heading)
  10698. (setq child-level (funcall outline-level))))))
  10699. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  10700. ;; any previous siblings are undone, it's blocked
  10701. (save-excursion
  10702. (org-back-to-heading t)
  10703. (let* ((pos (point))
  10704. (parent-pos (and (org-up-heading-safe) (point))))
  10705. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10706. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10707. (forward-line 1)
  10708. (re-search-forward org-not-done-heading-regexp pos t))
  10709. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  10710. ;; Search further up the hierarchy, to see if an ancestor is blocked
  10711. (while t
  10712. (goto-char parent-pos)
  10713. (if (not (looking-at org-not-done-heading-regexp))
  10714. (throw 'dont-block t)) ; do not block, parent is not a TODO
  10715. (setq pos (point))
  10716. (setq parent-pos (and (org-up-heading-safe) (point)))
  10717. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10718. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10719. (forward-line 1)
  10720. (re-search-forward org-not-done-heading-regexp pos t))
  10721. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  10722. (defcustom org-track-ordered-property-with-tag nil
  10723. "Should the ORDERED property also be shown as a tag?
  10724. The ORDERED property decides if an entry should require subtasks to be
  10725. completed in sequence. Since a property is not very visible, setting
  10726. this option means that toggling the ORDERED property with the command
  10727. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  10728. not relevant for the behavior, but it makes things more visible.
  10729. Note that toggling the tag with tags commands will not change the property
  10730. and therefore not influence behavior!
  10731. This can be t, meaning the tag ORDERED should be used, It can also be a
  10732. string to select a different tag for this task."
  10733. :group 'org-todo
  10734. :type '(choice
  10735. (const :tag "No tracking" nil)
  10736. (const :tag "Track with ORDERED tag" t)
  10737. (string :tag "Use other tag")))
  10738. (defun org-toggle-ordered-property ()
  10739. "Toggle the ORDERED property of the current entry.
  10740. For better visibility, you can track the value of this property with a tag.
  10741. See variable `org-track-ordered-property-with-tag'."
  10742. (interactive)
  10743. (let* ((t1 org-track-ordered-property-with-tag)
  10744. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  10745. (save-excursion
  10746. (org-back-to-heading)
  10747. (if (org-entry-get nil "ORDERED")
  10748. (progn
  10749. (org-delete-property "ORDERED")
  10750. (and tag (org-toggle-tag tag 'off))
  10751. (message "Subtasks can be completed in arbitrary order"))
  10752. (org-entry-put nil "ORDERED" "t")
  10753. (and tag (org-toggle-tag tag 'on))
  10754. (message "Subtasks must be completed in sequence")))))
  10755. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  10756. (defun org-block-todo-from-checkboxes (change-plist)
  10757. "Block turning an entry into a TODO, using checkboxes.
  10758. This checks whether the current task should be blocked from state
  10759. changes because there are unchecked boxes in this entry."
  10760. (if (not org-enforce-todo-checkbox-dependencies)
  10761. t ; if locally turned off don't block
  10762. (catch 'dont-block
  10763. ;; If this is not a todo state change, or if this entry is already DONE,
  10764. ;; do not block
  10765. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10766. (member (plist-get change-plist :from)
  10767. (cons 'done org-done-keywords))
  10768. (member (plist-get change-plist :to)
  10769. (cons 'todo org-not-done-keywords))
  10770. (not (plist-get change-plist :to)))
  10771. (throw 'dont-block t))
  10772. ;; If this task has checkboxes that are not checked, it's blocked
  10773. (save-excursion
  10774. (org-back-to-heading t)
  10775. (let ((beg (point)) end)
  10776. (outline-next-heading)
  10777. (setq end (point))
  10778. (goto-char beg)
  10779. (if (org-list-search-forward
  10780. (concat (org-item-beginning-re)
  10781. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  10782. "\\[[- ]\\]")
  10783. end t)
  10784. (progn
  10785. (if (boundp 'org-blocked-by-checkboxes)
  10786. (setq org-blocked-by-checkboxes t))
  10787. (throw 'dont-block nil)))))
  10788. t))) ; do not block
  10789. (defun org-entry-blocked-p ()
  10790. "Is the current entry blocked?"
  10791. (if (org-entry-get nil "NOBLOCKING")
  10792. nil ;; Never block this entry
  10793. (not
  10794. (run-hook-with-args-until-failure
  10795. 'org-blocker-hook
  10796. (list :type 'todo-state-change
  10797. :position (point)
  10798. :from 'todo
  10799. :to 'done)))))
  10800. (defun org-update-statistics-cookies (all)
  10801. "Update the statistics cookie, either from TODO or from checkboxes.
  10802. This should be called with the cursor in a line with a statistics cookie."
  10803. (interactive "P")
  10804. (if all
  10805. (progn
  10806. (org-update-checkbox-count 'all)
  10807. (org-map-entries 'org-update-parent-todo-statistics))
  10808. (if (not (org-at-heading-p))
  10809. (org-update-checkbox-count)
  10810. (let ((pos (move-marker (make-marker) (point)))
  10811. end l1 l2)
  10812. (ignore-errors (org-back-to-heading t))
  10813. (if (not (org-at-heading-p))
  10814. (org-update-checkbox-count)
  10815. (setq l1 (org-outline-level))
  10816. (setq end (save-excursion
  10817. (outline-next-heading)
  10818. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  10819. (point)))
  10820. (if (and (save-excursion
  10821. (re-search-forward
  10822. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  10823. (not (save-excursion (re-search-forward
  10824. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  10825. (org-update-checkbox-count)
  10826. (if (and l2 (> l2 l1))
  10827. (progn
  10828. (goto-char end)
  10829. (org-update-parent-todo-statistics))
  10830. (goto-char pos)
  10831. (beginning-of-line 1)
  10832. (while (re-search-forward
  10833. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  10834. (point-at-eol) t)
  10835. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  10836. (goto-char pos)
  10837. (move-marker pos nil)))))
  10838. (defvar org-entry-property-inherited-from) ;; defined below
  10839. (defun org-update-parent-todo-statistics ()
  10840. "Update any statistics cookie in the parent of the current headline.
  10841. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  10842. the entire subtree and this will travel up the hierarchy and update
  10843. statistics everywhere."
  10844. (let* ((prop (save-excursion (org-up-heading-safe)
  10845. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  10846. (recursive (or (not org-hierarchical-todo-statistics)
  10847. (and prop (string-match "\\<recursive\\>" prop))))
  10848. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  10849. 0))
  10850. (first t)
  10851. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10852. level ltoggle l1 new ndel
  10853. (cnt-all 0) (cnt-done 0) is-percent kwd
  10854. checkbox-beg ov ovs ove cookie-present)
  10855. (catch 'exit
  10856. (save-excursion
  10857. (beginning-of-line 1)
  10858. (setq ltoggle (funcall outline-level))
  10859. ;; Three situations are to consider:
  10860. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  10861. ;; to the top-level ancestor on the headline;
  10862. ;; 2. If parent has "recursive" property, repeat up to the
  10863. ;; headline setting that property, taking inheritance into
  10864. ;; account;
  10865. ;; 3. Else, move up to direct parent and proceed only once.
  10866. (while (and (setq level (org-up-heading-safe))
  10867. (or recursive first)
  10868. (>= (point) lim))
  10869. (setq first nil cookie-present nil)
  10870. (unless (and level
  10871. (not (string-match
  10872. "\\<checkbox\\>"
  10873. (downcase (or (org-entry-get nil "COOKIE_DATA")
  10874. "")))))
  10875. (throw 'exit nil))
  10876. (while (re-search-forward box-re (point-at-eol) t)
  10877. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10878. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  10879. (save-match-data
  10880. (unless (outline-next-heading) (throw 'exit nil))
  10881. (while (and (looking-at org-complex-heading-regexp)
  10882. (> (setq l1 (length (match-string 1))) level))
  10883. (setq kwd (and (or recursive (= l1 ltoggle))
  10884. (match-string 2)))
  10885. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10886. (and (listp org-provide-todo-statistics)
  10887. (or (member kwd org-provide-todo-statistics)
  10888. (member kwd org-done-keywords))))
  10889. (setq cnt-all (1+ cnt-all))
  10890. (if (eq org-provide-todo-statistics t)
  10891. (and kwd (setq cnt-all (1+ cnt-all)))))
  10892. (and (member kwd org-done-keywords)
  10893. (setq cnt-done (1+ cnt-done)))
  10894. (outline-next-heading)))
  10895. (setq new
  10896. (if is-percent
  10897. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10898. (format "[%d/%d]" cnt-done cnt-all))
  10899. ndel (- (match-end 0) checkbox-beg))
  10900. ;; handle overlays when updating cookie from column view
  10901. (when (setq ov (car (overlays-at checkbox-beg)))
  10902. (setq ovs (overlay-start ov) ove (overlay-end ov))
  10903. (delete-overlay ov))
  10904. (goto-char checkbox-beg)
  10905. (insert new)
  10906. (delete-region (point) (+ (point) ndel))
  10907. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  10908. (when ov (move-overlay ov ovs ove)))
  10909. (when cookie-present
  10910. (run-hook-with-args 'org-after-todo-statistics-hook
  10911. cnt-done (- cnt-all cnt-done))))))
  10912. (run-hooks 'org-todo-statistics-hook)))
  10913. (defvar org-after-todo-statistics-hook nil
  10914. "Hook that is called after a TODO statistics cookie has been updated.
  10915. Each function is called with two arguments: the number of not-done entries
  10916. and the number of done entries.
  10917. For example, the following function, when added to this hook, will switch
  10918. an entry to DONE when all children are done, and back to TODO when new
  10919. entries are set to a TODO status. Note that this hook is only called
  10920. when there is a statistics cookie in the headline!
  10921. (defun org-summary-todo (n-done n-not-done)
  10922. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10923. (let (org-log-done org-log-states) ; turn off logging
  10924. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10925. ")
  10926. (defvar org-todo-statistics-hook nil
  10927. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10928. This hook runs even if there is no statistics cookie present, in which case
  10929. `org-after-todo-statistics-hook' would not run.")
  10930. (defun org-todo-trigger-tag-changes (state)
  10931. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10932. (let ((l org-todo-state-tags-triggers)
  10933. changes)
  10934. (when (or (not state) (equal state ""))
  10935. (setq changes (append changes (cdr (assoc "" l)))))
  10936. (when (and (stringp state) (> (length state) 0))
  10937. (setq changes (append changes (cdr (assoc state l)))))
  10938. (when (member state org-not-done-keywords)
  10939. (setq changes (append changes (cdr (assoc 'todo l)))))
  10940. (when (member state org-done-keywords)
  10941. (setq changes (append changes (cdr (assoc 'done l)))))
  10942. (dolist (c changes)
  10943. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10944. (defun org-local-logging (value)
  10945. "Get logging settings from a property VALUE."
  10946. (let* (words w a)
  10947. ;; directly set the variables, they are already local.
  10948. (setq org-log-done nil
  10949. org-log-repeat nil
  10950. org-todo-log-states nil)
  10951. (setq words (org-split-string value))
  10952. (while (setq w (pop words))
  10953. (cond
  10954. ((setq a (assoc w org-startup-options))
  10955. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10956. (set (nth 1 a) (nth 2 a))))
  10957. ((setq a (org-extract-log-state-settings w))
  10958. (and (member (car a) org-todo-keywords-1)
  10959. (push a org-todo-log-states)))))))
  10960. (defun org-get-todo-sequence-head (kwd)
  10961. "Return the head of the TODO sequence to which KWD belongs.
  10962. If KWD is not set, check if there is a text property remembering the
  10963. right sequence."
  10964. (let (p)
  10965. (cond
  10966. ((not kwd)
  10967. (or (get-text-property (point-at-bol) 'org-todo-head)
  10968. (progn
  10969. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  10970. nil (point-at-eol)))
  10971. (get-text-property p 'org-todo-head))))
  10972. ((not (member kwd org-todo-keywords-1))
  10973. (car org-todo-keywords-1))
  10974. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  10975. (defun org-fast-todo-selection ()
  10976. "Fast TODO keyword selection with single keys.
  10977. Returns the new TODO keyword, or nil if no state change should occur."
  10978. (let* ((fulltable org-todo-key-alist)
  10979. (done-keywords org-done-keywords) ;; needed for the faces.
  10980. (maxlen (apply 'max (mapcar
  10981. (lambda (x)
  10982. (if (stringp (car x)) (string-width (car x)) 0))
  10983. fulltable)))
  10984. (expert nil)
  10985. (fwidth (+ maxlen 3 1 3))
  10986. (ncol (/ (- (window-width) 4) fwidth))
  10987. tg cnt e c tbl
  10988. groups ingroup)
  10989. (save-excursion
  10990. (save-window-excursion
  10991. (if expert
  10992. (set-buffer (get-buffer-create " *Org todo*"))
  10993. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  10994. (erase-buffer)
  10995. (org-set-local 'org-done-keywords done-keywords)
  10996. (setq tbl fulltable cnt 0)
  10997. (while (setq e (pop tbl))
  10998. (cond
  10999. ((equal e '(:startgroup))
  11000. (push '() groups) (setq ingroup t)
  11001. (when (not (= cnt 0))
  11002. (setq cnt 0)
  11003. (insert "\n"))
  11004. (insert "{ "))
  11005. ((equal e '(:endgroup))
  11006. (setq ingroup nil cnt 0)
  11007. (insert "}\n"))
  11008. ((equal e '(:newline))
  11009. (when (not (= cnt 0))
  11010. (setq cnt 0)
  11011. (insert "\n")
  11012. (setq e (car tbl))
  11013. (while (equal (car tbl) '(:newline))
  11014. (insert "\n")
  11015. (setq tbl (cdr tbl)))))
  11016. (t
  11017. (setq tg (car e) c (cdr e))
  11018. (if ingroup (push tg (car groups)))
  11019. (setq tg (org-add-props tg nil 'face
  11020. (org-get-todo-face tg)))
  11021. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11022. (insert "[" c "] " tg (make-string
  11023. (- fwidth 4 (length tg)) ?\ ))
  11024. (when (= (setq cnt (1+ cnt)) ncol)
  11025. (insert "\n")
  11026. (if ingroup (insert " "))
  11027. (setq cnt 0)))))
  11028. (insert "\n")
  11029. (goto-char (point-min))
  11030. (if (not expert) (org-fit-window-to-buffer))
  11031. (message "[a-z..]:Set [SPC]:clear")
  11032. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11033. (cond
  11034. ((or (= c ?\C-g)
  11035. (and (= c ?q) (not (rassoc c fulltable))))
  11036. (setq quit-flag t))
  11037. ((= c ?\ ) nil)
  11038. ((setq e (rassoc c fulltable) tg (car e))
  11039. tg)
  11040. (t (setq quit-flag t)))))))
  11041. (defun org-entry-is-todo-p ()
  11042. (member (org-get-todo-state) org-not-done-keywords))
  11043. (defun org-entry-is-done-p ()
  11044. (member (org-get-todo-state) org-done-keywords))
  11045. (defun org-get-todo-state ()
  11046. (save-excursion
  11047. (org-back-to-heading t)
  11048. (and (looking-at org-todo-line-regexp)
  11049. (match-end 2)
  11050. (match-string 2))))
  11051. (defun org-at-date-range-p (&optional inactive-ok)
  11052. "Is the cursor inside a date range?"
  11053. (interactive)
  11054. (save-excursion
  11055. (catch 'exit
  11056. (let ((pos (point)))
  11057. (skip-chars-backward "^[<\r\n")
  11058. (skip-chars-backward "<[")
  11059. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11060. (>= (match-end 0) pos)
  11061. (throw 'exit t))
  11062. (skip-chars-backward "^<[\r\n")
  11063. (skip-chars-backward "<[")
  11064. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11065. (>= (match-end 0) pos)
  11066. (throw 'exit t)))
  11067. nil)))
  11068. (defun org-get-repeat (&optional tagline)
  11069. "Check if there is a deadline/schedule with repeater in this entry."
  11070. (save-match-data
  11071. (save-excursion
  11072. (org-back-to-heading t)
  11073. (and (re-search-forward (if tagline
  11074. (concat tagline "\\s-*" org-repeat-re)
  11075. org-repeat-re)
  11076. (org-entry-end-position) t)
  11077. (match-string-no-properties 1)))))
  11078. (defvar org-last-changed-timestamp)
  11079. (defvar org-last-inserted-timestamp)
  11080. (defvar org-log-post-message)
  11081. (defvar org-log-note-purpose)
  11082. (defvar org-log-note-how)
  11083. (defvar org-log-note-extra)
  11084. (defun org-auto-repeat-maybe (done-word)
  11085. "Check if the current headline contains a repeated deadline/schedule.
  11086. If yes, set TODO state back to what it was and change the base date
  11087. of repeating deadline/scheduled time stamps to new date.
  11088. This function is run automatically after each state change to a DONE state."
  11089. ;; last-state is dynamically scoped into this function
  11090. (let* ((repeat (org-get-repeat))
  11091. (aa (assoc org-last-state org-todo-kwd-alist))
  11092. (interpret (nth 1 aa))
  11093. (head (nth 2 aa))
  11094. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11095. (msg "Entry repeats: ")
  11096. (org-log-done nil)
  11097. (org-todo-log-states nil)
  11098. re type n what ts time to-state)
  11099. (when repeat
  11100. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  11101. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  11102. org-todo-repeat-to-state))
  11103. (unless (and to-state (member to-state org-todo-keywords-1))
  11104. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11105. (org-todo to-state)
  11106. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11107. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11108. (org-time-stamp-format t t))))
  11109. (when org-log-repeat
  11110. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11111. (memq 'org-add-log-note post-command-hook))
  11112. ;; OK, we are already setup for some record
  11113. (if (eq org-log-repeat 'note)
  11114. ;; make sure we take a note, not only a time stamp
  11115. (setq org-log-note-how 'note))
  11116. ;; Set up for taking a record
  11117. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  11118. org-last-state
  11119. 'findpos org-log-repeat)))
  11120. (org-back-to-heading t)
  11121. (org-add-planning-info nil nil 'closed)
  11122. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11123. org-deadline-time-regexp "\\)\\|\\("
  11124. org-ts-regexp "\\)"))
  11125. (while (re-search-forward
  11126. re (save-excursion (outline-next-heading) (point)) t)
  11127. (setq type (if (match-end 1) org-scheduled-string
  11128. (if (match-end 3) org-deadline-string "Plain:"))
  11129. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  11130. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  11131. (setq n (string-to-number (match-string 2 ts))
  11132. what (match-string 3 ts))
  11133. (if (equal what "w") (setq n (* n 7) what "d"))
  11134. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  11135. (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  11136. ;; Preparation, see if we need to modify the start date for the change
  11137. (when (match-end 1)
  11138. (setq time (save-match-data (org-time-string-to-time ts)))
  11139. (cond
  11140. ((equal (match-string 1 ts) ".")
  11141. ;; Shift starting date to today
  11142. (org-timestamp-change
  11143. (- (org-today) (time-to-days time))
  11144. 'day))
  11145. ((equal (match-string 1 ts) "+")
  11146. (let ((nshiftmax 10) (nshift 0))
  11147. (while (or (= nshift 0)
  11148. (<= (time-to-days time)
  11149. (time-to-days (current-time))))
  11150. (when (= (incf nshift) nshiftmax)
  11151. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  11152. (error "Abort")))
  11153. (org-timestamp-change n (cdr (assoc what whata)))
  11154. (org-at-timestamp-p t)
  11155. (setq ts (match-string 1))
  11156. (setq time (save-match-data (org-time-string-to-time ts)))))
  11157. (org-timestamp-change (- n) (cdr (assoc what whata)))
  11158. ;; rematch, so that we have everything in place for the real shift
  11159. (org-at-timestamp-p t)
  11160. (setq ts (match-string 1))
  11161. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  11162. (org-timestamp-change n (cdr (assoc what whata)))
  11163. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  11164. (setq org-log-post-message msg)
  11165. (message "%s" msg))))
  11166. (defun org-show-todo-tree (arg)
  11167. "Make a compact tree which shows all headlines marked with TODO.
  11168. The tree will show the lines where the regexp matches, and all higher
  11169. headlines above the match.
  11170. With a \\[universal-argument] prefix, prompt for a regexp to match.
  11171. With a numeric prefix N, construct a sparse tree for the Nth element
  11172. of `org-todo-keywords-1'."
  11173. (interactive "P")
  11174. (let ((case-fold-search nil)
  11175. (kwd-re
  11176. (cond ((null arg) org-not-done-regexp)
  11177. ((equal arg '(4))
  11178. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  11179. (mapcar 'list org-todo-keywords-1))))
  11180. (concat "\\("
  11181. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  11182. "\\)\\>")))
  11183. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  11184. (regexp-quote (nth (1- (prefix-numeric-value arg))
  11185. org-todo-keywords-1)))
  11186. (t (error "Invalid prefix argument: %s" arg)))))
  11187. (message "%d TODO entries found"
  11188. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  11189. (defun org-deadline (&optional remove time)
  11190. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  11191. With argument REMOVE, remove any deadline from the item.
  11192. With argument TIME, set the deadline at the corresponding date. TIME
  11193. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11194. (interactive "P")
  11195. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11196. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11197. 'region-start-level 'region))
  11198. org-loop-over-headlines-in-active-region)
  11199. (org-map-entries
  11200. `(org-deadline ',remove ,time)
  11201. org-loop-over-headlines-in-active-region
  11202. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11203. (let* ((old-date (org-entry-get nil "DEADLINE"))
  11204. (repeater (and old-date
  11205. (string-match
  11206. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11207. old-date)
  11208. (match-string 1 old-date))))
  11209. (if remove
  11210. (progn
  11211. (when (and old-date org-log-redeadline)
  11212. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11213. org-log-redeadline))
  11214. (org-remove-timestamp-with-keyword org-deadline-string)
  11215. (message "Item no longer has a deadline."))
  11216. (org-add-planning-info 'deadline time 'closed)
  11217. (when (and old-date org-log-redeadline
  11218. (not (equal old-date
  11219. (substring org-last-inserted-timestamp 1 -1))))
  11220. (org-add-log-setup 'redeadline nil old-date 'findpos
  11221. org-log-redeadline))
  11222. (when repeater
  11223. (save-excursion
  11224. (org-back-to-heading t)
  11225. (when (re-search-forward (concat org-deadline-string " "
  11226. org-last-inserted-timestamp)
  11227. (save-excursion
  11228. (outline-next-heading) (point)) t)
  11229. (goto-char (1- (match-end 0)))
  11230. (insert " " repeater)
  11231. (setq org-last-inserted-timestamp
  11232. (concat (substring org-last-inserted-timestamp 0 -1)
  11233. " " repeater
  11234. (substring org-last-inserted-timestamp -1))))))
  11235. (message "Deadline on %s" org-last-inserted-timestamp)))))
  11236. (defun org-schedule (&optional remove time)
  11237. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11238. With argument REMOVE, remove any scheduling date from the item.
  11239. With argument TIME, scheduled at the corresponding date. TIME can
  11240. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11241. (interactive "P")
  11242. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11243. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11244. 'region-start-level 'region))
  11245. org-loop-over-headlines-in-active-region)
  11246. (org-map-entries
  11247. `(org-schedule ',remove ,time)
  11248. org-loop-over-headlines-in-active-region
  11249. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11250. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11251. (repeater (and old-date
  11252. (string-match
  11253. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11254. old-date)
  11255. (match-string 1 old-date))))
  11256. (if remove
  11257. (progn
  11258. (when (and old-date org-log-reschedule)
  11259. (org-add-log-setup 'delschedule nil old-date 'findpos
  11260. org-log-reschedule))
  11261. (org-remove-timestamp-with-keyword org-scheduled-string)
  11262. (message "Item is no longer scheduled."))
  11263. (org-add-planning-info 'scheduled time 'closed)
  11264. (when (and old-date org-log-reschedule
  11265. (not (equal old-date
  11266. (substring org-last-inserted-timestamp 1 -1))))
  11267. (org-add-log-setup 'reschedule nil old-date 'findpos
  11268. org-log-reschedule))
  11269. (when repeater
  11270. (save-excursion
  11271. (org-back-to-heading t)
  11272. (when (re-search-forward (concat org-scheduled-string " "
  11273. org-last-inserted-timestamp)
  11274. (save-excursion
  11275. (outline-next-heading) (point)) t)
  11276. (goto-char (1- (match-end 0)))
  11277. (insert " " repeater)
  11278. (setq org-last-inserted-timestamp
  11279. (concat (substring org-last-inserted-timestamp 0 -1)
  11280. " " repeater
  11281. (substring org-last-inserted-timestamp -1))))))
  11282. (message "Scheduled to %s" org-last-inserted-timestamp)))))
  11283. (defun org-get-scheduled-time (pom &optional inherit)
  11284. "Get the scheduled time as a time tuple, of a format suitable
  11285. for calling org-schedule with, or if there is no scheduling,
  11286. returns nil."
  11287. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11288. (when time
  11289. (apply 'encode-time (org-parse-time-string time)))))
  11290. (defun org-get-deadline-time (pom &optional inherit)
  11291. "Get the deadline as a time tuple, of a format suitable for
  11292. calling org-deadline with, or if there is no scheduling, returns
  11293. nil."
  11294. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11295. (when time
  11296. (apply 'encode-time (org-parse-time-string time)))))
  11297. (defun org-remove-timestamp-with-keyword (keyword)
  11298. "Remove all time stamps with KEYWORD in the current entry."
  11299. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11300. beg)
  11301. (save-excursion
  11302. (org-back-to-heading t)
  11303. (setq beg (point))
  11304. (outline-next-heading)
  11305. (while (re-search-backward re beg t)
  11306. (replace-match "")
  11307. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11308. (equal (char-before) ?\ ))
  11309. (backward-delete-char 1)
  11310. (if (string-match "^[ \t]*$" (buffer-substring
  11311. (point-at-bol) (point-at-eol)))
  11312. (delete-region (point-at-bol)
  11313. (min (point-max) (1+ (point-at-eol))))))))))
  11314. (defun org-add-planning-info (what &optional time &rest remove)
  11315. "Insert new timestamp with keyword in the line directly after the headline.
  11316. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11317. If non is given, the user is prompted for a date.
  11318. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11319. be removed."
  11320. (interactive)
  11321. (let (org-time-was-given org-end-time-was-given ts
  11322. end default-time default-input)
  11323. (catch 'exit
  11324. (when (and (memq what '(scheduled deadline))
  11325. (or (not time)
  11326. (and (stringp time)
  11327. (string-match "^[-+]+[0-9]" time))))
  11328. ;; Try to get a default date/time from existing timestamp
  11329. (save-excursion
  11330. (org-back-to-heading t)
  11331. (setq end (save-excursion (outline-next-heading) (point)))
  11332. (when (re-search-forward (if (eq what 'scheduled)
  11333. org-scheduled-time-regexp
  11334. org-deadline-time-regexp)
  11335. end t)
  11336. (setq ts (match-string 1)
  11337. default-time
  11338. (apply 'encode-time (org-parse-time-string ts))
  11339. default-input (and ts (org-get-compact-tod ts))))))
  11340. (when what
  11341. (setq time
  11342. (if (stringp time)
  11343. ;; This is a string (relative or absolute), set proper date
  11344. (apply 'encode-time
  11345. (org-read-date-analyze
  11346. time default-time (decode-time default-time)))
  11347. ;; If necessary, get the time from the user
  11348. (or time (org-read-date nil 'to-time nil nil
  11349. default-time default-input)))))
  11350. (when (and org-insert-labeled-timestamps-at-point
  11351. (member what '(scheduled deadline)))
  11352. (insert
  11353. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11354. (org-insert-time-stamp time org-time-was-given
  11355. nil nil nil (list org-end-time-was-given))
  11356. (setq what nil))
  11357. (save-excursion
  11358. (save-restriction
  11359. (let (col list elt ts buffer-invisibility-spec)
  11360. (org-back-to-heading t)
  11361. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11362. (goto-char (match-end 1))
  11363. (setq col (current-column))
  11364. (goto-char (match-end 0))
  11365. (if (eobp) (insert "\n") (forward-char 1))
  11366. (when (and (not what)
  11367. (not (looking-at
  11368. (concat "[ \t]*"
  11369. org-keyword-time-not-clock-regexp))))
  11370. ;; Nothing to add, nothing to remove...... :-)
  11371. (throw 'exit nil))
  11372. (if (and (not (looking-at org-outline-regexp))
  11373. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11374. "[^\r\n]*"))
  11375. (not (equal (match-string 1) org-clock-string)))
  11376. (narrow-to-region (match-beginning 0) (match-end 0))
  11377. (insert-before-markers "\n")
  11378. (backward-char 1)
  11379. (narrow-to-region (point) (point))
  11380. (and org-adapt-indentation (org-indent-to-column col)))
  11381. ;; Check if we have to remove something.
  11382. (setq list (cons what remove))
  11383. (while list
  11384. (setq elt (pop list))
  11385. (when (or (and (eq elt 'scheduled)
  11386. (re-search-forward org-scheduled-time-regexp nil t))
  11387. (and (eq elt 'deadline)
  11388. (re-search-forward org-deadline-time-regexp nil t))
  11389. (and (eq elt 'closed)
  11390. (re-search-forward org-closed-time-regexp nil t)))
  11391. (replace-match "")
  11392. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11393. (and (looking-at "[ \t]+") (replace-match ""))
  11394. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11395. (when what
  11396. (insert
  11397. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11398. (cond ((eq what 'scheduled) org-scheduled-string)
  11399. ((eq what 'deadline) org-deadline-string)
  11400. ((eq what 'closed) org-closed-string))
  11401. " ")
  11402. (setq ts (org-insert-time-stamp
  11403. time
  11404. (or org-time-was-given
  11405. (and (eq what 'closed) org-log-done-with-time))
  11406. (eq what 'closed)
  11407. nil nil (list org-end-time-was-given)))
  11408. (insert
  11409. (if (not (or (bolp) (eq (char-before) ?\ )
  11410. (memq (char-after) '(32 10))
  11411. (eobp))) " " ""))
  11412. (end-of-line 1))
  11413. (goto-char (point-min))
  11414. (widen)
  11415. (if (and (looking-at "[ \t]*\n")
  11416. (equal (char-before) ?\n))
  11417. (delete-region (1- (point)) (point-at-eol)))
  11418. ts))))))
  11419. (defvar org-log-note-marker (make-marker))
  11420. (defvar org-log-note-purpose nil)
  11421. (defvar org-log-note-state nil)
  11422. (defvar org-log-note-previous-state nil)
  11423. (defvar org-log-note-how nil)
  11424. (defvar org-log-note-extra nil)
  11425. (defvar org-log-note-window-configuration nil)
  11426. (defvar org-log-note-return-to (make-marker))
  11427. (defvar org-log-note-effective-time nil
  11428. "Remembered current time so that dynamically scoped
  11429. `org-extend-today-until' affects tha timestamps in state change
  11430. log")
  11431. (defvar org-log-post-message nil
  11432. "Message to be displayed after a log note has been stored.
  11433. The auto-repeater uses this.")
  11434. (defun org-add-note ()
  11435. "Add a note to the current entry.
  11436. This is done in the same way as adding a state change note."
  11437. (interactive)
  11438. (org-add-log-setup 'note nil nil 'findpos nil))
  11439. (defvar org-property-end-re)
  11440. (defun org-add-log-setup (&optional purpose state prev-state
  11441. findpos how extra)
  11442. "Set up the post command hook to take a note.
  11443. If this is about to TODO state change, the new state is expected in STATE.
  11444. When FINDPOS is non-nil, find the correct position for the note in
  11445. the current entry. If not, assume that it can be inserted at point.
  11446. HOW is an indicator what kind of note should be created.
  11447. EXTRA is additional text that will be inserted into the notes buffer."
  11448. (let* ((org-log-into-drawer (org-log-into-drawer))
  11449. (drawer (cond ((stringp org-log-into-drawer)
  11450. org-log-into-drawer)
  11451. (org-log-into-drawer "LOGBOOK"))))
  11452. (save-restriction
  11453. (save-excursion
  11454. (when findpos
  11455. (org-back-to-heading t)
  11456. (narrow-to-region (point) (save-excursion
  11457. (outline-next-heading) (point)))
  11458. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  11459. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  11460. "[^\r\n]*\\)?"))
  11461. (goto-char (match-end 0))
  11462. (cond
  11463. (drawer
  11464. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  11465. nil t)
  11466. (progn
  11467. (goto-char (match-end 0))
  11468. (or org-log-states-order-reversed
  11469. (and (re-search-forward org-property-end-re nil t)
  11470. (goto-char (1- (match-beginning 0))))))
  11471. (insert "\n:" drawer ":\n:END:")
  11472. (beginning-of-line 0)
  11473. (org-indent-line)
  11474. (beginning-of-line 2)
  11475. (org-indent-line)
  11476. (end-of-line 0)))
  11477. ((and org-log-state-notes-insert-after-drawers
  11478. (save-excursion
  11479. (forward-line) (looking-at org-drawer-regexp)))
  11480. (forward-line)
  11481. (while (looking-at org-drawer-regexp)
  11482. (goto-char (match-end 0))
  11483. (re-search-forward org-property-end-re (point-max) t)
  11484. (forward-line))
  11485. (forward-line -1)))
  11486. (unless org-log-states-order-reversed
  11487. (and (= (char-after) ?\n) (forward-char 1))
  11488. (org-skip-over-state-notes)
  11489. (skip-chars-backward " \t\n\r")))
  11490. (move-marker org-log-note-marker (point))
  11491. (setq org-log-note-purpose purpose
  11492. org-log-note-state state
  11493. org-log-note-previous-state prev-state
  11494. org-log-note-how how
  11495. org-log-note-extra extra
  11496. org-log-note-effective-time (org-current-effective-time))
  11497. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  11498. (defun org-skip-over-state-notes ()
  11499. "Skip past the list of State notes in an entry."
  11500. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  11501. (when (ignore-errors (goto-char (org-in-item-p)))
  11502. (let* ((struct (org-list-struct))
  11503. (prevs (org-list-prevs-alist struct)))
  11504. (while (looking-at "[ \t]*- State")
  11505. (goto-char (or (org-list-get-next-item (point) struct prevs)
  11506. (org-list-get-item-end (point) struct)))))))
  11507. (defun org-add-log-note (&optional purpose)
  11508. "Pop up a window for taking a note, and add this note later at point."
  11509. (remove-hook 'post-command-hook 'org-add-log-note)
  11510. (setq org-log-note-window-configuration (current-window-configuration))
  11511. (delete-other-windows)
  11512. (move-marker org-log-note-return-to (point))
  11513. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  11514. (goto-char org-log-note-marker)
  11515. (org-switch-to-buffer-other-window "*Org Note*")
  11516. (erase-buffer)
  11517. (if (memq org-log-note-how '(time state))
  11518. (let (current-prefix-arg) (org-store-log-note))
  11519. (let ((org-inhibit-startup t)) (org-mode))
  11520. (insert (format "# Insert note for %s.
  11521. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  11522. (cond
  11523. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  11524. ((eq org-log-note-purpose 'done) "closed todo item")
  11525. ((eq org-log-note-purpose 'state)
  11526. (format "state change from \"%s\" to \"%s\""
  11527. (or org-log-note-previous-state "")
  11528. (or org-log-note-state "")))
  11529. ((eq org-log-note-purpose 'reschedule)
  11530. "rescheduling")
  11531. ((eq org-log-note-purpose 'delschedule)
  11532. "no longer scheduled")
  11533. ((eq org-log-note-purpose 'redeadline)
  11534. "changing deadline")
  11535. ((eq org-log-note-purpose 'deldeadline)
  11536. "removing deadline")
  11537. ((eq org-log-note-purpose 'refile)
  11538. "refiling")
  11539. ((eq org-log-note-purpose 'note)
  11540. "this entry")
  11541. (t (error "This should not happen")))))
  11542. (if org-log-note-extra (insert org-log-note-extra))
  11543. (org-set-local 'org-finish-function 'org-store-log-note)
  11544. (run-hooks 'org-log-buffer-setup-hook)))
  11545. (defvar org-note-abort nil) ; dynamically scoped
  11546. (defun org-store-log-note ()
  11547. "Finish taking a log note, and insert it to where it belongs."
  11548. (let ((txt (buffer-string))
  11549. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  11550. lines ind bul)
  11551. (kill-buffer (current-buffer))
  11552. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  11553. (setq txt (replace-match "" t t txt)))
  11554. (if (string-match "\\s-+\\'" txt)
  11555. (setq txt (replace-match "" t t txt)))
  11556. (setq lines (org-split-string txt "\n"))
  11557. (when (and note (string-match "\\S-" note))
  11558. (setq note
  11559. (org-replace-escapes
  11560. note
  11561. (list (cons "%u" (user-login-name))
  11562. (cons "%U" user-full-name)
  11563. (cons "%t" (format-time-string
  11564. (org-time-stamp-format 'long 'inactive)
  11565. org-log-note-effective-time))
  11566. (cons "%T" (format-time-string
  11567. (org-time-stamp-format 'long nil)
  11568. org-log-note-effective-time))
  11569. (cons "%d" (format-time-string
  11570. (org-time-stamp-format nil 'inactive)
  11571. org-log-note-effective-time))
  11572. (cons "%D" (format-time-string
  11573. (org-time-stamp-format nil nil)
  11574. org-log-note-effective-time))
  11575. (cons "%s" (if org-log-note-state
  11576. (concat "\"" org-log-note-state "\"")
  11577. ""))
  11578. (cons "%S" (if org-log-note-previous-state
  11579. (concat "\"" org-log-note-previous-state "\"")
  11580. "\"\"")))))
  11581. (if lines (setq note (concat note " \\\\")))
  11582. (push note lines))
  11583. (when (or current-prefix-arg org-note-abort)
  11584. (when org-log-into-drawer
  11585. (org-remove-empty-drawer-at
  11586. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  11587. org-log-note-marker))
  11588. (setq lines nil))
  11589. (when lines
  11590. (with-current-buffer (marker-buffer org-log-note-marker)
  11591. (save-excursion
  11592. (goto-char org-log-note-marker)
  11593. (move-marker org-log-note-marker nil)
  11594. (end-of-line 1)
  11595. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  11596. (setq ind (save-excursion
  11597. (if (ignore-errors (goto-char (org-in-item-p)))
  11598. (let ((struct (org-list-struct)))
  11599. (org-list-get-ind
  11600. (org-list-get-top-point struct) struct))
  11601. (skip-chars-backward " \r\t\n")
  11602. (cond
  11603. ((and (org-at-heading-p)
  11604. org-adapt-indentation)
  11605. (1+ (org-current-level)))
  11606. ((org-at-heading-p) 0)
  11607. (t (org-get-indentation))))))
  11608. (setq bul (org-list-bullet-string "-"))
  11609. (org-indent-line-to ind)
  11610. (insert bul (pop lines))
  11611. (let ((ind-body (+ (length bul) ind)))
  11612. (while lines
  11613. (insert "\n")
  11614. (org-indent-line-to ind-body)
  11615. (insert (pop lines))))
  11616. (message "Note stored")
  11617. (org-back-to-heading t)
  11618. (org-cycle-hide-drawers 'children)))))
  11619. (set-window-configuration org-log-note-window-configuration)
  11620. (with-current-buffer (marker-buffer org-log-note-return-to)
  11621. (goto-char org-log-note-return-to))
  11622. (move-marker org-log-note-return-to nil)
  11623. (and org-log-post-message (message "%s" org-log-post-message)))
  11624. (defun org-remove-empty-drawer-at (drawer pos)
  11625. "Remove an empty drawer DRAWER at position POS.
  11626. POS may also be a marker."
  11627. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  11628. (save-excursion
  11629. (save-restriction
  11630. (widen)
  11631. (goto-char pos)
  11632. (if (org-in-regexp
  11633. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  11634. (replace-match ""))))))
  11635. (defvar org-ts-type nil)
  11636. (defun org-sparse-tree (&optional arg type)
  11637. "Create a sparse tree, prompt for the details.
  11638. This command can create sparse trees. You first need to select the type
  11639. of match used to create the tree:
  11640. t Show all TODO entries.
  11641. T Show entries with a specific TODO keyword.
  11642. m Show entries selected by a tags/property match.
  11643. p Enter a property name and its value (both with completion on existing
  11644. names/values) and show entries with that property.
  11645. r Show entries matching a regular expression (`/' can be used as well).
  11646. b Show deadlines and scheduled items before a date.
  11647. a Show deadlines and scheduled items after a date.
  11648. d Show deadlines due within `org-deadline-warning-days'.
  11649. D Show deadlines and scheduled items between a date range."
  11650. (interactive "P")
  11651. (let (ans kwd value ts-type)
  11652. (setq type (or type org-sparse-tree-default-date-type))
  11653. (setq org-ts-type type)
  11654. (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"
  11655. (cond ((eq type 'all) "all timestamps")
  11656. ((eq type 'scheduled) "only scheduled")
  11657. ((eq type 'deadline) "only deadline")
  11658. ((eq type 'active) "only active timestamps")
  11659. ((eq type 'inactive) "only inactive timestamps")
  11660. ((eq type 'scheduled-or-deadline) "scheduled/deadline")
  11661. (t "scheduled/deadline")))
  11662. (setq ans (read-char-exclusive))
  11663. (cond
  11664. ((equal ans ?c)
  11665. (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
  11666. ((equal ans ?d)
  11667. (call-interactively 'org-check-deadlines))
  11668. ((equal ans ?b)
  11669. (call-interactively 'org-check-before-date))
  11670. ((equal ans ?a)
  11671. (call-interactively 'org-check-after-date))
  11672. ((equal ans ?D)
  11673. (call-interactively 'org-check-dates-range))
  11674. ((equal ans ?t)
  11675. (org-show-todo-tree nil))
  11676. ((equal ans ?T)
  11677. (org-show-todo-tree '(4)))
  11678. ((member ans '(?T ?m))
  11679. (call-interactively 'org-match-sparse-tree))
  11680. ((member ans '(?p ?P))
  11681. (setq kwd (org-icompleting-read "Property: "
  11682. (mapcar 'list (org-buffer-property-keys))))
  11683. (setq value (org-icompleting-read "Value: "
  11684. (mapcar 'list (org-property-values kwd))))
  11685. (unless (string-match "\\`{.*}\\'" value)
  11686. (setq value (concat "\"" value "\"")))
  11687. (org-match-sparse-tree arg (concat kwd "=" value)))
  11688. ((member ans '(?r ?R ?/))
  11689. (call-interactively 'org-occur))
  11690. (t (error "No such sparse tree command \"%c\"" ans)))))
  11691. (defvar org-occur-highlights nil
  11692. "List of overlays used for occur matches.")
  11693. (make-variable-buffer-local 'org-occur-highlights)
  11694. (defvar org-occur-parameters nil
  11695. "Parameters of the active org-occur calls.
  11696. This is a list, each call to org-occur pushes as cons cell,
  11697. containing the regular expression and the callback, onto the list.
  11698. The list can contain several entries if `org-occur' has been called
  11699. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  11700. will only contain one set of parameters. When the highlights are
  11701. removed (for example with `C-c C-c', or with the next edit (depending
  11702. on `org-remove-highlights-with-change'), this variable is emptied
  11703. as well.")
  11704. (make-variable-buffer-local 'org-occur-parameters)
  11705. (defun org-occur (regexp &optional keep-previous callback)
  11706. "Make a compact tree which shows all matches of REGEXP.
  11707. The tree will show the lines where the regexp matches, and all higher
  11708. headlines above the match. It will also show the heading after the match,
  11709. to make sure editing the matching entry is easy.
  11710. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  11711. call to `org-occur' will be kept, to allow stacking of calls to this
  11712. command.
  11713. If CALLBACK is non-nil, it is a function which is called to confirm
  11714. that the match should indeed be shown."
  11715. (interactive "sRegexp: \nP")
  11716. (when (equal regexp "")
  11717. (error "Regexp cannot be empty"))
  11718. (unless keep-previous
  11719. (org-remove-occur-highlights nil nil t))
  11720. (push (cons regexp callback) org-occur-parameters)
  11721. (let ((cnt 0))
  11722. (save-excursion
  11723. (goto-char (point-min))
  11724. (if (or (not keep-previous) ; do not want to keep
  11725. (not org-occur-highlights)) ; no previous matches
  11726. ;; hide everything
  11727. (org-overview))
  11728. (while (re-search-forward regexp nil t)
  11729. (when (or (not callback)
  11730. (save-match-data (funcall callback)))
  11731. (setq cnt (1+ cnt))
  11732. (when org-highlight-sparse-tree-matches
  11733. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  11734. (org-show-context 'occur-tree))))
  11735. (when org-remove-highlights-with-change
  11736. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  11737. nil 'local))
  11738. (unless org-sparse-tree-open-archived-trees
  11739. (org-hide-archived-subtrees (point-min) (point-max)))
  11740. (run-hooks 'org-occur-hook)
  11741. (if (org-called-interactively-p 'interactive)
  11742. (message "%d match(es) for regexp %s" cnt regexp))
  11743. cnt))
  11744. (defun org-occur-next-match (&optional n reset)
  11745. "Function for `next-error-function' to find sparse tree matches.
  11746. N is the number of matches to move, when negative move backwards.
  11747. RESET is entirely ignored - this function always goes back to the
  11748. starting point when no match is found."
  11749. (let* ((limit (if (< n 0) (point-min) (point-max)))
  11750. (search-func (if (< n 0)
  11751. 'previous-single-char-property-change
  11752. 'next-single-char-property-change))
  11753. (n (abs n))
  11754. (pos (point))
  11755. p1)
  11756. (catch 'exit
  11757. (while (setq p1 (funcall search-func (point) 'org-type))
  11758. (when (equal p1 limit)
  11759. (goto-char pos)
  11760. (error "No more matches"))
  11761. (when (equal (get-char-property p1 'org-type) 'org-occur)
  11762. (setq n (1- n))
  11763. (when (= n 0)
  11764. (goto-char p1)
  11765. (throw 'exit (point))))
  11766. (goto-char p1))
  11767. (goto-char p1)
  11768. (error "No more matches"))))
  11769. (defun org-show-context (&optional key)
  11770. "Make sure point and context are visible.
  11771. How much context is shown depends upon the variables
  11772. `org-show-hierarchy-above', `org-show-following-heading',
  11773. `org-show-entry-below' and `org-show-siblings'."
  11774. (let ((heading-p (org-at-heading-p t))
  11775. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  11776. (following-p (org-get-alist-option org-show-following-heading key))
  11777. (entry-p (org-get-alist-option org-show-entry-below key))
  11778. (siblings-p (org-get-alist-option org-show-siblings key)))
  11779. (catch 'exit
  11780. ;; Show heading or entry text
  11781. (if (and heading-p (not entry-p))
  11782. (org-flag-heading nil) ; only show the heading
  11783. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  11784. (org-show-hidden-entry))) ; show entire entry
  11785. (when following-p
  11786. ;; Show next sibling, or heading below text
  11787. (save-excursion
  11788. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  11789. (org-flag-heading nil))))
  11790. (when siblings-p (org-show-siblings))
  11791. (when hierarchy-p
  11792. ;; show all higher headings, possibly with siblings
  11793. (save-excursion
  11794. (while (and (condition-case nil
  11795. (progn (org-up-heading-all 1) t)
  11796. (error nil))
  11797. (not (bobp)))
  11798. (org-flag-heading nil)
  11799. (when siblings-p (org-show-siblings))))))))
  11800. (defvar org-reveal-start-hook nil
  11801. "Hook run before revealing a location.")
  11802. (defun org-reveal (&optional siblings)
  11803. "Show current entry, hierarchy above it, and the following headline.
  11804. This can be used to show a consistent set of context around locations
  11805. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  11806. not t for the search context.
  11807. With optional argument SIBLINGS, on each level of the hierarchy all
  11808. siblings are shown. This repairs the tree structure to what it would
  11809. look like when opened with hierarchical calls to `org-cycle'.
  11810. With double optional argument \\[universal-argument] \\[universal-argument], \
  11811. go to the parent and show the
  11812. entire tree."
  11813. (interactive "P")
  11814. (run-hooks 'org-reveal-start-hook)
  11815. (let ((org-show-hierarchy-above t)
  11816. (org-show-following-heading t)
  11817. (org-show-siblings (if siblings t org-show-siblings)))
  11818. (org-show-context nil))
  11819. (when (equal siblings '(16))
  11820. (save-excursion
  11821. (when (org-up-heading-safe)
  11822. (org-show-subtree)
  11823. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  11824. (defun org-highlight-new-match (beg end)
  11825. "Highlight from BEG to END and mark the highlight is an occur headline."
  11826. (let ((ov (make-overlay beg end)))
  11827. (overlay-put ov 'face 'secondary-selection)
  11828. (overlay-put ov 'org-type 'org-occur)
  11829. (push ov org-occur-highlights)))
  11830. (defun org-remove-occur-highlights (&optional beg end noremove)
  11831. "Remove the occur highlights from the buffer.
  11832. BEG and END are ignored. If NOREMOVE is nil, remove this function
  11833. from the `before-change-functions' in the current buffer."
  11834. (interactive)
  11835. (unless org-inhibit-highlight-removal
  11836. (mapc 'delete-overlay org-occur-highlights)
  11837. (setq org-occur-highlights nil)
  11838. (setq org-occur-parameters nil)
  11839. (unless noremove
  11840. (remove-hook 'before-change-functions
  11841. 'org-remove-occur-highlights 'local))))
  11842. ;;;; Priorities
  11843. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  11844. "Regular expression matching the priority indicator.")
  11845. (defvar org-remove-priority-next-time nil)
  11846. (defun org-priority-up ()
  11847. "Increase the priority of the current item."
  11848. (interactive)
  11849. (org-priority 'up))
  11850. (defun org-priority-down ()
  11851. "Decrease the priority of the current item."
  11852. (interactive)
  11853. (org-priority 'down))
  11854. (defun org-priority (&optional action)
  11855. "Change the priority of an item.
  11856. ACTION can be `set', `up', `down', or a character."
  11857. (interactive)
  11858. (unless org-enable-priority-commands
  11859. (error "Priority commands are disabled"))
  11860. (setq action (or action 'set))
  11861. (let (current new news have remove)
  11862. (save-excursion
  11863. (org-back-to-heading t)
  11864. (if (looking-at org-priority-regexp)
  11865. (setq current (string-to-char (match-string 2))
  11866. have t))
  11867. (cond
  11868. ((eq action 'remove)
  11869. (setq remove t new ?\ ))
  11870. ((or (eq action 'set)
  11871. (if (featurep 'xemacs) (characterp action) (integerp action)))
  11872. (if (not (eq action 'set))
  11873. (setq new action)
  11874. (message "Priority %c-%c, SPC to remove: "
  11875. org-highest-priority org-lowest-priority)
  11876. (save-match-data
  11877. (setq new (read-char-exclusive))))
  11878. (if (and (= (upcase org-highest-priority) org-highest-priority)
  11879. (= (upcase org-lowest-priority) org-lowest-priority))
  11880. (setq new (upcase new)))
  11881. (cond ((equal new ?\ ) (setq remove t))
  11882. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  11883. (error "Priority must be between `%c' and `%c'"
  11884. org-highest-priority org-lowest-priority))))
  11885. ((eq action 'up)
  11886. (setq new (if have
  11887. (1- current) ; normal cycling
  11888. ;; last priority was empty
  11889. (if (eq last-command this-command)
  11890. org-lowest-priority ; wrap around empty to lowest
  11891. ;; default
  11892. (if org-priority-start-cycle-with-default
  11893. org-default-priority
  11894. (1- org-default-priority))))))
  11895. ((eq action 'down)
  11896. (setq new (if have
  11897. (1+ current) ; normal cycling
  11898. ;; last priority was empty
  11899. (if (eq last-command this-command)
  11900. org-highest-priority ; wrap around empty to highest
  11901. ;; default
  11902. (if org-priority-start-cycle-with-default
  11903. org-default-priority
  11904. (1+ org-default-priority))))))
  11905. (t (error "Invalid action")))
  11906. (if (or (< (upcase new) org-highest-priority)
  11907. (> (upcase new) org-lowest-priority))
  11908. (if (and (memq action '(up down))
  11909. (not have) (not (eq last-command this-command)))
  11910. ;; `new' is from default priority
  11911. (error
  11912. "The default can not be set, see `org-default-priority' why")
  11913. ;; normal cycling: `new' is beyond highest/lowest priority
  11914. ;; and is wrapped around to the empty priority
  11915. (setq remove t)))
  11916. (setq news (format "%c" new))
  11917. (if have
  11918. (if remove
  11919. (replace-match "" t t nil 1)
  11920. (replace-match news t t nil 2))
  11921. (if remove
  11922. (error "No priority cookie found in line")
  11923. (let ((case-fold-search nil))
  11924. (looking-at org-todo-line-regexp))
  11925. (if (match-end 2)
  11926. (progn
  11927. (goto-char (match-end 2))
  11928. (insert " [#" news "]"))
  11929. (goto-char (match-beginning 3))
  11930. (insert "[#" news "] "))))
  11931. (org-preserve-lc (org-set-tags nil 'align)))
  11932. (if remove
  11933. (message "Priority removed")
  11934. (message "Priority of current item set to %s" news))))
  11935. (defun org-get-priority (s)
  11936. "Find priority cookie and return priority."
  11937. (if (functionp org-get-priority-function)
  11938. (funcall org-get-priority-function)
  11939. (save-match-data
  11940. (if (not (string-match org-priority-regexp s))
  11941. (* 1000 (- org-lowest-priority org-default-priority))
  11942. (* 1000 (- org-lowest-priority
  11943. (string-to-char (match-string 2 s))))))))
  11944. ;;;; Tags
  11945. (defvar org-agenda-archives-mode)
  11946. (defvar org-map-continue-from nil
  11947. "Position from where mapping should continue.
  11948. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  11949. (defvar org-scanner-tags nil
  11950. "The current tag list while the tags scanner is running.")
  11951. (defvar org-trust-scanner-tags nil
  11952. "Should `org-get-tags-at' use the tags for the scanner.
  11953. This is for internal dynamical scoping only.
  11954. When this is non-nil, the function `org-get-tags-at' will return the value
  11955. of `org-scanner-tags' instead of building the list by itself. This
  11956. can lead to large speed-ups when the tags scanner is used in a file with
  11957. many entries, and when the list of tags is retrieved, for example to
  11958. obtain a list of properties. Building the tags list for each entry in such
  11959. a file becomes an N^2 operation - but with this variable set, it scales
  11960. as N.")
  11961. (defun org-scan-tags (action matcher todo-only &optional start-level)
  11962. "Scan headline tags with inheritance and produce output ACTION.
  11963. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  11964. or `agenda' to produce an entry list for an agenda view. It can also be
  11965. a Lisp form or a function that should be called at each matched headline, in
  11966. this case the return value is a list of all return values from these calls.
  11967. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  11968. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  11969. only lines with a not-done TODO keyword are included in the output.
  11970. This should be the same variable that was scoped into
  11971. and set by `org-make-tags-matcher' when it constructed MATCHER.
  11972. START-LEVEL can be a string with asterisks, reducing the scope to
  11973. headlines matching this string."
  11974. (require 'org-agenda)
  11975. (let* ((re (concat "^"
  11976. (if start-level
  11977. ;; Get the correct level to match
  11978. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  11979. org-outline-regexp)
  11980. " *\\(\\<\\("
  11981. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  11982. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  11983. (props (list 'face 'default
  11984. 'done-face 'org-agenda-done
  11985. 'undone-face 'default
  11986. 'mouse-face 'highlight
  11987. 'org-not-done-regexp org-not-done-regexp
  11988. 'org-todo-regexp org-todo-regexp
  11989. 'org-complex-heading-regexp org-complex-heading-regexp
  11990. 'help-echo
  11991. (format "mouse-2 or RET jump to org file %s"
  11992. (abbreviate-file-name
  11993. (or (buffer-file-name (buffer-base-buffer))
  11994. (buffer-name (buffer-base-buffer)))))))
  11995. (case-fold-search nil)
  11996. (org-map-continue-from nil)
  11997. lspos tags tags-list
  11998. (tags-alist (list (cons 0 org-file-tags)))
  11999. (llast 0) rtn rtn1 level category i txt
  12000. todo marker entry priority)
  12001. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  12002. (setq action (list 'lambda nil action)))
  12003. (save-excursion
  12004. (goto-char (point-min))
  12005. (when (eq action 'sparse-tree)
  12006. (org-overview)
  12007. (org-remove-occur-highlights))
  12008. (while (re-search-forward re nil t)
  12009. (setq org-map-continue-from nil)
  12010. (catch :skip
  12011. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  12012. tags (if (match-end 4) (org-match-string-no-properties 4)))
  12013. (goto-char (setq lspos (match-beginning 0)))
  12014. (setq level (org-reduced-level (funcall outline-level))
  12015. category (org-get-category))
  12016. (setq i llast llast level)
  12017. ;; remove tag lists from same and sublevels
  12018. (while (>= i level)
  12019. (when (setq entry (assoc i tags-alist))
  12020. (setq tags-alist (delete entry tags-alist)))
  12021. (setq i (1- i)))
  12022. ;; add the next tags
  12023. (when tags
  12024. (setq tags (org-split-string tags ":")
  12025. tags-alist
  12026. (cons (cons level tags) tags-alist)))
  12027. ;; compile tags for current headline
  12028. (setq tags-list
  12029. (if org-use-tag-inheritance
  12030. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  12031. tags)
  12032. org-scanner-tags tags-list)
  12033. (when org-use-tag-inheritance
  12034. (setcdr (car tags-alist)
  12035. (mapcar (lambda (x)
  12036. (setq x (copy-sequence x))
  12037. (org-add-prop-inherited x))
  12038. (cdar tags-alist))))
  12039. (when (and tags org-use-tag-inheritance
  12040. (or (not (eq t org-use-tag-inheritance))
  12041. org-tags-exclude-from-inheritance))
  12042. ;; selective inheritance, remove uninherited ones
  12043. (setcdr (car tags-alist)
  12044. (org-remove-uninherited-tags (cdar tags-alist))))
  12045. (when (and
  12046. ;; eval matcher only when the todo condition is OK
  12047. (and (or (not todo-only) (member todo org-not-done-keywords))
  12048. (let ((case-fold-search t) (org-trust-scanner-tags t))
  12049. (eval matcher)))
  12050. ;; Call the skipper, but return t if it does not skip,
  12051. ;; so that the `and' form continues evaluating
  12052. (progn
  12053. (unless (eq action 'sparse-tree) (org-agenda-skip))
  12054. t)
  12055. ;; Check if timestamps are deselecting this entry
  12056. (or (not todo-only)
  12057. (and (member todo org-not-done-keywords)
  12058. (or (not org-agenda-tags-todo-honor-ignore-options)
  12059. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  12060. ;; Extra check for the archive tag
  12061. ;; FIXME: Does the skipper already do this????
  12062. (or
  12063. (not (member org-archive-tag tags-list))
  12064. ;; we have an archive tag, should we use this anyway?
  12065. (or (not org-agenda-skip-archived-trees)
  12066. (and (eq action 'agenda) org-agenda-archives-mode))))
  12067. ;; select this headline
  12068. (cond
  12069. ((eq action 'sparse-tree)
  12070. (and org-highlight-sparse-tree-matches
  12071. (org-get-heading) (match-end 0)
  12072. (org-highlight-new-match
  12073. (match-beginning 1) (match-end 1)))
  12074. (org-show-context 'tags-tree))
  12075. ((eq action 'agenda)
  12076. (setq txt (org-agenda-format-item
  12077. ""
  12078. (concat
  12079. (if (eq org-tags-match-list-sublevels 'indented)
  12080. (make-string (1- level) ?.) "")
  12081. (org-get-heading))
  12082. category
  12083. tags-list)
  12084. priority (org-get-priority txt))
  12085. (goto-char lspos)
  12086. (setq marker (org-agenda-new-marker))
  12087. (org-add-props txt props
  12088. 'org-marker marker 'org-hd-marker marker 'org-category category
  12089. 'todo-state todo
  12090. 'priority priority 'type "tagsmatch")
  12091. (push txt rtn))
  12092. ((functionp action)
  12093. (setq org-map-continue-from nil)
  12094. (save-excursion
  12095. (setq rtn1 (funcall action))
  12096. (push rtn1 rtn)))
  12097. (t (error "Invalid action")))
  12098. ;; if we are to skip sublevels, jump to end of subtree
  12099. (unless org-tags-match-list-sublevels
  12100. (org-end-of-subtree t)
  12101. (backward-char 1))))
  12102. ;; Get the correct position from where to continue
  12103. (if org-map-continue-from
  12104. (goto-char org-map-continue-from)
  12105. (and (= (point) lspos) (end-of-line 1)))))
  12106. (when (and (eq action 'sparse-tree)
  12107. (not org-sparse-tree-open-archived-trees))
  12108. (org-hide-archived-subtrees (point-min) (point-max)))
  12109. (nreverse rtn)))
  12110. (defun org-remove-uninherited-tags (tags)
  12111. "Remove all tags that are not inherited from the list TAGS."
  12112. (cond
  12113. ((eq org-use-tag-inheritance t)
  12114. (if org-tags-exclude-from-inheritance
  12115. (org-delete-all org-tags-exclude-from-inheritance tags)
  12116. tags))
  12117. ((not org-use-tag-inheritance) nil)
  12118. ((stringp org-use-tag-inheritance)
  12119. (delq nil (mapcar
  12120. (lambda (x)
  12121. (if (and (string-match org-use-tag-inheritance x)
  12122. (not (member x org-tags-exclude-from-inheritance)))
  12123. x nil))
  12124. tags)))
  12125. ((listp org-use-tag-inheritance)
  12126. (delq nil (mapcar
  12127. (lambda (x)
  12128. (if (member x org-use-tag-inheritance) x nil))
  12129. tags)))))
  12130. (defun org-match-sparse-tree (&optional todo-only match)
  12131. "Create a sparse tree according to tags string MATCH.
  12132. MATCH can contain positive and negative selection of tags, like
  12133. \"+WORK+URGENT-WITHBOSS\".
  12134. If optional argument TODO-ONLY is non-nil, only select lines that are
  12135. also TODO lines."
  12136. (interactive "P")
  12137. (org-agenda-prepare-buffers (list (current-buffer)))
  12138. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  12139. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  12140. (defvar org-cached-props nil)
  12141. (defun org-cached-entry-get (pom property)
  12142. (if (or (eq t org-use-property-inheritance)
  12143. (and (stringp org-use-property-inheritance)
  12144. (string-match org-use-property-inheritance property))
  12145. (and (listp org-use-property-inheritance)
  12146. (member property org-use-property-inheritance)))
  12147. ;; Caching is not possible, check it directly
  12148. (org-entry-get pom property 'inherit)
  12149. ;; Get all properties, so that we can do complicated checks easily
  12150. (cdr (assoc property (or org-cached-props
  12151. (setq org-cached-props
  12152. (org-entry-properties pom)))))))
  12153. (defun org-global-tags-completion-table (&optional files)
  12154. "Return the list of all tags in all agenda buffer/files.
  12155. Optional FILES argument is a list of files which can be used
  12156. instead of the agenda files."
  12157. (save-excursion
  12158. (org-uniquify
  12159. (delq nil
  12160. (apply 'append
  12161. (mapcar
  12162. (lambda (file)
  12163. (set-buffer (find-file-noselect file))
  12164. (append (org-get-buffer-tags)
  12165. (mapcar (lambda (x) (if (stringp (car-safe x))
  12166. (list (car-safe x)) nil))
  12167. org-tag-alist)))
  12168. (if (and files (car files))
  12169. files
  12170. (org-agenda-files))))))))
  12171. (defun org-make-tags-matcher (match)
  12172. "Create the TAGS/TODO matcher form for the selection string MATCH.
  12173. The variable `todo-only' is scoped dynamically into this function.
  12174. It will be set to t if the matcher restricts matching to TODO entries,
  12175. otherwise will not be touched.
  12176. Returns a cons of the selection string MATCH and the constructed
  12177. lisp form implementing the matcher. The matcher is to be evaluated
  12178. at an Org entry, with point on the headline, and returns t if the
  12179. entry matches the selection string MATCH. The returned lisp form
  12180. references two variables with information about the entry, which
  12181. must be bound around the form's evaluation: todo, the TODO keyword
  12182. at the entry (or nil of none); and tags-list, the list of all tags
  12183. at the entry including inherited ones. Additionally, the category
  12184. of the entry (if any) must be specified as the text property
  12185. 'org-category on the headline.
  12186. See also `org-scan-tags'.
  12187. "
  12188. (declare (special todo-only))
  12189. (unless (boundp 'todo-only)
  12190. (error "org-make-tags-matcher expects todo-only to be scoped in"))
  12191. (unless match
  12192. ;; Get a new match request, with completion
  12193. (let ((org-last-tags-completion-table
  12194. (org-global-tags-completion-table)))
  12195. (setq match (org-completing-read-no-i
  12196. "Match: " 'org-tags-completion-function nil nil nil
  12197. 'org-tags-history))))
  12198. ;; Parse the string and create a lisp form
  12199. (let ((match0 match)
  12200. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  12201. minus tag mm
  12202. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  12203. orterms term orlist re-p str-p level-p level-op time-p
  12204. prop-p pn pv po gv rest)
  12205. (if (string-match "/+" match)
  12206. ;; match contains also a todo-matching request
  12207. (progn
  12208. (setq tagsmatch (substring match 0 (match-beginning 0))
  12209. todomatch (substring match (match-end 0)))
  12210. (if (string-match "^!" todomatch)
  12211. (setq todo-only t todomatch (substring todomatch 1)))
  12212. (if (string-match "^\\s-*$" todomatch)
  12213. (setq todomatch nil)))
  12214. ;; only matching tags
  12215. (setq tagsmatch match todomatch nil))
  12216. ;; Make the tags matcher
  12217. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12218. (setq tagsmatcher t)
  12219. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12220. (while (setq term (pop orterms))
  12221. (while (and (equal (substring term -1) "\\") orterms)
  12222. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12223. (while (string-match re term)
  12224. (setq rest (substring term (match-end 0))
  12225. minus (and (match-end 1)
  12226. (equal (match-string 1 term) "-"))
  12227. tag (save-match-data (replace-regexp-in-string
  12228. "\\\\-" "-"
  12229. (match-string 2 term)))
  12230. re-p (equal (string-to-char tag) ?{)
  12231. level-p (match-end 4)
  12232. prop-p (match-end 5)
  12233. mm (cond
  12234. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12235. (level-p
  12236. (setq level-op (org-op-to-function (match-string 3 term)))
  12237. `(,level-op level ,(string-to-number
  12238. (match-string 4 term))))
  12239. (prop-p
  12240. (setq pn (match-string 5 term)
  12241. po (match-string 6 term)
  12242. pv (match-string 7 term)
  12243. re-p (equal (string-to-char pv) ?{)
  12244. str-p (equal (string-to-char pv) ?\")
  12245. time-p (save-match-data
  12246. (string-match "^\"[[<].*[]>]\"$" pv))
  12247. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12248. (if time-p (setq pv (org-matcher-time pv)))
  12249. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12250. (cond
  12251. ((equal pn "CATEGORY")
  12252. (setq gv '(get-text-property (point) 'org-category)))
  12253. ((equal pn "TODO")
  12254. (setq gv 'todo))
  12255. (t
  12256. (setq gv `(org-cached-entry-get nil ,pn))))
  12257. (if re-p
  12258. (if (eq po 'org<>)
  12259. `(not (string-match ,pv (or ,gv "")))
  12260. `(string-match ,pv (or ,gv "")))
  12261. (if str-p
  12262. `(,po (or ,gv "") ,pv)
  12263. `(,po (string-to-number (or ,gv ""))
  12264. ,(string-to-number pv) ))))
  12265. (t `(member ,tag tags-list)))
  12266. mm (if minus (list 'not mm) mm)
  12267. term rest)
  12268. (push mm tagsmatcher))
  12269. (push (if (> (length tagsmatcher) 1)
  12270. (cons 'and tagsmatcher)
  12271. (car tagsmatcher))
  12272. orlist)
  12273. (setq tagsmatcher nil))
  12274. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12275. (setq tagsmatcher
  12276. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12277. ;; Make the todo matcher
  12278. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12279. (setq todomatcher t)
  12280. (setq orterms (org-split-string todomatch "|") orlist nil)
  12281. (while (setq term (pop orterms))
  12282. (while (string-match re term)
  12283. (setq minus (and (match-end 1)
  12284. (equal (match-string 1 term) "-"))
  12285. kwd (match-string 2 term)
  12286. re-p (equal (string-to-char kwd) ?{)
  12287. term (substring term (match-end 0))
  12288. mm (if re-p
  12289. `(string-match ,(substring kwd 1 -1) todo)
  12290. (list 'equal 'todo kwd))
  12291. mm (if minus (list 'not mm) mm))
  12292. (push mm todomatcher))
  12293. (push (if (> (length todomatcher) 1)
  12294. (cons 'and todomatcher)
  12295. (car todomatcher))
  12296. orlist)
  12297. (setq todomatcher nil))
  12298. (setq todomatcher (if (> (length orlist) 1)
  12299. (cons 'or orlist) (car orlist))))
  12300. ;; Return the string and lisp forms of the matcher
  12301. (setq matcher (if todomatcher
  12302. (list 'and tagsmatcher todomatcher)
  12303. tagsmatcher))
  12304. (when todo-only
  12305. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12306. matcher)))
  12307. (cons match0 matcher)))
  12308. (defun org-op-to-function (op &optional stringp)
  12309. "Turn an operator into the appropriate function."
  12310. (setq op
  12311. (cond
  12312. ((equal op "<" ) '(< string< org-time<))
  12313. ((equal op ">" ) '(> org-string> org-time>))
  12314. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12315. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12316. ((member op '("=" "==")) '(= string= org-time=))
  12317. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12318. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12319. (defun org<> (a b) (not (= a b)))
  12320. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12321. (defun org-string>= (a b) (not (string< a b)))
  12322. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12323. (defun org-string<> (a b) (not (string= a b)))
  12324. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  12325. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  12326. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  12327. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  12328. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  12329. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  12330. (defun org-2ft (s)
  12331. "Convert S to a floating point time.
  12332. If S is already a number, just return it. If it is a string, parse
  12333. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  12334. (cond
  12335. ((numberp s) s)
  12336. ((stringp s)
  12337. (condition-case nil
  12338. (float-time (apply 'encode-time (org-parse-time-string s)))
  12339. (error 0.)))
  12340. (t 0.)))
  12341. (defun org-time-today ()
  12342. "Time in seconds today at 0:00.
  12343. Returns the float number of seconds since the beginning of the
  12344. epoch to the beginning of today (00:00)."
  12345. (float-time (apply 'encode-time
  12346. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  12347. (defun org-matcher-time (s)
  12348. "Interpret a time comparison value."
  12349. (save-match-data
  12350. (cond
  12351. ((string= s "<now>") (float-time))
  12352. ((string= s "<today>") (org-time-today))
  12353. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  12354. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  12355. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  12356. (+ (org-time-today)
  12357. (* (string-to-number (match-string 1 s))
  12358. (cdr (assoc (match-string 2 s)
  12359. '(("d" . 86400.0) ("w" . 604800.0)
  12360. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  12361. (t (org-2ft s)))))
  12362. (defun org-match-any-p (re list)
  12363. "Does re match any element of list?"
  12364. (setq list (mapcar (lambda (x) (string-match re x)) list))
  12365. (delq nil list))
  12366. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  12367. (defvar org-tags-overlay (make-overlay 1 1))
  12368. (org-detach-overlay org-tags-overlay)
  12369. (defun org-get-local-tags-at (&optional pos)
  12370. "Get a list of tags defined in the current headline."
  12371. (org-get-tags-at pos 'local))
  12372. (defun org-get-local-tags ()
  12373. "Get a list of tags defined in the current headline."
  12374. (org-get-tags-at nil 'local))
  12375. (defun org-get-tags-at (&optional pos local)
  12376. "Get a list of all headline tags applicable at POS.
  12377. POS defaults to point. If tags are inherited, the list contains
  12378. the targets in the same sequence as the headlines appear, i.e.
  12379. the tags of the current headline come last.
  12380. When LOCAL is non-nil, only return tags from the current headline,
  12381. ignore inherited ones."
  12382. (interactive)
  12383. (if (and org-trust-scanner-tags
  12384. (or (not pos) (equal pos (point)))
  12385. (not local))
  12386. org-scanner-tags
  12387. (let (tags ltags lastpos parent)
  12388. (save-excursion
  12389. (save-restriction
  12390. (widen)
  12391. (goto-char (or pos (point)))
  12392. (save-match-data
  12393. (catch 'done
  12394. (condition-case nil
  12395. (progn
  12396. (org-back-to-heading t)
  12397. (while (not (equal lastpos (point)))
  12398. (setq lastpos (point))
  12399. (when (looking-at
  12400. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  12401. (setq ltags (org-split-string
  12402. (org-match-string-no-properties 1) ":"))
  12403. (when parent
  12404. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  12405. (setq tags (append
  12406. (if parent
  12407. (org-remove-uninherited-tags ltags)
  12408. ltags)
  12409. tags)))
  12410. (or org-use-tag-inheritance (throw 'done t))
  12411. (if local (throw 'done t))
  12412. (or (org-up-heading-safe) (error nil))
  12413. (setq parent t)))
  12414. (error nil)))))
  12415. (if local
  12416. tags
  12417. (append (org-remove-uninherited-tags org-file-tags) tags))))))
  12418. (defun org-add-prop-inherited (s)
  12419. (add-text-properties 0 (length s) '(inherited t) s)
  12420. s)
  12421. (defun org-toggle-tag (tag &optional onoff)
  12422. "Toggle the tag TAG for the current line.
  12423. If ONOFF is `on' or `off', don't toggle but set to this state."
  12424. (let (res current)
  12425. (save-excursion
  12426. (org-back-to-heading t)
  12427. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  12428. (point-at-eol) t)
  12429. (progn
  12430. (setq current (match-string 1))
  12431. (replace-match ""))
  12432. (setq current ""))
  12433. (setq current (nreverse (org-split-string current ":")))
  12434. (cond
  12435. ((eq onoff 'on)
  12436. (setq res t)
  12437. (or (member tag current) (push tag current)))
  12438. ((eq onoff 'off)
  12439. (or (not (member tag current)) (setq current (delete tag current))))
  12440. (t (if (member tag current)
  12441. (setq current (delete tag current))
  12442. (setq res t)
  12443. (push tag current))))
  12444. (end-of-line 1)
  12445. (if current
  12446. (progn
  12447. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  12448. (org-set-tags nil t))
  12449. (delete-horizontal-space))
  12450. (run-hooks 'org-after-tags-change-hook))
  12451. res))
  12452. (defun org-align-tags-here (to-col)
  12453. ;; Assumes that this is a headline
  12454. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  12455. (beginning-of-line 1)
  12456. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12457. (< pos (match-beginning 2)))
  12458. (progn
  12459. (setq tags-l (- (match-end 2) (match-beginning 2)))
  12460. (goto-char (match-beginning 1))
  12461. (insert " ")
  12462. (delete-region (point) (1+ (match-beginning 2)))
  12463. (setq ncol (max (current-column)
  12464. (1+ col)
  12465. (if (> to-col 0)
  12466. to-col
  12467. (- (abs to-col) tags-l))))
  12468. (setq p (point))
  12469. (insert (make-string (- ncol (current-column)) ?\ ))
  12470. (setq ncol (current-column))
  12471. (when indent-tabs-mode (tabify p (point-at-eol)))
  12472. (org-move-to-column (min ncol col) t))
  12473. (goto-char pos))))
  12474. (defun org-set-tags-command (&optional arg just-align)
  12475. "Call the set-tags command for the current entry."
  12476. (interactive "P")
  12477. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  12478. (org-set-tags arg just-align)
  12479. (save-excursion
  12480. (org-back-to-heading t)
  12481. (org-set-tags arg just-align))))
  12482. (defun org-set-tags-to (data)
  12483. "Set the tags of the current entry to DATA, replacing the current tags.
  12484. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  12485. If DATA is nil or the empty string, any tags will be removed."
  12486. (interactive "sTags: ")
  12487. (setq data
  12488. (cond
  12489. ((eq data nil) "")
  12490. ((equal data "") "")
  12491. ((stringp data)
  12492. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  12493. ":"))
  12494. ((listp data)
  12495. (concat ":" (mapconcat 'identity data ":") ":"))))
  12496. (when data
  12497. (save-excursion
  12498. (org-back-to-heading t)
  12499. (when (looking-at org-complex-heading-regexp)
  12500. (if (match-end 5)
  12501. (progn
  12502. (goto-char (match-beginning 5))
  12503. (insert data)
  12504. (delete-region (point) (point-at-eol))
  12505. (org-set-tags nil 'align))
  12506. (goto-char (point-at-eol))
  12507. (insert " " data)
  12508. (org-set-tags nil 'align)))
  12509. (beginning-of-line 1)
  12510. (if (looking-at ".*?\\([ \t]+\\)$")
  12511. (delete-region (match-beginning 1) (match-end 1))))))
  12512. (defun org-align-all-tags ()
  12513. "Align the tags i all headings."
  12514. (interactive)
  12515. (save-excursion
  12516. (or (ignore-errors (org-back-to-heading t))
  12517. (outline-next-heading))
  12518. (if (org-at-heading-p)
  12519. (org-set-tags t)
  12520. (message "No headings"))))
  12521. (defvar org-indent-indentation-per-level)
  12522. (defun org-set-tags (&optional arg just-align)
  12523. "Set the tags for the current headline.
  12524. With prefix ARG, realign all tags in headings in the current buffer."
  12525. (interactive "P")
  12526. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12527. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12528. 'region-start-level 'region))
  12529. org-loop-over-headlines-in-active-region)
  12530. (org-map-entries
  12531. ;; We don't use ARG and JUST-ALIGN here these args are not
  12532. ;; useful when looping over headlines
  12533. `(org-set-tags)
  12534. org-loop-over-headlines-in-active-region
  12535. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12536. (let* ((re org-outline-regexp-bol)
  12537. (current (unless arg (org-get-tags-string)))
  12538. (col (current-column))
  12539. (org-setting-tags t)
  12540. table current-tags inherited-tags ; computed below when needed
  12541. tags p0 c0 c1 rpl di tc level)
  12542. (if arg
  12543. (save-excursion
  12544. (goto-char (point-min))
  12545. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  12546. (while (re-search-forward re nil t)
  12547. (org-set-tags nil t)
  12548. (end-of-line 1)))
  12549. (message "All tags realigned to column %d" org-tags-column))
  12550. (if just-align
  12551. (setq tags current)
  12552. ;; Get a new set of tags from the user
  12553. (save-excursion
  12554. (setq table (append org-tag-persistent-alist
  12555. (or org-tag-alist (org-get-buffer-tags))
  12556. (and
  12557. org-complete-tags-always-offer-all-agenda-tags
  12558. (org-global-tags-completion-table
  12559. (org-agenda-files))))
  12560. org-last-tags-completion-table table
  12561. current-tags (org-split-string current ":")
  12562. inherited-tags (nreverse
  12563. (nthcdr (length current-tags)
  12564. (nreverse (org-get-tags-at))))
  12565. tags
  12566. (if (or (eq t org-use-fast-tag-selection)
  12567. (and org-use-fast-tag-selection
  12568. (delq nil (mapcar 'cdr table))))
  12569. (org-fast-tag-selection
  12570. current-tags inherited-tags table
  12571. (if org-fast-tag-selection-include-todo
  12572. org-todo-key-alist))
  12573. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  12574. (org-trim
  12575. (org-icompleting-read "Tags: "
  12576. 'org-tags-completion-function
  12577. nil nil current 'org-tags-history))))))
  12578. (while (string-match "[-+&]+" tags)
  12579. ;; No boolean logic, just a list
  12580. (setq tags (replace-match ":" t t tags))))
  12581. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  12582. (if org-tags-sort-function
  12583. (setq tags (mapconcat 'identity
  12584. (sort (org-split-string
  12585. tags (org-re "[^[:alnum:]_@#%]+"))
  12586. org-tags-sort-function) ":")))
  12587. (if (string-match "\\`[\t ]*\\'" tags)
  12588. (setq tags "")
  12589. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  12590. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  12591. ;; Insert new tags at the correct column
  12592. (beginning-of-line 1)
  12593. (setq level (or (and (looking-at org-outline-regexp)
  12594. (- (match-end 0) (point) 1))
  12595. 1))
  12596. (cond
  12597. ((and (equal current "") (equal tags "")))
  12598. ((re-search-forward
  12599. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  12600. (point-at-eol) t)
  12601. (if (equal tags "")
  12602. (setq rpl "")
  12603. (goto-char (match-beginning 0))
  12604. (setq c0 (current-column)
  12605. ;; compute offset for the case of org-indent-mode active
  12606. di (if org-indent-mode
  12607. (* (1- org-indent-indentation-per-level) (1- level))
  12608. 0)
  12609. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  12610. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  12611. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  12612. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  12613. (replace-match rpl t t)
  12614. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  12615. tags)
  12616. (t (error "Tags alignment failed")))
  12617. (org-move-to-column col)
  12618. (unless just-align
  12619. (run-hooks 'org-after-tags-change-hook))))))
  12620. (defun org-change-tag-in-region (beg end tag off)
  12621. "Add or remove TAG for each entry in the region.
  12622. This works in the agenda, and also in an org-mode buffer."
  12623. (interactive
  12624. (list (region-beginning) (region-end)
  12625. (let ((org-last-tags-completion-table
  12626. (if (derived-mode-p 'org-mode)
  12627. (org-get-buffer-tags)
  12628. (org-global-tags-completion-table))))
  12629. (org-icompleting-read
  12630. "Tag: " 'org-tags-completion-function nil nil nil
  12631. 'org-tags-history))
  12632. (progn
  12633. (message "[s]et or [r]emove? ")
  12634. (equal (read-char-exclusive) ?r))))
  12635. (if (fboundp 'deactivate-mark) (deactivate-mark))
  12636. (let ((agendap (equal major-mode 'org-agenda-mode))
  12637. l1 l2 m buf pos newhead (cnt 0))
  12638. (goto-char end)
  12639. (setq l2 (1- (org-current-line)))
  12640. (goto-char beg)
  12641. (setq l1 (org-current-line))
  12642. (loop for l from l1 to l2 do
  12643. (org-goto-line l)
  12644. (setq m (get-text-property (point) 'org-hd-marker))
  12645. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  12646. (and agendap m))
  12647. (setq buf (if agendap (marker-buffer m) (current-buffer))
  12648. pos (if agendap m (point)))
  12649. (with-current-buffer buf
  12650. (save-excursion
  12651. (save-restriction
  12652. (goto-char pos)
  12653. (setq cnt (1+ cnt))
  12654. (org-toggle-tag tag (if off 'off 'on))
  12655. (setq newhead (org-get-heading)))))
  12656. (and agendap (org-agenda-change-all-lines newhead m))))
  12657. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  12658. (defun org-tags-completion-function (string predicate &optional flag)
  12659. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  12660. (confirm (lambda (x) (stringp (car x)))))
  12661. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  12662. (setq s1 (match-string 1 string)
  12663. s2 (match-string 2 string))
  12664. (setq s1 "" s2 string))
  12665. (cond
  12666. ((eq flag nil)
  12667. ;; try completion
  12668. (setq rtn (try-completion s2 ctable confirm))
  12669. (if (stringp rtn)
  12670. (setq rtn
  12671. (concat s1 s2 (substring rtn (length s2))
  12672. (if (and org-add-colon-after-tag-completion
  12673. (assoc rtn ctable))
  12674. ":" ""))))
  12675. rtn)
  12676. ((eq flag t)
  12677. ;; all-completions
  12678. (all-completions s2 ctable confirm)
  12679. )
  12680. ((eq flag 'lambda)
  12681. ;; exact match?
  12682. (assoc s2 ctable)))
  12683. ))
  12684. (defun org-fast-tag-insert (kwd tags face &optional end)
  12685. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  12686. (insert (format "%-12s" (concat kwd ":"))
  12687. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  12688. (or end "")))
  12689. (defun org-fast-tag-show-exit (flag)
  12690. (save-excursion
  12691. (org-goto-line 3)
  12692. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  12693. (replace-match ""))
  12694. (when flag
  12695. (end-of-line 1)
  12696. (org-move-to-column (- (window-width) 19) t)
  12697. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  12698. (defun org-set-current-tags-overlay (current prefix)
  12699. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  12700. (if (featurep 'xemacs)
  12701. (org-overlay-display org-tags-overlay (concat prefix s)
  12702. 'secondary-selection)
  12703. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  12704. (org-overlay-display org-tags-overlay (concat prefix s)))))
  12705. (defvar org-last-tag-selection-key nil)
  12706. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  12707. "Fast tag selection with single keys.
  12708. CURRENT is the current list of tags in the headline, INHERITED is the
  12709. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  12710. possibly with grouping information. TODO-TABLE is a similar table with
  12711. TODO keywords, should these have keys assigned to them.
  12712. If the keys are nil, a-z are automatically assigned.
  12713. Returns the new tags string, or nil to not change the current settings."
  12714. (let* ((fulltable (append table todo-table))
  12715. (maxlen (apply 'max (mapcar
  12716. (lambda (x)
  12717. (if (stringp (car x)) (string-width (car x)) 0))
  12718. fulltable)))
  12719. (buf (current-buffer))
  12720. (expert (eq org-fast-tag-selection-single-key 'expert))
  12721. (buffer-tags nil)
  12722. (fwidth (+ maxlen 3 1 3))
  12723. (ncol (/ (- (window-width) 4) fwidth))
  12724. (i-face 'org-done)
  12725. (c-face 'org-todo)
  12726. tg cnt e c char c1 c2 ntable tbl rtn
  12727. ov-start ov-end ov-prefix
  12728. (exit-after-next org-fast-tag-selection-single-key)
  12729. (done-keywords org-done-keywords)
  12730. groups ingroup)
  12731. (save-excursion
  12732. (beginning-of-line 1)
  12733. (if (looking-at
  12734. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12735. (setq ov-start (match-beginning 1)
  12736. ov-end (match-end 1)
  12737. ov-prefix "")
  12738. (setq ov-start (1- (point-at-eol))
  12739. ov-end (1+ ov-start))
  12740. (skip-chars-forward "^\n\r")
  12741. (setq ov-prefix
  12742. (concat
  12743. (buffer-substring (1- (point)) (point))
  12744. (if (> (current-column) org-tags-column)
  12745. " "
  12746. (make-string (- org-tags-column (current-column)) ?\ ))))))
  12747. (move-overlay org-tags-overlay ov-start ov-end)
  12748. (save-window-excursion
  12749. (if expert
  12750. (set-buffer (get-buffer-create " *Org tags*"))
  12751. (delete-other-windows)
  12752. (split-window-vertically)
  12753. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  12754. (erase-buffer)
  12755. (org-set-local 'org-done-keywords done-keywords)
  12756. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  12757. (org-fast-tag-insert "Current" current c-face "\n\n")
  12758. (org-fast-tag-show-exit exit-after-next)
  12759. (org-set-current-tags-overlay current ov-prefix)
  12760. (setq tbl fulltable char ?a cnt 0)
  12761. (while (setq e (pop tbl))
  12762. (cond
  12763. ((equal (car e) :startgroup)
  12764. (push '() groups) (setq ingroup t)
  12765. (when (not (= cnt 0))
  12766. (setq cnt 0)
  12767. (insert "\n"))
  12768. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  12769. ((equal (car e) :endgroup)
  12770. (setq ingroup nil cnt 0)
  12771. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  12772. ((equal e '(:newline))
  12773. (when (not (= cnt 0))
  12774. (setq cnt 0)
  12775. (insert "\n")
  12776. (setq e (car tbl))
  12777. (while (equal (car tbl) '(:newline))
  12778. (insert "\n")
  12779. (setq tbl (cdr tbl)))))
  12780. (t
  12781. (setq tg (copy-sequence (car e)) c2 nil)
  12782. (if (cdr e)
  12783. (setq c (cdr e))
  12784. ;; automatically assign a character.
  12785. (setq c1 (string-to-char
  12786. (downcase (substring
  12787. tg (if (= (string-to-char tg) ?@) 1 0)))))
  12788. (if (or (rassoc c1 ntable) (rassoc c1 table))
  12789. (while (or (rassoc char ntable) (rassoc char table))
  12790. (setq char (1+ char)))
  12791. (setq c2 c1))
  12792. (setq c (or c2 char)))
  12793. (if ingroup (push tg (car groups)))
  12794. (setq tg (org-add-props tg nil 'face
  12795. (cond
  12796. ((not (assoc tg table))
  12797. (org-get-todo-face tg))
  12798. ((member tg current) c-face)
  12799. ((member tg inherited) i-face))))
  12800. (if (and (= cnt 0) (not ingroup)) (insert " "))
  12801. (insert "[" c "] " tg (make-string
  12802. (- fwidth 4 (length tg)) ?\ ))
  12803. (push (cons tg c) ntable)
  12804. (when (= (setq cnt (1+ cnt)) ncol)
  12805. (insert "\n")
  12806. (if ingroup (insert " "))
  12807. (setq cnt 0)))))
  12808. (setq ntable (nreverse ntable))
  12809. (insert "\n")
  12810. (goto-char (point-min))
  12811. (if (not expert) (org-fit-window-to-buffer))
  12812. (setq rtn
  12813. (catch 'exit
  12814. (while t
  12815. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  12816. (if (not groups) "no " "")
  12817. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  12818. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  12819. (setq org-last-tag-selection-key c)
  12820. (cond
  12821. ((= c ?\r) (throw 'exit t))
  12822. ((= c ?!)
  12823. (setq groups (not groups))
  12824. (goto-char (point-min))
  12825. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  12826. ((= c ?\C-c)
  12827. (if (not expert)
  12828. (org-fast-tag-show-exit
  12829. (setq exit-after-next (not exit-after-next)))
  12830. (setq expert nil)
  12831. (delete-other-windows)
  12832. (set-window-buffer (split-window-vertically) " *Org tags*")
  12833. (org-switch-to-buffer-other-window " *Org tags*")
  12834. (org-fit-window-to-buffer)))
  12835. ((or (= c ?\C-g)
  12836. (and (= c ?q) (not (rassoc c ntable))))
  12837. (org-detach-overlay org-tags-overlay)
  12838. (setq quit-flag t))
  12839. ((= c ?\ )
  12840. (setq current nil)
  12841. (if exit-after-next (setq exit-after-next 'now)))
  12842. ((= c ?\t)
  12843. (condition-case nil
  12844. (setq tg (org-icompleting-read
  12845. "Tag: "
  12846. (or buffer-tags
  12847. (with-current-buffer buf
  12848. (org-get-buffer-tags)))))
  12849. (quit (setq tg "")))
  12850. (when (string-match "\\S-" tg)
  12851. (add-to-list 'buffer-tags (list tg))
  12852. (if (member tg current)
  12853. (setq current (delete tg current))
  12854. (push tg current)))
  12855. (if exit-after-next (setq exit-after-next 'now)))
  12856. ((setq e (rassoc c todo-table) tg (car e))
  12857. (with-current-buffer buf
  12858. (save-excursion (org-todo tg)))
  12859. (if exit-after-next (setq exit-after-next 'now)))
  12860. ((setq e (rassoc c ntable) tg (car e))
  12861. (if (member tg current)
  12862. (setq current (delete tg current))
  12863. (loop for g in groups do
  12864. (if (member tg g)
  12865. (mapc (lambda (x)
  12866. (setq current (delete x current)))
  12867. g)))
  12868. (push tg current))
  12869. (if exit-after-next (setq exit-after-next 'now))))
  12870. ;; Create a sorted list
  12871. (setq current
  12872. (sort current
  12873. (lambda (a b)
  12874. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  12875. (if (eq exit-after-next 'now) (throw 'exit t))
  12876. (goto-char (point-min))
  12877. (beginning-of-line 2)
  12878. (delete-region (point) (point-at-eol))
  12879. (org-fast-tag-insert "Current" current c-face)
  12880. (org-set-current-tags-overlay current ov-prefix)
  12881. (while (re-search-forward
  12882. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  12883. (setq tg (match-string 1))
  12884. (add-text-properties
  12885. (match-beginning 1) (match-end 1)
  12886. (list 'face
  12887. (cond
  12888. ((member tg current) c-face)
  12889. ((member tg inherited) i-face)
  12890. (t (get-text-property (match-beginning 1) 'face))))))
  12891. (goto-char (point-min)))))
  12892. (org-detach-overlay org-tags-overlay)
  12893. (if rtn
  12894. (mapconcat 'identity current ":")
  12895. nil))))
  12896. (defun org-get-tags-string ()
  12897. "Get the TAGS string in the current headline."
  12898. (unless (org-at-heading-p t)
  12899. (error "Not on a heading"))
  12900. (save-excursion
  12901. (beginning-of-line 1)
  12902. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12903. (org-match-string-no-properties 1)
  12904. "")))
  12905. (defun org-get-tags ()
  12906. "Get the list of tags specified in the current headline."
  12907. (org-split-string (org-get-tags-string) ":"))
  12908. (defun org-get-buffer-tags ()
  12909. "Get a table of all tags used in the buffer, for completion."
  12910. (let (tags)
  12911. (save-excursion
  12912. (goto-char (point-min))
  12913. (while (re-search-forward
  12914. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  12915. (when (equal (char-after (point-at-bol 0)) ?*)
  12916. (mapc (lambda (x) (add-to-list 'tags x))
  12917. (org-split-string (org-match-string-no-properties 1) ":")))))
  12918. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  12919. (mapcar 'list tags)))
  12920. ;;;; The mapping API
  12921. ;;;###autoload
  12922. (defun org-map-entries (func &optional match scope &rest skip)
  12923. "Call FUNC at each headline selected by MATCH in SCOPE.
  12924. FUNC is a function or a lisp form. The function will be called without
  12925. arguments, with the cursor positioned at the beginning of the headline.
  12926. The return values of all calls to the function will be collected and
  12927. returned as a list.
  12928. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  12929. does not need to preserve point. After evaluation, the cursor will be
  12930. moved to the end of the line (presumably of the headline of the
  12931. processed entry) and search continues from there. Under some
  12932. circumstances, this may not produce the wanted results. For example,
  12933. if you have removed (e.g. archived) the current (sub)tree it could
  12934. mean that the next entry will be skipped entirely. In such cases, you
  12935. can specify the position from where search should continue by making
  12936. FUNC set the variable `org-map-continue-from' to the desired buffer
  12937. position.
  12938. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  12939. Only headlines that are matched by this query will be considered during
  12940. the iteration. When MATCH is nil or t, all headlines will be
  12941. visited by the iteration.
  12942. SCOPE determines the scope of this command. It can be any of:
  12943. nil The current buffer, respecting the restriction if any
  12944. tree The subtree started with the entry at point
  12945. region The entries within the active region, if any
  12946. region-start-level
  12947. The entries within the active region, but only those at
  12948. the same level than the first one.
  12949. file The current buffer, without restriction
  12950. file-with-archives
  12951. The current buffer, and any archives associated with it
  12952. agenda All agenda files
  12953. agenda-with-archives
  12954. All agenda files with any archive files associated with them
  12955. \(file1 file2 ...)
  12956. If this is a list, all files in the list will be scanned
  12957. The remaining args are treated as settings for the skipping facilities of
  12958. the scanner. The following items can be given here:
  12959. archive skip trees with the archive tag.
  12960. comment skip trees with the COMMENT keyword
  12961. function or Emacs Lisp form:
  12962. will be used as value for `org-agenda-skip-function', so whenever
  12963. the function returns t, FUNC will not be called for that
  12964. entry and search will continue from the point where the
  12965. function leaves it.
  12966. If your function needs to retrieve the tags including inherited tags
  12967. at the *current* entry, you can use the value of the variable
  12968. `org-scanner-tags' which will be much faster than getting the value
  12969. with `org-get-tags-at'. If your function gets properties with
  12970. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  12971. to t around the call to `org-entry-properties' to get the same speedup.
  12972. Note that if your function moves around to retrieve tags and properties at
  12973. a *different* entry, you cannot use these techniques."
  12974. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  12975. (not (org-region-active-p)))
  12976. (let* ((org-agenda-archives-mode nil) ; just to make sure
  12977. (org-agenda-skip-archived-trees (memq 'archive skip))
  12978. (org-agenda-skip-comment-trees (memq 'comment skip))
  12979. (org-agenda-skip-function
  12980. (car (org-delete-all '(comment archive) skip)))
  12981. (org-tags-match-list-sublevels t)
  12982. (start-level (eq scope 'region-start-level))
  12983. matcher file res
  12984. org-todo-keywords-for-agenda
  12985. org-done-keywords-for-agenda
  12986. org-todo-keyword-alist-for-agenda
  12987. org-drawers-for-agenda
  12988. org-tag-alist-for-agenda
  12989. todo-only)
  12990. (cond
  12991. ((eq match t) (setq matcher t))
  12992. ((eq match nil) (setq matcher t))
  12993. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  12994. (save-excursion
  12995. (save-restriction
  12996. (cond ((eq scope 'tree)
  12997. (org-back-to-heading t)
  12998. (org-narrow-to-subtree)
  12999. (setq scope nil))
  13000. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  13001. (org-region-active-p))
  13002. ;; If needed, set start-level to a string like "2"
  13003. (when start-level
  13004. (save-excursion
  13005. (goto-char (region-beginning))
  13006. (unless (org-at-heading-p) (outline-next-heading))
  13007. (setq start-level (org-current-level))))
  13008. (narrow-to-region (region-beginning)
  13009. (save-excursion
  13010. (goto-char (region-end))
  13011. (unless (and (bolp) (org-at-heading-p))
  13012. (outline-next-heading))
  13013. (point)))
  13014. (setq scope nil)))
  13015. (if (not scope)
  13016. (progn
  13017. (org-agenda-prepare-buffers
  13018. (list (buffer-file-name (current-buffer))))
  13019. (setq res (org-scan-tags func matcher todo-only start-level)))
  13020. ;; Get the right scope
  13021. (cond
  13022. ((and scope (listp scope) (symbolp (car scope)))
  13023. (setq scope (eval scope)))
  13024. ((eq scope 'agenda)
  13025. (setq scope (org-agenda-files t)))
  13026. ((eq scope 'agenda-with-archives)
  13027. (setq scope (org-agenda-files t))
  13028. (setq scope (org-add-archive-files scope)))
  13029. ((eq scope 'file)
  13030. (setq scope (list (buffer-file-name))))
  13031. ((eq scope 'file-with-archives)
  13032. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  13033. (org-agenda-prepare-buffers scope)
  13034. (while (setq file (pop scope))
  13035. (with-current-buffer (org-find-base-buffer-visiting file)
  13036. (save-excursion
  13037. (save-restriction
  13038. (widen)
  13039. (goto-char (point-min))
  13040. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  13041. res)))
  13042. ;;;; Properties
  13043. ;;; Setting and retrieving properties
  13044. (defconst org-special-properties
  13045. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  13046. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
  13047. "The special properties valid in Org-mode.
  13048. These are properties that are not defined in the property drawer,
  13049. but in some other way.")
  13050. (defconst org-default-properties
  13051. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  13052. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  13053. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  13054. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  13055. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  13056. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  13057. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  13058. "Some properties that are used by Org-mode for various purposes.
  13059. Being in this list makes sure that they are offered for completion.")
  13060. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  13061. "Regular expression matching the first line of a property drawer.")
  13062. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  13063. "Regular expression matching the last line of a property drawer.")
  13064. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  13065. "Regular expression matching the first line of a property drawer.")
  13066. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  13067. "Regular expression matching the first line of a property drawer.")
  13068. (defconst org-property-drawer-re
  13069. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  13070. org-property-end-re "\\)\n?")
  13071. "Matches an entire property drawer.")
  13072. (defconst org-clock-drawer-re
  13073. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  13074. org-property-end-re "\\)\n?")
  13075. "Matches an entire clock drawer.")
  13076. (defsubst org-re-property (property)
  13077. "Return a regexp matching a PROPERTY line.
  13078. Match group 1 will be set to the value."
  13079. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
  13080. (defsubst org-re-property-keyword (property)
  13081. "Return a regexp matching a PROPERTY line, possibly with no
  13082. value for the property."
  13083. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)?"))
  13084. (defun org-property-action ()
  13085. "Do an action on properties."
  13086. (interactive)
  13087. (let (c)
  13088. (org-at-property-p)
  13089. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  13090. (setq c (read-char-exclusive))
  13091. (cond
  13092. ((equal c ?s)
  13093. (call-interactively 'org-set-property))
  13094. ((equal c ?d)
  13095. (call-interactively 'org-delete-property))
  13096. ((equal c ?D)
  13097. (call-interactively 'org-delete-property-globally))
  13098. ((equal c ?c)
  13099. (call-interactively 'org-compute-property-at-point))
  13100. (t (error "No such property action %c" c)))))
  13101. (defun org-inc-effort ()
  13102. "Increment the value of the effort property in the current entry."
  13103. (interactive)
  13104. (org-set-effort nil t))
  13105. (defun org-set-effort (&optional value increment)
  13106. "Set the effort property of the current entry.
  13107. With numerical prefix arg, use the nth allowed value, 0 stands for the
  13108. 10th allowed value.
  13109. When INCREMENT is non-nil, set the property to the next allowed value."
  13110. (interactive "P")
  13111. (if (equal value 0) (setq value 10))
  13112. (let* ((completion-ignore-case t)
  13113. (prop org-effort-property)
  13114. (cur (org-entry-get nil prop))
  13115. (allowed (org-property-get-allowed-values nil prop 'table))
  13116. (existing (mapcar 'list (org-property-values prop)))
  13117. rpl
  13118. (val (cond
  13119. ((stringp value) value)
  13120. ((and allowed (integerp value))
  13121. (or (car (nth (1- value) allowed))
  13122. (car (org-last allowed))))
  13123. ((and allowed increment)
  13124. (or (caadr (member (list cur) allowed))
  13125. (error "Allowed effort values are not set")))
  13126. (allowed
  13127. (message "Select 1-9,0, [RET%s]: %s"
  13128. (if cur (concat "=" cur) "")
  13129. (mapconcat 'car allowed " "))
  13130. (setq rpl (read-char-exclusive))
  13131. (if (equal rpl ?\r)
  13132. cur
  13133. (setq rpl (- rpl ?0))
  13134. (if (equal rpl 0) (setq rpl 10))
  13135. (if (and (> rpl 0) (<= rpl (length allowed)))
  13136. (car (nth (1- rpl) allowed))
  13137. (org-completing-read "Effort: " allowed nil))))
  13138. (t
  13139. (let (org-completion-use-ido org-completion-use-iswitchb)
  13140. (org-completing-read
  13141. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  13142. (concat "[" cur "]") "")
  13143. ": ")
  13144. existing nil nil "" nil cur))))))
  13145. (unless (equal (org-entry-get nil prop) val)
  13146. (org-entry-put nil prop val))
  13147. (message "%s is now %s" prop val)))
  13148. (defun org-at-property-p ()
  13149. "Is cursor inside a property drawer?"
  13150. (save-excursion
  13151. (beginning-of-line 1)
  13152. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  13153. (save-match-data ;; Used by calling procedures
  13154. (let ((p (point))
  13155. (range (unless (org-before-first-heading-p)
  13156. (org-get-property-block))))
  13157. (and range (<= (car range) p) (< p (cdr range))))))))
  13158. (defun org-get-property-block (&optional beg end force)
  13159. "Return the (beg . end) range of the body of the property drawer.
  13160. BEG and END are the beginning and end of the current subtree, or of
  13161. the part before the first headline. If they are not given, they will
  13162. be found. If the drawer does not exist and FORCE is non-nil, create
  13163. the drawer."
  13164. (catch 'exit
  13165. (save-excursion
  13166. (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
  13167. (progn (org-back-to-heading t) (point))))
  13168. (end (or end (and (not (outline-next-heading)) (point-max))
  13169. (point))))
  13170. (goto-char beg)
  13171. (if (re-search-forward org-property-start-re end t)
  13172. (setq beg (1+ (match-end 0)))
  13173. (if force
  13174. (save-excursion
  13175. (org-insert-property-drawer)
  13176. (setq end (progn (outline-next-heading) (point))))
  13177. (throw 'exit nil))
  13178. (goto-char beg)
  13179. (if (re-search-forward org-property-start-re end t)
  13180. (setq beg (1+ (match-end 0)))))
  13181. (if (re-search-forward org-property-end-re end t)
  13182. (setq end (match-beginning 0))
  13183. (or force (throw 'exit nil))
  13184. (goto-char beg)
  13185. (setq end beg)
  13186. (org-indent-line)
  13187. (insert ":END:\n"))
  13188. (cons beg end)))))
  13189. (defun org-entry-properties (&optional pom which specific)
  13190. "Get all properties of the entry at point-or-marker POM.
  13191. This includes the TODO keyword, the tags, time strings for deadline,
  13192. scheduled, and clocking, and any additional properties defined in the
  13193. entry. The return value is an alist, keys may occur multiple times
  13194. if the property key was used several times.
  13195. POM may also be nil, in which case the current entry is used.
  13196. If WHICH is nil or `all', get all properties. If WHICH is
  13197. `special' or `standard', only get that subclass. If WHICH
  13198. is a string only get exactly this property. SPECIFIC can be a string, the
  13199. specific property we are interested in. Specifying it can speed
  13200. things up because then unnecessary parsing is avoided."
  13201. (setq which (or which 'all))
  13202. (org-with-point-at pom
  13203. (let ((clockstr (substring org-clock-string 0 -1))
  13204. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  13205. (case-fold-search nil)
  13206. beg end range props sum-props key key1 value string clocksum clocksumt)
  13207. (save-excursion
  13208. (when (condition-case nil
  13209. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  13210. (error nil))
  13211. (setq beg (point))
  13212. (setq sum-props (get-text-property (point) 'org-summaries))
  13213. (setq clocksum (get-text-property (point) :org-clock-minutes)
  13214. clocksumt (get-text-property (point) :org-clock-minutes-today))
  13215. (outline-next-heading)
  13216. (setq end (point))
  13217. (when (memq which '(all special))
  13218. ;; Get the special properties, like TODO and tags
  13219. (goto-char beg)
  13220. (when (and (or (not specific) (string= specific "TODO"))
  13221. (looking-at org-todo-line-regexp) (match-end 2))
  13222. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  13223. (when (and (or (not specific) (string= specific "PRIORITY"))
  13224. (looking-at org-priority-regexp))
  13225. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  13226. (when (or (not specific) (string= specific "FILE"))
  13227. (push (cons "FILE" buffer-file-name) props))
  13228. (when (and (or (not specific) (string= specific "TAGS"))
  13229. (setq value (org-get-tags-string))
  13230. (string-match "\\S-" value))
  13231. (push (cons "TAGS" value) props))
  13232. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13233. (setq value (org-get-tags-at)))
  13234. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13235. ":"))
  13236. props))
  13237. (when (or (not specific) (string= specific "BLOCKED"))
  13238. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13239. (when (or (not specific)
  13240. (member specific
  13241. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13242. "TIMESTAMP" "TIMESTAMP_IA")))
  13243. (catch 'match
  13244. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13245. (setq key (if (match-end 1)
  13246. (substring (org-match-string-no-properties 1)
  13247. 0 -1))
  13248. string (if (equal key clockstr)
  13249. (org-trim
  13250. (buffer-substring-no-properties
  13251. (match-beginning 3) (goto-char
  13252. (point-at-eol))))
  13253. (substring (org-match-string-no-properties 3)
  13254. 1 -1)))
  13255. ;; Get the correct property name from the key. This is
  13256. ;; necessary if the user has configured time keywords.
  13257. (setq key1 (concat key ":"))
  13258. (cond
  13259. ((not key)
  13260. (setq key
  13261. (if (= (char-after (match-beginning 3)) ?\[)
  13262. "TIMESTAMP_IA" "TIMESTAMP")))
  13263. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13264. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13265. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13266. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13267. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13268. (progn
  13269. (push (cons key string) props)
  13270. ;; no need to search further if match is found
  13271. (throw 'match t))
  13272. (when (or (equal key "CLOCK") (not (assoc key props)))
  13273. (push (cons key string) props)))))))
  13274. (when (memq which '(all standard))
  13275. ;; Get the standard properties, like :PROP: ...
  13276. (setq range (org-get-property-block beg end))
  13277. (when range
  13278. (goto-char (car range))
  13279. (while (re-search-forward
  13280. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  13281. (cdr range) t)
  13282. (setq key (org-match-string-no-properties 1)
  13283. value (org-trim (or (org-match-string-no-properties 2) "")))
  13284. (unless (member key excluded)
  13285. (push (cons key (or value "")) props)))))
  13286. (if clocksum
  13287. (push (cons "CLOCKSUM"
  13288. (org-columns-number-to-string (/ (float clocksum) 60.)
  13289. 'add_times))
  13290. props))
  13291. (if clocksumt
  13292. (push (cons "CLOCKSUM_T"
  13293. (org-columns-number-to-string (/ (float clocksumt) 60.)
  13294. 'add_times))
  13295. props))
  13296. (unless (assoc "CATEGORY" props)
  13297. (push (cons "CATEGORY" (org-get-category)) props))
  13298. (append sum-props (nreverse props)))))))
  13299. (defun org-entry-get (pom property &optional inherit literal-nil)
  13300. "Get value of PROPERTY for entry or content at point-or-marker POM.
  13301. If INHERIT is non-nil and the entry does not have the property,
  13302. then also check higher levels of the hierarchy.
  13303. If INHERIT is the symbol `selective', use inheritance only if the setting
  13304. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13305. If the property is present but empty, the return value is the empty string.
  13306. If the property is not present at all, nil is returned.
  13307. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13308. do not interpret it as the list atom nil. This is used for inheritance
  13309. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13310. (org-with-point-at pom
  13311. (if (and inherit (if (eq inherit 'selective)
  13312. (org-property-inherit-p property)
  13313. t))
  13314. (org-entry-get-with-inheritance property literal-nil)
  13315. (if (member property org-special-properties)
  13316. ;; We need a special property. Use `org-entry-properties' to
  13317. ;; retrieve it, but specify the wanted property
  13318. (cdr (assoc property (org-entry-properties nil 'special property)))
  13319. (let* ((range (org-get-property-block))
  13320. (props (list (or (assoc property org-file-properties)
  13321. (assoc property org-global-properties)
  13322. (assoc property org-global-properties-fixed))))
  13323. (ap (lambda (key)
  13324. (when (re-search-forward
  13325. (org-re-property key) (cdr range) t)
  13326. (setq props
  13327. (org-update-property-plist
  13328. key
  13329. (if (match-end 1)
  13330. (org-match-string-no-properties 1) "")
  13331. props)))))
  13332. val)
  13333. (when (and range (goto-char (car range)))
  13334. (funcall ap property)
  13335. (goto-char (car range))
  13336. (while (funcall ap (concat property "+")))
  13337. (setq val (cdr (assoc property props)))
  13338. (when val (if literal-nil val (org-not-nil val)))))))))
  13339. (defun org-property-or-variable-value (var &optional inherit)
  13340. "Check if there is a property fixing the value of VAR.
  13341. If yes, return this value. If not, return the current value of the variable."
  13342. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  13343. (if (and prop (stringp prop) (string-match "\\S-" prop))
  13344. (read prop)
  13345. (symbol-value var))))
  13346. (defun org-entry-delete (pom property)
  13347. "Delete the property PROPERTY from entry at point-or-marker POM."
  13348. (org-with-point-at pom
  13349. (if (member property org-special-properties)
  13350. nil ; cannot delete these properties.
  13351. (let ((range (org-get-property-block)))
  13352. (if (and range
  13353. (goto-char (car range))
  13354. (re-search-forward
  13355. (org-re-property property)
  13356. (cdr range) t))
  13357. (progn
  13358. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  13359. t)
  13360. nil)))))
  13361. ;; Multi-values properties are properties that contain multiple values
  13362. ;; These values are assumed to be single words, separated by whitespace.
  13363. (defun org-entry-add-to-multivalued-property (pom property value)
  13364. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  13365. (let* ((old (org-entry-get pom property))
  13366. (values (and old (org-split-string old "[ \t]"))))
  13367. (setq value (org-entry-protect-space value))
  13368. (unless (member value values)
  13369. (setq values (cons value values))
  13370. (org-entry-put pom property
  13371. (mapconcat 'identity values " ")))))
  13372. (defun org-entry-remove-from-multivalued-property (pom property value)
  13373. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  13374. (let* ((old (org-entry-get pom property))
  13375. (values (and old (org-split-string old "[ \t]"))))
  13376. (setq value (org-entry-protect-space value))
  13377. (when (member value values)
  13378. (setq values (delete value values))
  13379. (org-entry-put pom property
  13380. (mapconcat 'identity values " ")))))
  13381. (defun org-entry-member-in-multivalued-property (pom property value)
  13382. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  13383. (let* ((old (org-entry-get pom property))
  13384. (values (and old (org-split-string old "[ \t]"))))
  13385. (setq value (org-entry-protect-space value))
  13386. (member value values)))
  13387. (defun org-entry-get-multivalued-property (pom property)
  13388. "Return a list of values in a multivalued property."
  13389. (let* ((value (org-entry-get pom property))
  13390. (values (and value (org-split-string value "[ \t]"))))
  13391. (mapcar 'org-entry-restore-space values)))
  13392. (defun org-entry-put-multivalued-property (pom property &rest values)
  13393. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  13394. VALUES should be a list of strings. Spaces will be protected."
  13395. (org-entry-put pom property
  13396. (mapconcat 'org-entry-protect-space values " "))
  13397. (let* ((value (org-entry-get pom property))
  13398. (values (and value (org-split-string value "[ \t]"))))
  13399. (mapcar 'org-entry-restore-space values)))
  13400. (defun org-entry-protect-space (s)
  13401. "Protect spaces and newline in string S."
  13402. (while (string-match " " s)
  13403. (setq s (replace-match "%20" t t s)))
  13404. (while (string-match "\n" s)
  13405. (setq s (replace-match "%0A" t t s)))
  13406. s)
  13407. (defun org-entry-restore-space (s)
  13408. "Restore spaces and newline in string S."
  13409. (while (string-match "%20" s)
  13410. (setq s (replace-match " " t t s)))
  13411. (while (string-match "%0A" s)
  13412. (setq s (replace-match "\n" t t s)))
  13413. s)
  13414. (defvar org-entry-property-inherited-from (make-marker)
  13415. "Marker pointing to the entry from where a property was inherited.
  13416. Each call to `org-entry-get-with-inheritance' will set this marker to the
  13417. location of the entry where the inheritance search matched. If there was
  13418. no match, the marker will point nowhere.
  13419. Note that also `org-entry-get' calls this function, if the INHERIT flag
  13420. is set.")
  13421. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  13422. "Get PROPERTY of entry or content at point, search higher levels if needed.
  13423. The search will stop at the first ancestor which has the property defined.
  13424. If the value found is \"nil\", return nil to show that the property
  13425. should be considered as undefined (this is the meaning of nil here).
  13426. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  13427. (move-marker org-entry-property-inherited-from nil)
  13428. (let (tmp)
  13429. (save-excursion
  13430. (save-restriction
  13431. (widen)
  13432. (catch 'ex
  13433. (while t
  13434. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  13435. (or (ignore-errors (org-back-to-heading t))
  13436. (goto-char (point-min)))
  13437. (move-marker org-entry-property-inherited-from (point))
  13438. (throw 'ex tmp))
  13439. (or (ignore-errors (org-up-heading-safe))
  13440. (throw 'ex nil))))))
  13441. (setq tmp (or tmp
  13442. (cdr (assoc property org-file-properties))
  13443. (cdr (assoc property org-global-properties))
  13444. (cdr (assoc property org-global-properties-fixed))))
  13445. (if literal-nil tmp (org-not-nil tmp))))
  13446. (defvar org-property-changed-functions nil
  13447. "Hook called when the value of a property has changed.
  13448. Each hook function should accept two arguments, the name of the property
  13449. and the new value.")
  13450. (defun org-entry-put (pom property value)
  13451. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  13452. (org-with-point-at pom
  13453. (org-back-to-heading t)
  13454. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  13455. range)
  13456. (cond
  13457. ((equal property "TODO")
  13458. (when (and (stringp value) (string-match "\\S-" value)
  13459. (not (member value org-todo-keywords-1)))
  13460. (error "\"%s\" is not a valid TODO state" value))
  13461. (if (or (not value)
  13462. (not (string-match "\\S-" value)))
  13463. (setq value 'none))
  13464. (org-todo value)
  13465. (org-set-tags nil 'align))
  13466. ((equal property "PRIORITY")
  13467. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  13468. (string-to-char value) ?\ ))
  13469. (org-set-tags nil 'align))
  13470. ((equal property "SCHEDULED")
  13471. (if (re-search-forward org-scheduled-time-regexp end t)
  13472. (cond
  13473. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13474. ((eq value 'later) (org-timestamp-change 1 'day))
  13475. (t (call-interactively 'org-schedule)))
  13476. (call-interactively 'org-schedule)))
  13477. ((equal property "DEADLINE")
  13478. (if (re-search-forward org-deadline-time-regexp end t)
  13479. (cond
  13480. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13481. ((eq value 'later) (org-timestamp-change 1 'day))
  13482. (t (call-interactively 'org-deadline)))
  13483. (call-interactively 'org-deadline)))
  13484. ((member property org-special-properties)
  13485. (error "The %s property can not yet be set with `org-entry-put'"
  13486. property))
  13487. (t ; a non-special property
  13488. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  13489. (setq range (org-get-property-block beg end 'force))
  13490. (goto-char (car range))
  13491. (if (re-search-forward
  13492. (org-re-property-keyword property) (cdr range) t)
  13493. (progn
  13494. (delete-region (match-beginning 0) (match-end 0))
  13495. (goto-char (match-beginning 0)))
  13496. (goto-char (cdr range))
  13497. (insert "\n")
  13498. (backward-char 1)
  13499. (org-indent-line))
  13500. (insert ":" property ":")
  13501. (and value (insert " " value))
  13502. (org-indent-line)))))
  13503. (run-hook-with-args 'org-property-changed-functions property value)))
  13504. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  13505. "Get all property keys in the current buffer.
  13506. With INCLUDE-SPECIALS, also list the special properties that reflect things
  13507. like tags and TODO state.
  13508. With INCLUDE-DEFAULTS, also include properties that has special meaning
  13509. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  13510. and others.
  13511. With INCLUDE-COLUMNS, also include property names given in COLUMN
  13512. formats in the current buffer."
  13513. (let (rtn range cfmt s p)
  13514. (save-excursion
  13515. (save-restriction
  13516. (widen)
  13517. (goto-char (point-min))
  13518. (while (re-search-forward org-property-start-re nil t)
  13519. (setq range (org-get-property-block))
  13520. (goto-char (car range))
  13521. (while (re-search-forward
  13522. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  13523. (cdr range) t)
  13524. (add-to-list 'rtn (org-match-string-no-properties 1)))
  13525. (outline-next-heading))))
  13526. (when include-specials
  13527. (setq rtn (append org-special-properties rtn)))
  13528. (when include-defaults
  13529. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  13530. (add-to-list 'rtn org-effort-property))
  13531. (when include-columns
  13532. (save-excursion
  13533. (save-restriction
  13534. (widen)
  13535. (goto-char (point-min))
  13536. (while (re-search-forward
  13537. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  13538. nil t)
  13539. (setq cfmt (match-string 2) s 0)
  13540. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  13541. cfmt s)
  13542. (setq s (match-end 0)
  13543. p (match-string 1 cfmt))
  13544. (unless (or (equal p "ITEM")
  13545. (member p org-special-properties))
  13546. (add-to-list 'rtn (match-string 1 cfmt))))))))
  13547. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  13548. (defun org-property-values (key)
  13549. "Return a list of all values of property KEY in the current buffer."
  13550. (save-excursion
  13551. (save-restriction
  13552. (widen)
  13553. (goto-char (point-min))
  13554. (let ((re (org-re-property key))
  13555. values)
  13556. (while (re-search-forward re nil t)
  13557. (add-to-list 'values (org-trim (match-string 1))))
  13558. (delete "" values)))))
  13559. (defun org-insert-property-drawer ()
  13560. "Insert a property drawer into the current entry."
  13561. (org-back-to-heading t)
  13562. (looking-at org-outline-regexp)
  13563. (let ((indent (if org-adapt-indentation
  13564. (- (match-end 0) (match-beginning 0))
  13565. 0))
  13566. (beg (point))
  13567. (re (concat "^[ \t]*" org-keyword-time-regexp))
  13568. end hiddenp)
  13569. (outline-next-heading)
  13570. (setq end (point))
  13571. (goto-char beg)
  13572. (while (re-search-forward re end t))
  13573. (setq hiddenp (outline-invisible-p))
  13574. (end-of-line 1)
  13575. (and (equal (char-after) ?\n) (forward-char 1))
  13576. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  13577. (if (member (match-string 1) '("CLOCK:" ":END:"))
  13578. ;; just skip this line
  13579. (beginning-of-line 2)
  13580. ;; Drawer start, find the end
  13581. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  13582. (beginning-of-line 1)))
  13583. (org-skip-over-state-notes)
  13584. (skip-chars-backward " \t\n\r")
  13585. (if (eq (char-before) ?*) (forward-char 1))
  13586. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  13587. (beginning-of-line 0)
  13588. (org-indent-to-column indent)
  13589. (beginning-of-line 2)
  13590. (org-indent-to-column indent)
  13591. (beginning-of-line 0)
  13592. (if hiddenp
  13593. (save-excursion
  13594. (org-back-to-heading t)
  13595. (hide-entry))
  13596. (org-flag-drawer t))))
  13597. (defun org-insert-drawer (&optional arg drawer)
  13598. "Insert a drawer at point.
  13599. Optional argument DRAWER, when non-nil, is a string representing
  13600. drawer's name. Otherwise, the user is prompted for a name.
  13601. If a region is active, insert the drawer around that region
  13602. instead.
  13603. Point is left between drawer's boundaries."
  13604. (interactive "P")
  13605. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  13606. "LOGBOOK"))
  13607. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  13608. ;; internally by Org. They are meant to be inserted
  13609. ;; automatically.
  13610. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  13611. ;; Remove system drawers from list. Note: For some reason,
  13612. ;; `org-completing-read' ignores the predicate while
  13613. ;; `completing-read' handles it fine.
  13614. (drawer (if arg "PROPERTIES"
  13615. (or drawer
  13616. (completing-read
  13617. "Drawer: " org-drawers
  13618. (lambda (d) (not (member d system-drawers))))))))
  13619. (cond
  13620. ;; With C-u, fall back on `org-insert-property-drawer'
  13621. (arg (org-insert-property-drawer))
  13622. ;; With an active region, insert a drawer at point.
  13623. ((not (org-region-active-p))
  13624. (progn
  13625. (unless (bolp) (insert "\n"))
  13626. (insert (format ":%s:\n\n:END:\n" drawer))
  13627. (forward-line -2)))
  13628. ;; Otherwise, insert the drawer at point
  13629. (t
  13630. (let ((rbeg (region-beginning))
  13631. (rend (copy-marker (region-end))))
  13632. (unwind-protect
  13633. (progn
  13634. (goto-char rbeg)
  13635. (beginning-of-line)
  13636. (when (save-excursion
  13637. (re-search-forward org-outline-regexp-bol rend t))
  13638. (error "Drawers cannot contain headlines"))
  13639. ;; Position point at the beginning of the first
  13640. ;; non-blank line in region. Insert drawer's opening
  13641. ;; there, then indent it.
  13642. (org-skip-whitespace)
  13643. (beginning-of-line)
  13644. (insert ":" drawer ":\n")
  13645. (forward-line -1)
  13646. (indent-for-tab-command)
  13647. ;; Move point to the beginning of the first blank line
  13648. ;; after the last non-blank line in region. Insert
  13649. ;; drawer's closing, then indent it.
  13650. (goto-char rend)
  13651. (skip-chars-backward " \r\t\n")
  13652. (insert "\n:END:")
  13653. (indent-for-tab-command)
  13654. (unless (eolp) (insert "\n")))
  13655. ;; Clear marker, whatever the outcome of insertion is.
  13656. (set-marker rend nil)))))))
  13657. (defvar org-property-set-functions-alist nil
  13658. "Property set function alist.
  13659. Each entry should have the following format:
  13660. (PROPERTY . READ-FUNCTION)
  13661. The read function will be called with the same argument as
  13662. `org-completing-read'.")
  13663. (defun org-set-property-function (property)
  13664. "Get the function that should be used to set PROPERTY.
  13665. This is computed according to `org-property-set-functions-alist'."
  13666. (or (cdr (assoc property org-property-set-functions-alist))
  13667. 'org-completing-read))
  13668. (defun org-read-property-value (property)
  13669. "Read PROPERTY value from user."
  13670. (let* ((completion-ignore-case t)
  13671. (allowed (org-property-get-allowed-values nil property 'table))
  13672. (cur (org-entry-get nil property))
  13673. (prompt (concat property " value"
  13674. (if (and cur (string-match "\\S-" cur))
  13675. (concat " [" cur "]") "") ": "))
  13676. (set-function (org-set-property-function property))
  13677. (val (if allowed
  13678. (funcall set-function prompt allowed nil
  13679. (not (get-text-property 0 'org-unrestricted
  13680. (caar allowed))))
  13681. (let (org-completion-use-ido org-completion-use-iswitchb)
  13682. (funcall set-function prompt
  13683. (mapcar 'list (org-property-values property))
  13684. nil nil "" nil cur)))))
  13685. (if (equal val "")
  13686. cur
  13687. val)))
  13688. (defvar org-last-set-property nil)
  13689. (defun org-read-property-name ()
  13690. "Read a property name."
  13691. (let* ((completion-ignore-case t)
  13692. (keys (org-buffer-property-keys nil t t))
  13693. (default-prop (or (save-excursion
  13694. (save-match-data
  13695. (beginning-of-line)
  13696. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  13697. (null (string= (match-string 1) "END"))
  13698. (match-string 1))))
  13699. org-last-set-property))
  13700. (property (org-icompleting-read
  13701. (concat "Property"
  13702. (if default-prop (concat " [" default-prop "]") "")
  13703. ": ")
  13704. (mapcar 'list keys)
  13705. nil nil nil nil
  13706. default-prop
  13707. )))
  13708. (if (member property keys)
  13709. property
  13710. (or (cdr (assoc (downcase property)
  13711. (mapcar (lambda (x) (cons (downcase x) x))
  13712. keys)))
  13713. property))))
  13714. (defun org-set-property (property value)
  13715. "In the current entry, set PROPERTY to VALUE.
  13716. When called interactively, this will prompt for a property name, offering
  13717. completion on existing and default properties. And then it will prompt
  13718. for a value, offering completion either on allowed values (via an inherited
  13719. xxx_ALL property) or on existing values in other instances of this property
  13720. in the current file."
  13721. (interactive (list nil nil))
  13722. (let* ((property (or property (org-read-property-name)))
  13723. (value (or value (org-read-property-value property)))
  13724. (fn (cdr (assoc property org-properties-postprocess-alist))))
  13725. (setq org-last-set-property property)
  13726. ;; Possibly postprocess the inserted value:
  13727. (when fn (setq value (funcall fn value)))
  13728. (unless (equal (org-entry-get nil property) value)
  13729. (org-entry-put nil property value))))
  13730. (defun org-delete-property (property)
  13731. "In the current entry, delete PROPERTY."
  13732. (interactive
  13733. (let* ((completion-ignore-case t)
  13734. (prop (org-icompleting-read "Property: "
  13735. (org-entry-properties nil 'standard))))
  13736. (list prop)))
  13737. (message "Property %s %s" property
  13738. (if (org-entry-delete nil property)
  13739. "deleted"
  13740. "was not present in the entry")))
  13741. (defun org-delete-property-globally (property)
  13742. "Remove PROPERTY globally, from all entries."
  13743. (interactive
  13744. (let* ((completion-ignore-case t)
  13745. (prop (org-icompleting-read
  13746. "Globally remove property: "
  13747. (mapcar 'list (org-buffer-property-keys)))))
  13748. (list prop)))
  13749. (save-excursion
  13750. (save-restriction
  13751. (widen)
  13752. (goto-char (point-min))
  13753. (let ((cnt 0))
  13754. (while (re-search-forward
  13755. (org-re-property property)
  13756. nil t)
  13757. (setq cnt (1+ cnt))
  13758. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  13759. (message "Property \"%s\" removed from %d entries" property cnt)))))
  13760. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  13761. (defun org-compute-property-at-point ()
  13762. "Compute the property at point.
  13763. This looks for an enclosing column format, extracts the operator and
  13764. then applies it to the property in the column format's scope."
  13765. (interactive)
  13766. (unless (org-at-property-p)
  13767. (error "Not at a property"))
  13768. (let ((prop (org-match-string-no-properties 2)))
  13769. (org-columns-get-format-and-top-level)
  13770. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  13771. (error "No operator defined for property %s" prop))
  13772. (org-columns-compute prop)))
  13773. (defvar org-property-allowed-value-functions nil
  13774. "Hook for functions supplying allowed values for a specific property.
  13775. The functions must take a single argument, the name of the property, and
  13776. return a flat list of allowed values. If \":ETC\" is one of
  13777. the values, this means that these values are intended as defaults for
  13778. completion, but that other values should be allowed too.
  13779. The functions must return nil if they are not responsible for this
  13780. property.")
  13781. (defun org-property-get-allowed-values (pom property &optional table)
  13782. "Get allowed values for the property PROPERTY.
  13783. When TABLE is non-nil, return an alist that can directly be used for
  13784. completion."
  13785. (let (vals)
  13786. (cond
  13787. ((equal property "TODO")
  13788. (setq vals (org-with-point-at pom
  13789. (append org-todo-keywords-1 '("")))))
  13790. ((equal property "PRIORITY")
  13791. (let ((n org-lowest-priority))
  13792. (while (>= n org-highest-priority)
  13793. (push (char-to-string n) vals)
  13794. (setq n (1- n)))))
  13795. ((member property org-special-properties))
  13796. ((setq vals (run-hook-with-args-until-success
  13797. 'org-property-allowed-value-functions property)))
  13798. (t
  13799. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  13800. (when (and vals (string-match "\\S-" vals))
  13801. (setq vals (car (read-from-string (concat "(" vals ")"))))
  13802. (setq vals (mapcar (lambda (x)
  13803. (cond ((stringp x) x)
  13804. ((numberp x) (number-to-string x))
  13805. ((symbolp x) (symbol-name x))
  13806. (t "???")))
  13807. vals)))))
  13808. (when (member ":ETC" vals)
  13809. (setq vals (remove ":ETC" vals))
  13810. (org-add-props (car vals) '(org-unrestricted t)))
  13811. (if table (mapcar 'list vals) vals)))
  13812. (defun org-property-previous-allowed-value (&optional previous)
  13813. "Switch to the next allowed value for this property."
  13814. (interactive)
  13815. (org-property-next-allowed-value t))
  13816. (defun org-property-next-allowed-value (&optional previous)
  13817. "Switch to the next allowed value for this property."
  13818. (interactive)
  13819. (unless (org-at-property-p)
  13820. (error "Not at a property"))
  13821. (let* ((key (match-string 2))
  13822. (value (match-string 3))
  13823. (allowed (or (org-property-get-allowed-values (point) key)
  13824. (and (member value '("[ ]" "[-]" "[X]"))
  13825. '("[ ]" "[X]"))))
  13826. nval)
  13827. (unless allowed
  13828. (error "Allowed values for this property have not been defined"))
  13829. (if previous (setq allowed (reverse allowed)))
  13830. (if (member value allowed)
  13831. (setq nval (car (cdr (member value allowed)))))
  13832. (setq nval (or nval (car allowed)))
  13833. (if (equal nval value)
  13834. (error "Only one allowed value for this property"))
  13835. (org-at-property-p)
  13836. (replace-match (concat " :" key ": " nval) t t)
  13837. (org-indent-line)
  13838. (beginning-of-line 1)
  13839. (skip-chars-forward " \t")
  13840. (run-hook-with-args 'org-property-changed-functions key nval)))
  13841. (defun org-find-olp (path &optional this-buffer)
  13842. "Return a marker pointing to the entry at outline path OLP.
  13843. If anything goes wrong, throw an error.
  13844. You can wrap this call to catch the error like this:
  13845. (condition-case msg
  13846. (org-mobile-locate-entry (match-string 4))
  13847. (error (nth 1 msg)))
  13848. The return value will then be either a string with the error message,
  13849. or a marker if everything is OK.
  13850. If THIS-BUFFER is set, the outline path does not contain a file,
  13851. only headings."
  13852. (let* ((file (if this-buffer buffer-file-name (pop path)))
  13853. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  13854. (level 1)
  13855. (lmin 1)
  13856. (lmax 1)
  13857. limit re end found pos heading cnt flevel)
  13858. (unless buffer (error "File not found :%s" file))
  13859. (with-current-buffer buffer
  13860. (save-excursion
  13861. (save-restriction
  13862. (widen)
  13863. (setq limit (point-max))
  13864. (goto-char (point-min))
  13865. (while (setq heading (pop path))
  13866. (setq re (format org-complex-heading-regexp-format
  13867. (regexp-quote heading)))
  13868. (setq cnt 0 pos (point))
  13869. (while (re-search-forward re end t)
  13870. (setq level (- (match-end 1) (match-beginning 1)))
  13871. (if (and (>= level lmin) (<= level lmax))
  13872. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  13873. (when (= cnt 0) (error "Heading not found on level %d: %s"
  13874. lmax heading))
  13875. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  13876. lmax heading))
  13877. (goto-char found)
  13878. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  13879. (setq end (save-excursion (org-end-of-subtree t t))))
  13880. (when (org-at-heading-p)
  13881. (move-marker (make-marker) (point))))))))
  13882. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  13883. "Find node HEADING in BUFFER.
  13884. Return a marker to the heading if it was found, or nil if not.
  13885. If POS-ONLY is set, return just the position instead of a marker.
  13886. The heading text must match exact, but it may have a TODO keyword,
  13887. a priority cookie and tags in the standard locations."
  13888. (with-current-buffer (or buffer (current-buffer))
  13889. (save-excursion
  13890. (save-restriction
  13891. (widen)
  13892. (goto-char (point-min))
  13893. (let (case-fold-search)
  13894. (if (re-search-forward
  13895. (format org-complex-heading-regexp-format
  13896. (regexp-quote heading)) nil t)
  13897. (if pos-only
  13898. (match-beginning 0)
  13899. (move-marker (make-marker) (match-beginning 0)))))))))
  13900. (defun org-find-exact-heading-in-directory (heading &optional dir)
  13901. "Find Org node headline HEADING in all .org files in directory DIR.
  13902. When the target headline is found, return a marker to this location."
  13903. (let ((files (directory-files (or dir default-directory)
  13904. nil "\\`[^.#].*\\.org\\'"))
  13905. file visiting m buffer)
  13906. (catch 'found
  13907. (while (setq file (pop files))
  13908. (message "trying %s" file)
  13909. (setq visiting (org-find-base-buffer-visiting file))
  13910. (setq buffer (or visiting (find-file-noselect file)))
  13911. (setq m (org-find-exact-headline-in-buffer
  13912. heading buffer))
  13913. (when (and (not m) (not visiting)) (kill-buffer buffer))
  13914. (and m (throw 'found m))))))
  13915. (defun org-find-entry-with-id (ident)
  13916. "Locate the entry that contains the ID property with exact value IDENT.
  13917. IDENT can be a string, a symbol or a number, this function will search for
  13918. the string representation of it.
  13919. Return the position where this entry starts, or nil if there is no such entry."
  13920. (interactive "sID: ")
  13921. (let ((id (cond
  13922. ((stringp ident) ident)
  13923. ((symbol-name ident) (symbol-name ident))
  13924. ((numberp ident) (number-to-string ident))
  13925. (t (error "IDENT %s must be a string, symbol or number" ident))))
  13926. (case-fold-search nil))
  13927. (save-excursion
  13928. (save-restriction
  13929. (widen)
  13930. (goto-char (point-min))
  13931. (when (re-search-forward
  13932. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  13933. nil t)
  13934. (org-back-to-heading t)
  13935. (point))))))
  13936. ;;;; Timestamps
  13937. (defvar org-last-changed-timestamp nil)
  13938. (defvar org-last-inserted-timestamp nil
  13939. "The last time stamp inserted with `org-insert-time-stamp'.")
  13940. (defvar org-time-was-given) ; dynamically scoped parameter
  13941. (defvar org-end-time-was-given) ; dynamically scoped parameter
  13942. (defvar org-ts-what) ; dynamically scoped parameter
  13943. (defun org-time-stamp (arg &optional inactive)
  13944. "Prompt for a date/time and insert a time stamp.
  13945. If the user specifies a time like HH:MM or if this command is
  13946. called with at least one prefix argument, the time stamp contains
  13947. the date and the time. Otherwise, only the date is be included.
  13948. All parts of a date not specified by the user is filled in from
  13949. the current date/time. So if you just press return without
  13950. typing anything, the time stamp will represent the current
  13951. date/time.
  13952. If there is already a timestamp at the cursor, it will be
  13953. modified.
  13954. With two universal prefix arguments, insert an active timestamp
  13955. with the current time without prompting the user."
  13956. (interactive "P")
  13957. (let* ((ts nil)
  13958. (default-time
  13959. ;; Default time is either today, or, when entering a range,
  13960. ;; the range start.
  13961. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  13962. (save-excursion
  13963. (re-search-backward
  13964. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  13965. (- (point) 20) t)))
  13966. (apply 'encode-time (org-parse-time-string (match-string 1)))
  13967. (current-time)))
  13968. (default-input (and ts (org-get-compact-tod ts)))
  13969. (repeater (save-excursion
  13970. (save-match-data
  13971. (beginning-of-line)
  13972. (when (re-search-forward
  13973. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  13974. (save-excursion (progn (end-of-line) (point))) t)
  13975. (match-string 0)))))
  13976. org-time-was-given org-end-time-was-given time)
  13977. (cond
  13978. ((and (org-at-timestamp-p t)
  13979. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  13980. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  13981. (insert "--")
  13982. (setq time (let ((this-command this-command))
  13983. (org-read-date arg 'totime nil nil
  13984. default-time default-input inactive)))
  13985. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  13986. ((org-at-timestamp-p t)
  13987. (setq time (let ((this-command this-command))
  13988. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  13989. (when (org-at-timestamp-p t) ; just to get the match data
  13990. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  13991. (replace-match "")
  13992. (setq org-last-changed-timestamp
  13993. (org-insert-time-stamp
  13994. time (or org-time-was-given arg)
  13995. inactive nil nil (list org-end-time-was-given)))
  13996. (when repeater (goto-char (1- (point))) (insert " " repeater)
  13997. (setq org-last-changed-timestamp
  13998. (concat (substring org-last-inserted-timestamp 0 -1)
  13999. " " repeater ">"))))
  14000. (message "Timestamp updated"))
  14001. ((equal arg '(16))
  14002. (org-insert-time-stamp (current-time) t))
  14003. (t
  14004. (setq time (let ((this-command this-command))
  14005. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14006. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  14007. nil nil (list org-end-time-was-given))))))
  14008. ;; FIXME: can we use this for something else, like computing time differences?
  14009. (defun org-get-compact-tod (s)
  14010. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  14011. (let* ((t1 (match-string 1 s))
  14012. (h1 (string-to-number (match-string 2 s)))
  14013. (m1 (string-to-number (match-string 3 s)))
  14014. (t2 (and (match-end 4) (match-string 5 s)))
  14015. (h2 (and t2 (string-to-number (match-string 6 s))))
  14016. (m2 (and t2 (string-to-number (match-string 7 s))))
  14017. dh dm)
  14018. (if (not t2)
  14019. t1
  14020. (setq dh (- h2 h1) dm (- m2 m1))
  14021. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  14022. (concat t1 "+" (number-to-string dh)
  14023. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  14024. (defun org-time-stamp-inactive (&optional arg)
  14025. "Insert an inactive time stamp.
  14026. An inactive time stamp is enclosed in square brackets instead of angle
  14027. brackets. It is inactive in the sense that it does not trigger agenda entries,
  14028. does not link to the calendar and cannot be changed with the S-cursor keys.
  14029. So these are more for recording a certain time/date."
  14030. (interactive "P")
  14031. (org-time-stamp arg 'inactive))
  14032. (defvar org-date-ovl (make-overlay 1 1))
  14033. (overlay-put org-date-ovl 'face 'org-date-selected)
  14034. (org-detach-overlay org-date-ovl)
  14035. (defvar org-ans1) ; dynamically scoped parameter
  14036. (defvar org-ans2) ; dynamically scoped parameter
  14037. (defvar org-plain-time-of-day-regexp) ; defined below
  14038. (defvar org-overriding-default-time nil) ; dynamically scoped
  14039. (defvar org-read-date-overlay nil)
  14040. (defvar org-dcst nil) ; dynamically scoped
  14041. (defvar org-read-date-history nil)
  14042. (defvar org-read-date-final-answer nil)
  14043. (defvar org-read-date-analyze-futurep nil)
  14044. (defvar org-read-date-analyze-forced-year nil)
  14045. (defvar org-read-date-inactive)
  14046. (defun org-read-date (&optional org-with-time to-time from-string prompt
  14047. default-time default-input inactive)
  14048. "Read a date, possibly a time, and make things smooth for the user.
  14049. The prompt will suggest to enter an ISO date, but you can also enter anything
  14050. which will at least partially be understood by `parse-time-string'.
  14051. Unrecognized parts of the date will default to the current day, month, year,
  14052. hour and minute. If this command is called to replace a timestamp at point,
  14053. or to enter the second timestamp of a range, the default time is taken
  14054. from the existing stamp. Furthermore, the command prefers the future,
  14055. so if you are giving a date where the year is not given, and the day-month
  14056. combination is already past in the current year, it will assume you
  14057. mean next year. For details, see the manual. A few examples:
  14058. 3-2-5 --> 2003-02-05
  14059. feb 15 --> currentyear-02-15
  14060. 2/15 --> currentyear-02-15
  14061. sep 12 9 --> 2009-09-12
  14062. 12:45 --> today 12:45
  14063. 22 sept 0:34 --> currentyear-09-22 0:34
  14064. 12 --> currentyear-currentmonth-12
  14065. Fri --> nearest Friday (today or later)
  14066. etc.
  14067. Furthermore you can specify a relative date by giving, as the *first* thing
  14068. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  14069. change in days weeks, months, years.
  14070. With a single plus or minus, the date is relative to today. With a double
  14071. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  14072. +4d --> four days from today
  14073. +4 --> same as above
  14074. +2w --> two weeks from today
  14075. ++5 --> five days from default date
  14076. The function understands only English month and weekday abbreviations.
  14077. While prompting, a calendar is popped up - you can also select the
  14078. date with the mouse (button 1). The calendar shows a period of three
  14079. months. To scroll it to other months, use the keys `>' and `<'.
  14080. If you don't like the calendar, turn it off with
  14081. \(setq org-read-date-popup-calendar nil)
  14082. With optional argument TO-TIME, the date will immediately be converted
  14083. to an internal time.
  14084. With an optional argument WITH-TIME, the prompt will suggest to also
  14085. insert a time. Note that when WITH-TIME is not set, you can still
  14086. enter a time, and this function will inform the calling routine about
  14087. this change. The calling routine may then choose to change the format
  14088. used to insert the time stamp into the buffer to include the time.
  14089. With optional argument FROM-STRING, read from this string instead from
  14090. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  14091. the time/date that is used for everything that is not specified by the
  14092. user."
  14093. (require 'parse-time)
  14094. (let* ((org-time-stamp-rounding-minutes
  14095. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  14096. (org-dcst org-display-custom-times)
  14097. (ct (org-current-time))
  14098. (org-def (or org-overriding-default-time default-time ct))
  14099. (org-defdecode (decode-time org-def))
  14100. (dummy (progn
  14101. (when (< (nth 2 org-defdecode) org-extend-today-until)
  14102. (setcar (nthcdr 2 org-defdecode) -1)
  14103. (setcar (nthcdr 1 org-defdecode) 59)
  14104. (setq org-def (apply 'encode-time org-defdecode)
  14105. org-defdecode (decode-time org-def)))))
  14106. (calendar-frame-setup nil)
  14107. (calendar-setup nil)
  14108. (calendar-move-hook nil)
  14109. (calendar-view-diary-initially-flag nil)
  14110. (calendar-view-holidays-initially-flag nil)
  14111. (timestr (format-time-string
  14112. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  14113. (prompt (concat (if prompt (concat prompt " ") "")
  14114. (format "Date+time [%s]: " timestr)))
  14115. ans (org-ans0 "") org-ans1 org-ans2 final)
  14116. (cond
  14117. (from-string (setq ans from-string))
  14118. (org-read-date-popup-calendar
  14119. (save-excursion
  14120. (save-window-excursion
  14121. (calendar)
  14122. (org-eval-in-calendar '(setq cursor-type nil) t)
  14123. (unwind-protect
  14124. (progn
  14125. (calendar-forward-day (- (time-to-days org-def)
  14126. (calendar-absolute-from-gregorian
  14127. (calendar-current-date))))
  14128. (org-eval-in-calendar nil t)
  14129. (let* ((old-map (current-local-map))
  14130. (map (copy-keymap calendar-mode-map))
  14131. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  14132. (org-defkey map (kbd "RET") 'org-calendar-select)
  14133. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  14134. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  14135. (org-defkey minibuffer-local-map [(meta shift left)]
  14136. (lambda () (interactive)
  14137. (org-eval-in-calendar '(calendar-backward-month 1))))
  14138. (org-defkey minibuffer-local-map [(meta shift right)]
  14139. (lambda () (interactive)
  14140. (org-eval-in-calendar '(calendar-forward-month 1))))
  14141. (org-defkey minibuffer-local-map [(meta shift up)]
  14142. (lambda () (interactive)
  14143. (org-eval-in-calendar '(calendar-backward-year 1))))
  14144. (org-defkey minibuffer-local-map [(meta shift down)]
  14145. (lambda () (interactive)
  14146. (org-eval-in-calendar '(calendar-forward-year 1))))
  14147. (org-defkey minibuffer-local-map [?\e (shift left)]
  14148. (lambda () (interactive)
  14149. (org-eval-in-calendar '(calendar-backward-month 1))))
  14150. (org-defkey minibuffer-local-map [?\e (shift right)]
  14151. (lambda () (interactive)
  14152. (org-eval-in-calendar '(calendar-forward-month 1))))
  14153. (org-defkey minibuffer-local-map [?\e (shift up)]
  14154. (lambda () (interactive)
  14155. (org-eval-in-calendar '(calendar-backward-year 1))))
  14156. (org-defkey minibuffer-local-map [?\e (shift down)]
  14157. (lambda () (interactive)
  14158. (org-eval-in-calendar '(calendar-forward-year 1))))
  14159. (org-defkey minibuffer-local-map [(shift up)]
  14160. (lambda () (interactive)
  14161. (org-eval-in-calendar '(calendar-backward-week 1))))
  14162. (org-defkey minibuffer-local-map [(shift down)]
  14163. (lambda () (interactive)
  14164. (org-eval-in-calendar '(calendar-forward-week 1))))
  14165. (org-defkey minibuffer-local-map [(shift left)]
  14166. (lambda () (interactive)
  14167. (org-eval-in-calendar '(calendar-backward-day 1))))
  14168. (org-defkey minibuffer-local-map [(shift right)]
  14169. (lambda () (interactive)
  14170. (org-eval-in-calendar '(calendar-forward-day 1))))
  14171. (org-defkey minibuffer-local-map ">"
  14172. (lambda () (interactive)
  14173. (org-eval-in-calendar '(scroll-calendar-left 1))))
  14174. (org-defkey minibuffer-local-map "<"
  14175. (lambda () (interactive)
  14176. (org-eval-in-calendar '(scroll-calendar-right 1))))
  14177. (org-defkey minibuffer-local-map "\C-v"
  14178. (lambda () (interactive)
  14179. (org-eval-in-calendar
  14180. '(calendar-scroll-left-three-months 1))))
  14181. (org-defkey minibuffer-local-map "\M-v"
  14182. (lambda () (interactive)
  14183. (org-eval-in-calendar
  14184. '(calendar-scroll-right-three-months 1))))
  14185. (run-hooks 'org-read-date-minibuffer-setup-hook)
  14186. (unwind-protect
  14187. (progn
  14188. (use-local-map map)
  14189. (setq org-read-date-inactive inactive)
  14190. (add-hook 'post-command-hook 'org-read-date-display)
  14191. (setq org-ans0 (read-string prompt default-input
  14192. 'org-read-date-history nil))
  14193. ;; org-ans0: from prompt
  14194. ;; org-ans1: from mouse click
  14195. ;; org-ans2: from calendar motion
  14196. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  14197. (remove-hook 'post-command-hook 'org-read-date-display)
  14198. (use-local-map old-map)
  14199. (when org-read-date-overlay
  14200. (delete-overlay org-read-date-overlay)
  14201. (setq org-read-date-overlay nil)))))
  14202. (bury-buffer "*Calendar*")))))
  14203. (t ; Naked prompt only
  14204. (unwind-protect
  14205. (setq ans (read-string prompt default-input
  14206. 'org-read-date-history timestr))
  14207. (when org-read-date-overlay
  14208. (delete-overlay org-read-date-overlay)
  14209. (setq org-read-date-overlay nil)))))
  14210. (setq final (org-read-date-analyze ans org-def org-defdecode))
  14211. (when org-read-date-analyze-forced-year
  14212. (message "Year was forced into %s"
  14213. (if org-read-date-force-compatible-dates
  14214. "compatible range (1970-2037)"
  14215. "range representable on this machine"))
  14216. (ding))
  14217. ;; One round trip to get rid of 34th of August and stuff like that....
  14218. (setq final (decode-time (apply 'encode-time final)))
  14219. (setq org-read-date-final-answer ans)
  14220. (if to-time
  14221. (apply 'encode-time final)
  14222. (if (and (boundp 'org-time-was-given) org-time-was-given)
  14223. (format "%04d-%02d-%02d %02d:%02d"
  14224. (nth 5 final) (nth 4 final) (nth 3 final)
  14225. (nth 2 final) (nth 1 final))
  14226. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  14227. (defvar org-def)
  14228. (defvar org-defdecode)
  14229. (defvar org-with-time)
  14230. (defun org-read-date-display ()
  14231. "Display the current date prompt interpretation in the minibuffer."
  14232. (when org-read-date-display-live
  14233. (when org-read-date-overlay
  14234. (delete-overlay org-read-date-overlay))
  14235. (when (minibufferp (current-buffer))
  14236. (save-excursion
  14237. (end-of-line 1)
  14238. (while (not (equal (buffer-substring
  14239. (max (point-min) (- (point) 4)) (point))
  14240. " "))
  14241. (insert " ")))
  14242. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14243. " " (or org-ans1 org-ans2)))
  14244. (org-end-time-was-given nil)
  14245. (f (org-read-date-analyze ans org-def org-defdecode))
  14246. (fmts (if org-dcst
  14247. org-time-stamp-custom-formats
  14248. org-time-stamp-formats))
  14249. (fmt (if (or org-with-time
  14250. (and (boundp 'org-time-was-given) org-time-was-given))
  14251. (cdr fmts)
  14252. (car fmts)))
  14253. (txt (format-time-string fmt (apply 'encode-time f)))
  14254. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  14255. (txt (concat "=> " txt)))
  14256. (when (and org-end-time-was-given
  14257. (string-match org-plain-time-of-day-regexp txt))
  14258. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  14259. org-end-time-was-given
  14260. (substring txt (match-end 0)))))
  14261. (when org-read-date-analyze-futurep
  14262. (setq txt (concat txt " (=>F)")))
  14263. (setq org-read-date-overlay
  14264. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  14265. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  14266. (defun org-read-date-analyze (ans org-def org-defdecode)
  14267. "Analyze the combined answer of the date prompt."
  14268. ;; FIXME: cleanup and comment
  14269. (let ((nowdecode (decode-time (current-time)))
  14270. delta deltan deltaw deltadef year month day
  14271. hour minute second wday pm h2 m2 tl wday1
  14272. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  14273. (setq org-read-date-analyze-futurep nil
  14274. org-read-date-analyze-forced-year nil)
  14275. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  14276. (setq ans "+0"))
  14277. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  14278. (unless (save-match-data (string-match org-plain-time-of-day-regexp ans))
  14279. (setq ans (replace-match "" t t ans)
  14280. deltan (car delta)
  14281. deltaw (nth 1 delta)
  14282. deltadef (nth 2 delta))))
  14283. ;; Check if there is an iso week date in there
  14284. ;; If yes, store the info and postpone interpreting it until the rest
  14285. ;; of the parsing is done
  14286. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  14287. (setq iso-year (if (match-end 1)
  14288. (org-small-year-to-year
  14289. (string-to-number (match-string 1 ans))))
  14290. iso-weekday (if (match-end 3)
  14291. (string-to-number (match-string 3 ans)))
  14292. iso-week (string-to-number (match-string 2 ans)))
  14293. (setq ans (replace-match "" t t ans)))
  14294. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  14295. (when (string-match
  14296. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  14297. (setq year (if (match-end 2)
  14298. (string-to-number (match-string 2 ans))
  14299. (progn (setq kill-year t)
  14300. (string-to-number (format-time-string "%Y"))))
  14301. month (string-to-number (match-string 3 ans))
  14302. day (string-to-number (match-string 4 ans)))
  14303. (if (< year 100) (setq year (+ 2000 year)))
  14304. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14305. t nil ans)))
  14306. ;; Help matching dotted european dates
  14307. (when (string-match
  14308. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
  14309. (setq year (if (match-end 3)
  14310. (string-to-number (match-string 3 ans))
  14311. (progn (setq kill-year t)
  14312. (string-to-number (format-time-string "%Y"))))
  14313. day (string-to-number (match-string 1 ans))
  14314. month (string-to-number (match-string 2 ans))
  14315. ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14316. t nil ans)))
  14317. ;; Help matching american dates, like 5/30 or 5/30/7
  14318. (when (string-match
  14319. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  14320. (setq year (if (match-end 4)
  14321. (string-to-number (match-string 4 ans))
  14322. (progn (setq kill-year t)
  14323. (string-to-number (format-time-string "%Y"))))
  14324. month (string-to-number (match-string 1 ans))
  14325. day (string-to-number (match-string 2 ans)))
  14326. (if (< year 100) (setq year (+ 2000 year)))
  14327. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14328. t nil ans)))
  14329. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  14330. ;; If there is a time with am/pm, and *no* time without it, we convert
  14331. ;; so that matching will be successful.
  14332. (loop for i from 1 to 2 do ; twice, for end time as well
  14333. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  14334. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  14335. (setq hour (string-to-number (match-string 1 ans))
  14336. minute (if (match-end 3)
  14337. (string-to-number (match-string 3 ans))
  14338. 0)
  14339. pm (equal ?p
  14340. (string-to-char (downcase (match-string 4 ans)))))
  14341. (if (and (= hour 12) (not pm))
  14342. (setq hour 0)
  14343. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  14344. (setq ans (replace-match (format "%02d:%02d" hour minute)
  14345. t t ans))))
  14346. ;; Check if a time range is given as a duration
  14347. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  14348. (setq hour (string-to-number (match-string 1 ans))
  14349. h2 (+ hour (string-to-number (match-string 3 ans)))
  14350. minute (string-to-number (match-string 2 ans))
  14351. m2 (+ minute (if (match-end 5) (string-to-number
  14352. (match-string 5 ans))0)))
  14353. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  14354. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  14355. t t ans)))
  14356. ;; Check if there is a time range
  14357. (when (boundp 'org-end-time-was-given)
  14358. (setq org-time-was-given nil)
  14359. (when (and (string-match org-plain-time-of-day-regexp ans)
  14360. (match-end 8))
  14361. (setq org-end-time-was-given (match-string 8 ans))
  14362. (setq ans (concat (substring ans 0 (match-beginning 7))
  14363. (substring ans (match-end 7))))))
  14364. (setq tl (parse-time-string ans)
  14365. day (or (nth 3 tl) (nth 3 org-defdecode))
  14366. month (or (nth 4 tl)
  14367. (if (and org-read-date-prefer-future
  14368. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  14369. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  14370. (nth 4 org-defdecode)))
  14371. year (or (and (not kill-year) (nth 5 tl))
  14372. (if (and org-read-date-prefer-future
  14373. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  14374. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  14375. (nth 5 org-defdecode)))
  14376. hour (or (nth 2 tl) (nth 2 org-defdecode))
  14377. minute (or (nth 1 tl) (nth 1 org-defdecode))
  14378. second (or (nth 0 tl) 0)
  14379. wday (nth 6 tl))
  14380. (when (and (eq org-read-date-prefer-future 'time)
  14381. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  14382. (equal day (nth 3 nowdecode))
  14383. (equal month (nth 4 nowdecode))
  14384. (equal year (nth 5 nowdecode))
  14385. (nth 2 tl)
  14386. (or (< (nth 2 tl) (nth 2 nowdecode))
  14387. (and (= (nth 2 tl) (nth 2 nowdecode))
  14388. (nth 1 tl)
  14389. (< (nth 1 tl) (nth 1 nowdecode)))))
  14390. (setq day (1+ day)
  14391. futurep t))
  14392. ;; Special date definitions below
  14393. (cond
  14394. (iso-week
  14395. ;; There was an iso week
  14396. (require 'cal-iso)
  14397. (setq futurep nil)
  14398. (setq year (or iso-year year)
  14399. day (or iso-weekday wday 1)
  14400. wday nil ; to make sure that the trigger below does not match
  14401. iso-date (calendar-gregorian-from-absolute
  14402. (calendar-absolute-from-iso
  14403. (list iso-week day year))))
  14404. ; FIXME: Should we also push ISO weeks into the future?
  14405. ; (when (and org-read-date-prefer-future
  14406. ; (not iso-year)
  14407. ; (< (calendar-absolute-from-gregorian iso-date)
  14408. ; (time-to-days (current-time))))
  14409. ; (setq year (1+ year)
  14410. ; iso-date (calendar-gregorian-from-absolute
  14411. ; (calendar-absolute-from-iso
  14412. ; (list iso-week day year)))))
  14413. (setq month (car iso-date)
  14414. year (nth 2 iso-date)
  14415. day (nth 1 iso-date)))
  14416. (deltan
  14417. (setq futurep nil)
  14418. (unless deltadef
  14419. (let ((now (decode-time (current-time))))
  14420. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  14421. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  14422. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  14423. ((equal deltaw "m") (setq month (+ month deltan)))
  14424. ((equal deltaw "y") (setq year (+ year deltan)))))
  14425. ((and wday (not (nth 3 tl)))
  14426. ;; Weekday was given, but no day, so pick that day in the week
  14427. ;; on or after the derived date.
  14428. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  14429. (unless (equal wday wday1)
  14430. (setq day (+ day (% (- wday wday1 -7) 7))))))
  14431. (if (and (boundp 'org-time-was-given)
  14432. (nth 2 tl))
  14433. (setq org-time-was-given t))
  14434. (if (< year 100) (setq year (+ 2000 year)))
  14435. ;; Check of the date is representable
  14436. (if org-read-date-force-compatible-dates
  14437. (progn
  14438. (if (< year 1970)
  14439. (setq year 1970 org-read-date-analyze-forced-year t))
  14440. (if (> year 2037)
  14441. (setq year 2037 org-read-date-analyze-forced-year t)))
  14442. (condition-case nil
  14443. (ignore (encode-time second minute hour day month year))
  14444. (error
  14445. (setq year (nth 5 org-defdecode))
  14446. (setq org-read-date-analyze-forced-year t))))
  14447. (setq org-read-date-analyze-futurep futurep)
  14448. (list second minute hour day month year)))
  14449. (defvar parse-time-weekdays)
  14450. (defun org-read-date-get-relative (s today default)
  14451. "Check string S for special relative date string.
  14452. TODAY and DEFAULT are internal times, for today and for a default.
  14453. Return shift list (N what def-flag)
  14454. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  14455. N is the number of WHATs to shift.
  14456. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  14457. the DEFAULT date rather than TODAY."
  14458. (require 'parse-time)
  14459. (when (and
  14460. (string-match
  14461. (concat
  14462. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  14463. "\\([0-9]+\\)?"
  14464. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  14465. "\\([ \t]\\|$\\)") s)
  14466. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  14467. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  14468. (string-to-char (substring (match-string 1 s) -1))
  14469. ?+))
  14470. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  14471. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  14472. (what (if (match-end 3) (match-string 3 s) "d"))
  14473. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  14474. (date (if rel default today))
  14475. (wday (nth 6 (decode-time date)))
  14476. delta)
  14477. (if wday1
  14478. (progn
  14479. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  14480. (if (= dir ?-) (setq delta (- delta 7)))
  14481. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  14482. (list delta "d" rel))
  14483. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  14484. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  14485. "Turn a user-specified date into the internal representation.
  14486. The internal representation needed by the calendar is (month day year).
  14487. This is a wrapper to handle the brain-dead convention in calendar that
  14488. user function argument order change dependent on argument order."
  14489. (if (boundp 'calendar-date-style)
  14490. (cond
  14491. ((eq calendar-date-style 'american)
  14492. (list arg1 arg2 arg3))
  14493. ((eq calendar-date-style 'european)
  14494. (list arg2 arg1 arg3))
  14495. ((eq calendar-date-style 'iso)
  14496. (list arg2 arg3 arg1)))
  14497. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  14498. (if (org-bound-and-true-p european-calendar-style)
  14499. (list arg2 arg1 arg3)
  14500. (list arg1 arg2 arg3)))))
  14501. (defun org-eval-in-calendar (form &optional keepdate)
  14502. "Eval FORM in the calendar window and return to current window.
  14503. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  14504. otherwise stick to the current value of `org-ans2'."
  14505. (let ((sf (selected-frame))
  14506. (sw (selected-window)))
  14507. (select-window (get-buffer-window "*Calendar*" t))
  14508. (eval form)
  14509. (when (and (not keepdate) (calendar-cursor-to-date))
  14510. (let* ((date (calendar-cursor-to-date))
  14511. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14512. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  14513. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  14514. (select-window sw)
  14515. (org-select-frame-set-input-focus sf)))
  14516. (defun org-calendar-select ()
  14517. "Return to `org-read-date' with the date currently selected.
  14518. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14519. (interactive)
  14520. (when (calendar-cursor-to-date)
  14521. (let* ((date (calendar-cursor-to-date))
  14522. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14523. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14524. (if (active-minibuffer-window) (exit-minibuffer))))
  14525. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  14526. "Insert a date stamp for the date given by the internal TIME.
  14527. WITH-HM means use the stamp format that includes the time of the day.
  14528. INACTIVE means use square brackets instead of angular ones, so that the
  14529. stamp will not contribute to the agenda.
  14530. PRE and POST are optional strings to be inserted before and after the
  14531. stamp.
  14532. The command returns the inserted time stamp."
  14533. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  14534. stamp)
  14535. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  14536. (insert-before-markers (or pre ""))
  14537. (when (listp extra)
  14538. (setq extra (car extra))
  14539. (if (and (stringp extra)
  14540. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  14541. (setq extra (format "-%02d:%02d"
  14542. (string-to-number (match-string 1 extra))
  14543. (string-to-number (match-string 2 extra))))
  14544. (setq extra nil)))
  14545. (when extra
  14546. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  14547. (insert-before-markers (setq stamp (format-time-string fmt time)))
  14548. (insert-before-markers (or post ""))
  14549. (setq org-last-inserted-timestamp stamp)))
  14550. (defun org-toggle-time-stamp-overlays ()
  14551. "Toggle the use of custom time stamp formats."
  14552. (interactive)
  14553. (setq org-display-custom-times (not org-display-custom-times))
  14554. (unless org-display-custom-times
  14555. (let ((p (point-min)) (bmp (buffer-modified-p)))
  14556. (while (setq p (next-single-property-change p 'display))
  14557. (if (and (get-text-property p 'display)
  14558. (eq (get-text-property p 'face) 'org-date))
  14559. (remove-text-properties
  14560. p (setq p (next-single-property-change p 'display))
  14561. '(display t))))
  14562. (set-buffer-modified-p bmp)))
  14563. (if (featurep 'xemacs)
  14564. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  14565. (org-restart-font-lock)
  14566. (setq org-table-may-need-update t)
  14567. (if org-display-custom-times
  14568. (message "Time stamps are overlaid with custom format")
  14569. (message "Time stamp overlays removed")))
  14570. (defun org-display-custom-time (beg end)
  14571. "Overlay modified time stamp format over timestamp between BEG and END."
  14572. (let* ((ts (buffer-substring beg end))
  14573. t1 w1 with-hm tf time str w2 (off 0))
  14574. (save-match-data
  14575. (setq t1 (org-parse-time-string ts t))
  14576. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  14577. (setq off (- (match-end 0) (match-beginning 0)))))
  14578. (setq end (- end off))
  14579. (setq w1 (- end beg)
  14580. with-hm (and (nth 1 t1) (nth 2 t1))
  14581. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  14582. time (org-fix-decoded-time t1)
  14583. str (org-add-props
  14584. (format-time-string
  14585. (substring tf 1 -1) (apply 'encode-time time))
  14586. nil 'mouse-face 'highlight)
  14587. w2 (length str))
  14588. (if (not (= w2 w1))
  14589. (add-text-properties (1+ beg) (+ 2 beg)
  14590. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  14591. (if (featurep 'xemacs)
  14592. (progn
  14593. (put-text-property beg end 'invisible t)
  14594. (put-text-property beg end 'end-glyph (make-glyph str)))
  14595. (put-text-property beg end 'display str))))
  14596. (defun org-translate-time (string)
  14597. "Translate all timestamps in STRING to custom format.
  14598. But do this only if the variable `org-display-custom-times' is set."
  14599. (when org-display-custom-times
  14600. (save-match-data
  14601. (let* ((start 0)
  14602. (re org-ts-regexp-both)
  14603. t1 with-hm inactive tf time str beg end)
  14604. (while (setq start (string-match re string start))
  14605. (setq beg (match-beginning 0)
  14606. end (match-end 0)
  14607. t1 (save-match-data
  14608. (org-parse-time-string (substring string beg end) t))
  14609. with-hm (and (nth 1 t1) (nth 2 t1))
  14610. inactive (equal (substring string beg (1+ beg)) "[")
  14611. tf (funcall (if with-hm 'cdr 'car)
  14612. org-time-stamp-custom-formats)
  14613. time (org-fix-decoded-time t1)
  14614. str (format-time-string
  14615. (concat
  14616. (if inactive "[" "<") (substring tf 1 -1)
  14617. (if inactive "]" ">"))
  14618. (apply 'encode-time time))
  14619. string (replace-match str t t string)
  14620. start (+ start (length str)))))))
  14621. string)
  14622. (defun org-fix-decoded-time (time)
  14623. "Set 0 instead of nil for the first 6 elements of time.
  14624. Don't touch the rest."
  14625. (let ((n 0))
  14626. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  14627. (defun org-days-to-time (timestamp-string)
  14628. "Difference between TIMESTAMP-STRING and now in days."
  14629. (- (time-to-days (org-time-string-to-time timestamp-string))
  14630. (time-to-days (current-time))))
  14631. (defun org-deadline-close (timestamp-string &optional ndays)
  14632. "Is the time in TIMESTAMP-STRING close to the current date?"
  14633. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  14634. (and (< (org-days-to-time timestamp-string) ndays)
  14635. (not (org-entry-is-done-p))))
  14636. (defun org-get-wdays (ts)
  14637. "Get the deadline lead time appropriate for timestring TS."
  14638. (cond
  14639. ((<= org-deadline-warning-days 0)
  14640. ;; 0 or negative, enforce this value no matter what
  14641. (- org-deadline-warning-days))
  14642. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  14643. ;; lead time is specified.
  14644. (floor (* (string-to-number (match-string 1 ts))
  14645. (cdr (assoc (match-string 2 ts)
  14646. '(("d" . 1) ("w" . 7)
  14647. ("m" . 30.4) ("y" . 365.25)))))))
  14648. ;; go for the default.
  14649. (t org-deadline-warning-days)))
  14650. (defun org-calendar-select-mouse (ev)
  14651. "Return to `org-read-date' with the date currently selected.
  14652. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14653. (interactive "e")
  14654. (mouse-set-point ev)
  14655. (when (calendar-cursor-to-date)
  14656. (let* ((date (calendar-cursor-to-date))
  14657. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14658. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14659. (if (active-minibuffer-window) (exit-minibuffer))))
  14660. (defun org-check-deadlines (ndays)
  14661. "Check if there are any deadlines due or past due.
  14662. A deadline is considered due if it happens within `org-deadline-warning-days'
  14663. days from today's date. If the deadline appears in an entry marked DONE,
  14664. it is not shown. The prefix arg NDAYS can be used to test that many
  14665. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  14666. (interactive "P")
  14667. (let* ((org-warn-days
  14668. (cond
  14669. ((equal ndays '(4)) 100000)
  14670. (ndays (prefix-numeric-value ndays))
  14671. (t (abs org-deadline-warning-days))))
  14672. (case-fold-search nil)
  14673. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14674. (callback
  14675. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  14676. (message "%d deadlines past-due or due within %d days"
  14677. (org-occur regexp nil callback)
  14678. org-warn-days)))
  14679. (defsubst org-re-timestamp (type)
  14680. "Return a regexp for timestamp TYPE.
  14681. Allowed values for TYPE are:
  14682. all: all timestamps
  14683. active: only active timestamps (<...>)
  14684. inactive: only inactive timestamps ([...])
  14685. scheduled: only scheduled timestamps
  14686. deadline: only deadline timestamps
  14687. When TYPE is nil, fall back on returning a regexp that matches
  14688. both scheduled and deadline timestamps."
  14689. (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
  14690. ((eq type 'active) org-ts-regexp)
  14691. ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
  14692. ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
  14693. ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14694. ((eq type 'scheduled-or-deadline)
  14695. (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
  14696. (defun org-check-before-date (date)
  14697. "Check if there are deadlines or scheduled entries before DATE."
  14698. (interactive (list (org-read-date)))
  14699. (let ((case-fold-search nil)
  14700. (regexp (org-re-timestamp org-ts-type))
  14701. (callback
  14702. (lambda () (time-less-p
  14703. (org-time-string-to-time (match-string 1))
  14704. (org-time-string-to-time date)))))
  14705. (message "%d entries before %s"
  14706. (org-occur regexp nil callback) date)))
  14707. (defun org-check-after-date (date)
  14708. "Check if there are deadlines or scheduled entries after DATE."
  14709. (interactive (list (org-read-date)))
  14710. (let ((case-fold-search nil)
  14711. (regexp (org-re-timestamp org-ts-type))
  14712. (callback
  14713. (lambda () (not
  14714. (time-less-p
  14715. (org-time-string-to-time (match-string 1))
  14716. (org-time-string-to-time date))))))
  14717. (message "%d entries after %s"
  14718. (org-occur regexp nil callback) date)))
  14719. (defun org-check-dates-range (start-date end-date)
  14720. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  14721. (interactive (list (org-read-date nil nil nil "Range starts")
  14722. (org-read-date nil nil nil "Range end")))
  14723. (let ((case-fold-search nil)
  14724. (regexp (org-re-timestamp org-ts-type))
  14725. (callback
  14726. (lambda ()
  14727. (let ((match (match-string 1)))
  14728. (and
  14729. (not (time-less-p
  14730. (org-time-string-to-time match)
  14731. (org-time-string-to-time start-date)))
  14732. (time-less-p
  14733. (org-time-string-to-time match)
  14734. (org-time-string-to-time end-date)))))))
  14735. (message "%d entries between %s and %s"
  14736. (org-occur regexp nil callback) start-date end-date)))
  14737. (defun org-evaluate-time-range (&optional to-buffer)
  14738. "Evaluate a time range by computing the difference between start and end.
  14739. Normally the result is just printed in the echo area, but with prefix arg
  14740. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  14741. If the time range is actually in a table, the result is inserted into the
  14742. next column.
  14743. For time difference computation, a year is assumed to be exactly 365
  14744. days in order to avoid rounding problems."
  14745. (interactive "P")
  14746. (or
  14747. (org-clock-update-time-maybe)
  14748. (save-excursion
  14749. (unless (org-at-date-range-p t)
  14750. (goto-char (point-at-bol))
  14751. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  14752. (if (not (org-at-date-range-p t))
  14753. (error "Not at a time-stamp range, and none found in current line")))
  14754. (let* ((ts1 (match-string 1))
  14755. (ts2 (match-string 2))
  14756. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  14757. (match-end (match-end 0))
  14758. (time1 (org-time-string-to-time ts1))
  14759. (time2 (org-time-string-to-time ts2))
  14760. (t1 (org-float-time time1))
  14761. (t2 (org-float-time time2))
  14762. (diff (abs (- t2 t1)))
  14763. (negative (< (- t2 t1) 0))
  14764. ;; (ys (floor (* 365 24 60 60)))
  14765. (ds (* 24 60 60))
  14766. (hs (* 60 60))
  14767. (fy "%dy %dd %02d:%02d")
  14768. (fy1 "%dy %dd")
  14769. (fd "%dd %02d:%02d")
  14770. (fd1 "%dd")
  14771. (fh "%02d:%02d")
  14772. y d h m align)
  14773. (if havetime
  14774. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14775. y 0
  14776. d (floor (/ diff ds)) diff (mod diff ds)
  14777. h (floor (/ diff hs)) diff (mod diff hs)
  14778. m (floor (/ diff 60)))
  14779. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14780. y 0
  14781. d (floor (+ (/ diff ds) 0.5))
  14782. h 0 m 0))
  14783. (if (not to-buffer)
  14784. (message "%s" (org-make-tdiff-string y d h m))
  14785. (if (org-at-table-p)
  14786. (progn
  14787. (goto-char match-end)
  14788. (setq align t)
  14789. (and (looking-at " *|") (goto-char (match-end 0))))
  14790. (goto-char match-end))
  14791. (if (looking-at
  14792. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  14793. (replace-match ""))
  14794. (if negative (insert " -"))
  14795. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  14796. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  14797. (insert " " (format fh h m))))
  14798. (if align (org-table-align))
  14799. (message "Time difference inserted")))))
  14800. (defun org-make-tdiff-string (y d h m)
  14801. (let ((fmt "")
  14802. (l nil))
  14803. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  14804. l (push y l)))
  14805. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  14806. l (push d l)))
  14807. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  14808. l (push h l)))
  14809. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  14810. l (push m l)))
  14811. (apply 'format fmt (nreverse l))))
  14812. (defun org-time-string-to-time (s &optional buffer pos)
  14813. (condition-case errdata
  14814. (apply 'encode-time (org-parse-time-string s))
  14815. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14816. s (if (not (and buffer pos))
  14817. ""
  14818. (format " at %d in buffer `%s'" pos buffer))
  14819. (cdr errdata)))))
  14820. (defun org-time-string-to-seconds (s)
  14821. (org-float-time (org-time-string-to-time s)))
  14822. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  14823. "Convert a time stamp to an absolute day number.
  14824. If there is a specifier for a cyclic time stamp, get the closest date to
  14825. DAYNR.
  14826. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  14827. The variable date is bound by the calendar when this is called."
  14828. (cond
  14829. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  14830. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  14831. daynr
  14832. (+ daynr 1000)))
  14833. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  14834. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  14835. (time-to-days (current-time))) (match-string 0 s)
  14836. prefer show-all))
  14837. (t (time-to-days
  14838. (condition-case errdata
  14839. (apply 'encode-time (org-parse-time-string s))
  14840. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14841. s (if (not (and buffer pos))
  14842. ""
  14843. (format " at %d in buffer `%s'" pos buffer))
  14844. (cdr errdata))))))))
  14845. (defun org-days-to-iso-week (days)
  14846. "Return the iso week number."
  14847. (require 'cal-iso)
  14848. (car (calendar-iso-from-absolute days)))
  14849. (defun org-small-year-to-year (year)
  14850. "Convert 2-digit years into 4-digit years.
  14851. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  14852. The year 2000 cannot be abbreviated. Any year larger than 99
  14853. is returned unchanged."
  14854. (if (< year 38)
  14855. (setq year (+ 2000 year))
  14856. (if (< year 100)
  14857. (setq year (+ 1900 year))))
  14858. year)
  14859. (defun org-time-from-absolute (d)
  14860. "Return the time corresponding to date D.
  14861. D may be an absolute day number, or a calendar-type list (month day year)."
  14862. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  14863. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  14864. (defun org-calendar-holiday ()
  14865. "List of holidays, for Diary display in Org-mode."
  14866. (require 'holidays)
  14867. (let ((hl (funcall
  14868. (if (fboundp 'calendar-check-holidays)
  14869. 'calendar-check-holidays 'check-calendar-holidays) date)))
  14870. (if hl (mapconcat 'identity hl "; "))))
  14871. (defun org-diary-sexp-entry (sexp entry date)
  14872. "Process a SEXP diary ENTRY for DATE."
  14873. (require 'diary-lib)
  14874. (let ((result (if calendar-debug-sexp
  14875. (let ((stack-trace-on-error t))
  14876. (eval (car (read-from-string sexp))))
  14877. (condition-case nil
  14878. (eval (car (read-from-string sexp)))
  14879. (error
  14880. (beep)
  14881. (message "Bad sexp at line %d in %s: %s"
  14882. (org-current-line)
  14883. (buffer-file-name) sexp)
  14884. (sleep-for 2))))))
  14885. (cond ((stringp result) (split-string result "; "))
  14886. ((and (consp result)
  14887. (not (consp (cdr result)))
  14888. (stringp (cdr result))) (cdr result))
  14889. ((and (consp result)
  14890. (stringp (car result))) result)
  14891. (result entry))))
  14892. (defun org-diary-to-ical-string (frombuf)
  14893. "Get iCalendar entries from diary entries in buffer FROMBUF.
  14894. This uses the icalendar.el library."
  14895. (let* ((tmpdir (if (featurep 'xemacs)
  14896. (temp-directory)
  14897. temporary-file-directory))
  14898. (tmpfile (make-temp-name
  14899. (expand-file-name "orgics" tmpdir)))
  14900. buf rtn b e)
  14901. (with-current-buffer frombuf
  14902. (icalendar-export-region (point-min) (point-max) tmpfile)
  14903. (setq buf (find-buffer-visiting tmpfile))
  14904. (set-buffer buf)
  14905. (goto-char (point-min))
  14906. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  14907. (setq b (match-beginning 0)))
  14908. (goto-char (point-max))
  14909. (if (re-search-backward "^END:VEVENT" nil t)
  14910. (setq e (match-end 0)))
  14911. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  14912. (kill-buffer buf)
  14913. (delete-file tmpfile)
  14914. rtn))
  14915. (defun org-closest-date (start current change prefer show-all)
  14916. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  14917. When PREFER is `past', return a date that is either CURRENT or past.
  14918. When PREFER is `future', return a date that is either CURRENT or future.
  14919. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  14920. ;; Make the proper lists from the dates
  14921. (catch 'exit
  14922. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  14923. dn dw sday cday n1 n2 n0
  14924. d m y y1 y2 date1 date2 nmonths nm ny m2)
  14925. (setq start (org-date-to-gregorian start)
  14926. current (org-date-to-gregorian
  14927. (if show-all
  14928. current
  14929. (time-to-days (current-time))))
  14930. sday (calendar-absolute-from-gregorian start)
  14931. cday (calendar-absolute-from-gregorian current))
  14932. (if (<= cday sday) (throw 'exit sday))
  14933. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  14934. (setq dn (string-to-number (match-string 1 change))
  14935. dw (cdr (assoc (match-string 2 change) a1)))
  14936. (error "Invalid change specifier: %s" change))
  14937. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  14938. (cond
  14939. ((eq dw 'day)
  14940. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  14941. n2 (+ n1 dn)))
  14942. ((eq dw 'year)
  14943. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  14944. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  14945. (setq date1 (list m d y1)
  14946. n1 (calendar-absolute-from-gregorian date1)
  14947. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  14948. n2 (calendar-absolute-from-gregorian date2)))
  14949. ((eq dw 'month)
  14950. ;; approx number of month between the two dates
  14951. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  14952. ;; How often does dn fit in there?
  14953. (setq d (nth 1 start) m (car start) y (nth 2 start)
  14954. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  14955. m (+ m nm)
  14956. ny (floor (/ m 12))
  14957. y (+ y ny)
  14958. m (- m (* ny 12)))
  14959. (while (> m 12) (setq m (- m 12) y (1+ y)))
  14960. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  14961. (setq m2 (+ m dn) y2 y)
  14962. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14963. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  14964. (while (<= n2 cday)
  14965. (setq n1 n2 m m2 y y2)
  14966. (setq m2 (+ m dn) y2 y)
  14967. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14968. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  14969. ;; Make sure n1 is the earlier date
  14970. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  14971. (if show-all
  14972. (cond
  14973. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14974. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14975. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  14976. (cond
  14977. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14978. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14979. (t (if (= cday n1) n1 n2)))))))
  14980. (defun org-date-to-gregorian (date)
  14981. "Turn any specification of DATE into a Gregorian date for the calendar."
  14982. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  14983. ((and (listp date) (= (length date) 3)) date)
  14984. ((stringp date)
  14985. (setq date (org-parse-time-string date))
  14986. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  14987. ((listp date)
  14988. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  14989. (defun org-parse-time-string (s &optional nodefault)
  14990. "Parse the standard Org-mode time string.
  14991. This should be a lot faster than the normal `parse-time-string'.
  14992. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  14993. hour and minute fields will be nil if not given."
  14994. (if (string-match org-ts-regexp0 s)
  14995. (list 0
  14996. (if (or (match-beginning 8) (not nodefault))
  14997. (string-to-number (or (match-string 8 s) "0")))
  14998. (if (or (match-beginning 7) (not nodefault))
  14999. (string-to-number (or (match-string 7 s) "0")))
  15000. (string-to-number (match-string 4 s))
  15001. (string-to-number (match-string 3 s))
  15002. (string-to-number (match-string 2 s))
  15003. nil nil nil)
  15004. (error "Not a standard Org-mode time string: %s" s)))
  15005. (defun org-timestamp-up (&optional arg)
  15006. "Increase the date item at the cursor by one.
  15007. If the cursor is on the year, change the year. If it is on the month,
  15008. the day or the time, change that.
  15009. With prefix ARG, change by that many units."
  15010. (interactive "p")
  15011. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  15012. (defun org-timestamp-down (&optional arg)
  15013. "Decrease the date item at the cursor by one.
  15014. If the cursor is on the year, change the year. If it is on the month,
  15015. the day or the time, change that.
  15016. With prefix ARG, change by that many units."
  15017. (interactive "p")
  15018. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  15019. (defun org-timestamp-up-day (&optional arg)
  15020. "Increase the date in the time stamp by one day.
  15021. With prefix ARG, change that many days."
  15022. (interactive "p")
  15023. (if (and (not (org-at-timestamp-p t))
  15024. (org-at-heading-p))
  15025. (org-todo 'up)
  15026. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  15027. (defun org-timestamp-down-day (&optional arg)
  15028. "Decrease the date in the time stamp by one day.
  15029. With prefix ARG, change that many days."
  15030. (interactive "p")
  15031. (if (and (not (org-at-timestamp-p t))
  15032. (org-at-heading-p))
  15033. (org-todo 'down)
  15034. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  15035. (defun org-at-timestamp-p (&optional inactive-ok)
  15036. "Determine if the cursor is in or at a timestamp."
  15037. (interactive)
  15038. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  15039. (pos (point))
  15040. (ans (or (looking-at tsr)
  15041. (save-excursion
  15042. (skip-chars-backward "^[<\n\r\t")
  15043. (if (> (point) (point-min)) (backward-char 1))
  15044. (and (looking-at tsr)
  15045. (> (- (match-end 0) pos) -1))))))
  15046. (and ans
  15047. (boundp 'org-ts-what)
  15048. (setq org-ts-what
  15049. (cond
  15050. ((= pos (match-beginning 0)) 'bracket)
  15051. ;; Point is considered to be "on the bracket" whether
  15052. ;; it's really on it or right after it.
  15053. ((= pos (1- (match-end 0))) 'bracket)
  15054. ((= pos (match-end 0)) 'after)
  15055. ((org-pos-in-match-range pos 2) 'year)
  15056. ((org-pos-in-match-range pos 3) 'month)
  15057. ((org-pos-in-match-range pos 7) 'hour)
  15058. ((org-pos-in-match-range pos 8) 'minute)
  15059. ((or (org-pos-in-match-range pos 4)
  15060. (org-pos-in-match-range pos 5)) 'day)
  15061. ((and (> pos (or (match-end 8) (match-end 5)))
  15062. (< pos (match-end 0)))
  15063. (- pos (or (match-end 8) (match-end 5))))
  15064. (t 'day))))
  15065. ans))
  15066. (defun org-toggle-timestamp-type ()
  15067. "Toggle the type (<active> or [inactive]) of a time stamp."
  15068. (interactive)
  15069. (when (org-at-timestamp-p t)
  15070. (let ((beg (match-beginning 0)) (end (match-end 0))
  15071. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  15072. (save-excursion
  15073. (goto-char beg)
  15074. (while (re-search-forward "[][<>]" end t)
  15075. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  15076. t t)))
  15077. (message "Timestamp is now %sactive"
  15078. (if (equal (char-after beg) ?<) "" "in")))))
  15079. (defvar org-clock-history) ; defined in org-clock.el
  15080. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  15081. (defun org-timestamp-change (n &optional what updown)
  15082. "Change the date in the time stamp at point.
  15083. The date will be changed by N times WHAT. WHAT can be `day', `month',
  15084. `year', `minute', `second'. If WHAT is not given, the cursor position
  15085. in the timestamp determines what will be changed."
  15086. (let ((origin (point)) origin-cat
  15087. with-hm inactive
  15088. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  15089. org-ts-what
  15090. extra rem
  15091. ts time time0 fixnext clrgx)
  15092. (if (not (org-at-timestamp-p t))
  15093. (error "Not at a timestamp"))
  15094. (if (and (not what) (eq org-ts-what 'bracket))
  15095. (org-toggle-timestamp-type)
  15096. ;; Point isn't on brackets. Remember the part of the time-stamp
  15097. ;; the point was in. Indeed, size of time-stamps may change,
  15098. ;; but point must be kept in the same category nonetheless.
  15099. (setq origin-cat org-ts-what)
  15100. (if (and (not what) (not (eq org-ts-what 'day))
  15101. org-display-custom-times
  15102. (get-text-property (point) 'display)
  15103. (not (get-text-property (1- (point)) 'display)))
  15104. (setq org-ts-what 'day))
  15105. (setq org-ts-what (or what org-ts-what)
  15106. inactive (= (char-after (match-beginning 0)) ?\[)
  15107. ts (match-string 0))
  15108. (replace-match "")
  15109. (if (string-match
  15110. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  15111. ts)
  15112. (setq extra (match-string 1 ts)))
  15113. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  15114. (setq with-hm t))
  15115. (setq time0 (org-parse-time-string ts))
  15116. (when (and updown
  15117. (eq org-ts-what 'minute)
  15118. (not current-prefix-arg))
  15119. ;; This looks like s-up and s-down. Change by one rounding step.
  15120. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  15121. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  15122. (setcar (cdr time0) (+ (nth 1 time0)
  15123. (if (> n 0) (- rem) (- dm rem))))))
  15124. (setq time
  15125. (encode-time (or (car time0) 0)
  15126. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  15127. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  15128. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  15129. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  15130. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  15131. (nthcdr 6 time0)))
  15132. (when (and (member org-ts-what '(hour minute))
  15133. extra
  15134. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  15135. (setq extra (org-modify-ts-extra
  15136. extra
  15137. (if (eq org-ts-what 'hour) 2 5)
  15138. n dm)))
  15139. (when (integerp org-ts-what)
  15140. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  15141. (if (eq what 'calendar)
  15142. (let ((cal-date (org-get-date-from-calendar)))
  15143. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  15144. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  15145. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  15146. (setcar time0 (or (car time0) 0))
  15147. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  15148. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  15149. (setq time (apply 'encode-time time0))))
  15150. ;; Insert the new time-stamp, and ensure point stays in the same
  15151. ;; category as before (i.e. not after the last position in that
  15152. ;; category).
  15153. (let ((pos (point)))
  15154. ;; Stay before inserted string. `save-excursion' is of no use.
  15155. (setq org-last-changed-timestamp
  15156. (org-insert-time-stamp time with-hm inactive nil nil extra))
  15157. (goto-char pos))
  15158. (save-match-data
  15159. (looking-at org-ts-regexp3)
  15160. (goto-char (cond
  15161. ;; `day' category ends before `hour' if any, or at
  15162. ;; the end of the day name.
  15163. ((eq origin-cat 'day)
  15164. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  15165. ((eq origin-cat 'hour) (min (match-end 7) origin))
  15166. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  15167. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  15168. ;; `year' and `month' have both fixed size: point
  15169. ;; couldn't have moved into another part.
  15170. (t origin))))
  15171. ;; Update clock if on a CLOCK line.
  15172. (org-clock-update-time-maybe)
  15173. ;; Maybe adjust the closest clock in `org-clock-history'
  15174. (when org-clock-adjust-closest
  15175. (if (not (and (org-at-clock-log-p)
  15176. (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
  15177. org-clock-history))))))
  15178. (message "No clock to adjust")
  15179. (cond ((save-excursion ; fix previous clock?
  15180. (re-search-backward org-ts-regexp0 nil t)
  15181. (org-looking-back (concat org-clock-string " \\[")))
  15182. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  15183. ((save-excursion ; fix next clock?
  15184. (re-search-backward org-ts-regexp0 nil t)
  15185. (looking-at (concat org-ts-regexp0 "\\] =>")))
  15186. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  15187. (save-window-excursion
  15188. ;; Find closest clock to point, adjust the previous/next one in history
  15189. (let* ((p (save-excursion (org-back-to-heading t)))
  15190. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  15191. (clfixnth
  15192. (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
  15193. (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
  15194. (if (not clfixpos)
  15195. (message "No clock to adjust")
  15196. (save-excursion
  15197. (org-goto-marker-or-bmk clfixpos)
  15198. (org-show-subtree)
  15199. (when (re-search-forward clrgx nil t)
  15200. (goto-char (match-beginning 1))
  15201. (let (org-clock-adjust-closest)
  15202. (org-timestamp-change n org-ts-what updown))
  15203. (message "Clock adjusted in %s for heading: %s"
  15204. (file-name-nondirectory (buffer-file-name))
  15205. (org-get-heading t t)))))))))
  15206. ;; Try to recenter the calendar window, if any.
  15207. (if (and org-calendar-follow-timestamp-change
  15208. (get-buffer-window "*Calendar*" t)
  15209. (memq org-ts-what '(day month year)))
  15210. (org-recenter-calendar (time-to-days time))))))
  15211. (defun org-modify-ts-extra (s pos n dm)
  15212. "Change the different parts of the lead-time and repeat fields in timestamp."
  15213. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  15214. ng h m new rem)
  15215. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  15216. (cond
  15217. ((or (org-pos-in-match-range pos 2)
  15218. (org-pos-in-match-range pos 3))
  15219. (setq m (string-to-number (match-string 3 s))
  15220. h (string-to-number (match-string 2 s)))
  15221. (if (org-pos-in-match-range pos 2)
  15222. (setq h (+ h n))
  15223. (setq n (* dm (org-no-warnings (signum n))))
  15224. (when (not (= 0 (setq rem (% m dm))))
  15225. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  15226. (setq m (+ m n)))
  15227. (if (< m 0) (setq m (+ m 60) h (1- h)))
  15228. (if (> m 59) (setq m (- m 60) h (1+ h)))
  15229. (setq h (min 24 (max 0 h)))
  15230. (setq ng 1 new (format "-%02d:%02d" h m)))
  15231. ((org-pos-in-match-range pos 6)
  15232. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  15233. ((org-pos-in-match-range pos 5)
  15234. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  15235. ((org-pos-in-match-range pos 9)
  15236. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  15237. ((org-pos-in-match-range pos 8)
  15238. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  15239. (when ng
  15240. (setq s (concat
  15241. (substring s 0 (match-beginning ng))
  15242. new
  15243. (substring s (match-end ng))))))
  15244. s))
  15245. (defun org-recenter-calendar (date)
  15246. "If the calendar is visible, recenter it to DATE."
  15247. (let ((cwin (get-buffer-window "*Calendar*" t)))
  15248. (when cwin
  15249. (let ((calendar-move-hook nil))
  15250. (with-selected-window cwin
  15251. (calendar-goto-date (if (listp date) date
  15252. (calendar-gregorian-from-absolute date))))))))
  15253. (defun org-goto-calendar (&optional arg)
  15254. "Go to the Emacs calendar at the current date.
  15255. If there is a time stamp in the current line, go to that date.
  15256. A prefix ARG can be used to force the current date."
  15257. (interactive "P")
  15258. (let ((tsr org-ts-regexp) diff
  15259. (calendar-move-hook nil)
  15260. (calendar-view-holidays-initially-flag nil)
  15261. (calendar-view-diary-initially-flag nil))
  15262. (if (or (org-at-timestamp-p)
  15263. (save-excursion
  15264. (beginning-of-line 1)
  15265. (looking-at (concat ".*" tsr))))
  15266. (let ((d1 (time-to-days (current-time)))
  15267. (d2 (time-to-days
  15268. (org-time-string-to-time (match-string 1)))))
  15269. (setq diff (- d2 d1))))
  15270. (calendar)
  15271. (calendar-goto-today)
  15272. (if (and diff (not arg)) (calendar-forward-day diff))))
  15273. (defun org-get-date-from-calendar ()
  15274. "Return a list (month day year) of date at point in calendar."
  15275. (with-current-buffer "*Calendar*"
  15276. (save-match-data
  15277. (calendar-cursor-to-date))))
  15278. (defun org-date-from-calendar ()
  15279. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  15280. If there is already a time stamp at the cursor position, update it."
  15281. (interactive)
  15282. (if (org-at-timestamp-p t)
  15283. (org-timestamp-change 0 'calendar)
  15284. (let ((cal-date (org-get-date-from-calendar)))
  15285. (org-insert-time-stamp
  15286. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  15287. (defun org-minutes-to-hh:mm-string (m)
  15288. "Compute H:MM from a number of minutes."
  15289. (let ((h (/ m 60)))
  15290. (setq m (- m (* 60 h)))
  15291. (format org-time-clocksum-format h m)))
  15292. (defun org-hh:mm-string-to-minutes (s)
  15293. "Convert a string H:MM to a number of minutes.
  15294. If the string is just a number, interpret it as minutes.
  15295. In fact, the first hh:mm or number in the string will be taken,
  15296. there can be extra stuff in the string.
  15297. If no number is found, the return value is 0."
  15298. (cond
  15299. ((integerp s) s)
  15300. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  15301. (+ (* (string-to-number (match-string 1 s)) 60)
  15302. (string-to-number (match-string 2 s))))
  15303. ((string-match "\\([0-9]+\\)" s)
  15304. (string-to-number (match-string 1 s)))
  15305. (t 0)))
  15306. (defcustom org-effort-durations
  15307. `(("h" . 60)
  15308. ("d" . ,(* 60 8))
  15309. ("w" . ,(* 60 8 5))
  15310. ("m" . ,(* 60 8 5 4))
  15311. ("y" . ,(* 60 8 5 40)))
  15312. "Conversion factor to minutes for an effort modifier.
  15313. Each entry has the form (MODIFIER . MINUTES).
  15314. In an effort string, a number followed by MODIFIER is multiplied
  15315. by the specified number of MINUTES to obtain an effort in
  15316. minutes.
  15317. For example, if the value of this variable is ((\"hours\" . 60)), then an
  15318. effort string \"2hours\" is equivalent to 120 minutes."
  15319. :group 'org-agenda
  15320. :version "24.1"
  15321. :type '(alist :key-type (string :tag "Modifier")
  15322. :value-type (number :tag "Minutes")))
  15323. (defun org-duration-string-to-minutes (s &optional output-to-string)
  15324. "Convert a duration string S to minutes.
  15325. A bare number is interpreted as minutes, modifiers can be set by
  15326. customizing `org-effort-durations' (which see).
  15327. Entries containing a colon are interpreted as H:MM by
  15328. `org-hh:mm-string-to-minutes'."
  15329. (let ((result 0)
  15330. (re (concat "\\([0-9.]+\\) *\\("
  15331. (regexp-opt (mapcar 'car org-effort-durations))
  15332. "\\)")))
  15333. (while (string-match re s)
  15334. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  15335. (string-to-number (match-string 1 s))))
  15336. (setq s (replace-match "" nil t s)))
  15337. (setq result (floor result))
  15338. (incf result (org-hh:mm-string-to-minutes s))
  15339. (if output-to-string (number-to-string result) result)))
  15340. ;;;; Files
  15341. (defun org-save-all-org-buffers ()
  15342. "Save all Org-mode buffers without user confirmation."
  15343. (interactive)
  15344. (message "Saving all Org-mode buffers...")
  15345. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  15346. (when (featurep 'org-id) (org-id-locations-save))
  15347. (message "Saving all Org-mode buffers... done"))
  15348. (defun org-revert-all-org-buffers ()
  15349. "Revert all Org-mode buffers.
  15350. Prompt for confirmation when there are unsaved changes.
  15351. Be sure you know what you are doing before letting this function
  15352. overwrite your changes.
  15353. This function is useful in a setup where one tracks org files
  15354. with a version control system, to revert on one machine after pulling
  15355. changes from another. I believe the procedure must be like this:
  15356. 1. M-x org-save-all-org-buffers
  15357. 2. Pull changes from the other machine, resolve conflicts
  15358. 3. M-x org-revert-all-org-buffers"
  15359. (interactive)
  15360. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  15361. (error "Abort"))
  15362. (save-excursion
  15363. (save-window-excursion
  15364. (mapc
  15365. (lambda (b)
  15366. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  15367. (with-current-buffer b buffer-file-name))
  15368. (org-pop-to-buffer-same-window b)
  15369. (revert-buffer t 'no-confirm)))
  15370. (buffer-list))
  15371. (when (and (featurep 'org-id) org-id-track-globally)
  15372. (org-id-locations-load)))))
  15373. ;;;; Agenda files
  15374. ;;;###autoload
  15375. (defun org-switchb (&optional arg)
  15376. "Switch between Org buffers.
  15377. With one prefix argument, restrict available buffers to files.
  15378. With two prefix arguments, restrict available buffers to agenda files.
  15379. Defaults to `iswitchb' for buffer name completion.
  15380. Set `org-completion-use-ido' to make it use ido instead."
  15381. (interactive "P")
  15382. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  15383. ((equal arg '(16)) (org-buffer-list 'agenda))
  15384. (t (org-buffer-list))))
  15385. (org-completion-use-iswitchb org-completion-use-iswitchb)
  15386. (org-completion-use-ido org-completion-use-ido))
  15387. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  15388. (setq org-completion-use-iswitchb t))
  15389. (org-pop-to-buffer-same-window
  15390. (org-icompleting-read "Org buffer: "
  15391. (mapcar 'list (mapcar 'buffer-name blist))
  15392. nil t))))
  15393. ;;; Define some older names previously used for this functionality
  15394. ;;;###autoload
  15395. (defalias 'org-ido-switchb 'org-switchb)
  15396. ;;;###autoload
  15397. (defalias 'org-iswitchb 'org-switchb)
  15398. (defun org-buffer-list (&optional predicate exclude-tmp)
  15399. "Return a list of Org buffers.
  15400. PREDICATE can be `export', `files' or `agenda'.
  15401. export restrict the list to Export buffers.
  15402. files restrict the list to buffers visiting Org files.
  15403. agenda restrict the list to buffers visiting agenda files.
  15404. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  15405. (let* ((bfn nil)
  15406. (agenda-files (and (eq predicate 'agenda)
  15407. (mapcar 'file-truename (org-agenda-files t))))
  15408. (filter
  15409. (cond
  15410. ((eq predicate 'files)
  15411. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  15412. ((eq predicate 'export)
  15413. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  15414. ((eq predicate 'agenda)
  15415. (lambda (b)
  15416. (with-current-buffer b
  15417. (and (derived-mode-p 'org-mode)
  15418. (setq bfn (buffer-file-name b))
  15419. (member (file-truename bfn) agenda-files)))))
  15420. (t (lambda (b) (with-current-buffer b
  15421. (or (derived-mode-p 'org-mode)
  15422. (string-match "\*Org .*Export"
  15423. (buffer-name b)))))))))
  15424. (delq nil
  15425. (mapcar
  15426. (lambda(b)
  15427. (if (and (funcall filter b)
  15428. (or (not exclude-tmp)
  15429. (not (string-match "tmp" (buffer-name b)))))
  15430. b
  15431. nil))
  15432. (buffer-list)))))
  15433. (defun org-agenda-files (&optional unrestricted archives)
  15434. "Get the list of agenda files.
  15435. Optional UNRESTRICTED means return the full list even if a restriction
  15436. is currently in place.
  15437. When ARCHIVES is t, include all archive files that are really being
  15438. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  15439. `org-agenda-archives-mode' is t."
  15440. (let ((files
  15441. (cond
  15442. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  15443. ((stringp org-agenda-files) (org-read-agenda-file-list))
  15444. ((listp org-agenda-files) org-agenda-files)
  15445. (t (error "Invalid value of `org-agenda-files'")))))
  15446. (setq files (apply 'append
  15447. (mapcar (lambda (f)
  15448. (if (file-directory-p f)
  15449. (directory-files
  15450. f t org-agenda-file-regexp)
  15451. (list f)))
  15452. files)))
  15453. (when org-agenda-skip-unavailable-files
  15454. (setq files (delq nil
  15455. (mapcar (function
  15456. (lambda (file)
  15457. (and (file-readable-p file) file)))
  15458. files))))
  15459. (when (or (eq archives t)
  15460. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  15461. (setq files (org-add-archive-files files)))
  15462. files))
  15463. (defun org-agenda-file-p (&optional file)
  15464. "Return non-nil, if FILE is an agenda file.
  15465. If FILE is omitted, use the file associated with the current
  15466. buffer."
  15467. (member (or file (buffer-file-name))
  15468. (org-agenda-files t)))
  15469. (defun org-edit-agenda-file-list ()
  15470. "Edit the list of agenda files.
  15471. Depending on setup, this either uses customize to edit the variable
  15472. `org-agenda-files', or it visits the file that is holding the list. In the
  15473. latter case, the buffer is set up in a way that saving it automatically kills
  15474. the buffer and restores the previous window configuration."
  15475. (interactive)
  15476. (if (stringp org-agenda-files)
  15477. (let ((cw (current-window-configuration)))
  15478. (find-file org-agenda-files)
  15479. (org-set-local 'org-window-configuration cw)
  15480. (org-add-hook 'after-save-hook
  15481. (lambda ()
  15482. (set-window-configuration
  15483. (prog1 org-window-configuration
  15484. (kill-buffer (current-buffer))))
  15485. (org-install-agenda-files-menu)
  15486. (message "New agenda file list installed"))
  15487. nil 'local)
  15488. (message "%s" (substitute-command-keys
  15489. "Edit list and finish with \\[save-buffer]")))
  15490. (customize-variable 'org-agenda-files)))
  15491. (defun org-store-new-agenda-file-list (list)
  15492. "Set new value for the agenda file list and save it correctly."
  15493. (if (stringp org-agenda-files)
  15494. (let ((fe (org-read-agenda-file-list t)) b u)
  15495. (while (setq b (find-buffer-visiting org-agenda-files))
  15496. (kill-buffer b))
  15497. (with-temp-file org-agenda-files
  15498. (insert
  15499. (mapconcat
  15500. (lambda (f) ;; Keep un-expanded entries.
  15501. (if (setq u (assoc f fe))
  15502. (cdr u)
  15503. f))
  15504. list "\n")
  15505. "\n")))
  15506. (let ((org-mode-hook nil) (org-inhibit-startup t)
  15507. (org-insert-mode-line-in-empty-file nil))
  15508. (setq org-agenda-files list)
  15509. (customize-save-variable 'org-agenda-files org-agenda-files))))
  15510. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  15511. "Read the list of agenda files from a file.
  15512. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  15513. filenames, used by `org-store-new-agenda-file-list' to write back
  15514. un-expanded file names."
  15515. (when (file-directory-p org-agenda-files)
  15516. (error "`org-agenda-files' cannot be a single directory"))
  15517. (when (stringp org-agenda-files)
  15518. (with-temp-buffer
  15519. (insert-file-contents org-agenda-files)
  15520. (mapcar
  15521. (lambda (f)
  15522. (let ((e (expand-file-name (substitute-in-file-name f)
  15523. org-directory)))
  15524. (if pair-with-expansion
  15525. (cons e f)
  15526. e)))
  15527. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  15528. ;;;###autoload
  15529. (defun org-cycle-agenda-files ()
  15530. "Cycle through the files in `org-agenda-files'.
  15531. If the current buffer visits an agenda file, find the next one in the list.
  15532. If the current buffer does not, find the first agenda file."
  15533. (interactive)
  15534. (let* ((fs (org-agenda-files t))
  15535. (files (append fs (list (car fs))))
  15536. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  15537. file)
  15538. (unless files (error "No agenda files"))
  15539. (catch 'exit
  15540. (while (setq file (pop files))
  15541. (if (equal (file-truename file) tcf)
  15542. (when (car files)
  15543. (find-file (car files))
  15544. (throw 'exit t))))
  15545. (find-file (car fs)))
  15546. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  15547. (defun org-agenda-file-to-front (&optional to-end)
  15548. "Move/add the current file to the top of the agenda file list.
  15549. If the file is not present in the list, it is added to the front. If it is
  15550. present, it is moved there. With optional argument TO-END, add/move to the
  15551. end of the list."
  15552. (interactive "P")
  15553. (let ((org-agenda-skip-unavailable-files nil)
  15554. (file-alist (mapcar (lambda (x)
  15555. (cons (file-truename x) x))
  15556. (org-agenda-files t)))
  15557. (ctf (file-truename buffer-file-name))
  15558. x had)
  15559. (setq x (assoc ctf file-alist) had x)
  15560. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  15561. (if to-end
  15562. (setq file-alist (append (delq x file-alist) (list x)))
  15563. (setq file-alist (cons x (delq x file-alist))))
  15564. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  15565. (org-install-agenda-files-menu)
  15566. (message "File %s to %s of agenda file list"
  15567. (if had "moved" "added") (if to-end "end" "front"))))
  15568. (defun org-remove-file (&optional file)
  15569. "Remove current file from the list of files in variable `org-agenda-files'.
  15570. These are the files which are being checked for agenda entries.
  15571. Optional argument FILE means use this file instead of the current."
  15572. (interactive)
  15573. (let* ((org-agenda-skip-unavailable-files nil)
  15574. (file (or file buffer-file-name))
  15575. (true-file (file-truename file))
  15576. (afile (abbreviate-file-name file))
  15577. (files (delq nil (mapcar
  15578. (lambda (x)
  15579. (if (equal true-file
  15580. (file-truename x))
  15581. nil x))
  15582. (org-agenda-files t)))))
  15583. (if (not (= (length files) (length (org-agenda-files t))))
  15584. (progn
  15585. (org-store-new-agenda-file-list files)
  15586. (org-install-agenda-files-menu)
  15587. (message "Removed file: %s" afile))
  15588. (message "File was not in list: %s (not removed)" afile))))
  15589. (defun org-file-menu-entry (file)
  15590. (vector file (list 'find-file file) t))
  15591. (defun org-check-agenda-file (file)
  15592. "Make sure FILE exists. If not, ask user what to do."
  15593. (when (not (file-exists-p file))
  15594. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  15595. (abbreviate-file-name file))
  15596. (let ((r (downcase (read-char-exclusive))))
  15597. (cond
  15598. ((equal r ?r)
  15599. (org-remove-file file)
  15600. (throw 'nextfile t))
  15601. (t (error "Abort"))))))
  15602. (defun org-get-agenda-file-buffer (file)
  15603. "Get a buffer visiting FILE. If the buffer needs to be created, add
  15604. it to the list of buffers which might be released later."
  15605. (let ((buf (org-find-base-buffer-visiting file)))
  15606. (if buf
  15607. buf ; just return it
  15608. ;; Make a new buffer and remember it
  15609. (setq buf (find-file-noselect file))
  15610. (if buf (push buf org-agenda-new-buffers))
  15611. buf)))
  15612. (defun org-release-buffers (blist)
  15613. "Release all buffers in list, asking the user for confirmation when needed.
  15614. When a buffer is unmodified, it is just killed. When modified, it is saved
  15615. \(if the user agrees) and then killed."
  15616. (let (buf file)
  15617. (while (setq buf (pop blist))
  15618. (setq file (buffer-file-name buf))
  15619. (when (and (buffer-modified-p buf)
  15620. file
  15621. (y-or-n-p (format "Save file %s? " file)))
  15622. (with-current-buffer buf (save-buffer)))
  15623. (kill-buffer buf))))
  15624. (defun org-agenda-prepare-buffers (files)
  15625. "Create buffers for all agenda files, protect archived trees and comments."
  15626. (interactive)
  15627. (let ((pa '(:org-archived t))
  15628. (pc '(:org-comment t))
  15629. (pall '(:org-archived t :org-comment t))
  15630. (inhibit-read-only t)
  15631. (rea (concat ":" org-archive-tag ":"))
  15632. bmp file re)
  15633. (save-excursion
  15634. (save-restriction
  15635. (while (setq file (pop files))
  15636. (catch 'nextfile
  15637. (if (bufferp file)
  15638. (set-buffer file)
  15639. (org-check-agenda-file file)
  15640. (set-buffer (org-get-agenda-file-buffer file)))
  15641. (widen)
  15642. (setq bmp (buffer-modified-p))
  15643. (org-refresh-category-properties)
  15644. (setq org-todo-keywords-for-agenda
  15645. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  15646. (setq org-done-keywords-for-agenda
  15647. (append org-done-keywords-for-agenda org-done-keywords))
  15648. (setq org-todo-keyword-alist-for-agenda
  15649. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  15650. (setq org-drawers-for-agenda
  15651. (append org-drawers-for-agenda org-drawers))
  15652. (setq org-tag-alist-for-agenda
  15653. (append org-tag-alist-for-agenda org-tag-alist))
  15654. (save-excursion
  15655. (remove-text-properties (point-min) (point-max) pall)
  15656. (when org-agenda-skip-archived-trees
  15657. (goto-char (point-min))
  15658. (while (re-search-forward rea nil t)
  15659. (if (org-at-heading-p t)
  15660. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  15661. (goto-char (point-min))
  15662. (setq re (format org-heading-keyword-regexp-format
  15663. org-comment-string))
  15664. (while (re-search-forward re nil t)
  15665. (add-text-properties
  15666. (match-beginning 0) (org-end-of-subtree t) pc)))
  15667. (set-buffer-modified-p bmp)))))
  15668. (setq org-todo-keywords-for-agenda
  15669. (org-uniquify org-todo-keywords-for-agenda))
  15670. (setq org-todo-keyword-alist-for-agenda
  15671. (org-uniquify org-todo-keyword-alist-for-agenda)
  15672. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  15673. ;;;; Embedded LaTeX
  15674. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  15675. "Keymap for the minor `org-cdlatex-mode'.")
  15676. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  15677. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  15678. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  15679. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  15680. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  15681. (defvar org-cdlatex-texmathp-advice-is-done nil
  15682. "Flag remembering if we have applied the advice to texmathp already.")
  15683. (define-minor-mode org-cdlatex-mode
  15684. "Toggle the minor `org-cdlatex-mode'.
  15685. This mode supports entering LaTeX environment and math in LaTeX fragments
  15686. in Org-mode.
  15687. \\{org-cdlatex-mode-map}"
  15688. nil " OCDL" nil
  15689. (when org-cdlatex-mode
  15690. (require 'cdlatex)
  15691. (run-hooks 'cdlatex-mode-hook)
  15692. (cdlatex-compute-tables))
  15693. (unless org-cdlatex-texmathp-advice-is-done
  15694. (setq org-cdlatex-texmathp-advice-is-done t)
  15695. (defadvice texmathp (around org-math-always-on activate)
  15696. "Always return t in org-mode buffers.
  15697. This is because we want to insert math symbols without dollars even outside
  15698. the LaTeX math segments. If Orgmode thinks that point is actually inside
  15699. an embedded LaTeX fragment, let texmathp do its job.
  15700. \\[org-cdlatex-mode-map]"
  15701. (interactive)
  15702. (let (p)
  15703. (cond
  15704. ((not (derived-mode-p 'org-mode)) ad-do-it)
  15705. ((eq this-command 'cdlatex-math-symbol)
  15706. (setq ad-return-value t
  15707. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  15708. (t
  15709. (let ((p (org-inside-LaTeX-fragment-p)))
  15710. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  15711. (setq ad-return-value t
  15712. texmathp-why '("Org-mode embedded math" . 0))
  15713. (if p ad-do-it)))))))))
  15714. (defun turn-on-org-cdlatex ()
  15715. "Unconditionally turn on `org-cdlatex-mode'."
  15716. (org-cdlatex-mode 1))
  15717. (defun org-inside-LaTeX-fragment-p ()
  15718. "Test if point is inside a LaTeX fragment.
  15719. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  15720. sequence appearing also before point.
  15721. Even though the matchers for math are configurable, this function assumes
  15722. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  15723. delimiters are skipped when they have been removed by customization.
  15724. The return value is nil, or a cons cell with the delimiter and the
  15725. position of this delimiter.
  15726. This function does a reasonably good job, but can locally be fooled by
  15727. for example currency specifications. For example it will assume being in
  15728. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  15729. fragments that are properly closed, but during editing, we have to live
  15730. with the uncertainty caused by missing closing delimiters. This function
  15731. looks only before point, not after."
  15732. (catch 'exit
  15733. (let ((pos (point))
  15734. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  15735. (lim (progn
  15736. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  15737. (point)))
  15738. dd-on str (start 0) m re)
  15739. (goto-char pos)
  15740. (when dodollar
  15741. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  15742. re (nth 1 (assoc "$" org-latex-regexps)))
  15743. (while (string-match re str start)
  15744. (cond
  15745. ((= (match-end 0) (length str))
  15746. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  15747. ((= (match-end 0) (- (length str) 5))
  15748. (throw 'exit nil))
  15749. (t (setq start (match-end 0))))))
  15750. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  15751. (goto-char pos)
  15752. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  15753. (and (match-beginning 2) (throw 'exit nil))
  15754. ;; count $$
  15755. (while (re-search-backward "\\$\\$" lim t)
  15756. (setq dd-on (not dd-on)))
  15757. (goto-char pos)
  15758. (if dd-on (cons "$$" m))))))
  15759. (defun org-inside-latex-macro-p ()
  15760. "Is point inside a LaTeX macro or its arguments?"
  15761. (save-match-data
  15762. (org-in-regexp
  15763. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  15764. (defun org-try-cdlatex-tab ()
  15765. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  15766. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  15767. - inside a LaTeX fragment, or
  15768. - after the first word in a line, where an abbreviation expansion could
  15769. insert a LaTeX environment."
  15770. (when org-cdlatex-mode
  15771. (cond
  15772. ;; Before any word on the line: No expansion possible.
  15773. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  15774. ;; Just after first word on the line: Expand it. Make sure it
  15775. ;; cannot happen on headlines, though.
  15776. ((save-excursion
  15777. (skip-chars-backward "a-zA-Z0-9*")
  15778. (skip-chars-backward " \t")
  15779. (and (bolp) (not (org-at-heading-p))))
  15780. (cdlatex-tab) t)
  15781. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  15782. (defun org-cdlatex-underscore-caret (&optional arg)
  15783. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  15784. Revert to the normal definition outside of these fragments."
  15785. (interactive "P")
  15786. (if (org-inside-LaTeX-fragment-p)
  15787. (call-interactively 'cdlatex-sub-superscript)
  15788. (let (org-cdlatex-mode)
  15789. (call-interactively (key-binding (vector last-input-event))))))
  15790. (defun org-cdlatex-math-modify (&optional arg)
  15791. "Execute `cdlatex-math-modify' in LaTeX fragments.
  15792. Revert to the normal definition outside of these fragments."
  15793. (interactive "P")
  15794. (if (org-inside-LaTeX-fragment-p)
  15795. (call-interactively 'cdlatex-math-modify)
  15796. (let (org-cdlatex-mode)
  15797. (call-interactively (key-binding (vector last-input-event))))))
  15798. (defvar org-latex-fragment-image-overlays nil
  15799. "List of overlays carrying the images of latex fragments.")
  15800. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  15801. (defun org-remove-latex-fragment-image-overlays ()
  15802. "Remove all overlays with LaTeX fragment images in current buffer."
  15803. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  15804. (setq org-latex-fragment-image-overlays nil))
  15805. (defun org-preview-latex-fragment (&optional subtree)
  15806. "Preview the LaTeX fragment at point, or all locally or globally.
  15807. If the cursor is in a LaTeX fragment, create the image and overlay
  15808. it over the source code. If there is no fragment at point, display
  15809. all fragments in the current text, from one headline to the next. With
  15810. prefix SUBTREE, display all fragments in the current subtree. With a
  15811. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  15812. the cursor is before the first headline,
  15813. display all fragments in the buffer.
  15814. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  15815. (interactive "P")
  15816. (unless buffer-file-name
  15817. (error "Can't preview LaTeX fragment in a non-file buffer"))
  15818. (org-remove-latex-fragment-image-overlays)
  15819. (save-excursion
  15820. (save-restriction
  15821. (let (beg end at msg)
  15822. (cond
  15823. ((or (equal subtree '(16))
  15824. (not (save-excursion
  15825. (re-search-backward org-outline-regexp-bol nil t))))
  15826. (setq beg (point-min) end (point-max)
  15827. msg "Creating images for buffer...%s"))
  15828. ((equal subtree '(4))
  15829. (org-back-to-heading)
  15830. (setq beg (point) end (org-end-of-subtree t)
  15831. msg "Creating images for subtree...%s"))
  15832. (t
  15833. (if (setq at (org-inside-LaTeX-fragment-p))
  15834. (goto-char (max (point-min) (- (cdr at) 2)))
  15835. (org-back-to-heading))
  15836. (setq beg (point) end (progn (outline-next-heading) (point))
  15837. msg (if at "Creating image...%s"
  15838. "Creating images for entry...%s"))))
  15839. (message msg "")
  15840. (narrow-to-region beg end)
  15841. (goto-char beg)
  15842. (org-format-latex
  15843. (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
  15844. (file-name-nondirectory
  15845. buffer-file-name)))
  15846. default-directory 'overlays msg at 'forbuffer
  15847. org-latex-create-formula-image-program)
  15848. (message msg "done. Use `C-c C-c' to remove images.")))))
  15849. (defvar org-latex-regexps
  15850. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  15851. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  15852. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  15853. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15854. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15855. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  15856. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  15857. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  15858. "Regular expressions for matching embedded LaTeX.")
  15859. (defvar org-export-have-math nil) ;; dynamic scoping
  15860. (defun org-format-latex (prefix &optional dir overlays msg at
  15861. forbuffer processing-type)
  15862. "Replace LaTeX fragments with links to an image, and produce images.
  15863. Some of the options can be changed using the variable
  15864. `org-format-latex-options'."
  15865. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  15866. (let* ((prefixnodir (file-name-nondirectory prefix))
  15867. (absprefix (expand-file-name prefix dir))
  15868. (todir (file-name-directory absprefix))
  15869. (opt org-format-latex-options)
  15870. (matchers (plist-get opt :matchers))
  15871. (re-list org-latex-regexps)
  15872. (org-format-latex-header-extra
  15873. (plist-get (org-infile-export-plist) :latex-header-extra))
  15874. (cnt 0) txt hash link beg end re e checkdir
  15875. executables-checked string
  15876. m n block-type block linkfile movefile ov)
  15877. ;; Check the different regular expressions
  15878. (while (setq e (pop re-list))
  15879. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  15880. block (if block-type "\n\n" ""))
  15881. (when (member m matchers)
  15882. (goto-char (point-min))
  15883. (while (re-search-forward re nil t)
  15884. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  15885. (not (get-text-property (match-beginning n)
  15886. 'org-protected))
  15887. (or (not overlays)
  15888. (not (eq (get-char-property (match-beginning n)
  15889. 'org-overlay-type)
  15890. 'org-latex-overlay))))
  15891. (setq org-export-have-math t)
  15892. (cond
  15893. ((eq processing-type 'verbatim)
  15894. ;; Leave the text verbatim, just protect it
  15895. (add-text-properties (match-beginning n) (match-end n)
  15896. '(org-protected t)))
  15897. ((eq processing-type 'mathjax)
  15898. ;; Prepare for MathJax processing
  15899. (setq string (match-string n))
  15900. (if (member m '("$" "$1"))
  15901. (save-excursion
  15902. (delete-region (match-beginning n) (match-end n))
  15903. (goto-char (match-beginning n))
  15904. (insert (org-add-props (concat "\\(" (substring string 1 -1)
  15905. "\\)")
  15906. '(org-protected t))))
  15907. (add-text-properties (match-beginning n) (match-end n)
  15908. '(org-protected t))))
  15909. ((or (eq processing-type 'dvipng)
  15910. (eq processing-type 'imagemagick))
  15911. ;; Process to an image
  15912. (setq txt (match-string n)
  15913. beg (match-beginning n) end (match-end n)
  15914. cnt (1+ cnt))
  15915. (let (print-length print-level) ; make sure full list is printed
  15916. (setq hash (sha1 (prin1-to-string
  15917. (list org-format-latex-header
  15918. org-format-latex-header-extra
  15919. org-export-latex-default-packages-alist
  15920. org-export-latex-packages-alist
  15921. org-format-latex-options
  15922. forbuffer txt)))
  15923. linkfile (format "%s_%s.png" prefix hash)
  15924. movefile (format "%s_%s.png" absprefix hash)))
  15925. (setq link (concat block "[[file:" linkfile "]]" block))
  15926. (if msg (message msg cnt))
  15927. (goto-char beg)
  15928. (unless checkdir ; make sure the directory exists
  15929. (setq checkdir t)
  15930. (or (file-directory-p todir) (make-directory todir t)))
  15931. (cond
  15932. ((eq processing-type 'dvipng)
  15933. (unless executables-checked
  15934. (org-check-external-command
  15935. "latex" "needed to convert LaTeX fragments to images")
  15936. (org-check-external-command
  15937. "dvipng" "needed to convert LaTeX fragments to images")
  15938. (setq executables-checked t))
  15939. (unless (file-exists-p movefile)
  15940. (org-create-formula-image-with-dvipng
  15941. txt movefile opt forbuffer)))
  15942. ((eq processing-type 'imagemagick)
  15943. (unless executables-checked
  15944. (org-check-external-command
  15945. "convert" "you need to install imagemagick")
  15946. (setq executables-checked t))
  15947. (unless (file-exists-p movefile)
  15948. (org-create-formula-image-with-imagemagick
  15949. txt movefile opt forbuffer))))
  15950. (if overlays
  15951. (progn
  15952. (mapc (lambda (o)
  15953. (if (eq (overlay-get o 'org-overlay-type)
  15954. 'org-latex-overlay)
  15955. (delete-overlay o)))
  15956. (overlays-in beg end))
  15957. (setq ov (make-overlay beg end))
  15958. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  15959. (if (featurep 'xemacs)
  15960. (progn
  15961. (overlay-put ov 'invisible t)
  15962. (overlay-put
  15963. ov 'end-glyph
  15964. (make-glyph (vector 'png :file movefile))))
  15965. (overlay-put
  15966. ov 'display
  15967. (list 'image :type 'png :file movefile :ascent 'center)))
  15968. (push ov org-latex-fragment-image-overlays)
  15969. (goto-char end))
  15970. (delete-region beg end)
  15971. (insert (org-add-props link
  15972. (list 'org-latex-src
  15973. (replace-regexp-in-string
  15974. "\"" "" txt)
  15975. 'org-latex-src-embed-type
  15976. (if block-type 'paragraph 'character))))))
  15977. ((eq processing-type 'mathml)
  15978. ;; Process to MathML
  15979. (unless executables-checked
  15980. (unless (save-match-data (org-format-latex-mathml-available-p))
  15981. (error "LaTeX to MathML converter not configured"))
  15982. (setq executables-checked t))
  15983. (setq txt (match-string n)
  15984. beg (match-beginning n) end (match-end n)
  15985. cnt (1+ cnt))
  15986. (if msg (message msg cnt))
  15987. (goto-char beg)
  15988. (delete-region beg end)
  15989. (insert (org-format-latex-as-mathml
  15990. txt block-type prefix dir)))
  15991. (t
  15992. (error "Unknown conversion type %s for latex fragments"
  15993. processing-type)))))))))
  15994. (defun org-create-math-formula (latex-frag &optional mathml-file)
  15995. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  15996. Use `org-latex-to-mathml-convert-command'. If the conversion is
  15997. sucessful, return the portion between \"<math...> </math>\"
  15998. elements otherwise return nil. When MATHML-FILE is specified,
  15999. write the results in to that file. When invoked as an
  16000. interactive command, prompt for LATEX-FRAG, with initial value
  16001. set to the current active region and echo the results for user
  16002. inspection."
  16003. (interactive (list (let ((frag (when (org-region-active-p)
  16004. (buffer-substring-no-properties
  16005. (region-beginning) (region-end)))))
  16006. (read-string "LaTeX Fragment: " frag nil frag))))
  16007. (unless latex-frag (error "Invalid latex-frag"))
  16008. (let* ((tmp-in-file (file-relative-name
  16009. (make-temp-name (expand-file-name "ltxmathml-in"))))
  16010. (ignore (write-region latex-frag nil tmp-in-file))
  16011. (tmp-out-file (file-relative-name
  16012. (make-temp-name (expand-file-name "ltxmathml-out"))))
  16013. (cmd (format-spec
  16014. org-latex-to-mathml-convert-command
  16015. `((?j . ,(shell-quote-argument
  16016. (expand-file-name org-latex-to-mathml-jar-file)))
  16017. (?I . ,(shell-quote-argument tmp-in-file))
  16018. (?o . ,(shell-quote-argument tmp-out-file)))))
  16019. mathml shell-command-output)
  16020. (when (org-called-interactively-p 'any)
  16021. (unless (org-format-latex-mathml-available-p)
  16022. (error "LaTeX to MathML converter not configured")))
  16023. (message "Running %s" cmd)
  16024. (setq shell-command-output (shell-command-to-string cmd))
  16025. (setq mathml
  16026. (when (file-readable-p tmp-out-file)
  16027. (with-current-buffer (find-file-noselect tmp-out-file t)
  16028. (goto-char (point-min))
  16029. (when (re-search-forward
  16030. (concat
  16031. (regexp-quote
  16032. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  16033. "\\(.\\|\n\\)*"
  16034. (regexp-quote "</math>")) nil t)
  16035. (prog1 (match-string 0) (kill-buffer))))))
  16036. (cond
  16037. (mathml
  16038. (setq mathml
  16039. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  16040. (when mathml-file
  16041. (write-region mathml nil mathml-file))
  16042. (when (org-called-interactively-p 'any)
  16043. (message mathml)))
  16044. ((message "LaTeX to MathML conversion failed")
  16045. (message shell-command-output)))
  16046. (delete-file tmp-in-file)
  16047. (when (file-exists-p tmp-out-file)
  16048. (delete-file tmp-out-file))
  16049. mathml))
  16050. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  16051. prefix &optional dir)
  16052. "Use `org-create-math-formula' but check local cache first."
  16053. (let* ((absprefix (expand-file-name prefix dir))
  16054. (print-length nil) (print-level nil)
  16055. (formula-id (concat
  16056. "formula-"
  16057. (sha1
  16058. (prin1-to-string
  16059. (list latex-frag
  16060. org-latex-to-mathml-convert-command)))))
  16061. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  16062. (formula-cache-dir (file-name-directory formula-cache)))
  16063. (unless (file-directory-p formula-cache-dir)
  16064. (make-directory formula-cache-dir t))
  16065. (unless (file-exists-p formula-cache)
  16066. (org-create-math-formula latex-frag formula-cache))
  16067. (if (file-exists-p formula-cache)
  16068. ;; Successful conversion. Return the link to MathML file.
  16069. (org-add-props
  16070. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  16071. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  16072. 'org-latex-src-embed-type (if latex-frag-type
  16073. 'paragraph 'character)))
  16074. ;; Failed conversion. Return the LaTeX fragment verbatim
  16075. (add-text-properties
  16076. 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
  16077. latex-frag)))
  16078. ;; This function borrows from Ganesh Swami's latex2png.el
  16079. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  16080. "This calls dvipng."
  16081. (require 'org-latex)
  16082. (let* ((tmpdir (if (featurep 'xemacs)
  16083. (temp-directory)
  16084. temporary-file-directory))
  16085. (texfilebase (make-temp-name
  16086. (expand-file-name "orgtex" tmpdir)))
  16087. (texfile (concat texfilebase ".tex"))
  16088. (dvifile (concat texfilebase ".dvi"))
  16089. (pngfile (concat texfilebase ".png"))
  16090. (fnh (if (featurep 'xemacs)
  16091. (font-height (face-font 'default))
  16092. (face-attribute 'default :height nil)))
  16093. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16094. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16095. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16096. "Black"))
  16097. (bg (or (plist-get options (if buffer :background :html-background))
  16098. "Transparent")))
  16099. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  16100. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  16101. (with-temp-file texfile
  16102. (insert (org-splice-latex-header
  16103. org-format-latex-header
  16104. org-export-latex-default-packages-alist
  16105. org-export-latex-packages-alist t
  16106. org-format-latex-header-extra))
  16107. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  16108. (require 'org-latex)
  16109. (org-export-latex-fix-inputenc))
  16110. (let ((dir default-directory))
  16111. (condition-case nil
  16112. (progn
  16113. (cd tmpdir)
  16114. (call-process "latex" nil nil nil texfile))
  16115. (error nil))
  16116. (cd dir))
  16117. (if (not (file-exists-p dvifile))
  16118. (progn (message "Failed to create dvi file from %s" texfile) nil)
  16119. (condition-case nil
  16120. (if (featurep 'xemacs)
  16121. (call-process "dvipng" nil nil nil
  16122. "-fg" fg "-bg" bg
  16123. "-T" "tight"
  16124. "-o" pngfile
  16125. dvifile)
  16126. (call-process "dvipng" nil nil nil
  16127. "-fg" fg "-bg" bg
  16128. "-D" dpi
  16129. ;;"-x" scale "-y" scale
  16130. "-T" "tight"
  16131. "-o" pngfile
  16132. dvifile))
  16133. (error nil))
  16134. (if (not (file-exists-p pngfile))
  16135. (if org-format-latex-signal-error
  16136. (error "Failed to create png file from %s" texfile)
  16137. (message "Failed to create png file from %s" texfile)
  16138. nil)
  16139. ;; Use the requested file name and clean up
  16140. (copy-file pngfile tofile 'replace)
  16141. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  16142. (if (file-exists-p (concat texfilebase e))
  16143. (delete-file (concat texfilebase e))))
  16144. pngfile))))
  16145. (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
  16146. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  16147. "This calls convert, which is included into imagemagick."
  16148. (require 'org-latex)
  16149. (let* ((tmpdir (if (featurep 'xemacs)
  16150. (temp-directory)
  16151. temporary-file-directory))
  16152. (texfilebase (make-temp-name
  16153. (expand-file-name "orgtex" tmpdir)))
  16154. (texfile (concat texfilebase ".tex"))
  16155. (pdffile (concat texfilebase ".pdf"))
  16156. (pngfile (concat texfilebase ".png"))
  16157. (fnh (if (featurep 'xemacs)
  16158. (font-height (face-font 'default))
  16159. (face-attribute 'default :height nil)))
  16160. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  16161. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  16162. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  16163. "black"))
  16164. (bg (or (plist-get options (if buffer :background :html-background))
  16165. "white")))
  16166. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  16167. (setq fg (org-latex-color-format fg)))
  16168. (if (eq bg 'default) (setq bg (org-latex-color :background))
  16169. (setq bg (org-latex-color-format
  16170. (if (string= bg "Transparent")(setq bg "white")))))
  16171. (with-temp-file texfile
  16172. (insert (org-splice-latex-header
  16173. org-format-latex-header
  16174. org-export-latex-default-packages-alist
  16175. org-export-latex-packages-alist t
  16176. org-format-latex-header-extra))
  16177. (insert "\n\\begin{document}\n"
  16178. "\\definecolor{fg}{rgb}{" fg "}\n"
  16179. "\\definecolor{bg}{rgb}{" bg "}\n"
  16180. "\n\\pagecolor{bg}\n"
  16181. "\n{\\color{fg}\n"
  16182. string
  16183. "\n}\n"
  16184. "\n\\end{document}\n" )
  16185. (require 'org-latex)
  16186. (org-export-latex-fix-inputenc))
  16187. (let ((dir default-directory) cmd cmds latex-frags-cmds)
  16188. (condition-case nil
  16189. (progn
  16190. (cd tmpdir)
  16191. (setq cmds org-latex-to-pdf-process)
  16192. (while cmds
  16193. (setq latex-frags-cmds (pop cmds))
  16194. (if (listp latex-frags-cmds)
  16195. (setq cmds nil)
  16196. (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
  16197. (while latex-frags-cmds
  16198. (setq cmd (pop latex-frags-cmds))
  16199. (while (string-match "%b" cmd)
  16200. (setq cmd (replace-match
  16201. (save-match-data
  16202. (shell-quote-argument texfile))
  16203. t t cmd)))
  16204. (while (string-match "%f" cmd)
  16205. (setq cmd (replace-match
  16206. (save-match-data
  16207. (shell-quote-argument (file-name-nondirectory texfile)))
  16208. t t cmd)))
  16209. (while (string-match "%o" cmd)
  16210. (setq cmd (replace-match
  16211. (save-match-data
  16212. (shell-quote-argument (file-name-directory texfile)))
  16213. t t cmd)))
  16214. (setq cmd (split-string cmd))
  16215. (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
  16216. (error nil))
  16217. (cd dir))
  16218. (if (not (file-exists-p pdffile))
  16219. (progn (message "Failed to create pdf file from %s" texfile) nil)
  16220. (condition-case nil
  16221. (if (featurep 'xemacs)
  16222. (call-process "convert" nil nil nil
  16223. "-density" "96"
  16224. "-trim"
  16225. "-antialias"
  16226. pdffile
  16227. "-quality" "100"
  16228. ;; "-sharpen" "0x1.0"
  16229. pngfile)
  16230. (call-process "convert" nil nil nil
  16231. "-density" dpi
  16232. "-trim"
  16233. "-antialias"
  16234. pdffile
  16235. "-quality" "100"
  16236. ; "-sharpen" "0x1.0"
  16237. pngfile))
  16238. (error nil))
  16239. (if (not (file-exists-p pngfile))
  16240. (if org-format-latex-signal-error
  16241. (error "Failed to create png file from %s" texfile)
  16242. (message "Failed to create png file from %s" texfile)
  16243. nil)
  16244. ;; Use the requested file name and clean up
  16245. (copy-file pngfile tofile 'replace)
  16246. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  16247. (if (file-exists-p (concat texfilebase e))
  16248. (delete-file (concat texfilebase e))))
  16249. pngfile))))
  16250. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  16251. "Fill a LaTeX header template TPL.
  16252. In the template, the following place holders will be recognized:
  16253. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  16254. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  16255. [PACKAGES] \\usepackage statements for PKG
  16256. [NO-PACKAGES] do not include PKG
  16257. [EXTRA] the string EXTRA
  16258. [NO-EXTRA] do not include EXTRA
  16259. For backward compatibility, if both the positive and the negative place
  16260. holder is missing, the positive one (without the \"NO-\") will be
  16261. assumed to be present at the end of the template.
  16262. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  16263. EXTRA is a string.
  16264. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  16265. (let (rpl (end ""))
  16266. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  16267. (setq rpl (if (or (match-end 1) (not def-pkg))
  16268. "" (org-latex-packages-to-string def-pkg snippets-p t))
  16269. tpl (replace-match rpl t t tpl))
  16270. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  16271. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  16272. (setq rpl (if (or (match-end 1) (not pkg))
  16273. "" (org-latex-packages-to-string pkg snippets-p t))
  16274. tpl (replace-match rpl t t tpl))
  16275. (if pkg (setq end
  16276. (concat end "\n"
  16277. (org-latex-packages-to-string pkg snippets-p)))))
  16278. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  16279. (setq rpl (if (or (match-end 1) (not extra))
  16280. "" (concat extra "\n"))
  16281. tpl (replace-match rpl t t tpl))
  16282. (if (and extra (string-match "\\S-" extra))
  16283. (setq end (concat end "\n" extra))))
  16284. (if (string-match "\\S-" end)
  16285. (concat tpl "\n" end)
  16286. tpl)))
  16287. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  16288. "Turn an alist of packages into a string with the \\usepackage macros."
  16289. (setq pkg (mapconcat (lambda(p)
  16290. (cond
  16291. ((stringp p) p)
  16292. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  16293. (format "%% Package %s omitted" (cadr p)))
  16294. ((equal "" (car p))
  16295. (format "\\usepackage{%s}" (cadr p)))
  16296. (t
  16297. (format "\\usepackage[%s]{%s}"
  16298. (car p) (cadr p)))))
  16299. pkg
  16300. "\n"))
  16301. (if newline (concat pkg "\n") pkg))
  16302. (defun org-dvipng-color (attr)
  16303. "Return a RGB color specification for dvipng."
  16304. (apply 'format "rgb %s %s %s"
  16305. (mapcar 'org-normalize-color
  16306. (if (featurep 'xemacs)
  16307. (color-rgb-components
  16308. (face-property 'default
  16309. (cond ((eq attr :foreground) 'foreground)
  16310. ((eq attr :background) 'background))))
  16311. (color-values (face-attribute 'default attr nil))))))
  16312. (defun org-latex-color (attr)
  16313. "Return a RGB color for the LaTeX color package."
  16314. (apply 'format "%s,%s,%s"
  16315. (mapcar 'org-normalize-color
  16316. (if (featurep 'xemacs)
  16317. (color-rgb-components
  16318. (face-property 'default
  16319. (cond ((eq attr :foreground) 'foreground)
  16320. ((eq attr :background) 'background))))
  16321. (color-values (face-attribute 'default attr nil))))))
  16322. (defun org-latex-color-format (color-name)
  16323. "Convert COLOR-NAME to a RGB color value."
  16324. (apply 'format "%s,%s,%s"
  16325. (mapcar 'org-normalize-color
  16326. (color-values color-name))))
  16327. (defun org-normalize-color (value)
  16328. "Return string to be used as color value for an RGB component."
  16329. (format "%g" (/ value 65535.0)))
  16330. ;; Image display
  16331. (defvar org-inline-image-overlays nil)
  16332. (make-variable-buffer-local 'org-inline-image-overlays)
  16333. (defun org-toggle-inline-images (&optional include-linked)
  16334. "Toggle the display of inline images.
  16335. INCLUDE-LINKED is passed to `org-display-inline-images'."
  16336. (interactive "P")
  16337. (if org-inline-image-overlays
  16338. (progn
  16339. (org-remove-inline-images)
  16340. (message "Inline image display turned off"))
  16341. (org-display-inline-images include-linked)
  16342. (if org-inline-image-overlays
  16343. (message "%d images displayed inline"
  16344. (length org-inline-image-overlays))
  16345. (message "No images to display inline"))))
  16346. (defun org-redisplay-inline-images ()
  16347. "Refresh the display of inline images."
  16348. (interactive)
  16349. (if (not org-inline-image-overlays)
  16350. (org-toggle-inline-images)
  16351. (org-toggle-inline-images)
  16352. (org-toggle-inline-images)))
  16353. (defun org-display-inline-images (&optional include-linked refresh beg end)
  16354. "Display inline images.
  16355. Normally only links without a description part are inlined, because this
  16356. is how it will work for export. When INCLUDE-LINKED is set, also links
  16357. with a description part will be inlined. This can be nice for a quick
  16358. look at those images, but it does not reflect what exported files will look
  16359. like.
  16360. When REFRESH is set, refresh existing images between BEG and END.
  16361. This will create new image displays only if necessary.
  16362. BEG and END default to the buffer boundaries."
  16363. (interactive "P")
  16364. (unless refresh
  16365. (org-remove-inline-images)
  16366. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  16367. (save-excursion
  16368. (save-restriction
  16369. (widen)
  16370. (setq beg (or beg (point-min)) end (or end (point-max)))
  16371. (goto-char beg)
  16372. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  16373. (substring (org-image-file-name-regexp) 0 -2)
  16374. "\\)\\]" (if include-linked "" "\\]")))
  16375. old file ov img)
  16376. (while (re-search-forward re end t)
  16377. (setq old (get-char-property-and-overlay (match-beginning 1)
  16378. 'org-image-overlay))
  16379. (setq file (expand-file-name
  16380. (concat (or (match-string 3) "") (match-string 4))))
  16381. (when (file-exists-p file)
  16382. (if (and (car-safe old) refresh)
  16383. (image-refresh (overlay-get (cdr old) 'display))
  16384. (setq img (save-match-data (create-image file)))
  16385. (when img
  16386. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  16387. (overlay-put ov 'display img)
  16388. (overlay-put ov 'face 'default)
  16389. (overlay-put ov 'org-image-overlay t)
  16390. (overlay-put ov 'modification-hooks
  16391. (list 'org-display-inline-modification-hook))
  16392. (push ov org-inline-image-overlays)))))))))
  16393. (defun org-display-inline-modification-hook (ov after beg end &optional len)
  16394. "Remove inline-display overlay if a corresponding region is modified."
  16395. (let ((inhibit-modification-hooks t))
  16396. (when (and ov after)
  16397. (delete ov org-inline-image-overlays)
  16398. (delete-overlay ov))))
  16399. (defun org-remove-inline-images ()
  16400. "Remove inline display of images."
  16401. (interactive)
  16402. (mapc 'delete-overlay org-inline-image-overlays)
  16403. (setq org-inline-image-overlays nil))
  16404. ;;;; Key bindings
  16405. ;; Outline functions from `outline-mode-prefix-map'
  16406. ;; that can be remapped in Org:
  16407. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  16408. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  16409. (define-key org-mode-map [remap outline-forward-same-level]
  16410. 'org-forward-heading-same-level)
  16411. (define-key org-mode-map [remap outline-backward-same-level]
  16412. 'org-backward-heading-same-level)
  16413. (define-key org-mode-map [remap show-branches]
  16414. 'org-kill-note-or-show-branches)
  16415. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  16416. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  16417. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  16418. ;; Outline functions from `outline-mode-prefix-map' that can not
  16419. ;; be remapped in Org:
  16420. ;;
  16421. ;; - the column "key binding" shows whether the Outline function is still
  16422. ;; available in Org mode on the same key that it has been bound to in
  16423. ;; Outline mode:
  16424. ;; - "overridden": key used for a different functionality in Org mode
  16425. ;; - else: key still bound to the same Outline function in Org mode
  16426. ;;
  16427. ;; | Outline function | key binding | Org replacement |
  16428. ;; |------------------------------------+-------------+-----------------------|
  16429. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  16430. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  16431. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  16432. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  16433. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  16434. ;; | `show-entry' | overridden | no replacement |
  16435. ;; | `show-children' | `C-c C-i' | visibility cycling |
  16436. ;; | `show-branches' | `C-c C-k' | still same function |
  16437. ;; | `show-subtree' | overridden | visibility cycling |
  16438. ;; | `show-all' | overridden | no replacement |
  16439. ;; | `hide-subtree' | overridden | visibility cycling |
  16440. ;; | `hide-body' | overridden | no replacement |
  16441. ;; | `hide-entry' | overridden | visibility cycling |
  16442. ;; | `hide-leaves' | overridden | no replacement |
  16443. ;; | `hide-sublevels' | overridden | no replacement |
  16444. ;; | `hide-other' | overridden | no replacement |
  16445. ;; Make `C-c C-x' a prefix key
  16446. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  16447. ;; TAB key with modifiers
  16448. (org-defkey org-mode-map "\C-i" 'org-cycle)
  16449. (org-defkey org-mode-map [(tab)] 'org-cycle)
  16450. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  16451. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  16452. ;; The following line is necessary under Suse GNU/Linux
  16453. (unless (featurep 'xemacs)
  16454. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  16455. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  16456. (define-key org-mode-map [backtab] 'org-shifttab)
  16457. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  16458. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  16459. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  16460. ;; Cursor keys with modifiers
  16461. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  16462. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  16463. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  16464. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  16465. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  16466. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  16467. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  16468. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  16469. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  16470. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  16471. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  16472. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  16473. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  16474. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  16475. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  16476. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  16477. ;; Babel keys
  16478. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  16479. (mapc (lambda (pair)
  16480. (define-key org-babel-map (car pair) (cdr pair)))
  16481. org-babel-key-bindings)
  16482. ;;; Extra keys for tty access.
  16483. ;; We only set them when really needed because otherwise the
  16484. ;; menus don't show the simple keys
  16485. (when (or org-use-extra-keys
  16486. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  16487. (not window-system))
  16488. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  16489. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  16490. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  16491. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  16492. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  16493. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  16494. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  16495. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  16496. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  16497. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  16498. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  16499. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  16500. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  16501. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  16502. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  16503. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  16504. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  16505. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  16506. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  16507. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  16508. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  16509. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  16510. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  16511. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  16512. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  16513. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  16514. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  16515. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  16516. ;; All the other keys
  16517. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  16518. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  16519. (if (boundp 'narrow-map)
  16520. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  16521. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  16522. (if (boundp 'narrow-map)
  16523. (org-defkey narrow-map "b" 'org-narrow-to-block)
  16524. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  16525. (if (boundp 'narrow-map)
  16526. (org-defkey narrow-map "e" 'org-narrow-to-element)
  16527. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  16528. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  16529. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  16530. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  16531. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  16532. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  16533. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  16534. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  16535. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  16536. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  16537. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  16538. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  16539. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  16540. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  16541. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  16542. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  16543. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  16544. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  16545. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  16546. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  16547. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  16548. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  16549. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  16550. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  16551. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  16552. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  16553. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  16554. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  16555. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  16556. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  16557. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  16558. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  16559. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  16560. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  16561. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  16562. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  16563. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  16564. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  16565. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  16566. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  16567. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  16568. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  16569. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  16570. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  16571. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  16572. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  16573. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  16574. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  16575. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  16576. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  16577. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  16578. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  16579. (org-defkey org-mode-map "\C-c^" 'org-sort)
  16580. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  16581. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  16582. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  16583. (org-defkey org-mode-map "\C-m" 'org-return)
  16584. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  16585. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  16586. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  16587. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  16588. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  16589. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  16590. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  16591. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  16592. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  16593. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  16594. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  16595. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  16596. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  16597. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  16598. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  16599. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  16600. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  16601. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  16602. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  16603. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  16604. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  16605. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  16606. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  16607. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  16608. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  16609. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  16610. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  16611. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  16612. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  16613. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  16614. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  16615. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  16616. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  16617. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  16618. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  16619. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  16620. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  16621. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  16622. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  16623. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  16624. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  16625. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  16626. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  16627. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  16628. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  16629. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  16630. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  16631. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  16632. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  16633. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  16634. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  16635. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  16636. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  16637. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  16638. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  16639. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  16640. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  16641. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  16642. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  16643. (when (featurep 'xemacs)
  16644. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  16645. (defconst org-speed-commands-default
  16646. '(
  16647. ("Outline Navigation")
  16648. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  16649. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  16650. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  16651. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  16652. ("u" . (org-speed-move-safe 'outline-up-heading))
  16653. ("j" . org-goto)
  16654. ("g" . (org-refile t))
  16655. ("Outline Visibility")
  16656. ("c" . org-cycle)
  16657. ("C" . org-shifttab)
  16658. (" " . org-display-outline-path)
  16659. (":" . org-columns)
  16660. ("Outline Structure Editing")
  16661. ("U" . org-shiftmetaup)
  16662. ("D" . org-shiftmetadown)
  16663. ("r" . org-metaright)
  16664. ("l" . org-metaleft)
  16665. ("R" . org-shiftmetaright)
  16666. ("L" . org-shiftmetaleft)
  16667. ("i" . (progn (forward-char 1) (call-interactively
  16668. 'org-insert-heading-respect-content)))
  16669. ("^" . org-sort)
  16670. ("w" . org-refile)
  16671. ("a" . org-archive-subtree-default-with-confirmation)
  16672. ("." . org-mark-subtree)
  16673. ("#" . org-toggle-comment)
  16674. ("Clock Commands")
  16675. ("I" . org-clock-in)
  16676. ("O" . org-clock-out)
  16677. ("Meta Data Editing")
  16678. ("t" . org-todo)
  16679. ("0" . (org-priority ?\ ))
  16680. ("1" . (org-priority ?A))
  16681. ("2" . (org-priority ?B))
  16682. ("3" . (org-priority ?C))
  16683. (";" . org-set-tags-command)
  16684. ("e" . org-set-effort)
  16685. ("E" . org-inc-effort)
  16686. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  16687. (org-entry-put (point) "APPT_WARNTIME" m)))
  16688. ("Agenda Views etc")
  16689. ("v" . org-agenda)
  16690. ("/" . org-sparse-tree)
  16691. ("Misc")
  16692. ("o" . org-open-at-point)
  16693. ("?" . org-speed-command-help)
  16694. ("<" . (org-agenda-set-restriction-lock 'subtree))
  16695. (">" . (org-agenda-remove-restriction-lock))
  16696. )
  16697. "The default speed commands.")
  16698. (defun org-print-speed-command (e)
  16699. (if (> (length (car e)) 1)
  16700. (progn
  16701. (princ "\n")
  16702. (princ (car e))
  16703. (princ "\n")
  16704. (princ (make-string (length (car e)) ?-))
  16705. (princ "\n"))
  16706. (princ (car e))
  16707. (princ " ")
  16708. (if (symbolp (cdr e))
  16709. (princ (symbol-name (cdr e)))
  16710. (prin1 (cdr e)))
  16711. (princ "\n")))
  16712. (defun org-speed-command-help ()
  16713. "Show the available speed commands."
  16714. (interactive)
  16715. (if (not org-use-speed-commands)
  16716. (error "Speed commands are not activated, customize `org-use-speed-commands'")
  16717. (with-output-to-temp-buffer "*Help*"
  16718. (princ "User-defined Speed commands\n===========================\n")
  16719. (mapc 'org-print-speed-command org-speed-commands-user)
  16720. (princ "\n")
  16721. (princ "Built-in Speed commands\n=======================\n")
  16722. (mapc 'org-print-speed-command org-speed-commands-default))
  16723. (with-current-buffer "*Help*"
  16724. (setq truncate-lines t))))
  16725. (defun org-speed-move-safe (cmd)
  16726. "Execute CMD, but make sure that the cursor always ends up in a headline.
  16727. If not, return to the original position and throw an error."
  16728. (interactive)
  16729. (let ((pos (point)))
  16730. (call-interactively cmd)
  16731. (unless (and (bolp) (org-at-heading-p))
  16732. (goto-char pos)
  16733. (error "Boundary reached while executing %s" cmd))))
  16734. (defvar org-self-insert-command-undo-counter 0)
  16735. (defvar org-table-auto-blank-field) ; defined in org-table.el
  16736. (defvar org-speed-command nil)
  16737. (defun org-speed-command-default-hook (keys)
  16738. "Hook for activating single-letter speed commands.
  16739. `org-speed-commands-default' specifies a minimal command set.
  16740. Use `org-speed-commands-user' for further customization."
  16741. (when (or (and (bolp) (looking-at org-outline-regexp))
  16742. (and (functionp org-use-speed-commands)
  16743. (funcall org-use-speed-commands)))
  16744. (cdr (assoc keys (append org-speed-commands-user
  16745. org-speed-commands-default)))))
  16746. (defun org-babel-speed-command-hook (keys)
  16747. "Hook for activating single-letter code block commands."
  16748. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  16749. (cdr (assoc keys org-babel-key-bindings))))
  16750. (defcustom org-speed-command-hook
  16751. '(org-speed-command-default-hook org-babel-speed-command-hook)
  16752. "Hook for activating speed commands at strategic locations.
  16753. Hook functions are called in sequence until a valid handler is
  16754. found.
  16755. Each hook takes a single argument, a user-pressed command key
  16756. which is also a `self-insert-command' from the global map.
  16757. Within the hook, examine the cursor position and the command key
  16758. and return nil or a valid handler as appropriate. Handler could
  16759. be one of an interactive command, a function, or a form.
  16760. Set `org-use-speed-commands' to non-nil value to enable this
  16761. hook. The default setting is `org-speed-command-default-hook'."
  16762. :group 'org-structure
  16763. :version "24.1"
  16764. :type 'hook)
  16765. (defun org-self-insert-command (N)
  16766. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  16767. If the cursor is in a table looking at whitespace, the whitespace is
  16768. overwritten, and the table is not marked as requiring realignment."
  16769. (interactive "p")
  16770. (org-check-before-invisible-edit 'insert)
  16771. (cond
  16772. ((and org-use-speed-commands
  16773. (setq org-speed-command
  16774. (run-hook-with-args-until-success
  16775. 'org-speed-command-hook (this-command-keys))))
  16776. (cond
  16777. ((commandp org-speed-command)
  16778. (setq this-command org-speed-command)
  16779. (call-interactively org-speed-command))
  16780. ((functionp org-speed-command)
  16781. (funcall org-speed-command))
  16782. ((and org-speed-command (listp org-speed-command))
  16783. (eval org-speed-command))
  16784. (t (let (org-use-speed-commands)
  16785. (call-interactively 'org-self-insert-command)))))
  16786. ((and
  16787. (org-table-p)
  16788. (progn
  16789. ;; check if we blank the field, and if that triggers align
  16790. (and (featurep 'org-table) org-table-auto-blank-field
  16791. (member last-command
  16792. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  16793. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  16794. ;; got extra space, this field does not determine column width
  16795. (let (org-table-may-need-update) (org-table-blank-field))
  16796. ;; no extra space, this field may determine column width
  16797. (org-table-blank-field)))
  16798. t)
  16799. (eq N 1)
  16800. (looking-at "[^|\n]* |"))
  16801. (let (org-table-may-need-update)
  16802. (goto-char (1- (match-end 0)))
  16803. (backward-delete-char 1)
  16804. (goto-char (match-beginning 0))
  16805. (self-insert-command N)))
  16806. (t
  16807. (setq org-table-may-need-update t)
  16808. (self-insert-command N)
  16809. (org-fix-tags-on-the-fly)
  16810. (if org-self-insert-cluster-for-undo
  16811. (if (not (eq last-command 'org-self-insert-command))
  16812. (setq org-self-insert-command-undo-counter 1)
  16813. (if (>= org-self-insert-command-undo-counter 20)
  16814. (setq org-self-insert-command-undo-counter 1)
  16815. (and (> org-self-insert-command-undo-counter 0)
  16816. buffer-undo-list (listp buffer-undo-list)
  16817. (not (cadr buffer-undo-list)) ; remove nil entry
  16818. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  16819. (setq org-self-insert-command-undo-counter
  16820. (1+ org-self-insert-command-undo-counter))))))))
  16821. (defun org-check-before-invisible-edit (kind)
  16822. "Check is editing if kind KIND would be dangerous with invisible text around.
  16823. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  16824. ;; First, try to get out of here as quickly as possible, to reduce overhead
  16825. (if (and org-catch-invisible-edits
  16826. (or (not (boundp 'visible-mode)) (not visible-mode))
  16827. (or (get-char-property (point) 'invisible)
  16828. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  16829. ;; OK, we need to take a closer look
  16830. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  16831. (invisible-before-point (if (bobp) nil (get-char-property
  16832. (1- (point)) 'invisible)))
  16833. (border-and-ok-direction
  16834. (or
  16835. ;; Check if we are acting predictably before invisible text
  16836. (and invisible-at-point (not invisible-before-point)
  16837. (memq kind '(insert delete-backward)))
  16838. ;; Check if we are acting predictably after invisible text
  16839. ;; This works not well, and I have turned it off. It seems
  16840. ;; better to always show and stop after invisible text.
  16841. ;; (and (not invisible-at-point) invisible-before-point
  16842. ;; (memq kind '(insert delete)))
  16843. )))
  16844. (when (or (memq invisible-at-point '(outline org-hide-block t))
  16845. (memq invisible-before-point '(outline org-hide-block t)))
  16846. (if (eq org-catch-invisible-edits 'error)
  16847. (error "Editing in invisible areas is prohibited - make visible first"))
  16848. (if (and org-custom-properties-overlays
  16849. (y-or-n-p "Display invisible properties in this buffer? "))
  16850. (org-toggle-custom-properties-visibility)
  16851. ;; Make the area visible
  16852. (save-excursion
  16853. (if invisible-before-point
  16854. (goto-char (previous-single-char-property-change
  16855. (point) 'invisible)))
  16856. (org-cycle))
  16857. (cond
  16858. ((eq org-catch-invisible-edits 'show)
  16859. ;; That's it, we do the edit after showing
  16860. (message
  16861. "Unfolding invisible region around point before editing")
  16862. (sit-for 1))
  16863. ((and (eq org-catch-invisible-edits 'smart)
  16864. border-and-ok-direction)
  16865. (message "Unfolding invisible region around point before editing"))
  16866. (t
  16867. ;; Don't do the edit, make the user repeat it in full visibility
  16868. (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  16869. (defun org-fix-tags-on-the-fly ()
  16870. (when (and (equal (char-after (point-at-bol)) ?*)
  16871. (org-at-heading-p))
  16872. (org-align-tags-here org-tags-column)))
  16873. (defun org-delete-backward-char (N)
  16874. "Like `delete-backward-char', insert whitespace at field end in tables.
  16875. When deleting backwards, in tables this function will insert whitespace in
  16876. front of the next \"|\" separator, to keep the table aligned. The table will
  16877. still be marked for re-alignment if the field did fill the entire column,
  16878. because, in this case the deletion might narrow the column."
  16879. (interactive "p")
  16880. (org-check-before-invisible-edit 'delete-backward)
  16881. (if (and (org-table-p)
  16882. (eq N 1)
  16883. (string-match "|" (buffer-substring (point-at-bol) (point)))
  16884. (looking-at ".*?|"))
  16885. (let ((pos (point))
  16886. (noalign (looking-at "[^|\n\r]* |"))
  16887. (c org-table-may-need-update))
  16888. (backward-delete-char N)
  16889. (if (not overwrite-mode)
  16890. (progn
  16891. (skip-chars-forward "^|")
  16892. (insert " ")
  16893. (goto-char (1- pos))))
  16894. ;; noalign: if there were two spaces at the end, this field
  16895. ;; does not determine the width of the column.
  16896. (if noalign (setq org-table-may-need-update c)))
  16897. (backward-delete-char N)
  16898. (org-fix-tags-on-the-fly)))
  16899. (defun org-delete-char (N)
  16900. "Like `delete-char', but insert whitespace at field end in tables.
  16901. When deleting characters, in tables this function will insert whitespace in
  16902. front of the next \"|\" separator, to keep the table aligned. The table will
  16903. still be marked for re-alignment if the field did fill the entire column,
  16904. because, in this case the deletion might narrow the column."
  16905. (interactive "p")
  16906. (org-check-before-invisible-edit 'delete)
  16907. (if (and (org-table-p)
  16908. (not (bolp))
  16909. (not (= (char-after) ?|))
  16910. (eq N 1))
  16911. (if (looking-at ".*?|")
  16912. (let ((pos (point))
  16913. (noalign (looking-at "[^|\n\r]* |"))
  16914. (c org-table-may-need-update))
  16915. (replace-match (concat
  16916. (substring (match-string 0) 1 -1)
  16917. " |"))
  16918. (goto-char pos)
  16919. ;; noalign: if there were two spaces at the end, this field
  16920. ;; does not determine the width of the column.
  16921. (if noalign (setq org-table-may-need-update c)))
  16922. (delete-char N))
  16923. (delete-char N)
  16924. (org-fix-tags-on-the-fly)))
  16925. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  16926. (put 'org-self-insert-command 'delete-selection t)
  16927. (put 'orgtbl-self-insert-command 'delete-selection t)
  16928. (put 'org-delete-char 'delete-selection 'supersede)
  16929. (put 'org-delete-backward-char 'delete-selection 'supersede)
  16930. (put 'org-yank 'delete-selection 'yank)
  16931. ;; Make `flyspell-mode' delay after some commands
  16932. (put 'org-self-insert-command 'flyspell-delayed t)
  16933. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  16934. (put 'org-delete-char 'flyspell-delayed t)
  16935. (put 'org-delete-backward-char 'flyspell-delayed t)
  16936. ;; Make pabbrev-mode expand after org-mode commands
  16937. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  16938. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  16939. ;; How to do this: Measure non-white length of current string
  16940. ;; If equal to column width, we should realign.
  16941. (defun org-remap (map &rest commands)
  16942. "In MAP, remap the functions given in COMMANDS.
  16943. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  16944. (let (new old)
  16945. (while commands
  16946. (setq old (pop commands) new (pop commands))
  16947. (if (fboundp 'command-remapping)
  16948. (org-defkey map (vector 'remap old) new)
  16949. (substitute-key-definition old new map global-map)))))
  16950. (when (eq org-enable-table-editor 'optimized)
  16951. ;; If the user wants maximum table support, we need to hijack
  16952. ;; some standard editing functions
  16953. (org-remap org-mode-map
  16954. 'self-insert-command 'org-self-insert-command
  16955. 'delete-char 'org-delete-char
  16956. 'delete-backward-char 'org-delete-backward-char)
  16957. (org-defkey org-mode-map "|" 'org-force-self-insert))
  16958. (defvar org-ctrl-c-ctrl-c-hook nil
  16959. "Hook for functions attaching themselves to `C-c C-c'.
  16960. This can be used to add additional functionality to the C-c C-c
  16961. key which executes context-dependent commands. This hook is run
  16962. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  16963. run after the last test.
  16964. Each function will be called with no arguments. The function
  16965. must check if the context is appropriate for it to act. If yes,
  16966. it should do its thing and then return a non-nil value. If the
  16967. context is wrong, just do nothing and return nil.")
  16968. (defvar org-ctrl-c-ctrl-c-final-hook nil
  16969. "Hook for functions attaching themselves to `C-c C-c'.
  16970. This can be used to add additional functionality to the C-c C-c
  16971. key which executes context-dependent commands. This hook is run
  16972. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  16973. before the first test.
  16974. Each function will be called with no arguments. The function
  16975. must check if the context is appropriate for it to act. If yes,
  16976. it should do its thing and then return a non-nil value. If the
  16977. context is wrong, just do nothing and return nil.")
  16978. (defvar org-tab-first-hook nil
  16979. "Hook for functions to attach themselves to TAB.
  16980. See `org-ctrl-c-ctrl-c-hook' for more information.
  16981. This hook runs as the first action when TAB is pressed, even before
  16982. `org-cycle' messes around with the `outline-regexp' to cater for
  16983. inline tasks and plain list item folding.
  16984. If any function in this hook returns t, any other actions that
  16985. would have been caused by TAB (such as table field motion or visibility
  16986. cycling) will not occur.")
  16987. (defvar org-tab-after-check-for-table-hook nil
  16988. "Hook for functions to attach themselves to TAB.
  16989. See `org-ctrl-c-ctrl-c-hook' for more information.
  16990. This hook runs after it has been established that the cursor is not in a
  16991. table, but before checking if the cursor is in a headline or if global cycling
  16992. should be done.
  16993. If any function in this hook returns t, not other actions like visibility
  16994. cycling will be done.")
  16995. (defvar org-tab-after-check-for-cycling-hook nil
  16996. "Hook for functions to attach themselves to TAB.
  16997. See `org-ctrl-c-ctrl-c-hook' for more information.
  16998. This hook runs after it has been established that not table field motion and
  16999. not visibility should be done because of current context. This is probably
  17000. the place where a package like yasnippets can hook in.")
  17001. (defvar org-tab-before-tab-emulation-hook nil
  17002. "Hook for functions to attach themselves to TAB.
  17003. See `org-ctrl-c-ctrl-c-hook' for more information.
  17004. This hook runs after every other options for TAB have been exhausted, but
  17005. before indentation and \t insertion takes place.")
  17006. (defvar org-metaleft-hook nil
  17007. "Hook for functions attaching themselves to `M-left'.
  17008. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17009. (defvar org-metaright-hook nil
  17010. "Hook for functions attaching themselves to `M-right'.
  17011. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17012. (defvar org-metaup-hook nil
  17013. "Hook for functions attaching themselves to `M-up'.
  17014. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17015. (defvar org-metadown-hook nil
  17016. "Hook for functions attaching themselves to `M-down'.
  17017. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17018. (defvar org-shiftmetaleft-hook nil
  17019. "Hook for functions attaching themselves to `M-S-left'.
  17020. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17021. (defvar org-shiftmetaright-hook nil
  17022. "Hook for functions attaching themselves to `M-S-right'.
  17023. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17024. (defvar org-shiftmetaup-hook nil
  17025. "Hook for functions attaching themselves to `M-S-up'.
  17026. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17027. (defvar org-shiftmetadown-hook nil
  17028. "Hook for functions attaching themselves to `M-S-down'.
  17029. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17030. (defvar org-metareturn-hook nil
  17031. "Hook for functions attaching themselves to `M-RET'.
  17032. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17033. (defvar org-shiftup-hook nil
  17034. "Hook for functions attaching themselves to `S-up'.
  17035. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17036. (defvar org-shiftup-final-hook nil
  17037. "Hook for functions attaching themselves to `S-up'.
  17038. This one runs after all other options except shift-select have been excluded.
  17039. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17040. (defvar org-shiftdown-hook nil
  17041. "Hook for functions attaching themselves to `S-down'.
  17042. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17043. (defvar org-shiftdown-final-hook nil
  17044. "Hook for functions attaching themselves to `S-down'.
  17045. This one runs after all other options except shift-select have been excluded.
  17046. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17047. (defvar org-shiftleft-hook nil
  17048. "Hook for functions attaching themselves to `S-left'.
  17049. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17050. (defvar org-shiftleft-final-hook nil
  17051. "Hook for functions attaching themselves to `S-left'.
  17052. This one runs after all other options except shift-select have been excluded.
  17053. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17054. (defvar org-shiftright-hook nil
  17055. "Hook for functions attaching themselves to `S-right'.
  17056. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17057. (defvar org-shiftright-final-hook nil
  17058. "Hook for functions attaching themselves to `S-right'.
  17059. This one runs after all other options except shift-select have been excluded.
  17060. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17061. (defun org-modifier-cursor-error ()
  17062. "Throw an error, a modified cursor command was applied in wrong context."
  17063. (error "This command is active in special context like tables, headlines or items"))
  17064. (defun org-shiftselect-error ()
  17065. "Throw an error because Shift-Cursor command was applied in wrong context."
  17066. (if (and (boundp 'shift-select-mode) shift-select-mode)
  17067. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  17068. (error "This command works only in special context like headlines or timestamps")))
  17069. (defun org-call-for-shift-select (cmd)
  17070. (let ((this-command-keys-shift-translated t))
  17071. (call-interactively cmd)))
  17072. (defun org-shifttab (&optional arg)
  17073. "Global visibility cycling or move to previous table field.
  17074. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  17075. on context.
  17076. See the individual commands for more information."
  17077. (interactive "P")
  17078. (cond
  17079. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  17080. ((integerp arg)
  17081. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  17082. (message "Content view to level: %d" arg)
  17083. (org-content (prefix-numeric-value arg2))
  17084. (setq org-cycle-global-status 'overview)))
  17085. (t (call-interactively 'org-global-cycle))))
  17086. (defun org-shiftmetaleft ()
  17087. "Promote subtree or delete table column.
  17088. Calls `org-promote-subtree', `org-outdent-item-tree', or
  17089. `org-table-delete-column', depending on context. See the
  17090. individual commands for more information."
  17091. (interactive)
  17092. (cond
  17093. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  17094. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  17095. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  17096. ((if (not (org-region-active-p)) (org-at-item-p)
  17097. (save-excursion (goto-char (region-beginning))
  17098. (org-at-item-p)))
  17099. (call-interactively 'org-outdent-item-tree))
  17100. (t (org-modifier-cursor-error))))
  17101. (defun org-shiftmetaright ()
  17102. "Demote subtree or insert table column.
  17103. Calls `org-demote-subtree', `org-indent-item-tree', or
  17104. `org-table-insert-column', depending on context. See the
  17105. individual commands for more information."
  17106. (interactive)
  17107. (cond
  17108. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  17109. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  17110. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  17111. ((if (not (org-region-active-p)) (org-at-item-p)
  17112. (save-excursion (goto-char (region-beginning))
  17113. (org-at-item-p)))
  17114. (call-interactively 'org-indent-item-tree))
  17115. (t (org-modifier-cursor-error))))
  17116. (defun org-shiftmetaup (&optional arg)
  17117. "Move subtree up or kill table row.
  17118. Calls `org-move-subtree-up' or `org-table-kill-row' or
  17119. `org-move-item-up' or `org-timestamp-up', depending on context.
  17120. See the individual commands for more information."
  17121. (interactive "P")
  17122. (cond
  17123. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  17124. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  17125. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17126. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17127. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17128. (call-interactively 'org-timestamp-up)))
  17129. (t (org-modifier-cursor-error))))
  17130. (defun org-shiftmetadown (&optional arg)
  17131. "Move subtree down or insert table row.
  17132. Calls `org-move-subtree-down' or `org-table-insert-row' or
  17133. `org-move-item-down' or `org-timestamp-up', depending on context.
  17134. See the individual commands for more information."
  17135. (interactive "P")
  17136. (cond
  17137. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  17138. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  17139. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17140. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17141. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  17142. (call-interactively 'org-timestamp-down)))
  17143. (t (org-modifier-cursor-error))))
  17144. (defsubst org-hidden-tree-error ()
  17145. (error
  17146. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  17147. (defun org-metaleft (&optional arg)
  17148. "Promote heading or move table column to left.
  17149. Calls `org-do-promote' or `org-table-move-column', depending on context.
  17150. With no specific context, calls the Emacs default `backward-word'.
  17151. See the individual commands for more information."
  17152. (interactive "P")
  17153. (cond
  17154. ((run-hook-with-args-until-success 'org-metaleft-hook))
  17155. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  17156. ((org-with-limited-levels
  17157. (or (org-at-heading-p)
  17158. (and (org-region-active-p)
  17159. (save-excursion
  17160. (goto-char (region-beginning))
  17161. (org-at-heading-p)))))
  17162. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17163. (call-interactively 'org-do-promote))
  17164. ;; At an inline task.
  17165. ((org-at-heading-p)
  17166. (call-interactively 'org-inlinetask-promote))
  17167. ((or (org-at-item-p)
  17168. (and (org-region-active-p)
  17169. (save-excursion
  17170. (goto-char (region-beginning))
  17171. (org-at-item-p))))
  17172. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17173. (call-interactively 'org-outdent-item))
  17174. (t (call-interactively 'backward-word))))
  17175. (defun org-metaright (&optional arg)
  17176. "Demote a subtree, a list item or move table column to right.
  17177. In front of a drawer or a block keyword, indent it correctly.
  17178. With no specific context, calls the Emacs default `forward-word'.
  17179. See the individual commands for more information."
  17180. (interactive "P")
  17181. (cond
  17182. ((run-hook-with-args-until-success 'org-metaright-hook))
  17183. ((org-at-table-p) (call-interactively 'org-table-move-column))
  17184. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  17185. ((org-at-block-p) (call-interactively 'org-indent-block))
  17186. ((org-with-limited-levels
  17187. (or (org-at-heading-p)
  17188. (and (org-region-active-p)
  17189. (save-excursion
  17190. (goto-char (region-beginning))
  17191. (org-at-heading-p)))))
  17192. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  17193. (call-interactively 'org-do-demote))
  17194. ;; At an inline task.
  17195. ((org-at-heading-p)
  17196. (call-interactively 'org-inlinetask-demote))
  17197. ((or (org-at-item-p)
  17198. (and (org-region-active-p)
  17199. (save-excursion
  17200. (goto-char (region-beginning))
  17201. (org-at-item-p))))
  17202. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  17203. (call-interactively 'org-indent-item))
  17204. (t (call-interactively 'forward-word))))
  17205. (defun org-check-for-hidden (what)
  17206. "Check if there are hidden headlines/items in the current visual line.
  17207. WHAT can be either `headlines' or `items'. If the current line is
  17208. an outline or item heading and it has a folded subtree below it,
  17209. this function returns t, nil otherwise."
  17210. (let ((re (cond
  17211. ((eq what 'headlines) org-outline-regexp-bol)
  17212. ((eq what 'items) (org-item-beginning-re))
  17213. (t (error "This should not happen"))))
  17214. beg end)
  17215. (save-excursion
  17216. (catch 'exit
  17217. (unless (org-region-active-p)
  17218. (setq beg (point-at-bol))
  17219. (beginning-of-line 2)
  17220. (while (and (not (eobp)) ;; this is like `next-line'
  17221. (get-char-property (1- (point)) 'invisible))
  17222. (beginning-of-line 2))
  17223. (setq end (point))
  17224. (goto-char beg)
  17225. (goto-char (point-at-eol))
  17226. (setq end (max end (point)))
  17227. (while (re-search-forward re end t)
  17228. (if (get-char-property (match-beginning 0) 'invisible)
  17229. (throw 'exit t))))
  17230. nil))))
  17231. (autoload 'org-element-at-point "org-element")
  17232. (declare-function org-element-at-point "org-element" (&optional keep-trail))
  17233. (declare-function org-element-type "org-element" (element))
  17234. (declare-function org-element-contents "org-element" (element))
  17235. (declare-function org-element-property "org-element" (property element))
  17236. (declare-function org-element-paragraph-parser "org-element" (limit))
  17237. (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion))
  17238. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  17239. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  17240. (declare-function org-element--parse-objects "org-element" (beg end acc restriction))
  17241. (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
  17242. (defun org-metaup (&optional arg)
  17243. "Move subtree up or move table row up.
  17244. Calls `org-move-subtree-up' or `org-table-move-row' or
  17245. `org-move-item-up', depending on context. See the individual commands
  17246. for more information."
  17247. (interactive "P")
  17248. (cond
  17249. ((run-hook-with-args-until-success 'org-metaup-hook))
  17250. ((org-region-active-p)
  17251. (let* ((a (min (region-beginning) (region-end)))
  17252. (b (1- (max (region-beginning) (region-end))))
  17253. (c (save-excursion (goto-char a)
  17254. (move-beginning-of-line 0)))
  17255. (d (save-excursion (goto-char a)
  17256. (move-end-of-line 0) (point))))
  17257. (transpose-regions a b c d)
  17258. (goto-char c)))
  17259. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  17260. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  17261. ((org-at-item-p) (call-interactively 'org-move-item-up))
  17262. (t (org-drag-element-backward))))
  17263. (defun org-metadown (&optional arg)
  17264. "Move subtree down or move table row down.
  17265. Calls `org-move-subtree-down' or `org-table-move-row' or
  17266. `org-move-item-down', depending on context. See the individual
  17267. commands for more information."
  17268. (interactive "P")
  17269. (cond
  17270. ((run-hook-with-args-until-success 'org-metadown-hook))
  17271. ((org-region-active-p)
  17272. (let* ((a (min (region-beginning) (region-end)))
  17273. (b (max (region-beginning) (region-end)))
  17274. (c (save-excursion (goto-char b)
  17275. (move-beginning-of-line 1)))
  17276. (d (save-excursion (goto-char b)
  17277. (move-end-of-line 1) (1+ (point)))))
  17278. (transpose-regions a b c d)
  17279. (goto-char d)))
  17280. ((org-at-table-p) (call-interactively 'org-table-move-row))
  17281. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  17282. ((org-at-item-p) (call-interactively 'org-move-item-down))
  17283. (t (org-drag-element-forward))))
  17284. (defun org-shiftup (&optional arg)
  17285. "Increase item in timestamp or increase priority of current headline.
  17286. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  17287. depending on context. See the individual commands for more information."
  17288. (interactive "P")
  17289. (cond
  17290. ((run-hook-with-args-until-success 'org-shiftup-hook))
  17291. ((and org-support-shift-select (org-region-active-p))
  17292. (org-call-for-shift-select 'previous-line))
  17293. ((org-at-timestamp-p t)
  17294. (call-interactively (if org-edit-timestamp-down-means-later
  17295. 'org-timestamp-down 'org-timestamp-up)))
  17296. ((and (not (eq org-support-shift-select 'always))
  17297. org-enable-priority-commands
  17298. (org-at-heading-p))
  17299. (call-interactively 'org-priority-up))
  17300. ((and (not org-support-shift-select) (org-at-item-p))
  17301. (call-interactively 'org-previous-item))
  17302. ((org-clocktable-try-shift 'up arg))
  17303. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  17304. (org-support-shift-select
  17305. (org-call-for-shift-select 'previous-line))
  17306. (t (org-shiftselect-error))))
  17307. (defun org-shiftdown (&optional arg)
  17308. "Decrease item in timestamp or decrease priority of current headline.
  17309. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  17310. depending on context. See the individual commands for more information."
  17311. (interactive "P")
  17312. (cond
  17313. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  17314. ((and org-support-shift-select (org-region-active-p))
  17315. (org-call-for-shift-select 'next-line))
  17316. ((org-at-timestamp-p t)
  17317. (call-interactively (if org-edit-timestamp-down-means-later
  17318. 'org-timestamp-up 'org-timestamp-down)))
  17319. ((and (not (eq org-support-shift-select 'always))
  17320. org-enable-priority-commands
  17321. (org-at-heading-p))
  17322. (call-interactively 'org-priority-down))
  17323. ((and (not org-support-shift-select) (org-at-item-p))
  17324. (call-interactively 'org-next-item))
  17325. ((org-clocktable-try-shift 'down arg))
  17326. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  17327. (org-support-shift-select
  17328. (org-call-for-shift-select 'next-line))
  17329. (t (org-shiftselect-error))))
  17330. (defun org-shiftright (&optional arg)
  17331. "Cycle the thing at point or in the current line, depending on context.
  17332. Depending on context, this does one of the following:
  17333. - switch a timestamp at point one day into the future
  17334. - on a headline, switch to the next TODO keyword.
  17335. - on an item, switch entire list to the next bullet type
  17336. - on a property line, switch to the next allowed value
  17337. - on a clocktable definition line, move time block into the future"
  17338. (interactive "P")
  17339. (cond
  17340. ((run-hook-with-args-until-success 'org-shiftright-hook))
  17341. ((and org-support-shift-select (org-region-active-p))
  17342. (org-call-for-shift-select 'forward-char))
  17343. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  17344. ((and (not (eq org-support-shift-select 'always))
  17345. (org-at-heading-p))
  17346. (let ((org-inhibit-logging
  17347. (not org-treat-S-cursor-todo-selection-as-state-change))
  17348. (org-inhibit-blocking
  17349. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17350. (org-call-with-arg 'org-todo 'right)))
  17351. ((or (and org-support-shift-select
  17352. (not (eq org-support-shift-select 'always))
  17353. (org-at-item-bullet-p))
  17354. (and (not org-support-shift-select) (org-at-item-p)))
  17355. (org-call-with-arg 'org-cycle-list-bullet nil))
  17356. ((and (not (eq org-support-shift-select 'always))
  17357. (org-at-property-p))
  17358. (call-interactively 'org-property-next-allowed-value))
  17359. ((org-clocktable-try-shift 'right arg))
  17360. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  17361. (org-support-shift-select
  17362. (org-call-for-shift-select 'forward-char))
  17363. (t (org-shiftselect-error))))
  17364. (defun org-shiftleft (&optional arg)
  17365. "Cycle the thing at point or in the current line, depending on context.
  17366. Depending on context, this does one of the following:
  17367. - switch a timestamp at point one day into the past
  17368. - on a headline, switch to the previous TODO keyword.
  17369. - on an item, switch entire list to the previous bullet type
  17370. - on a property line, switch to the previous allowed value
  17371. - on a clocktable definition line, move time block into the past"
  17372. (interactive "P")
  17373. (cond
  17374. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  17375. ((and org-support-shift-select (org-region-active-p))
  17376. (org-call-for-shift-select 'backward-char))
  17377. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  17378. ((and (not (eq org-support-shift-select 'always))
  17379. (org-at-heading-p))
  17380. (let ((org-inhibit-logging
  17381. (not org-treat-S-cursor-todo-selection-as-state-change))
  17382. (org-inhibit-blocking
  17383. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17384. (org-call-with-arg 'org-todo 'left)))
  17385. ((or (and org-support-shift-select
  17386. (not (eq org-support-shift-select 'always))
  17387. (org-at-item-bullet-p))
  17388. (and (not org-support-shift-select) (org-at-item-p)))
  17389. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  17390. ((and (not (eq org-support-shift-select 'always))
  17391. (org-at-property-p))
  17392. (call-interactively 'org-property-previous-allowed-value))
  17393. ((org-clocktable-try-shift 'left arg))
  17394. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  17395. (org-support-shift-select
  17396. (org-call-for-shift-select 'backward-char))
  17397. (t (org-shiftselect-error))))
  17398. (defun org-shiftcontrolright ()
  17399. "Switch to next TODO set."
  17400. (interactive)
  17401. (cond
  17402. ((and org-support-shift-select (org-region-active-p))
  17403. (org-call-for-shift-select 'forward-word))
  17404. ((and (not (eq org-support-shift-select 'always))
  17405. (org-at-heading-p))
  17406. (org-call-with-arg 'org-todo 'nextset))
  17407. (org-support-shift-select
  17408. (org-call-for-shift-select 'forward-word))
  17409. (t (org-shiftselect-error))))
  17410. (defun org-shiftcontrolleft ()
  17411. "Switch to previous TODO set."
  17412. (interactive)
  17413. (cond
  17414. ((and org-support-shift-select (org-region-active-p))
  17415. (org-call-for-shift-select 'backward-word))
  17416. ((and (not (eq org-support-shift-select 'always))
  17417. (org-at-heading-p))
  17418. (org-call-with-arg 'org-todo 'previousset))
  17419. (org-support-shift-select
  17420. (org-call-for-shift-select 'backward-word))
  17421. (t (org-shiftselect-error))))
  17422. (defun org-shiftcontrolup ()
  17423. "Change timestamps synchronously up in CLOCK log lines."
  17424. (interactive)
  17425. (cond ((and (not org-support-shift-select)
  17426. (org-at-clock-log-p)
  17427. (org-at-timestamp-p t))
  17428. (org-clock-timestamps-up))
  17429. (t (org-shiftselect-error))))
  17430. (defun org-shiftcontroldown ()
  17431. "Change timestamps synchronously down in CLOCK log lines."
  17432. (interactive)
  17433. (cond ((and (not org-support-shift-select)
  17434. (org-at-clock-log-p)
  17435. (org-at-timestamp-p t))
  17436. (org-clock-timestamps-down))
  17437. (t (org-shiftselect-error))))
  17438. (defun org-ctrl-c-ret ()
  17439. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  17440. (interactive)
  17441. (cond
  17442. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  17443. (t (call-interactively 'org-insert-heading))))
  17444. (defun org-find-visible ()
  17445. (let ((s (point)))
  17446. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17447. (get-char-property s 'invisible)))
  17448. s))
  17449. (defun org-find-invisible ()
  17450. (let ((s (point)))
  17451. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17452. (not (get-char-property s 'invisible))))
  17453. s))
  17454. (defun org-copy-visible (beg end)
  17455. "Copy the visible parts of the region."
  17456. (interactive "r")
  17457. (let (snippets s)
  17458. (save-excursion
  17459. (save-restriction
  17460. (narrow-to-region beg end)
  17461. (setq s (goto-char (point-min)))
  17462. (while (not (= (point) (point-max)))
  17463. (goto-char (org-find-invisible))
  17464. (push (buffer-substring s (point)) snippets)
  17465. (setq s (goto-char (org-find-visible))))))
  17466. (kill-new (apply 'concat (nreverse snippets)))))
  17467. (defun org-copy-special ()
  17468. "Copy region in table or copy current subtree.
  17469. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  17470. See the individual commands for more information."
  17471. (interactive)
  17472. (call-interactively
  17473. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  17474. (defun org-cut-special ()
  17475. "Cut region in table or cut current subtree.
  17476. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  17477. See the individual commands for more information."
  17478. (interactive)
  17479. (call-interactively
  17480. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  17481. (defun org-paste-special (arg)
  17482. "Paste rectangular region into table, or past subtree relative to level.
  17483. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  17484. See the individual commands for more information."
  17485. (interactive "P")
  17486. (if (org-at-table-p)
  17487. (org-table-paste-rectangle)
  17488. (org-paste-subtree arg)))
  17489. (defun org-edit-special (&optional arg)
  17490. "Call a special editor for the stuff at point.
  17491. When at a table, call the formula editor with `org-table-edit-formulas'.
  17492. When at the first line of an src example, call `org-edit-src-code'.
  17493. When in an #+include line, visit the include file. Otherwise call
  17494. `ffap' to visit the file at point."
  17495. (interactive)
  17496. ;; possibly prep session before editing source
  17497. (when arg
  17498. (let* ((info (org-babel-get-src-block-info))
  17499. (lang (nth 0 info))
  17500. (params (nth 2 info))
  17501. (session (cdr (assoc :session params))))
  17502. (when (and info session) ;; we are in a source-code block with a session
  17503. (funcall
  17504. (intern (concat "org-babel-prep-session:" lang)) session params))))
  17505. (cond ;; proceed with `org-edit-special'
  17506. ((save-excursion
  17507. (beginning-of-line 1)
  17508. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  17509. (find-file (org-trim (match-string 1))))
  17510. ((org-edit-src-code))
  17511. ((org-edit-fixed-width-region))
  17512. ((org-at-table.el-p)
  17513. (org-edit-src-code))
  17514. ((or (org-at-table-p)
  17515. (save-excursion
  17516. (beginning-of-line 1)
  17517. (let ((case-fold-search )) (looking-at "[ \t]*#\\+tblfm:"))))
  17518. (call-interactively 'org-table-edit-formulas))
  17519. (t (call-interactively 'ffap))))
  17520. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  17521. (defun org-ctrl-c-ctrl-c (&optional arg)
  17522. "Set tags in headline, or update according to changed information at point.
  17523. This command does many different things, depending on context:
  17524. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  17525. this is what we do.
  17526. - If the cursor is on a statistics cookie, update it.
  17527. - If the cursor is in a headline, prompt for tags and insert them
  17528. into the current line, aligned to `org-tags-column'. When called
  17529. with prefix arg, realign all tags in the current buffer.
  17530. - If the cursor is in one of the special #+KEYWORD lines, this
  17531. triggers scanning the buffer for these lines and updating the
  17532. information.
  17533. - If the cursor is inside a table, realign the table. This command
  17534. works even if the automatic table editor has been turned off.
  17535. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  17536. the entire table.
  17537. - If the cursor is at a footnote reference or definition, jump to
  17538. the corresponding definition or references, respectively.
  17539. - If the cursor is a the beginning of a dynamic block, update it.
  17540. - If the current buffer is a capture buffer, close note and file it.
  17541. - If the cursor is on a <<<target>>>, update radio targets and
  17542. corresponding links in this buffer.
  17543. - If the cursor is on a numbered item in a plain list, renumber the
  17544. ordered list.
  17545. - If the cursor is on a checkbox, toggle it.
  17546. - If the cursor is on a code block, evaluate it. The variable
  17547. `org-confirm-babel-evaluate' can be used to control prompting
  17548. before code block evaluation, by default every code block
  17549. evaluation requires confirmation. Code block evaluation can be
  17550. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  17551. (interactive "P")
  17552. (let ((org-enable-table-editor t))
  17553. (cond
  17554. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  17555. org-occur-highlights
  17556. org-latex-fragment-image-overlays)
  17557. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  17558. (org-remove-occur-highlights)
  17559. (org-remove-latex-fragment-image-overlays)
  17560. (message "Temporary highlights/overlays removed from current buffer"))
  17561. ((and (local-variable-p 'org-finish-function (current-buffer))
  17562. (fboundp org-finish-function))
  17563. (funcall org-finish-function))
  17564. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  17565. ((org-in-regexp org-ts-regexp-both)
  17566. (org-timestamp-change 0 'day))
  17567. ((or (looking-at org-property-start-re)
  17568. (org-at-property-p))
  17569. (call-interactively 'org-property-action))
  17570. ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
  17571. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  17572. (or (org-at-heading-p) (org-at-item-p)))
  17573. (call-interactively 'org-update-statistics-cookies))
  17574. ((org-at-heading-p) (call-interactively 'org-set-tags))
  17575. ((org-at-table.el-p)
  17576. (message "Use C-c ' to edit table.el tables"))
  17577. ((org-at-table-p)
  17578. (org-table-maybe-eval-formula)
  17579. (if arg
  17580. (call-interactively 'org-table-recalculate)
  17581. (org-table-maybe-recalculate-line))
  17582. (call-interactively 'org-table-align)
  17583. (orgtbl-send-table 'maybe))
  17584. ((or (org-footnote-at-reference-p)
  17585. (org-footnote-at-definition-p))
  17586. (call-interactively 'org-footnote-action))
  17587. ((org-at-item-checkbox-p)
  17588. ;; Cursor at a checkbox: repair list and update checkboxes. Send
  17589. ;; list only if at top item.
  17590. (let* ((cbox (match-string 1))
  17591. (struct (org-list-struct))
  17592. (old-struct (copy-tree struct))
  17593. (parents (org-list-parents-alist struct))
  17594. (orderedp (org-entry-get nil "ORDERED"))
  17595. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17596. block-item)
  17597. ;; Use a light version of `org-toggle-checkbox' to avoid
  17598. ;; computing list structure twice.
  17599. (let ((new-box (cond
  17600. ((equal arg '(16)) "[-]")
  17601. ((equal arg '(4)) nil)
  17602. ((equal "[X]" cbox) "[ ]")
  17603. (t "[X]"))))
  17604. (if (and firstp arg)
  17605. ;; If at first item of sub-list, remove check-box from
  17606. ;; every item at the same level.
  17607. (mapc
  17608. (lambda (pos) (org-list-set-checkbox pos struct new-box))
  17609. (org-list-get-all-items
  17610. (point-at-bol) struct (org-list-prevs-alist struct)))
  17611. (org-list-set-checkbox (point-at-bol) struct new-box)))
  17612. ;; Replicate `org-list-write-struct', while grabbing a return
  17613. ;; value from `org-list-struct-fix-box'.
  17614. (org-list-struct-fix-ind struct parents 2)
  17615. (org-list-struct-fix-item-end struct)
  17616. (let ((prevs (org-list-prevs-alist struct)))
  17617. (org-list-struct-fix-bul struct prevs)
  17618. (org-list-struct-fix-ind struct parents)
  17619. (setq block-item
  17620. (org-list-struct-fix-box struct parents prevs orderedp)))
  17621. (org-list-struct-apply-struct struct old-struct)
  17622. (org-update-checkbox-count-maybe)
  17623. (when block-item
  17624. (message
  17625. "Checkboxes were removed due to unchecked box at line %d"
  17626. (org-current-line block-item)))
  17627. (when firstp (org-list-send-list 'maybe))))
  17628. ((org-at-item-p)
  17629. ;; Cursor at an item: repair list. Do checkbox related actions
  17630. ;; only if function was called with an argument. Send list only
  17631. ;; if at top item.
  17632. (let* ((struct (org-list-struct))
  17633. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17634. old-struct)
  17635. (when arg
  17636. (setq old-struct (copy-tree struct))
  17637. (if firstp
  17638. ;; If at first item of sub-list, add check-box to every
  17639. ;; item at the same level.
  17640. (mapc
  17641. (lambda (pos)
  17642. (unless (org-list-get-checkbox pos struct)
  17643. (org-list-set-checkbox pos struct "[ ]")))
  17644. (org-list-get-all-items
  17645. (point-at-bol) struct (org-list-prevs-alist struct)))
  17646. (org-list-set-checkbox (point-at-bol) struct "[ ]")))
  17647. (org-list-write-struct
  17648. struct (org-list-parents-alist struct) old-struct)
  17649. (when arg (org-update-checkbox-count-maybe))
  17650. (when firstp (org-list-send-list 'maybe))))
  17651. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  17652. ;; Dynamic block
  17653. (beginning-of-line 1)
  17654. (save-excursion (org-update-dblock)))
  17655. ((save-excursion
  17656. (let ((case-fold-search t))
  17657. (beginning-of-line 1)
  17658. (looking-at "[ \t]*#\\+\\([a-z]+\\)")))
  17659. (cond
  17660. ((or (equal (match-string 1) "TBLFM")
  17661. (equal (match-string 1) "tblfm"))
  17662. ;; Recalculate the table before this line
  17663. (save-excursion
  17664. (beginning-of-line 1)
  17665. (skip-chars-backward " \r\n\t")
  17666. (if (org-at-table-p)
  17667. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  17668. (t
  17669. (let ((org-inhibit-startup-visibility-stuff t)
  17670. (org-startup-align-all-tables nil))
  17671. (when (boundp 'org-table-coordinate-overlays)
  17672. (mapc 'delete-overlay org-table-coordinate-overlays)
  17673. (setq org-table-coordinate-overlays nil))
  17674. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  17675. (message "Local setup has been refreshed"))))
  17676. ((org-clock-update-time-maybe))
  17677. (t
  17678. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  17679. (error "C-c C-c can do nothing useful at this location"))))))
  17680. (defun org-mode-restart ()
  17681. "Restart Org-mode, to scan again for special lines.
  17682. Also updates the keyword regular expressions."
  17683. (interactive)
  17684. (org-mode)
  17685. (message "Org-mode restarted"))
  17686. (defun org-kill-note-or-show-branches ()
  17687. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  17688. (interactive)
  17689. (if (not org-finish-function)
  17690. (progn
  17691. (hide-subtree)
  17692. (call-interactively 'show-branches))
  17693. (let ((org-note-abort t))
  17694. (funcall org-finish-function))))
  17695. (defun org-return (&optional indent)
  17696. "Goto next table row or insert a newline.
  17697. Calls `org-table-next-row' or `newline', depending on context.
  17698. See the individual commands for more information."
  17699. (interactive)
  17700. (let (org-ts-what)
  17701. (cond
  17702. ((or (bobp) (org-in-src-block-p))
  17703. (if indent (newline-and-indent) (newline)))
  17704. ((org-at-table-p)
  17705. (org-table-justify-field-maybe)
  17706. (call-interactively 'org-table-next-row))
  17707. ;; when `newline-and-indent' is called within a list, make sure
  17708. ;; text moved stays inside the item.
  17709. ((and (org-in-item-p) indent)
  17710. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  17711. (progn
  17712. (save-match-data (newline))
  17713. (org-indent-line-to (length (match-string 0))))
  17714. (let ((ind (org-get-indentation)))
  17715. (newline)
  17716. (if (org-looking-back org-list-end-re)
  17717. (org-indent-line)
  17718. (org-indent-line-to ind)))))
  17719. ((and org-return-follows-link
  17720. (org-at-timestamp-p t)
  17721. (not (eq org-ts-what 'after)))
  17722. (org-follow-timestamp-link))
  17723. ((and org-return-follows-link
  17724. (let ((tprop (get-text-property (point) 'face)))
  17725. (or (eq tprop 'org-link)
  17726. (and (listp tprop) (memq 'org-link tprop)))))
  17727. (call-interactively 'org-open-at-point))
  17728. ((and (org-at-heading-p)
  17729. (looking-at
  17730. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  17731. (org-show-entry)
  17732. (end-of-line 1)
  17733. (newline))
  17734. (t (if indent (newline-and-indent) (newline))))))
  17735. (defun org-return-indent ()
  17736. "Goto next table row or insert a newline and indent.
  17737. Calls `org-table-next-row' or `newline-and-indent', depending on
  17738. context. See the individual commands for more information."
  17739. (interactive)
  17740. (org-return t))
  17741. (defun org-ctrl-c-star ()
  17742. "Compute table, or change heading status of lines.
  17743. Calls `org-table-recalculate' or `org-toggle-heading',
  17744. depending on context."
  17745. (interactive)
  17746. (cond
  17747. ((org-at-table-p)
  17748. (call-interactively 'org-table-recalculate))
  17749. (t
  17750. ;; Convert all lines in region to list items
  17751. (call-interactively 'org-toggle-heading))))
  17752. (defun org-ctrl-c-minus ()
  17753. "Insert separator line in table or modify bullet status of line.
  17754. Also turns a plain line or a region of lines into list items.
  17755. Calls `org-table-insert-hline', `org-toggle-item', or
  17756. `org-cycle-list-bullet', depending on context."
  17757. (interactive)
  17758. (cond
  17759. ((org-at-table-p)
  17760. (call-interactively 'org-table-insert-hline))
  17761. ((org-region-active-p)
  17762. (call-interactively 'org-toggle-item))
  17763. ((org-in-item-p)
  17764. (call-interactively 'org-cycle-list-bullet))
  17765. (t
  17766. (call-interactively 'org-toggle-item))))
  17767. (defun org-toggle-item (arg)
  17768. "Convert headings or normal lines to items, items to normal lines.
  17769. If there is no active region, only the current line is considered.
  17770. If the first non blank line in the region is an headline, convert
  17771. all headlines to items, shifting text accordingly.
  17772. If it is an item, convert all items to normal lines.
  17773. If it is normal text, change region into an item. With a prefix
  17774. argument ARG, change each line in region into an item."
  17775. (interactive "P")
  17776. (let ((shift-text
  17777. (function
  17778. ;; Shift text in current section to IND, from point to END.
  17779. ;; The function leaves point to END line.
  17780. (lambda (ind end)
  17781. (let ((min-i 1000) (end (copy-marker end)))
  17782. ;; First determine the minimum indentation (MIN-I) of
  17783. ;; the text.
  17784. (save-excursion
  17785. (catch 'exit
  17786. (while (< (point) end)
  17787. (let ((i (org-get-indentation)))
  17788. (cond
  17789. ;; Skip blank lines and inline tasks.
  17790. ((looking-at "^[ \t]*$"))
  17791. ((looking-at org-outline-regexp-bol))
  17792. ;; We can't find less than 0 indentation.
  17793. ((zerop i) (throw 'exit (setq min-i 0)))
  17794. ((< i min-i) (setq min-i i))))
  17795. (forward-line))))
  17796. ;; Then indent each line so that a line indented to
  17797. ;; MIN-I becomes indented to IND. Ignore blank lines
  17798. ;; and inline tasks in the process.
  17799. (let ((delta (- ind min-i)))
  17800. (while (< (point) end)
  17801. (unless (or (looking-at "^[ \t]*$")
  17802. (looking-at org-outline-regexp-bol))
  17803. (org-indent-line-to (+ (org-get-indentation) delta)))
  17804. (forward-line)))))))
  17805. (skip-blanks
  17806. (function
  17807. ;; Return beginning of first non-blank line, starting from
  17808. ;; line at POS.
  17809. (lambda (pos)
  17810. (save-excursion
  17811. (goto-char pos)
  17812. (skip-chars-forward " \r\t\n")
  17813. (point-at-bol)))))
  17814. beg end)
  17815. ;; Determine boundaries of changes.
  17816. (if (org-region-active-p)
  17817. (setq beg (funcall skip-blanks (region-beginning))
  17818. end (copy-marker (region-end)))
  17819. (setq beg (funcall skip-blanks (point-at-bol))
  17820. end (copy-marker (point-at-eol))))
  17821. ;; Depending on the starting line, choose an action on the text
  17822. ;; between BEG and END.
  17823. (org-with-limited-levels
  17824. (save-excursion
  17825. (goto-char beg)
  17826. (cond
  17827. ;; Case 1. Start at an item: de-itemize. Note that it only
  17828. ;; happens when a region is active: `org-ctrl-c-minus'
  17829. ;; would call `org-cycle-list-bullet' otherwise.
  17830. ((org-at-item-p)
  17831. (while (< (point) end)
  17832. (when (org-at-item-p)
  17833. (skip-chars-forward " \t")
  17834. (delete-region (point) (match-end 0)))
  17835. (forward-line)))
  17836. ;; Case 2. Start at an heading: convert to items.
  17837. ((org-at-heading-p)
  17838. (let* ((bul (org-list-bullet-string "-"))
  17839. (bul-len (length bul))
  17840. ;; Indentation of the first heading. It should be
  17841. ;; relative to the indentation of its parent, if any.
  17842. (start-ind (save-excursion
  17843. (cond
  17844. ((not org-adapt-indentation) 0)
  17845. ((not (outline-previous-heading)) 0)
  17846. (t (length (match-string 0))))))
  17847. ;; Level of first heading. Further headings will be
  17848. ;; compared to it to determine hierarchy in the list.
  17849. (ref-level (org-reduced-level (org-outline-level))))
  17850. (while (< (point) end)
  17851. (let* ((level (org-reduced-level (org-outline-level)))
  17852. (delta (max 0 (- level ref-level))))
  17853. ;; If current headline is less indented than the first
  17854. ;; one, set it as reference, in order to preserve
  17855. ;; subtrees.
  17856. (when (< level ref-level) (setq ref-level level))
  17857. (replace-match bul t t)
  17858. (org-indent-line-to (+ start-ind (* delta bul-len)))
  17859. ;; Ensure all text down to END (or SECTION-END) belongs
  17860. ;; to the newly created item.
  17861. (let ((section-end (save-excursion
  17862. (or (outline-next-heading) (point)))))
  17863. (forward-line)
  17864. (funcall shift-text
  17865. (+ start-ind (* (1+ delta) bul-len))
  17866. (min end section-end)))))))
  17867. ;; Case 3. Normal line with ARG: turn each non-item line into
  17868. ;; an item.
  17869. (arg
  17870. (while (< (point) end)
  17871. (unless (or (org-at-heading-p) (org-at-item-p))
  17872. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  17873. (replace-match
  17874. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  17875. (forward-line)))
  17876. ;; Case 4. Normal line without ARG: make the first line of
  17877. ;; region an item, and shift indentation of others
  17878. ;; lines to set them as item's body.
  17879. (t (let* ((bul (org-list-bullet-string "-"))
  17880. (bul-len (length bul))
  17881. (ref-ind (org-get-indentation)))
  17882. (skip-chars-forward " \t")
  17883. (insert bul)
  17884. (forward-line)
  17885. (while (< (point) end)
  17886. ;; Ensure that lines less indented than first one
  17887. ;; still get included in item body.
  17888. (funcall shift-text
  17889. (+ ref-ind bul-len)
  17890. (min end (save-excursion (or (outline-next-heading)
  17891. (point)))))
  17892. (forward-line)))))))))
  17893. (defun org-toggle-heading (&optional nstars)
  17894. "Convert headings to normal text, or items or text to headings.
  17895. If there is no active region, only the current line is considered.
  17896. With a \\[universal-argument] prefix, convert the whole list at
  17897. point into heading.
  17898. In a region:
  17899. - If the first non blank line is an headline, remove the stars
  17900. from all headlines in the region.
  17901. - If it is a normal line turn each and every normal line (i.e. not an
  17902. heading or an item) in the region into a heading.
  17903. - If it is a plain list item, turn all plain list items into headings.
  17904. When converting a line into a heading, the number of stars is chosen
  17905. such that the lines become children of the current entry. However,
  17906. when a prefix argument is given, its value determines the number of
  17907. stars to add."
  17908. (interactive "P")
  17909. (let ((skip-blanks
  17910. (function
  17911. ;; Return beginning of first non-blank line, starting from
  17912. ;; line at POS.
  17913. (lambda (pos)
  17914. (save-excursion
  17915. (goto-char pos)
  17916. (while (org-at-comment-p) (forward-line))
  17917. (skip-chars-forward " \r\t\n")
  17918. (point-at-bol)))))
  17919. beg end toggled)
  17920. ;; Determine boundaries of changes. If a universal prefix has
  17921. ;; been given, put the list in a region. If region ends at a bol,
  17922. ;; do not consider the last line to be in the region.
  17923. (when (and current-prefix-arg (org-at-item-p))
  17924. (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
  17925. (org-mark-element))
  17926. (if (org-region-active-p)
  17927. (setq beg (funcall skip-blanks (region-beginning))
  17928. end (copy-marker (save-excursion
  17929. (goto-char (region-end))
  17930. (if (bolp) (point) (point-at-eol)))))
  17931. (setq beg (funcall skip-blanks (point-at-bol))
  17932. end (copy-marker (point-at-eol))))
  17933. ;; Ensure inline tasks don't count as headings.
  17934. (org-with-limited-levels
  17935. (save-excursion
  17936. (goto-char beg)
  17937. (cond
  17938. ;; Case 1. Started at an heading: de-star headings.
  17939. ((org-at-heading-p)
  17940. (while (< (point) end)
  17941. (when (org-at-heading-p t)
  17942. (looking-at org-outline-regexp) (replace-match "")
  17943. (setq toggled t))
  17944. (forward-line)))
  17945. ;; Case 2. Started at an item: change items into headlines.
  17946. ;; One star will be added by `org-list-to-subtree'.
  17947. ((org-at-item-p)
  17948. (let* ((stars (make-string
  17949. (if nstars
  17950. ;; subtract the star that will be added again by
  17951. ;; `org-list-to-subtree'
  17952. (1- (prefix-numeric-value current-prefix-arg))
  17953. (or (org-current-level) 0))
  17954. ?*))
  17955. (add-stars
  17956. (cond (nstars "") ; stars from prefix only
  17957. ((equal stars "") "") ; before first heading
  17958. (org-odd-levels-only "*") ; inside heading, odd
  17959. (t "")))) ; inside heading, oddeven
  17960. (while (< (point) end)
  17961. (when (org-at-item-p)
  17962. ;; Pay attention to cases when region ends before list.
  17963. (let* ((struct (org-list-struct))
  17964. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  17965. (save-restriction
  17966. (narrow-to-region (point) list-end)
  17967. (insert
  17968. (org-list-to-subtree
  17969. (org-list-parse-list t)
  17970. '(:istart (concat stars add-stars (funcall get-stars depth))
  17971. :icount (concat stars add-stars (funcall get-stars depth)))))))
  17972. (setq toggled t))
  17973. (forward-line))))
  17974. ;; Case 3. Started at normal text: make every line an heading,
  17975. ;; skipping headlines and items.
  17976. (t (let* ((stars (make-string
  17977. (if nstars
  17978. (prefix-numeric-value current-prefix-arg)
  17979. (or (org-current-level) 0))
  17980. ?*))
  17981. (add-stars
  17982. (cond (nstars "") ; stars from prefix only
  17983. ((equal stars "") "*") ; before first heading
  17984. (org-odd-levels-only "**") ; inside heading, odd
  17985. (t "*"))) ; inside heading, oddeven
  17986. (rpl (concat stars add-stars " ")))
  17987. (while (< (point) end)
  17988. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  17989. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  17990. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  17991. (forward-line)))))))
  17992. (unless toggled (message "Cannot toggle heading from here"))))
  17993. (defun org-meta-return (&optional arg)
  17994. "Insert a new heading or wrap a region in a table.
  17995. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  17996. See the individual commands for more information."
  17997. (interactive "P")
  17998. (cond
  17999. ((run-hook-with-args-until-success 'org-metareturn-hook))
  18000. ((or (org-at-drawer-p) (org-at-property-p))
  18001. (newline-and-indent))
  18002. ((org-at-table-p)
  18003. (call-interactively 'org-table-wrap-region))
  18004. (t (call-interactively 'org-insert-heading))))
  18005. ;;; Menu entries
  18006. ;; Define the Org-mode menus
  18007. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  18008. '("Tbl"
  18009. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  18010. ["Next Field" org-cycle (org-at-table-p)]
  18011. ["Previous Field" org-shifttab (org-at-table-p)]
  18012. ["Next Row" org-return (org-at-table-p)]
  18013. "--"
  18014. ["Blank Field" org-table-blank-field (org-at-table-p)]
  18015. ["Edit Field" org-table-edit-field (org-at-table-p)]
  18016. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  18017. "--"
  18018. ("Column"
  18019. ["Move Column Left" org-metaleft (org-at-table-p)]
  18020. ["Move Column Right" org-metaright (org-at-table-p)]
  18021. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  18022. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  18023. ("Row"
  18024. ["Move Row Up" org-metaup (org-at-table-p)]
  18025. ["Move Row Down" org-metadown (org-at-table-p)]
  18026. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  18027. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  18028. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  18029. "--"
  18030. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  18031. ("Rectangle"
  18032. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  18033. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  18034. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  18035. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  18036. "--"
  18037. ("Calculate"
  18038. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  18039. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  18040. ["Edit Formulas" org-edit-special (org-at-table-p)]
  18041. "--"
  18042. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  18043. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  18044. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  18045. "--"
  18046. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  18047. "--"
  18048. ["Sum Column/Rectangle" org-table-sum
  18049. (or (org-at-table-p) (org-region-active-p))]
  18050. ["Which Column?" org-table-current-column (org-at-table-p)])
  18051. ["Debug Formulas"
  18052. org-table-toggle-formula-debugger
  18053. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  18054. ["Show Col/Row Numbers"
  18055. org-table-toggle-coordinate-overlays
  18056. :style toggle
  18057. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  18058. "--"
  18059. ["Create" org-table-create (and (not (org-at-table-p))
  18060. org-enable-table-editor)]
  18061. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  18062. ["Import from File" org-table-import (not (org-at-table-p))]
  18063. ["Export to File" org-table-export (org-at-table-p)]
  18064. "--"
  18065. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  18066. (easy-menu-define org-org-menu org-mode-map "Org menu"
  18067. '("Org"
  18068. ("Show/Hide"
  18069. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  18070. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  18071. ["Sparse Tree..." org-sparse-tree t]
  18072. ["Reveal Context" org-reveal t]
  18073. ["Show All" show-all t]
  18074. "--"
  18075. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  18076. "--"
  18077. ["New Heading" org-insert-heading t]
  18078. ("Navigate Headings"
  18079. ["Up" outline-up-heading t]
  18080. ["Next" outline-next-visible-heading t]
  18081. ["Previous" outline-previous-visible-heading t]
  18082. ["Next Same Level" outline-forward-same-level t]
  18083. ["Previous Same Level" outline-backward-same-level t]
  18084. "--"
  18085. ["Jump" org-goto t])
  18086. ("Edit Structure"
  18087. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  18088. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  18089. "--"
  18090. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  18091. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  18092. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  18093. "--"
  18094. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  18095. "--"
  18096. ["Copy visible text" org-copy-visible t]
  18097. "--"
  18098. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  18099. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  18100. ["Demote Heading" org-metaright (not (org-at-table-p))]
  18101. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  18102. "--"
  18103. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  18104. "--"
  18105. ["Convert to odd levels" org-convert-to-odd-levels t]
  18106. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  18107. ("Editing"
  18108. ["Emphasis..." org-emphasize t]
  18109. ["Edit Source Example" org-edit-special t]
  18110. "--"
  18111. ["Footnote new/jump" org-footnote-action t]
  18112. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  18113. ("Archive"
  18114. ["Archive (default method)" org-archive-subtree-default t]
  18115. "--"
  18116. ["Move Subtree to Archive file" org-advertized-archive-subtree t]
  18117. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  18118. ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
  18119. )
  18120. "--"
  18121. ("Hyperlinks"
  18122. ["Store Link (Global)" org-store-link t]
  18123. ["Find existing link to here" org-occur-link-in-agenda-files t]
  18124. ["Insert Link" org-insert-link t]
  18125. ["Follow Link" org-open-at-point t]
  18126. "--"
  18127. ["Next link" org-next-link t]
  18128. ["Previous link" org-previous-link t]
  18129. "--"
  18130. ["Descriptive Links"
  18131. org-toggle-link-display
  18132. :style radio
  18133. :selected org-descriptive-links
  18134. ]
  18135. ["Literal Links"
  18136. org-toggle-link-display
  18137. :style radio
  18138. :selected (not org-descriptive-links)])
  18139. "--"
  18140. ("TODO Lists"
  18141. ["TODO/DONE/-" org-todo t]
  18142. ("Select keyword"
  18143. ["Next keyword" org-shiftright (org-at-heading-p)]
  18144. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  18145. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  18146. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  18147. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  18148. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  18149. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  18150. "--"
  18151. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  18152. :selected org-enforce-todo-dependencies :style toggle :active t]
  18153. "Settings for tree at point"
  18154. ["Do Children sequentially" org-toggle-ordered-property :style radio
  18155. :selected (org-entry-get nil "ORDERED")
  18156. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18157. ["Do Children parallel" org-toggle-ordered-property :style radio
  18158. :selected (not (org-entry-get nil "ORDERED"))
  18159. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  18160. "--"
  18161. ["Set Priority" org-priority t]
  18162. ["Priority Up" org-shiftup t]
  18163. ["Priority Down" org-shiftdown t]
  18164. "--"
  18165. ["Get news from all feeds" org-feed-update-all t]
  18166. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  18167. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  18168. ("TAGS and Properties"
  18169. ["Set Tags" org-set-tags-command t]
  18170. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  18171. "--"
  18172. ["Set property" org-set-property t]
  18173. ["Column view of properties" org-columns t]
  18174. ["Insert Column View DBlock" org-insert-columns-dblock t])
  18175. ("Dates and Scheduling"
  18176. ["Timestamp" org-time-stamp t]
  18177. ["Timestamp (inactive)" org-time-stamp-inactive t]
  18178. ("Change Date"
  18179. ["1 Day Later" org-shiftright t]
  18180. ["1 Day Earlier" org-shiftleft t]
  18181. ["1 ... Later" org-shiftup t]
  18182. ["1 ... Earlier" org-shiftdown t])
  18183. ["Compute Time Range" org-evaluate-time-range t]
  18184. ["Schedule Item" org-schedule t]
  18185. ["Deadline" org-deadline t]
  18186. "--"
  18187. ["Custom time format" org-toggle-time-stamp-overlays
  18188. :style radio :selected org-display-custom-times]
  18189. "--"
  18190. ["Goto Calendar" org-goto-calendar t]
  18191. ["Date from Calendar" org-date-from-calendar t]
  18192. "--"
  18193. ["Start/Restart Timer" org-timer-start t]
  18194. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  18195. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  18196. ["Insert Timer String" org-timer t]
  18197. ["Insert Timer Item" org-timer-item t])
  18198. ("Logging work"
  18199. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  18200. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  18201. ["Clock out" org-clock-out t]
  18202. ["Clock cancel" org-clock-cancel t]
  18203. "--"
  18204. ["Mark as default task" org-clock-mark-default-task t]
  18205. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  18206. ["Goto running clock" org-clock-goto t]
  18207. "--"
  18208. ["Display times" org-clock-display t]
  18209. ["Create clock table" org-clock-report t]
  18210. "--"
  18211. ["Record DONE time"
  18212. (progn (setq org-log-done (not org-log-done))
  18213. (message "Switching to %s will %s record a timestamp"
  18214. (car org-done-keywords)
  18215. (if org-log-done "automatically" "not")))
  18216. :style toggle :selected org-log-done])
  18217. "--"
  18218. ["Agenda Command..." org-agenda t]
  18219. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  18220. ("File List for Agenda")
  18221. ("Special views current file"
  18222. ["TODO Tree" org-show-todo-tree t]
  18223. ["Check Deadlines" org-check-deadlines t]
  18224. ["Timeline" org-timeline t]
  18225. ["Tags/Property tree" org-match-sparse-tree t])
  18226. "--"
  18227. ["Export/Publish..." org-export t]
  18228. ("LaTeX"
  18229. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  18230. :selected org-cdlatex-mode]
  18231. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  18232. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  18233. ["Modify math symbol" org-cdlatex-math-modify
  18234. (org-inside-LaTeX-fragment-p)]
  18235. ["Insert citation" org-reftex-citation t]
  18236. "--"
  18237. ["Template for BEAMER" (progn (require 'org-beamer)
  18238. (org-insert-beamer-options-template)) t])
  18239. "--"
  18240. ("MobileOrg"
  18241. ["Push Files and Views" org-mobile-push t]
  18242. ["Get Captured and Flagged" org-mobile-pull t]
  18243. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  18244. "--"
  18245. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  18246. "--"
  18247. ("Documentation"
  18248. ["Show Version" org-version t]
  18249. ["Info Documentation" org-info t])
  18250. ("Customize"
  18251. ["Browse Org Group" org-customize t]
  18252. "--"
  18253. ["Expand This Menu" org-create-customize-menu
  18254. (fboundp 'customize-menu-create)])
  18255. ["Send bug report" org-submit-bug-report t]
  18256. "--"
  18257. ("Refresh/Reload"
  18258. ["Refresh setup current buffer" org-mode-restart t]
  18259. ["Reload Org (after update)" org-reload t]
  18260. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  18261. ))
  18262. (defun org-info (&optional node)
  18263. "Read documentation for Org-mode in the info system.
  18264. With optional NODE, go directly to that node."
  18265. (interactive)
  18266. (info (format "(org)%s" (or node ""))))
  18267. ;;;###autoload
  18268. (defun org-submit-bug-report ()
  18269. "Submit a bug report on Org-mode via mail.
  18270. Don't hesitate to report any problems or inaccurate documentation.
  18271. If you don't have setup sending mail from (X)Emacs, please copy the
  18272. output buffer into your mail program, as it gives us important
  18273. information about your Org-mode version and configuration."
  18274. (interactive)
  18275. (require 'reporter)
  18276. (org-load-modules-maybe)
  18277. (org-require-autoloaded-modules)
  18278. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  18279. (reporter-submit-bug-report
  18280. "emacs-orgmode@gnu.org"
  18281. (org-version nil 'full)
  18282. (let (list)
  18283. (save-window-excursion
  18284. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  18285. (delete-other-windows)
  18286. (erase-buffer)
  18287. (insert "You are about to submit a bug report to the Org-mode mailing list.
  18288. We would like to add your full Org-mode and Outline configuration to the
  18289. bug report. This greatly simplifies the work of the maintainer and
  18290. other experts on the mailing list.
  18291. HOWEVER, some variables you have customized may contain private
  18292. information. The names of customers, colleagues, or friends, might
  18293. appear in the form of file names, tags, todo states, or search strings.
  18294. If you answer yes to the prompt, you might want to check and remove
  18295. such private information before sending the email.")
  18296. (add-text-properties (point-min) (point-max) '(face org-warning))
  18297. (when (yes-or-no-p "Include your Org-mode configuration ")
  18298. (mapatoms
  18299. (lambda (v)
  18300. (and (boundp v)
  18301. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  18302. (or (and (symbol-value v)
  18303. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  18304. (and
  18305. (get v 'custom-type) (get v 'standard-value)
  18306. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  18307. (push v list)))))
  18308. (kill-buffer (get-buffer "*Warn about privacy*"))
  18309. list))
  18310. nil nil
  18311. "Remember to cover the basics, that is, what you expected to happen and
  18312. what in fact did happen. You don't know how to make a good report? See
  18313. http://orgmode.org/manual/Feedback.html#Feedback
  18314. Your bug report will be posted to the Org-mode mailing list.
  18315. ------------------------------------------------------------------------")
  18316. (save-excursion
  18317. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  18318. (replace-match "\\1Bug: \\3 [\\2]")))))
  18319. (defun org-install-agenda-files-menu ()
  18320. (let ((bl (buffer-list)))
  18321. (save-excursion
  18322. (while bl
  18323. (set-buffer (pop bl))
  18324. (if (derived-mode-p 'org-mode) (setq bl nil)))
  18325. (when (derived-mode-p 'org-mode)
  18326. (easy-menu-change
  18327. '("Org") "File List for Agenda"
  18328. (append
  18329. (list
  18330. ["Edit File List" (org-edit-agenda-file-list) t]
  18331. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  18332. ["Remove Current File from List" org-remove-file t]
  18333. ["Cycle through agenda files" org-cycle-agenda-files t]
  18334. ["Occur in all agenda files" org-occur-in-agenda-files t]
  18335. "--")
  18336. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  18337. ;;;; Documentation
  18338. ;;;###autoload
  18339. (defun org-require-autoloaded-modules ()
  18340. (interactive)
  18341. (mapc 'require
  18342. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  18343. org-docbook org-exp org-html org-icalendar
  18344. org-id org-latex
  18345. org-publish org-remember org-table
  18346. org-timer org-xoxo)))
  18347. ;;;###autoload
  18348. (defun org-reload (&optional uncompiled)
  18349. "Reload all org lisp files.
  18350. With prefix arg UNCOMPILED, load the uncompiled versions."
  18351. (interactive "P")
  18352. (require 'find-func)
  18353. (let* ((file-re "^org\\(-.*\\)?\\.el")
  18354. (dir-org (file-name-directory (org-find-library-dir "org")))
  18355. (dir-org-contrib (ignore-errors
  18356. (file-name-directory
  18357. (org-find-library-dir "org-contribdir"))))
  18358. (babel-files
  18359. (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
  18360. (append (list nil "comint" "eval" "exp" "keys"
  18361. "lob" "ref" "table" "tangle")
  18362. (delq nil
  18363. (mapcar
  18364. (lambda (lang)
  18365. (when (cdr lang) (symbol-name (car lang))))
  18366. org-babel-load-languages)))))
  18367. (files
  18368. (append babel-files
  18369. (and dir-org-contrib
  18370. (directory-files dir-org-contrib t file-re))
  18371. (directory-files dir-org t file-re)))
  18372. (remove-re (concat (if (featurep 'xemacs)
  18373. "org-colview" "org-colview-xemacs")
  18374. "\\'")))
  18375. (setq files (mapcar 'file-name-sans-extension files))
  18376. (setq files (mapcar
  18377. (lambda (x) (if (string-match remove-re x) nil x))
  18378. files))
  18379. (setq files (delq nil files))
  18380. (mapc
  18381. (lambda (f)
  18382. (when (featurep (intern (file-name-nondirectory f)))
  18383. (if (and (not uncompiled)
  18384. (file-exists-p (concat f ".elc")))
  18385. (load (concat f ".elc") nil nil 'nosuffix)
  18386. (load (concat f ".el") nil nil 'nosuffix))))
  18387. files)
  18388. (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
  18389. (org-version nil 'full 'message))
  18390. ;;;###autoload
  18391. (defun org-customize ()
  18392. "Call the customize function with org as argument."
  18393. (interactive)
  18394. (org-load-modules-maybe)
  18395. (org-require-autoloaded-modules)
  18396. (customize-browse 'org))
  18397. (defun org-create-customize-menu ()
  18398. "Create a full customization menu for Org-mode, insert it into the menu."
  18399. (interactive)
  18400. (org-load-modules-maybe)
  18401. (org-require-autoloaded-modules)
  18402. (if (fboundp 'customize-menu-create)
  18403. (progn
  18404. (easy-menu-change
  18405. '("Org") "Customize"
  18406. `(["Browse Org group" org-customize t]
  18407. "--"
  18408. ,(customize-menu-create 'org)
  18409. ["Set" Custom-set t]
  18410. ["Save" Custom-save t]
  18411. ["Reset to Current" Custom-reset-current t]
  18412. ["Reset to Saved" Custom-reset-saved t]
  18413. ["Reset to Standard Settings" Custom-reset-standard t]))
  18414. (message "\"Org\"-menu now contains full customization menu"))
  18415. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  18416. ;;;; Miscellaneous stuff
  18417. ;;; Generally useful functions
  18418. (defun org-get-at-bol (property)
  18419. "Get text property PROPERTY at beginning of line."
  18420. (get-text-property (point-at-bol) property))
  18421. (defun org-find-text-property-in-string (prop s)
  18422. "Return the first non-nil value of property PROP in string S."
  18423. (or (get-text-property 0 prop s)
  18424. (get-text-property (or (next-single-property-change 0 prop s) 0)
  18425. prop s)))
  18426. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  18427. "Display the given MESSAGE as a warning."
  18428. (if (fboundp 'display-warning)
  18429. (display-warning 'org message
  18430. (if (featurep 'xemacs) 'warning :warning))
  18431. (let ((buf (get-buffer-create "*Org warnings*")))
  18432. (with-current-buffer buf
  18433. (goto-char (point-max))
  18434. (insert "Warning (Org): " message)
  18435. (unless (bolp)
  18436. (newline)))
  18437. (display-buffer buf)
  18438. (sit-for 0))))
  18439. (defun org-eval (form)
  18440. "Eval FORM and return result."
  18441. (condition-case error
  18442. (eval form)
  18443. (error (format "%%![Error: %s]" error))))
  18444. (defun org-in-clocktable-p ()
  18445. "Check if the cursor is in a clocktable."
  18446. (let ((pos (point)) start)
  18447. (save-excursion
  18448. (end-of-line 1)
  18449. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  18450. (setq start (match-beginning 0))
  18451. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  18452. (>= (match-end 0) pos)
  18453. start))))
  18454. (defun org-in-commented-line ()
  18455. "Is point in a line starting with `#'?"
  18456. (equal (char-after (point-at-bol)) ?#))
  18457. (defun org-in-indented-comment-line ()
  18458. "Is point in a line starting with `#' after some white space?"
  18459. (save-excursion
  18460. (save-match-data
  18461. (goto-char (point-at-bol))
  18462. (looking-at "[ \t]*#"))))
  18463. (defun org-in-verbatim-emphasis ()
  18464. (save-match-data
  18465. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  18466. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  18467. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  18468. (if (and marker (marker-buffer marker)
  18469. (buffer-live-p (marker-buffer marker)))
  18470. (progn
  18471. (org-pop-to-buffer-same-window (marker-buffer marker))
  18472. (if (or (> marker (point-max)) (< marker (point-min)))
  18473. (widen))
  18474. (goto-char marker)
  18475. (org-show-context 'org-goto))
  18476. (if bookmark
  18477. (bookmark-jump bookmark)
  18478. (error "Cannot find location"))))
  18479. (defun org-quote-csv-field (s)
  18480. "Quote field for inclusion in CSV material."
  18481. (if (string-match "[\",]" s)
  18482. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  18483. s))
  18484. (defun org-force-self-insert (N)
  18485. "Needed to enforce self-insert under remapping."
  18486. (interactive "p")
  18487. (self-insert-command N))
  18488. (defun org-string-width (s)
  18489. "Compute width of string, ignoring invisible characters.
  18490. This ignores character with invisibility property `org-link', and also
  18491. characters with property `org-cwidth', because these will become invisible
  18492. upon the next fontification round."
  18493. (let (b l)
  18494. (when (or (eq t buffer-invisibility-spec)
  18495. (assq 'org-link buffer-invisibility-spec))
  18496. (while (setq b (text-property-any 0 (length s)
  18497. 'invisible 'org-link s))
  18498. (setq s (concat (substring s 0 b)
  18499. (substring s (or (next-single-property-change
  18500. b 'invisible s) (length s)))))))
  18501. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  18502. (setq s (concat (substring s 0 b)
  18503. (substring s (or (next-single-property-change
  18504. b 'org-cwidth s) (length s))))))
  18505. (setq l (string-width s) b -1)
  18506. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  18507. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  18508. l))
  18509. (defun org-shorten-string (s maxlength)
  18510. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  18511. If the string is shorter or has length MAXLENGTH, just return the
  18512. original string. If it is longer, the functions finds a space in the
  18513. string, breaks this string off at that locations and adds three dots
  18514. as ellipsis. Including the ellipsis, the string will not be longer
  18515. than MAXLENGTH. If finding a good breaking point in the string does
  18516. not work, the string is just chopped off in the middle of a word
  18517. if necessary."
  18518. (if (<= (length s) maxlength)
  18519. s
  18520. (let* ((n (max (- maxlength 4) 1))
  18521. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  18522. (if (string-match re s)
  18523. (concat (match-string 1 s) "...")
  18524. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  18525. (defun org-get-indentation (&optional line)
  18526. "Get the indentation of the current line, interpreting tabs.
  18527. When LINE is given, assume it represents a line and compute its indentation."
  18528. (if line
  18529. (if (string-match "^ *" (org-remove-tabs line))
  18530. (match-end 0))
  18531. (save-excursion
  18532. (beginning-of-line 1)
  18533. (skip-chars-forward " \t")
  18534. (current-column))))
  18535. (defun org-get-string-indentation (s)
  18536. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  18537. (let ((n -1) (i 0) (w tab-width) c)
  18538. (catch 'exit
  18539. (while (< (setq n (1+ n)) (length s))
  18540. (setq c (aref s n))
  18541. (cond ((= c ?\ ) (setq i (1+ i)))
  18542. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  18543. (t (throw 'exit t)))))
  18544. i))
  18545. (defun org-remove-tabs (s &optional width)
  18546. "Replace tabulators in S with spaces.
  18547. Assumes that s is a single line, starting in column 0."
  18548. (setq width (or width tab-width))
  18549. (while (string-match "\t" s)
  18550. (setq s (replace-match
  18551. (make-string
  18552. (- (* width (/ (+ (match-beginning 0) width) width))
  18553. (match-beginning 0)) ?\ )
  18554. t t s)))
  18555. s)
  18556. (defun org-fix-indentation (line ind)
  18557. "Fix indentation in LINE.
  18558. IND is a cons cell with target and minimum indentation.
  18559. If the current indentation in LINE is smaller than the minimum,
  18560. leave it alone. If it is larger than ind, set it to the target."
  18561. (let* ((l (org-remove-tabs line))
  18562. (i (org-get-indentation l))
  18563. (i1 (car ind)) (i2 (cdr ind)))
  18564. (if (>= i i2) (setq l (substring line i2)))
  18565. (if (> i1 0)
  18566. (concat (make-string i1 ?\ ) l)
  18567. l)))
  18568. (defun org-remove-indentation (code &optional n)
  18569. "Remove the maximum common indentation from the lines in CODE.
  18570. N may optionally be the number of spaces to remove."
  18571. (with-temp-buffer
  18572. (insert code)
  18573. (org-do-remove-indentation n)
  18574. (buffer-string)))
  18575. (defun org-do-remove-indentation (&optional n)
  18576. "Remove the maximum common indentation from the buffer."
  18577. (untabify (point-min) (point-max))
  18578. (let ((min 10000) re)
  18579. (if n
  18580. (setq min n)
  18581. (goto-char (point-min))
  18582. (while (re-search-forward "^ *[^ \n]" nil t)
  18583. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  18584. (unless (or (= min 0) (= min 10000))
  18585. (setq re (format "^ \\{%d\\}" min))
  18586. (goto-char (point-min))
  18587. (while (re-search-forward re nil t)
  18588. (replace-match "")
  18589. (end-of-line 1))
  18590. min)))
  18591. (defun org-fill-template (template alist)
  18592. "Find each %key of ALIST in TEMPLATE and replace it."
  18593. (let ((case-fold-search nil)
  18594. entry key value)
  18595. (setq alist (sort (copy-sequence alist)
  18596. (lambda (a b) (< (length (car a)) (length (car b))))))
  18597. (while (setq entry (pop alist))
  18598. (setq template
  18599. (replace-regexp-in-string
  18600. (concat "%" (regexp-quote (car entry)))
  18601. (or (cdr entry) "") template t t)))
  18602. template))
  18603. (defun org-base-buffer (buffer)
  18604. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  18605. (if (not buffer)
  18606. buffer
  18607. (or (buffer-base-buffer buffer)
  18608. buffer)))
  18609. (defun org-trim (s)
  18610. "Remove whitespace at beginning and end of string."
  18611. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  18612. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  18613. s)
  18614. (defun org-wrap (string &optional width lines)
  18615. "Wrap string to either a number of lines, or a width in characters.
  18616. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  18617. that costs. If there is a word longer than WIDTH, the text is actually
  18618. wrapped to the length of that word.
  18619. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  18620. many lines, whatever width that takes.
  18621. The return value is a list of lines, without newlines at the end."
  18622. (let* ((words (org-split-string string "[ \t\n]+"))
  18623. (maxword (apply 'max (mapcar 'org-string-width words)))
  18624. w ll)
  18625. (cond (width
  18626. (org-do-wrap words (max maxword width)))
  18627. (lines
  18628. (setq w maxword)
  18629. (setq ll (org-do-wrap words maxword))
  18630. (if (<= (length ll) lines)
  18631. ll
  18632. (setq ll words)
  18633. (while (> (length ll) lines)
  18634. (setq w (1+ w))
  18635. (setq ll (org-do-wrap words w)))
  18636. ll))
  18637. (t (error "Cannot wrap this")))))
  18638. (defun org-do-wrap (words width)
  18639. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  18640. (let (lines line)
  18641. (while words
  18642. (setq line (pop words))
  18643. (while (and words (< (+ (length line) (length (car words))) width))
  18644. (setq line (concat line " " (pop words))))
  18645. (setq lines (push line lines)))
  18646. (nreverse lines)))
  18647. (defun org-split-string (string &optional separators)
  18648. "Splits STRING into substrings at SEPARATORS.
  18649. No empty strings are returned if there are matches at the beginning
  18650. and end of string."
  18651. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  18652. (start 0)
  18653. notfirst
  18654. (list nil))
  18655. (while (and (string-match rexp string
  18656. (if (and notfirst
  18657. (= start (match-beginning 0))
  18658. (< start (length string)))
  18659. (1+ start) start))
  18660. (< (match-beginning 0) (length string)))
  18661. (setq notfirst t)
  18662. (or (eq (match-beginning 0) 0)
  18663. (and (eq (match-beginning 0) (match-end 0))
  18664. (eq (match-beginning 0) start))
  18665. (setq list
  18666. (cons (substring string start (match-beginning 0))
  18667. list)))
  18668. (setq start (match-end 0)))
  18669. (or (eq start (length string))
  18670. (setq list
  18671. (cons (substring string start)
  18672. list)))
  18673. (nreverse list)))
  18674. (defun org-quote-vert (s)
  18675. "Replace \"|\" with \"\\vert\"."
  18676. (while (string-match "|" s)
  18677. (setq s (replace-match "\\vert" t t s)))
  18678. s)
  18679. (defun org-uuidgen-p (s)
  18680. "Is S an ID created by UUIDGEN?"
  18681. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  18682. (defun org-in-src-block-p nil
  18683. "Whether point is in a code source block."
  18684. (let (ov)
  18685. (when (setq ov (overlays-at (point)))
  18686. (memq 'org-block-background
  18687. (overlay-properties
  18688. (car ov))))))
  18689. (defun org-context ()
  18690. "Return a list of contexts of the current cursor position.
  18691. If several contexts apply, all are returned.
  18692. Each context entry is a list with a symbol naming the context, and
  18693. two positions indicating start and end of the context. Possible
  18694. contexts are:
  18695. :headline anywhere in a headline
  18696. :headline-stars on the leading stars in a headline
  18697. :todo-keyword on a TODO keyword (including DONE) in a headline
  18698. :tags on the TAGS in a headline
  18699. :priority on the priority cookie in a headline
  18700. :item on the first line of a plain list item
  18701. :item-bullet on the bullet/number of a plain list item
  18702. :checkbox on the checkbox in a plain list item
  18703. :table in an org-mode table
  18704. :table-special on a special filed in a table
  18705. :table-table in a table.el table
  18706. :clocktable in a clocktable
  18707. :src-block in a source block
  18708. :link on a hyperlink
  18709. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  18710. :target on a <<target>>
  18711. :radio-target on a <<<radio-target>>>
  18712. :latex-fragment on a LaTeX fragment
  18713. :latex-preview on a LaTeX fragment with overlaid preview image
  18714. This function expects the position to be visible because it uses font-lock
  18715. faces as a help to recognize the following contexts: :table-special, :link,
  18716. and :keyword."
  18717. (let* ((f (get-text-property (point) 'face))
  18718. (faces (if (listp f) f (list f)))
  18719. (case-fold-search t)
  18720. (p (point)) clist o)
  18721. ;; First the large context
  18722. (cond
  18723. ((org-at-heading-p t)
  18724. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  18725. (when (progn
  18726. (beginning-of-line 1)
  18727. (looking-at org-todo-line-tags-regexp))
  18728. (push (org-point-in-group p 1 :headline-stars) clist)
  18729. (push (org-point-in-group p 2 :todo-keyword) clist)
  18730. (push (org-point-in-group p 4 :tags) clist))
  18731. (goto-char p)
  18732. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  18733. (if (looking-at "\\[#[A-Z0-9]\\]")
  18734. (push (org-point-in-group p 0 :priority) clist)))
  18735. ((org-at-item-p)
  18736. (push (org-point-in-group p 2 :item-bullet) clist)
  18737. (push (list :item (point-at-bol)
  18738. (save-excursion (org-end-of-item) (point)))
  18739. clist)
  18740. (and (org-at-item-checkbox-p)
  18741. (push (org-point-in-group p 0 :checkbox) clist)))
  18742. ((org-at-table-p)
  18743. (push (list :table (org-table-begin) (org-table-end)) clist)
  18744. (if (memq 'org-formula faces)
  18745. (push (list :table-special
  18746. (previous-single-property-change p 'face)
  18747. (next-single-property-change p 'face)) clist)))
  18748. ((org-at-table-p 'any)
  18749. (push (list :table-table) clist)))
  18750. (goto-char p)
  18751. (let ((case-fold-search t))
  18752. ;; New the "medium" contexts: clocktables, source blocks
  18753. (cond ((org-in-clocktable-p)
  18754. (push (list :clocktable
  18755. (and (or (looking-at "#\\+BEGIN: clocktable")
  18756. (search-backward "#+BEGIN: clocktable" nil t))
  18757. (match-beginning 0))
  18758. (and (re-search-forward "#\\+END:?" nil t)
  18759. (match-end 0))) clist))
  18760. ((org-in-src-block-p)
  18761. (push (list :src-block
  18762. (and (or (looking-at "#\\+BEGIN_SRC")
  18763. (search-backward "#+BEGIN_SRC" nil t))
  18764. (match-beginning 0))
  18765. (and (search-forward "#+END_SRC" nil t)
  18766. (match-beginning 0))) clist))))
  18767. (goto-char p)
  18768. ;; Now the small context
  18769. (cond
  18770. ((org-at-timestamp-p)
  18771. (push (org-point-in-group p 0 :timestamp) clist))
  18772. ((memq 'org-link faces)
  18773. (push (list :link
  18774. (previous-single-property-change p 'face)
  18775. (next-single-property-change p 'face)) clist))
  18776. ((memq 'org-special-keyword faces)
  18777. (push (list :keyword
  18778. (previous-single-property-change p 'face)
  18779. (next-single-property-change p 'face)) clist))
  18780. ((org-at-target-p)
  18781. (push (org-point-in-group p 0 :target) clist)
  18782. (goto-char (1- (match-beginning 0)))
  18783. (if (looking-at org-radio-target-regexp)
  18784. (push (org-point-in-group p 0 :radio-target) clist))
  18785. (goto-char p))
  18786. ((setq o (car (delq nil
  18787. (mapcar
  18788. (lambda (x)
  18789. (if (memq x org-latex-fragment-image-overlays) x))
  18790. (overlays-at (point))))))
  18791. (push (list :latex-fragment
  18792. (overlay-start o) (overlay-end o)) clist)
  18793. (push (list :latex-preview
  18794. (overlay-start o) (overlay-end o)) clist))
  18795. ((org-inside-LaTeX-fragment-p)
  18796. ;; FIXME: positions wrong.
  18797. (push (list :latex-fragment (point) (point)) clist)))
  18798. (setq clist (nreverse (delq nil clist)))
  18799. clist))
  18800. ;; FIXME: Compare with at-regexp-p Do we need both?
  18801. (defun org-in-regexp (re &optional nlines visually)
  18802. "Check if point is inside a match of regexp.
  18803. Normally only the current line is checked, but you can include NLINES extra
  18804. lines both before and after point into the search.
  18805. If VISUALLY is set, require that the cursor is not after the match but
  18806. really on, so that the block visually is on the match."
  18807. (catch 'exit
  18808. (let ((pos (point))
  18809. (eol (point-at-eol (+ 1 (or nlines 0))))
  18810. (inc (if visually 1 0)))
  18811. (save-excursion
  18812. (beginning-of-line (- 1 (or nlines 0)))
  18813. (while (re-search-forward re eol t)
  18814. (if (and (<= (match-beginning 0) pos)
  18815. (>= (+ inc (match-end 0)) pos))
  18816. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  18817. (defun org-at-regexp-p (regexp)
  18818. "Is point inside a match of REGEXP in the current line?"
  18819. (catch 'exit
  18820. (save-excursion
  18821. (let ((pos (point)) (end (point-at-eol)))
  18822. (beginning-of-line 1)
  18823. (while (re-search-forward regexp end t)
  18824. (if (and (<= (match-beginning 0) pos)
  18825. (>= (match-end 0) pos))
  18826. (throw 'exit t)))
  18827. nil))))
  18828. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  18829. "Non-nil when point is between matches of START-RE and END-RE.
  18830. Also return a non-nil value when point is on one of the matches.
  18831. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  18832. buffer positions. Default values are the positions of headlines
  18833. surrounding the point.
  18834. The functions returns a cons cell whose car (resp. cdr) is the
  18835. position before START-RE (resp. after END-RE)."
  18836. (save-match-data
  18837. (let ((pos (point))
  18838. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  18839. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  18840. beg end)
  18841. (save-excursion
  18842. ;; Point is on a block when on START-RE or if START-RE can be
  18843. ;; found before it...
  18844. (and (or (org-at-regexp-p start-re)
  18845. (re-search-backward start-re limit-up t))
  18846. (setq beg (match-beginning 0))
  18847. ;; ... and END-RE after it...
  18848. (goto-char (match-end 0))
  18849. (re-search-forward end-re limit-down t)
  18850. (> (setq end (match-end 0)) pos)
  18851. ;; ... without another START-RE in-between.
  18852. (goto-char (match-beginning 0))
  18853. (not (re-search-backward start-re (1+ beg) t))
  18854. ;; Return value.
  18855. (cons beg end))))))
  18856. (defun org-in-block-p (names)
  18857. "Non-nil when point belongs to a block whose name belongs to NAMES.
  18858. NAMES is a list of strings containing names of blocks.
  18859. Return first block name matched, or nil. Beware that in case of
  18860. nested blocks, the returned name may not belong to the closest
  18861. block from point."
  18862. (save-match-data
  18863. (catch 'exit
  18864. (let ((case-fold-search t)
  18865. (lim-up (save-excursion (outline-previous-heading)))
  18866. (lim-down (save-excursion (outline-next-heading))))
  18867. (mapc (lambda (name)
  18868. (let ((n (regexp-quote name)))
  18869. (when (org-between-regexps-p
  18870. (concat "^[ \t]*#\\+begin_" n)
  18871. (concat "^[ \t]*#\\+end_" n)
  18872. lim-up lim-down)
  18873. (throw 'exit n))))
  18874. names))
  18875. nil)))
  18876. (defun org-occur-in-agenda-files (regexp &optional nlines)
  18877. "Call `multi-occur' with buffers for all agenda files."
  18878. (interactive "sOrg-files matching: \np")
  18879. (let* ((files (org-agenda-files))
  18880. (tnames (mapcar 'file-truename files))
  18881. (extra org-agenda-text-search-extra-files)
  18882. f)
  18883. (when (eq (car extra) 'agenda-archives)
  18884. (setq extra (cdr extra))
  18885. (setq files (org-add-archive-files files)))
  18886. (while (setq f (pop extra))
  18887. (unless (member (file-truename f) tnames)
  18888. (add-to-list 'files f 'append)
  18889. (add-to-list 'tnames (file-truename f) 'append)))
  18890. (multi-occur
  18891. (mapcar (lambda (x)
  18892. (with-current-buffer
  18893. (or (get-file-buffer x) (find-file-noselect x))
  18894. (widen)
  18895. (current-buffer)))
  18896. files)
  18897. regexp)))
  18898. (if (boundp 'occur-mode-find-occurrence-hook)
  18899. ;; Emacs 23
  18900. (add-hook 'occur-mode-find-occurrence-hook
  18901. (lambda ()
  18902. (when (derived-mode-p 'org-mode)
  18903. (org-reveal))))
  18904. ;; Emacs 22
  18905. (defadvice occur-mode-goto-occurrence
  18906. (after org-occur-reveal activate)
  18907. (and (derived-mode-p 'org-mode) (org-reveal)))
  18908. (defadvice occur-mode-goto-occurrence-other-window
  18909. (after org-occur-reveal activate)
  18910. (and (derived-mode-p 'org-mode) (org-reveal)))
  18911. (defadvice occur-mode-display-occurrence
  18912. (after org-occur-reveal activate)
  18913. (when (derived-mode-p 'org-mode)
  18914. (let ((pos (occur-mode-find-occurrence)))
  18915. (with-current-buffer (marker-buffer pos)
  18916. (save-excursion
  18917. (goto-char pos)
  18918. (org-reveal)))))))
  18919. (defun org-occur-link-in-agenda-files ()
  18920. "Create a link and search for it in the agendas.
  18921. The link is not stored in `org-stored-links', it is just created
  18922. for the search purpose."
  18923. (interactive)
  18924. (let ((link (condition-case nil
  18925. (org-store-link nil)
  18926. (error "Unable to create a link to here"))))
  18927. (org-occur-in-agenda-files (regexp-quote link))))
  18928. (defun org-uniquify (list)
  18929. "Remove duplicate elements from LIST."
  18930. (let (res)
  18931. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  18932. res))
  18933. (defun org-delete-all (elts list)
  18934. "Remove all elements in ELTS from LIST."
  18935. (while elts
  18936. (setq list (delete (pop elts) list)))
  18937. list)
  18938. (defun org-count (cl-item cl-seq)
  18939. "Count the number of occurrences of ITEM in SEQ.
  18940. Taken from `count' in cl-seq.el with all keyword arguments removed."
  18941. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  18942. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  18943. (while (< cl-start cl-end)
  18944. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  18945. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  18946. (setq cl-start (1+ cl-start)))
  18947. cl-count))
  18948. (defun org-remove-if (predicate seq)
  18949. "Remove everything from SEQ that fulfills PREDICATE."
  18950. (let (res e)
  18951. (while seq
  18952. (setq e (pop seq))
  18953. (if (not (funcall predicate e)) (push e res)))
  18954. (nreverse res)))
  18955. (defun org-remove-if-not (predicate seq)
  18956. "Remove everything from SEQ that does not fulfill PREDICATE."
  18957. (let (res e)
  18958. (while seq
  18959. (setq e (pop seq))
  18960. (if (funcall predicate e) (push e res)))
  18961. (nreverse res)))
  18962. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  18963. "Reduce two-argument FUNCTION across SEQ.
  18964. Taken from `reduce' in cl-seq.el with all keyword arguments but
  18965. \":initial-value\" removed."
  18966. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  18967. (cadr (memq :initial-value cl-keys)))
  18968. (cl-seq (pop cl-seq))
  18969. (t (funcall cl-func)))))
  18970. (while cl-seq
  18971. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  18972. cl-accum))
  18973. (defun org-back-over-empty-lines ()
  18974. "Move backwards over whitespace, to the beginning of the first empty line.
  18975. Returns the number of empty lines passed."
  18976. (let ((pos (point)))
  18977. (if (cdr (assoc 'heading org-blank-before-new-entry))
  18978. (skip-chars-backward " \t\n\r")
  18979. (unless (eobp)
  18980. (forward-line -1)))
  18981. (beginning-of-line 2)
  18982. (goto-char (min (point) pos))
  18983. (count-lines (point) pos)))
  18984. (defun org-skip-whitespace ()
  18985. (skip-chars-forward " \t\n\r"))
  18986. (defun org-point-in-group (point group &optional context)
  18987. "Check if POINT is in match-group GROUP.
  18988. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  18989. match. If the match group does not exist or point is not inside it,
  18990. return nil."
  18991. (and (match-beginning group)
  18992. (>= point (match-beginning group))
  18993. (<= point (match-end group))
  18994. (if context
  18995. (list context (match-beginning group) (match-end group))
  18996. t)))
  18997. (defun org-switch-to-buffer-other-window (&rest args)
  18998. "Switch to buffer in a second window on the current frame.
  18999. In particular, do not allow pop-up frames.
  19000. Returns the newly created buffer."
  19001. (let (pop-up-frames special-display-buffer-names special-display-regexps
  19002. special-display-function)
  19003. (apply 'switch-to-buffer-other-window args)))
  19004. (defun org-combine-plists (&rest plists)
  19005. "Create a single property list from all plists in PLISTS.
  19006. The process starts by copying the first list, and then setting properties
  19007. from the other lists. Settings in the last list are the most significant
  19008. ones and overrule settings in the other lists."
  19009. (let ((rtn (copy-sequence (pop plists)))
  19010. p v ls)
  19011. (while plists
  19012. (setq ls (pop plists))
  19013. (while ls
  19014. (setq p (pop ls) v (pop ls))
  19015. (setq rtn (plist-put rtn p v))))
  19016. rtn))
  19017. (defun org-replace-escapes (string table)
  19018. "Replace %-escapes in STRING with values in TABLE.
  19019. TABLE is an association list with keys like \"%a\" and string values.
  19020. The sequences in STRING may contain normal field width and padding information,
  19021. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  19022. so values can contain further %-escapes if they are define later in TABLE."
  19023. (let ((tbl (copy-alist table))
  19024. (case-fold-search nil)
  19025. (pchg 0)
  19026. e re rpl)
  19027. (while (setq e (pop tbl))
  19028. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  19029. (when (and (cdr e) (string-match re (cdr e)))
  19030. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  19031. (safe "SREF"))
  19032. (add-text-properties 0 3 (list 'sref sref) safe)
  19033. (setcdr e (replace-match safe t t (cdr e)))))
  19034. (while (string-match re string)
  19035. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  19036. (cdr e)))
  19037. (setq string (replace-match rpl t t string))))
  19038. (while (setq pchg (next-property-change pchg string))
  19039. (let ((sref (get-text-property pchg 'sref string)))
  19040. (when (and sref (string-match "SREF" string pchg))
  19041. (setq string (replace-match sref t t string)))))
  19042. string))
  19043. (defun org-sublist (list start end)
  19044. "Return a section of LIST, from START to END.
  19045. Counting starts at 1."
  19046. (let (rtn (c start))
  19047. (setq list (nthcdr (1- start) list))
  19048. (while (and list (<= c end))
  19049. (push (pop list) rtn)
  19050. (setq c (1+ c)))
  19051. (nreverse rtn)))
  19052. (defun org-find-base-buffer-visiting (file)
  19053. "Like `find-buffer-visiting' but always return the base buffer and
  19054. not an indirect buffer."
  19055. (let ((buf (or (get-file-buffer file)
  19056. (find-buffer-visiting file))))
  19057. (if buf
  19058. (or (buffer-base-buffer buf) buf)
  19059. nil)))
  19060. (defun org-image-file-name-regexp (&optional extensions)
  19061. "Return regexp matching the file names of images.
  19062. If EXTENSIONS is given, only match these."
  19063. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  19064. (image-file-name-regexp)
  19065. (let ((image-file-name-extensions
  19066. (or extensions
  19067. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  19068. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  19069. (concat "\\."
  19070. (regexp-opt (nconc (mapcar 'upcase
  19071. image-file-name-extensions)
  19072. image-file-name-extensions)
  19073. t)
  19074. "\\'"))))
  19075. (defun org-file-image-p (file &optional extensions)
  19076. "Return non-nil if FILE is an image."
  19077. (save-match-data
  19078. (string-match (org-image-file-name-regexp extensions) file)))
  19079. (defun org-get-cursor-date ()
  19080. "Return the date at cursor in as a time.
  19081. This works in the calendar and in the agenda, anywhere else it just
  19082. returns the current time."
  19083. (let (date day defd)
  19084. (cond
  19085. ((eq major-mode 'calendar-mode)
  19086. (setq date (calendar-cursor-to-date)
  19087. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  19088. ((eq major-mode 'org-agenda-mode)
  19089. (setq day (get-text-property (point) 'day))
  19090. (if day
  19091. (setq date (calendar-gregorian-from-absolute day)
  19092. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  19093. (nth 2 date))))))
  19094. (or defd (current-time))))
  19095. (defvar org-agenda-action-marker (make-marker)
  19096. "Marker pointing to the entry for the next agenda action.")
  19097. (defun org-mark-entry-for-agenda-action ()
  19098. "Mark the current entry as target of an agenda action.
  19099. Agenda actions are actions executed from the agenda with the key `k',
  19100. which make use of the date at the cursor."
  19101. (interactive)
  19102. (move-marker org-agenda-action-marker
  19103. (save-excursion (org-back-to-heading t) (point))
  19104. (current-buffer))
  19105. (message
  19106. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  19107. (defun org-mark-subtree (&optional up)
  19108. "Mark the current subtree.
  19109. This puts point at the start of the current subtree, and mark at
  19110. the end. If a numeric prefix UP is given, move up into the
  19111. hierarchy of headlines by UP levels before marking the subtree."
  19112. (interactive "P")
  19113. (org-with-limited-levels
  19114. (cond ((org-at-heading-p) (beginning-of-line))
  19115. ((org-before-first-heading-p) (error "Not in a subtree"))
  19116. (t (outline-previous-visible-heading 1))))
  19117. (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
  19118. (if (org-called-interactively-p 'any)
  19119. (call-interactively 'org-mark-element)
  19120. (org-mark-element)))
  19121. ;;; Indentation
  19122. (defun org-indent-line ()
  19123. "Indent line depending on context."
  19124. (interactive)
  19125. (let* ((pos (point))
  19126. (itemp (org-at-item-p))
  19127. (case-fold-search t)
  19128. (org-drawer-regexp (or org-drawer-regexp "\000"))
  19129. (inline-task-p (and (featurep 'org-inlinetask)
  19130. (org-inlinetask-in-task-p)))
  19131. (inline-re (and inline-task-p
  19132. (org-inlinetask-outline-regexp)))
  19133. column)
  19134. (if (and orgstruct-is-++ (eq pos (point)))
  19135. (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
  19136. (indent-according-to-mode))
  19137. (beginning-of-line 1)
  19138. (cond
  19139. ;; Headings
  19140. ((looking-at org-outline-regexp) (setq column 0))
  19141. ;; Included files
  19142. ((looking-at "#\\+include:") (setq column 0))
  19143. ;; Footnote definition
  19144. ((looking-at org-footnote-definition-re) (setq column 0))
  19145. ;; Literal examples
  19146. ((looking-at "[ \t]*:\\( \\|$\\)")
  19147. (setq column (org-get-indentation))) ; do nothing
  19148. ;; Lists
  19149. ((ignore-errors (goto-char (org-in-item-p)))
  19150. (setq column (if itemp
  19151. (org-get-indentation)
  19152. (org-list-item-body-column (point))))
  19153. (goto-char pos))
  19154. ;; Drawers
  19155. ((and (looking-at "[ \t]*:END:")
  19156. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  19157. (save-excursion
  19158. (goto-char (1- (match-beginning 1)))
  19159. (setq column (current-column))))
  19160. ;; Special blocks
  19161. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  19162. (save-excursion
  19163. (re-search-backward
  19164. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  19165. (setq column (org-get-indentation (match-string 0))))
  19166. ((and (not (looking-at "[ \t]*#\\+begin_"))
  19167. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  19168. (save-excursion
  19169. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  19170. (setq column
  19171. (cond ((equal (downcase (match-string 1)) "src")
  19172. ;; src blocks: let `org-edit-src-exit' handle them
  19173. (org-get-indentation))
  19174. ((equal (downcase (match-string 1)) "example")
  19175. (max (org-get-indentation)
  19176. (org-get-indentation (match-string 0))))
  19177. (t
  19178. (org-get-indentation (match-string 0))))))
  19179. ;; This line has nothing special, look at the previous relevant
  19180. ;; line to compute indentation
  19181. (t
  19182. (beginning-of-line 0)
  19183. (while (and (not (bobp))
  19184. (not (looking-at org-drawer-regexp))
  19185. ;; When point started in an inline task, do not move
  19186. ;; above task starting line.
  19187. (not (and inline-task-p (looking-at inline-re)))
  19188. ;; Skip drawers, blocks, empty lines, verbatim,
  19189. ;; comments, tables, footnotes definitions, lists,
  19190. ;; inline tasks.
  19191. (or (and (looking-at "[ \t]*:END:")
  19192. (re-search-backward org-drawer-regexp nil t))
  19193. (and (looking-at "[ \t]*#\\+end_")
  19194. (re-search-backward "[ \t]*#\\+begin_"nil t))
  19195. (looking-at "[ \t]*[\n:#|]")
  19196. (looking-at org-footnote-definition-re)
  19197. (and (ignore-errors (goto-char (org-in-item-p)))
  19198. (goto-char
  19199. (org-list-get-top-point (org-list-struct))))
  19200. (and (not inline-task-p)
  19201. (featurep 'org-inlinetask)
  19202. (org-inlinetask-in-task-p)
  19203. (or (org-inlinetask-goto-beginning) t))))
  19204. (beginning-of-line 0))
  19205. (cond
  19206. ;; There was an heading above.
  19207. ((looking-at "\\*+[ \t]+")
  19208. (if (not org-adapt-indentation)
  19209. (setq column 0)
  19210. (goto-char (match-end 0))
  19211. (setq column (current-column))))
  19212. ;; A drawer had started and is unfinished
  19213. ((looking-at org-drawer-regexp)
  19214. (goto-char (1- (match-beginning 1)))
  19215. (setq column (current-column)))
  19216. ;; Else, nothing noticeable found: get indentation and go on.
  19217. (t (setq column (org-get-indentation))))))
  19218. ;; Now apply indentation and move cursor accordingly
  19219. (goto-char pos)
  19220. (if (<= (current-column) (current-indentation))
  19221. (org-indent-line-to column)
  19222. (save-excursion (org-indent-line-to column)))
  19223. ;; Special polishing for properties, see `org-property-format'
  19224. (setq column (current-column))
  19225. (beginning-of-line 1)
  19226. (if (looking-at
  19227. "\\([ \t]*\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  19228. (replace-match (concat (match-string 1)
  19229. (format org-property-format
  19230. (match-string 2) (match-string 3)))
  19231. t t))
  19232. (org-move-to-column column))))
  19233. (defun org-indent-drawer ()
  19234. "Indent the drawer at point."
  19235. (interactive)
  19236. (let ((p (point))
  19237. (e (and (save-excursion (re-search-forward ":END:" nil t))
  19238. (match-end 0)))
  19239. (folded
  19240. (save-excursion
  19241. (end-of-line)
  19242. (when (overlays-at (point))
  19243. (member 'invisible (overlay-properties
  19244. (car (overlays-at (point)))))))))
  19245. (when folded (org-cycle))
  19246. (indent-for-tab-command)
  19247. (while (and (move-beginning-of-line 2) (< (point) e))
  19248. (indent-for-tab-command))
  19249. (goto-char p)
  19250. (when folded (org-cycle)))
  19251. (message "Drawer at point indented"))
  19252. (defun org-indent-block ()
  19253. "Indent the block at point."
  19254. (interactive)
  19255. (let ((p (point))
  19256. (case-fold-search t)
  19257. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  19258. (match-end 0)))
  19259. (folded
  19260. (save-excursion
  19261. (end-of-line)
  19262. (when (overlays-at (point))
  19263. (member 'invisible (overlay-properties
  19264. (car (overlays-at (point)))))))))
  19265. (when folded (org-cycle))
  19266. (indent-for-tab-command)
  19267. (while (and (move-beginning-of-line 2) (< (point) e))
  19268. (indent-for-tab-command))
  19269. (goto-char p)
  19270. (when folded (org-cycle)))
  19271. (message "Block at point indented"))
  19272. (defun org-indent-region (start end)
  19273. "Indent region."
  19274. (interactive "r")
  19275. (save-excursion
  19276. (let ((line-end (org-current-line end)))
  19277. (goto-char start)
  19278. (while (< (org-current-line) line-end)
  19279. (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
  19280. (t (call-interactively 'org-indent-line)))
  19281. (move-beginning-of-line 2)))))
  19282. ;;; Filling
  19283. ;; We use our own fill-paragraph and auto-fill functions.
  19284. ;; `org-fill-paragraph' relies on adaptive filling and context
  19285. ;; checking. Appropriate `fill-prefix' is computed with
  19286. ;; `org-adaptive-fill-function'.
  19287. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  19288. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  19289. ;; `org-adaptive-fill-function' value. Internally,
  19290. ;; `org-comment-line-break-function' breaks the line.
  19291. ;; `org-setup-filling' installs filling and auto-filling related
  19292. ;; variables during `org-mode' initialization.
  19293. (defun org-setup-filling ()
  19294. (interactive)
  19295. ;; Prevent auto-fill from inserting unwanted new items.
  19296. (when (boundp 'fill-nobreak-predicate)
  19297. (org-set-local
  19298. 'fill-nobreak-predicate
  19299. (org-uniquify
  19300. (append fill-nobreak-predicate
  19301. '(org-fill-paragraph-separate-nobreak-p
  19302. org-fill-line-break-nobreak-p)))))
  19303. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  19304. (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
  19305. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  19306. (org-set-local 'comment-line-break-function 'org-comment-line-break-function)
  19307. (org-set-local 'align-mode-rules-list
  19308. '((org-in-buffer-settings
  19309. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  19310. (modes . '(org-mode))))))
  19311. (defvar org-element-paragraph-separate) ; org-element.el
  19312. (defun org-fill-paragraph-separate-nobreak-p ()
  19313. "Non-nil when a line break at point would insert a new item."
  19314. (looking-at (substring org-element-paragraph-separate 1)))
  19315. (defun org-fill-line-break-nobreak-p ()
  19316. "Non-nil when a line break at point would create an Org line break."
  19317. (save-excursion
  19318. (skip-chars-backward "[ \t]")
  19319. (skip-chars-backward "\\\\")
  19320. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  19321. (declare-function message-in-body-p "message" ())
  19322. (defvar org-element--affiliated-re) ; From org-element.el
  19323. (defun org-adaptive-fill-function ()
  19324. "Compute a fill prefix for the current line.
  19325. Return fill prefix, as a string, or nil if current line isn't
  19326. meant to be filled."
  19327. (org-with-wide-buffer
  19328. (unless (and (derived-mode-p 'message-mode) (not (message-in-body-p)))
  19329. ;; FIXME: This is really the job of orgstruct++-mode
  19330. (let* ((p (line-beginning-position))
  19331. (element (save-excursion (beginning-of-line)
  19332. (org-element-at-point)))
  19333. (type (org-element-type element))
  19334. (post-affiliated
  19335. (save-excursion
  19336. (goto-char (org-element-property :begin element))
  19337. (while (looking-at org-element--affiliated-re) (forward-line))
  19338. (point))))
  19339. (unless (< p post-affiliated)
  19340. (case type
  19341. (comment (looking-at "[ \t]*# ?") (match-string 0))
  19342. (footnote-definition "")
  19343. ((item plain-list)
  19344. (make-string (org-list-item-body-column post-affiliated) ? ))
  19345. (paragraph
  19346. ;; Fill prefix is usually the same as the current line,
  19347. ;; except if the paragraph is at the beginning of an item.
  19348. (let ((parent (org-element-property :parent element)))
  19349. (cond ((eq (org-element-type parent) 'item)
  19350. (make-string (org-list-item-body-column
  19351. (org-element-property :begin parent))
  19352. ? ))
  19353. ((looking-at "[ \t]+") (match-string 0))
  19354. (t ""))))
  19355. (comment-block
  19356. ;; Only fill contents if P is within block boundaries.
  19357. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  19358. (forward-line)
  19359. (point)))
  19360. (cend (save-excursion
  19361. (goto-char (org-element-property :end element))
  19362. (skip-chars-backward " \r\t\n")
  19363. (line-beginning-position))))
  19364. (when (and (>= p cbeg) (< p cend))
  19365. (if (looking-at "[ \t]+") (match-string 0) ""))))))))))
  19366. (declare-function message-goto-body "message" ())
  19367. (defvar message-cite-prefix-regexp) ; From message.el
  19368. (defvar org-element-all-objects) ; From org-element.el
  19369. (defun org-fill-paragraph (&optional justify)
  19370. "Fill element at point, when applicable.
  19371. This function only applies to comment blocks, comments, example
  19372. blocks and paragraphs. Also, as a special case, re-align table
  19373. when point is at one.
  19374. If JUSTIFY is non-nil (interactively, with prefix argument),
  19375. justify as well. If `sentence-end-double-space' is non-nil, then
  19376. period followed by one space does not end a sentence, so don't
  19377. break a line there. The variable `fill-column' controls the
  19378. width for filling.
  19379. For convenience, when point is at a plain list, an item or
  19380. a footnote definition, try to fill the first paragraph within."
  19381. ;; Falls back on message-fill-paragraph when necessary
  19382. (interactive)
  19383. (if (and (derived-mode-p 'message-mode)
  19384. (or (not (message-in-body-p))
  19385. (save-excursion (move-beginning-of-line 1)
  19386. (looking-at message-cite-prefix-regexp))))
  19387. (let ((fill-paragraph-function
  19388. (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
  19389. (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
  19390. (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
  19391. (paragraph-separate
  19392. (cadadr (assoc 'paragraph-separate org-fb-vars))))
  19393. (fill-paragraph nil))
  19394. (save-excursion
  19395. ;; Move to end of line in order to get the first paragraph
  19396. ;; within a plain list or a footnote definition.
  19397. (end-of-line)
  19398. (let ((element (org-element-at-point)))
  19399. ;; First check if point is in a blank line at the beginning of
  19400. ;; the buffer. In that case, ignore filling.
  19401. (if (< (point) (org-element-property :begin element)) t
  19402. (case (org-element-type element)
  19403. ;; Align Org tables, leave table.el tables as-is.
  19404. (table-row (org-table-align) t)
  19405. (table
  19406. (when (eq (org-element-property :type element) 'org)
  19407. (org-table-align))
  19408. t)
  19409. (paragraph
  19410. ;; Paragraphs may contain `line-break' type objects.
  19411. (let ((beg (max (point-min)
  19412. (org-element-property :contents-begin element)))
  19413. (end (min (point-max)
  19414. (org-element-property :contents-end element))))
  19415. ;; Do nothing if point is at an affiliated keyword.
  19416. (if (< (point) beg) t
  19417. (when (derived-mode-p 'message-mode)
  19418. ;; In `message-mode', do not fill following
  19419. ;; citation in current paragraph nor text before
  19420. ;; message body.
  19421. (let ((body-start (save-excursion (message-goto-body))))
  19422. (when body-start (setq beg (max body-start beg))))
  19423. (when (save-excursion
  19424. (re-search-forward
  19425. (concat "^" message-cite-prefix-regexp) end t))
  19426. (setq end (match-beginning 0))))
  19427. ;; Fill paragraph, taking line breaks into
  19428. ;; consideration. For that, slice the paragraph
  19429. ;; using line breaks as separators, and fill the
  19430. ;; parts in reverse order to avoid messing with
  19431. ;; markers.
  19432. (save-excursion
  19433. (goto-char end)
  19434. (mapc
  19435. (lambda (pos)
  19436. (fill-region-as-paragraph pos (point) justify)
  19437. (goto-char pos))
  19438. ;; Find the list of ending positions for line
  19439. ;; breaks in the current paragraph. Add paragraph
  19440. ;; beginning to include first slice.
  19441. (nreverse
  19442. (cons
  19443. beg
  19444. (org-element-map
  19445. (org-element--parse-objects
  19446. beg end nil org-element-all-objects)
  19447. 'line-break
  19448. (lambda (lb) (org-element-property :end lb)))))))
  19449. t)))
  19450. ;; Contents of `comment-block' type elements should be
  19451. ;; filled as plain text, but only if point is within block
  19452. ;; markers.
  19453. (comment-block
  19454. (let* ((case-fold-search t)
  19455. (beg (save-excursion
  19456. (goto-char (org-element-property :begin element))
  19457. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  19458. (forward-line)
  19459. (point)))
  19460. (end (save-excursion
  19461. (goto-char (org-element-property :end element))
  19462. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  19463. (line-beginning-position))))
  19464. (when (and (>= (point) beg) (< (point) end))
  19465. (fill-region-as-paragraph
  19466. (save-excursion
  19467. (end-of-line)
  19468. (re-search-backward "^[ \t]*$" beg 'move)
  19469. (line-beginning-position))
  19470. (save-excursion
  19471. (beginning-of-line)
  19472. (re-search-forward "^[ \t]*$" end 'move)
  19473. (line-beginning-position))
  19474. justify)))
  19475. t)
  19476. ;; Fill comments.
  19477. (comment (fill-comment-paragraph justify))
  19478. ;; Ignore every other element.
  19479. (otherwise t)))))))
  19480. (defun org-auto-fill-function ()
  19481. "Auto-fill function."
  19482. ;; Check if auto-filling is meaningful.
  19483. (let ((fc (current-fill-column)))
  19484. (when (and fc (> (current-column) fc))
  19485. (let ((fill-prefix (org-adaptive-fill-function)))
  19486. (when fill-prefix (do-auto-fill))))))
  19487. (defun org-comment-line-break-function (&optional soft)
  19488. "Break line at point and indent, continuing comment if within one.
  19489. The inserted newline is marked hard if variable
  19490. `use-hard-newlines' is true, unless optional argument SOFT is
  19491. non-nil."
  19492. (if soft (insert-and-inherit ?\n) (newline 1))
  19493. (save-excursion (forward-char -1) (delete-horizontal-space))
  19494. (delete-horizontal-space)
  19495. (indent-to-left-margin)
  19496. (insert-before-markers-and-inherit fill-prefix))
  19497. ;;; Comments
  19498. ;; Org comments syntax is quite complex. It requires the entire line
  19499. ;; to be just a comment. Also, even with the right syntax at the
  19500. ;; beginning of line, some some elements (i.e. verse-block or
  19501. ;; example-block) don't accept comments. Usual Emacs comment commands
  19502. ;; cannot cope with those requirements. Therefore, Org replaces them.
  19503. ;; Org still relies on `comment-dwim', but cannot trust
  19504. ;; `comment-only-p'. So, `comment-region-function' and
  19505. ;; `uncomment-region-function' both point
  19506. ;; to`org-comment-or-uncomment-region'. Eventually,
  19507. ;; `org-insert-comment' takes care of insertion of comments at the
  19508. ;; beginning of line.
  19509. ;; `org-setup-comments-handling' install comments related variables
  19510. ;; during `org-mode' initialization.
  19511. (defun org-setup-comments-handling ()
  19512. (interactive)
  19513. (org-set-local 'comment-use-syntax nil)
  19514. (org-set-local 'comment-start "# ")
  19515. (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  19516. (org-set-local 'comment-insert-comment-function 'org-insert-comment)
  19517. (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
  19518. (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
  19519. (defun org-insert-comment ()
  19520. "Insert an empty comment above current line.
  19521. If the line is empty, insert comment at its beginning."
  19522. (beginning-of-line)
  19523. (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
  19524. (org-indent-line)
  19525. (insert "# "))
  19526. (defvar comment-empty-lines) ; From newcomment.el.
  19527. (defun org-comment-or-uncomment-region (beg end &rest ignore)
  19528. "Comment or uncomment each non-blank line in the region.
  19529. Uncomment each non-blank line between BEG and END if it only
  19530. contains commented lines. Otherwise, comment them."
  19531. (save-restriction
  19532. ;; Restrict region
  19533. (narrow-to-region (save-excursion (goto-char beg)
  19534. (skip-chars-forward " \r\t\n" end)
  19535. (line-beginning-position))
  19536. (save-excursion (goto-char end)
  19537. (skip-chars-backward " \r\t\n" beg)
  19538. (line-end-position)))
  19539. (let ((uncommentp
  19540. ;; UNCOMMENTP is non-nil when every non blank line between
  19541. ;; BEG and END is a comment.
  19542. (save-excursion
  19543. (goto-char (point-min))
  19544. (while (and (not (eobp))
  19545. (let ((element (org-element-at-point)))
  19546. (and (eq (org-element-type element) 'comment)
  19547. (goto-char (min (point-max)
  19548. (org-element-property
  19549. :end element)))))))
  19550. (eobp))))
  19551. (if uncommentp
  19552. ;; Only blank lines and comments in region: uncomment it.
  19553. (save-excursion
  19554. (goto-char (point-min))
  19555. (while (not (eobp))
  19556. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  19557. (replace-match "" nil nil nil 1))
  19558. (forward-line)))
  19559. ;; Comment each line in region.
  19560. (let ((min-indent (point-max)))
  19561. ;; First find the minimum indentation across all lines.
  19562. (save-excursion
  19563. (goto-char (point-min))
  19564. (while (and (not (eobp)) (not (zerop min-indent)))
  19565. (unless (looking-at "[ \t]*$")
  19566. (setq min-indent (min min-indent (current-indentation))))
  19567. (forward-line)))
  19568. ;; Then loop over all lines.
  19569. (save-excursion
  19570. (goto-char (point-min))
  19571. (while (not (eobp))
  19572. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  19573. (org-move-to-column min-indent t)
  19574. (insert comment-start))
  19575. (forward-line))))))))
  19576. ;;; Other stuff.
  19577. (defun org-toggle-fixed-width-section (arg)
  19578. "Toggle the fixed-width export.
  19579. If there is no active region, the QUOTE keyword at the current headline is
  19580. inserted or removed. When present, it causes the text between this headline
  19581. and the next to be exported as fixed-width text, and unmodified.
  19582. If there is an active region, this command adds or removes a colon as the
  19583. first character of this line. If the first character of a line is a colon,
  19584. this line is also exported in fixed-width font."
  19585. (interactive "P")
  19586. (let* ((cc 0)
  19587. (regionp (org-region-active-p))
  19588. (beg (if regionp (region-beginning) (point)))
  19589. (end (if regionp (region-end)))
  19590. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  19591. (case-fold-search nil)
  19592. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  19593. off)
  19594. (if regionp
  19595. (save-excursion
  19596. (goto-char beg)
  19597. (setq cc (current-column))
  19598. (beginning-of-line 1)
  19599. (setq off (looking-at re))
  19600. (while (> nlines 0)
  19601. (setq nlines (1- nlines))
  19602. (beginning-of-line 1)
  19603. (cond
  19604. (arg
  19605. (org-move-to-column cc t)
  19606. (insert ": \n")
  19607. (forward-line -1))
  19608. ((and off (looking-at re))
  19609. (replace-match "" t t nil 1))
  19610. ((not off) (org-move-to-column cc t) (insert ": ")))
  19611. (forward-line 1)))
  19612. (save-excursion
  19613. (org-back-to-heading)
  19614. (cond
  19615. ((looking-at (format org-heading-keyword-regexp-format
  19616. org-quote-string))
  19617. (goto-char (match-end 1))
  19618. (looking-at (concat " +" org-quote-string))
  19619. (replace-match "" t t)
  19620. (when (eolp) (insert " ")))
  19621. ((looking-at org-outline-regexp)
  19622. (goto-char (match-end 0))
  19623. (insert org-quote-string " ")))))))
  19624. (defun org-reftex-citation ()
  19625. "Use reftex-citation to insert a citation into the buffer.
  19626. This looks for a line like
  19627. #+BIBLIOGRAPHY: foo plain option:-d
  19628. and derives from it that foo.bib is the bibliography file relevant
  19629. for this document. It then installs the necessary environment for RefTeX
  19630. to work in this buffer and calls `reftex-citation' to insert a citation
  19631. into the buffer.
  19632. Export of such citations to both LaTeX and HTML is handled by the contributed
  19633. package org-exp-bibtex by Taru Karttunen."
  19634. (interactive)
  19635. (let ((reftex-docstruct-symbol 'rds)
  19636. (reftex-cite-format "\\cite{%l}")
  19637. rds bib)
  19638. (save-excursion
  19639. (save-restriction
  19640. (widen)
  19641. (let ((case-fold-search t)
  19642. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  19643. (if (not (save-excursion
  19644. (or (re-search-forward re nil t)
  19645. (re-search-backward re nil t))))
  19646. (error "No bibliography defined in file")
  19647. (setq bib (concat (match-string 1) ".bib")
  19648. rds (list (list 'bib bib)))))))
  19649. (call-interactively 'reftex-citation)))
  19650. ;;;; Functions extending outline functionality
  19651. (defun org-beginning-of-line (&optional arg)
  19652. "Go to the beginning of the current line. If that is invisible, continue
  19653. to a visible line beginning. This makes the function of C-a more intuitive.
  19654. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19655. first attempt, and only move to after the tags when the cursor is already
  19656. beyond the end of the headline."
  19657. (interactive "P")
  19658. (let ((pos (point))
  19659. (special (if (consp org-special-ctrl-a/e)
  19660. (car org-special-ctrl-a/e)
  19661. org-special-ctrl-a/e))
  19662. refpos)
  19663. (if (org-bound-and-true-p line-move-visual)
  19664. (beginning-of-visual-line 1)
  19665. (beginning-of-line 1))
  19666. (if (and arg (fboundp 'move-beginning-of-line))
  19667. (call-interactively 'move-beginning-of-line)
  19668. (if (bobp)
  19669. nil
  19670. (backward-char 1)
  19671. (if (org-truely-invisible-p)
  19672. (while (and (not (bobp)) (org-truely-invisible-p))
  19673. (backward-char 1)
  19674. (beginning-of-line 1))
  19675. (forward-char 1))))
  19676. (when special
  19677. (cond
  19678. ((and (looking-at org-complex-heading-regexp)
  19679. (= (char-after (match-end 1)) ?\ ))
  19680. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  19681. (point-at-eol)))
  19682. (goto-char
  19683. (if (eq special t)
  19684. (cond ((> pos refpos) refpos)
  19685. ((= pos (point)) refpos)
  19686. (t (point)))
  19687. (cond ((> pos (point)) (point))
  19688. ((not (eq last-command this-command)) (point))
  19689. (t refpos)))))
  19690. ((org-at-item-p)
  19691. ;; Being at an item and not looking at an the item means point
  19692. ;; was previously moved to beginning of a visual line, which
  19693. ;; doesn't contain the item. Therefore, do nothing special,
  19694. ;; just stay here.
  19695. (when (looking-at org-list-full-item-re)
  19696. ;; Set special position at first white space character after
  19697. ;; bullet, and check-box, if any.
  19698. (let ((after-bullet
  19699. (let ((box (match-end 3)))
  19700. (if (not box) (match-end 1)
  19701. (let ((after (char-after box)))
  19702. (if (and after (= after ? )) (1+ box) box))))))
  19703. ;; Special case: Move point to special position when
  19704. ;; currently after it or at beginning of line.
  19705. (if (eq special t)
  19706. (when (or (> pos after-bullet) (= (point) pos))
  19707. (goto-char after-bullet))
  19708. ;; Reversed case: Move point to special position when
  19709. ;; point was already at beginning of line and command is
  19710. ;; repeated.
  19711. (when (and (= (point) pos) (eq last-command this-command))
  19712. (goto-char after-bullet))))))))
  19713. (org-no-warnings
  19714. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19715. (defun org-end-of-line (&optional arg)
  19716. "Go to the end of the line.
  19717. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19718. first attempt, and only move to after the tags when the cursor is already
  19719. beyond the end of the headline."
  19720. (interactive "P")
  19721. (let ((special (if (consp org-special-ctrl-a/e)
  19722. (cdr org-special-ctrl-a/e)
  19723. org-special-ctrl-a/e)))
  19724. (cond
  19725. ((or (not special) arg
  19726. (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
  19727. (call-interactively
  19728. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19729. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19730. (t 'end-of-line))))
  19731. ((org-at-heading-p)
  19732. (let ((pos (point)))
  19733. (beginning-of-line 1)
  19734. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  19735. (if (eq special t)
  19736. (if (or (< pos (match-beginning 1))
  19737. (= pos (match-end 0)))
  19738. (goto-char (match-beginning 1))
  19739. (goto-char (match-end 0)))
  19740. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  19741. (goto-char (match-end 0))
  19742. (goto-char (match-beginning 1))))
  19743. (call-interactively (if (fboundp 'move-end-of-line)
  19744. 'move-end-of-line
  19745. 'end-of-line)))))
  19746. ((org-at-drawer-p)
  19747. (move-end-of-line 1)
  19748. (when (overlays-at (1- (point))) (backward-char 1)))
  19749. ;; At an item: Move before any hidden text.
  19750. (t (call-interactively
  19751. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19752. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19753. (t 'end-of-line)))))
  19754. (org-no-warnings
  19755. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19756. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  19757. (define-key org-mode-map "\C-e" 'org-end-of-line)
  19758. (defun org-backward-sentence (&optional arg)
  19759. "Go to beginning of sentence, or beginning of table field.
  19760. This will call `backward-sentence' or `org-table-beginning-of-field',
  19761. depending on context."
  19762. (interactive "P")
  19763. (cond
  19764. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  19765. (t (call-interactively 'backward-sentence))))
  19766. (defun org-forward-sentence (&optional arg)
  19767. "Go to end of sentence, or end of table field.
  19768. This will call `forward-sentence' or `org-table-end-of-field',
  19769. depending on context."
  19770. (interactive "P")
  19771. (cond
  19772. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  19773. (t (call-interactively 'forward-sentence))))
  19774. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  19775. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  19776. (defun org-kill-line (&optional arg)
  19777. "Kill line, to tags or end of line."
  19778. (interactive "P")
  19779. (cond
  19780. ((or (not org-special-ctrl-k)
  19781. (bolp)
  19782. (not (org-at-heading-p)))
  19783. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  19784. org-ctrl-k-protect-subtree)
  19785. (if (or (eq org-ctrl-k-protect-subtree 'error)
  19786. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  19787. (error "C-k aborted - would kill hidden subtree")))
  19788. (call-interactively
  19789. (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
  19790. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  19791. (kill-region (point) (match-beginning 1))
  19792. (org-set-tags nil t))
  19793. (t (kill-region (point) (point-at-eol)))))
  19794. (define-key org-mode-map "\C-k" 'org-kill-line)
  19795. (defun org-yank (&optional arg)
  19796. "Yank. If the kill is a subtree, treat it specially.
  19797. This command will look at the current kill and check if is a single
  19798. subtree, or a series of subtrees[1]. If it passes the test, and if the
  19799. cursor is at the beginning of a line or after the stars of a currently
  19800. empty headline, then the yank is handled specially. How exactly depends
  19801. on the value of the following variables, both set by default.
  19802. org-yank-folded-subtrees
  19803. When set, the subtree(s) will be folded after insertion, but only
  19804. if doing so would now swallow text after the yanked text.
  19805. org-yank-adjusted-subtrees
  19806. When set, the subtree will be promoted or demoted in order to
  19807. fit into the local outline tree structure, which means that the level
  19808. will be adjusted so that it becomes the smaller one of the two
  19809. *visible* surrounding headings.
  19810. Any prefix to this command will cause `yank' to be called directly with
  19811. no special treatment. In particular, a simple \\[universal-argument] prefix \
  19812. will just
  19813. plainly yank the text as it is.
  19814. \[1] The test checks if the first non-white line is a heading
  19815. and if there are no other headings with fewer stars."
  19816. (interactive "P")
  19817. (org-yank-generic 'yank arg))
  19818. (defun org-yank-generic (command arg)
  19819. "Perform some yank-like command.
  19820. This function implements the behavior described in the `org-yank'
  19821. documentation. However, it has been generalized to work for any
  19822. interactive command with similar behavior."
  19823. ;; pretend to be command COMMAND
  19824. (setq this-command command)
  19825. (if arg
  19826. (call-interactively command)
  19827. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  19828. (and (org-kill-is-subtree-p)
  19829. (or (bolp)
  19830. (and (looking-at "[ \t]*$")
  19831. (string-match
  19832. "\\`\\*+\\'"
  19833. (buffer-substring (point-at-bol) (point)))))))
  19834. swallowp)
  19835. (cond
  19836. ((and subtreep org-yank-folded-subtrees)
  19837. (let ((beg (point))
  19838. end)
  19839. (if (and subtreep org-yank-adjusted-subtrees)
  19840. (org-paste-subtree nil nil 'for-yank)
  19841. (call-interactively command))
  19842. (setq end (point))
  19843. (goto-char beg)
  19844. (when (and (bolp) subtreep
  19845. (not (setq swallowp
  19846. (org-yank-folding-would-swallow-text beg end))))
  19847. (org-with-limited-levels
  19848. (or (looking-at org-outline-regexp)
  19849. (re-search-forward org-outline-regexp-bol end t))
  19850. (while (and (< (point) end) (looking-at org-outline-regexp))
  19851. (hide-subtree)
  19852. (org-cycle-show-empty-lines 'folded)
  19853. (condition-case nil
  19854. (outline-forward-same-level 1)
  19855. (error (goto-char end))))))
  19856. (when swallowp
  19857. (message
  19858. "Inserted text not folded because that would swallow text"))
  19859. (goto-char end)
  19860. (skip-chars-forward " \t\n\r")
  19861. (beginning-of-line 1)
  19862. (push-mark beg 'nomsg)))
  19863. ((and subtreep org-yank-adjusted-subtrees)
  19864. (let ((beg (point-at-bol)))
  19865. (org-paste-subtree nil nil 'for-yank)
  19866. (push-mark beg 'nomsg)))
  19867. (t
  19868. (call-interactively command))))))
  19869. (defun org-yank-folding-would-swallow-text (beg end)
  19870. "Would hide-subtree at BEG swallow any text after END?"
  19871. (let (level)
  19872. (org-with-limited-levels
  19873. (save-excursion
  19874. (goto-char beg)
  19875. (when (or (looking-at org-outline-regexp)
  19876. (re-search-forward org-outline-regexp-bol end t))
  19877. (setq level (org-outline-level)))
  19878. (goto-char end)
  19879. (skip-chars-forward " \t\r\n\v\f")
  19880. (if (or (eobp)
  19881. (and (bolp) (looking-at org-outline-regexp)
  19882. (<= (org-outline-level) level)))
  19883. nil ; Nothing would be swallowed
  19884. t))))) ; something would swallow
  19885. (define-key org-mode-map "\C-y" 'org-yank)
  19886. (defun org-truely-invisible-p ()
  19887. "Check if point is at a character currently not visible.
  19888. This version does not only check the character property, but also
  19889. `visible-mode'."
  19890. ;; Early versions of noutline don't have `outline-invisible-p'.
  19891. (if (org-bound-and-true-p visible-mode)
  19892. nil
  19893. (outline-invisible-p)))
  19894. (defun org-invisible-p2 ()
  19895. "Check if point is at a character currently not visible."
  19896. (save-excursion
  19897. (if (and (eolp) (not (bobp))) (backward-char 1))
  19898. ;; Early versions of noutline don't have `outline-invisible-p'.
  19899. (outline-invisible-p)))
  19900. (defun org-back-to-heading (&optional invisible-ok)
  19901. "Call `outline-back-to-heading', but provide a better error message."
  19902. (condition-case nil
  19903. (outline-back-to-heading invisible-ok)
  19904. (error (error "Before first headline at position %d in buffer %s"
  19905. (point) (current-buffer)))))
  19906. (defun org-before-first-heading-p ()
  19907. "Before first heading?"
  19908. (save-excursion
  19909. (end-of-line)
  19910. (null (re-search-backward org-outline-regexp-bol nil t))))
  19911. (defun org-at-heading-p (&optional ignored)
  19912. (outline-on-heading-p t))
  19913. ;; Compatibility alias with Org versions < 7.8.03
  19914. (defalias 'org-on-heading-p 'org-at-heading-p)
  19915. (defun org-at-comment-p nil
  19916. "Is cursor in a line starting with a # character?"
  19917. (save-excursion
  19918. (beginning-of-line)
  19919. (looking-at "^#")))
  19920. (defun org-at-drawer-p nil
  19921. "Is cursor at a drawer keyword?"
  19922. (save-excursion
  19923. (move-beginning-of-line 1)
  19924. (looking-at org-drawer-regexp)))
  19925. (defun org-at-block-p nil
  19926. "Is cursor at a block keyword?"
  19927. (save-excursion
  19928. (move-beginning-of-line 1)
  19929. (looking-at org-block-regexp)))
  19930. (defun org-point-at-end-of-empty-headline ()
  19931. "If point is at the end of an empty headline, return t, else nil.
  19932. If the heading only contains a TODO keyword, it is still still considered
  19933. empty."
  19934. (and (looking-at "[ \t]*$")
  19935. (when org-todo-line-regexp
  19936. (save-excursion
  19937. (beginning-of-line 1)
  19938. (let ((case-fold-search nil))
  19939. (looking-at org-todo-line-regexp)
  19940. (string= (match-string 3) ""))))))
  19941. (defun org-at-heading-or-item-p ()
  19942. (or (org-at-heading-p) (org-at-item-p)))
  19943. (defun org-at-target-p ()
  19944. (or (org-in-regexp org-radio-target-regexp)
  19945. (org-in-regexp org-target-regexp)))
  19946. ;; Compatibility alias with Org versions < 7.8.03
  19947. (defalias 'org-on-target-p 'org-at-target-p)
  19948. (defun org-up-heading-all (arg)
  19949. "Move to the heading line of which the present line is a subheading.
  19950. This function considers both visible and invisible heading lines.
  19951. With argument, move up ARG levels."
  19952. (if (fboundp 'outline-up-heading-all)
  19953. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  19954. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  19955. (defun org-up-heading-safe ()
  19956. "Move to the heading line of which the present line is a subheading.
  19957. This version will not throw an error. It will return the level of the
  19958. headline found, or nil if no higher level is found.
  19959. Also, this function will be a lot faster than `outline-up-heading',
  19960. because it relies on stars being the outline starters. This can really
  19961. make a significant difference in outlines with very many siblings."
  19962. (let (start-level re)
  19963. (org-back-to-heading t)
  19964. (setq start-level (funcall outline-level))
  19965. (if (equal start-level 1)
  19966. nil
  19967. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  19968. (if (re-search-backward re nil t)
  19969. (funcall outline-level)))))
  19970. (defun org-first-sibling-p ()
  19971. "Is this heading the first child of its parents?"
  19972. (interactive)
  19973. (let ((re org-outline-regexp-bol)
  19974. level l)
  19975. (unless (org-at-heading-p t)
  19976. (error "Not at a heading"))
  19977. (setq level (funcall outline-level))
  19978. (save-excursion
  19979. (if (not (re-search-backward re nil t))
  19980. t
  19981. (setq l (funcall outline-level))
  19982. (< l level)))))
  19983. (defun org-goto-sibling (&optional previous)
  19984. "Goto the next sibling, even if it is invisible.
  19985. When PREVIOUS is set, go to the previous sibling instead. Returns t
  19986. when a sibling was found. When none is found, return nil and don't
  19987. move point."
  19988. (let ((fun (if previous 're-search-backward 're-search-forward))
  19989. (pos (point))
  19990. (re org-outline-regexp-bol)
  19991. level l)
  19992. (when (condition-case nil (org-back-to-heading t) (error nil))
  19993. (setq level (funcall outline-level))
  19994. (catch 'exit
  19995. (or previous (forward-char 1))
  19996. (while (funcall fun re nil t)
  19997. (setq l (funcall outline-level))
  19998. (when (< l level) (goto-char pos) (throw 'exit nil))
  19999. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  20000. (goto-char pos)
  20001. nil))))
  20002. (defun org-show-siblings ()
  20003. "Show all siblings of the current headline."
  20004. (save-excursion
  20005. (while (org-goto-sibling) (org-flag-heading nil)))
  20006. (save-excursion
  20007. (while (org-goto-sibling 'previous)
  20008. (org-flag-heading nil))))
  20009. (defun org-goto-first-child ()
  20010. "Goto the first child, even if it is invisible.
  20011. Return t when a child was found. Otherwise don't move point and
  20012. return nil."
  20013. (let (level (pos (point)) (re org-outline-regexp-bol))
  20014. (when (condition-case nil (org-back-to-heading t) (error nil))
  20015. (setq level (outline-level))
  20016. (forward-char 1)
  20017. (if (and (re-search-forward re nil t) (> (outline-level) level))
  20018. (progn (goto-char (match-beginning 0)) t)
  20019. (goto-char pos) nil))))
  20020. (defun org-show-hidden-entry ()
  20021. "Show an entry where even the heading is hidden."
  20022. (save-excursion
  20023. (org-show-entry)))
  20024. (defun org-flag-heading (flag &optional entry)
  20025. "Flag the current heading. FLAG non-nil means make invisible.
  20026. When ENTRY is non-nil, show the entire entry."
  20027. (save-excursion
  20028. (org-back-to-heading t)
  20029. ;; Check if we should show the entire entry
  20030. (if entry
  20031. (progn
  20032. (org-show-entry)
  20033. (save-excursion
  20034. (and (outline-next-heading)
  20035. (org-flag-heading nil))))
  20036. (outline-flag-region (max (point-min) (1- (point)))
  20037. (save-excursion (outline-end-of-heading) (point))
  20038. flag))))
  20039. (defun org-get-next-sibling ()
  20040. "Move to next heading of the same level, and return point.
  20041. If there is no such heading, return nil.
  20042. This is like outline-next-sibling, but invisible headings are ok."
  20043. (let ((level (funcall outline-level)))
  20044. (outline-next-heading)
  20045. (while (and (not (eobp)) (> (funcall outline-level) level))
  20046. (outline-next-heading))
  20047. (if (or (eobp) (< (funcall outline-level) level))
  20048. nil
  20049. (point))))
  20050. (defun org-get-last-sibling ()
  20051. "Move to previous heading of the same level, and return point.
  20052. If there is no such heading, return nil."
  20053. (let ((opoint (point))
  20054. (level (funcall outline-level)))
  20055. (outline-previous-heading)
  20056. (when (and (/= (point) opoint) (outline-on-heading-p t))
  20057. (while (and (> (funcall outline-level) level)
  20058. (not (bobp)))
  20059. (outline-previous-heading))
  20060. (if (< (funcall outline-level) level)
  20061. nil
  20062. (point)))))
  20063. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  20064. ;; This contains an exact copy of the original function, but it uses
  20065. ;; `org-back-to-heading', to make it work also in invisible
  20066. ;; trees. And is uses an invisible-OK argument.
  20067. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  20068. ;; Furthermore, when used inside Org, finding the end of a large subtree
  20069. ;; with many children and grandchildren etc, this can be much faster
  20070. ;; than the outline version.
  20071. (org-back-to-heading invisible-OK)
  20072. (let ((first t)
  20073. (level (funcall outline-level)))
  20074. (if (and (derived-mode-p 'org-mode) (< level 1000))
  20075. ;; A true heading (not a plain list item), in Org-mode
  20076. ;; This means we can easily find the end by looking
  20077. ;; only for the right number of stars. Using a regexp to do
  20078. ;; this is so much faster than using a Lisp loop.
  20079. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  20080. (forward-char 1)
  20081. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  20082. ;; something else, do it the slow way
  20083. (while (and (not (eobp))
  20084. (or first (> (funcall outline-level) level)))
  20085. (setq first nil)
  20086. (outline-next-heading)))
  20087. (unless to-heading
  20088. (if (memq (preceding-char) '(?\n ?\^M))
  20089. (progn
  20090. ;; Go to end of line before heading
  20091. (forward-char -1)
  20092. (if (memq (preceding-char) '(?\n ?\^M))
  20093. ;; leave blank line before heading
  20094. (forward-char -1))))))
  20095. (point))
  20096. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  20097. "Use Org version in org-mode, for dramatic speed-up."
  20098. (if (derived-mode-p 'org-mode)
  20099. (progn
  20100. (org-end-of-subtree nil t)
  20101. (unless (eobp) (backward-char 1)))
  20102. ad-do-it))
  20103. (defun org-end-of-meta-data-and-drawers ()
  20104. "Jump to the first text after meta data and drawers in the current entry.
  20105. This will move over empty lines, lines with planning time stamps,
  20106. clocking lines, and drawers."
  20107. (org-back-to-heading t)
  20108. (let ((end (save-excursion (outline-next-heading) (point)))
  20109. (re (concat "\\(" org-drawer-regexp "\\)"
  20110. "\\|" "[ \t]*" org-keyword-time-regexp)))
  20111. (forward-line 1)
  20112. (while (re-search-forward re end t)
  20113. (if (not (match-end 1))
  20114. ;; empty or planning line
  20115. (forward-line 1)
  20116. ;; a drawer, find the end
  20117. (re-search-forward "^[ \t]*:END:" end 'move)
  20118. (forward-line 1)))
  20119. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  20120. (point)))
  20121. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  20122. "Move forward to the arg'th subheading at same level as this one.
  20123. Stop at the first and last subheadings of a superior heading.
  20124. Normally this only looks at visible headings, but when INVISIBLE-OK is
  20125. non-nil it will also look at invisible ones."
  20126. (interactive "p")
  20127. (org-back-to-heading invisible-ok)
  20128. (org-at-heading-p)
  20129. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20130. (re (format "^\\*\\{1,%d\\} " level))
  20131. l)
  20132. (forward-char 1)
  20133. (while (> arg 0)
  20134. (while (and (re-search-forward re nil 'move)
  20135. (setq l (- (match-end 0) (match-beginning 0) 1))
  20136. (= l level)
  20137. (not invisible-ok)
  20138. (progn (backward-char 1) (outline-invisible-p)))
  20139. (if (< l level) (setq arg 1)))
  20140. (setq arg (1- arg)))
  20141. (beginning-of-line 1)))
  20142. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  20143. "Move backward to the arg'th subheading at same level as this one.
  20144. Stop at the first and last subheadings of a superior heading."
  20145. (interactive "p")
  20146. (org-back-to-heading)
  20147. (org-at-heading-p)
  20148. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  20149. (re (format "^\\*\\{1,%d\\} " level))
  20150. l)
  20151. (while (> arg 0)
  20152. (while (and (re-search-backward re nil 'move)
  20153. (setq l (- (match-end 0) (match-beginning 0) 1))
  20154. (= l level)
  20155. (not invisible-ok)
  20156. (outline-invisible-p))
  20157. (if (< l level) (setq arg 1)))
  20158. (setq arg (1- arg)))))
  20159. ;;;###autoload
  20160. (defun org-forward-element ()
  20161. "Move forward by one element.
  20162. Move to the next element at the same level, when possible."
  20163. (interactive)
  20164. (cond ((eobp) (error "Cannot move further down"))
  20165. ((org-with-limited-levels (org-at-heading-p))
  20166. (let ((origin (point)))
  20167. (org-forward-heading-same-level 1)
  20168. (unless (org-with-limited-levels (org-at-heading-p))
  20169. (goto-char origin)
  20170. (error "Cannot move further down"))))
  20171. (t
  20172. (let* ((elem (org-element-at-point))
  20173. (end (org-element-property :end elem))
  20174. (parent (org-element-property :parent elem)))
  20175. (if (and parent (= (org-element-property :contents-end parent) end))
  20176. (goto-char (org-element-property :end parent))
  20177. (goto-char end))))))
  20178. ;;;###autoload
  20179. (defun org-backward-element ()
  20180. "Move backward by one element.
  20181. Move to the previous element at the same level, when possible."
  20182. (interactive)
  20183. (cond ((bobp) (error "Cannot move further up"))
  20184. ((org-with-limited-levels (org-at-heading-p))
  20185. ;; At an headline, move to the previous one, if any, or stay
  20186. ;; here.
  20187. (let ((origin (point)))
  20188. (org-backward-heading-same-level 1)
  20189. (unless (org-with-limited-levels (org-at-heading-p))
  20190. (goto-char origin)
  20191. (error "Cannot move further up"))))
  20192. (t
  20193. (let* ((trail (org-element-at-point 'keep-trail))
  20194. (elem (car trail))
  20195. (prev-elem (nth 1 trail))
  20196. (beg (org-element-property :begin elem)))
  20197. (cond
  20198. ;; Move to beginning of current element if point isn't
  20199. ;; there already.
  20200. ((/= (point) beg) (goto-char beg))
  20201. (prev-elem (goto-char (org-element-property :begin prev-elem)))
  20202. ((org-before-first-heading-p) (goto-char (point-min)))
  20203. (t (org-back-to-heading)))))))
  20204. ;;;###autoload
  20205. (defun org-up-element ()
  20206. "Move to upper element."
  20207. (interactive)
  20208. (if (org-with-limited-levels (org-at-heading-p))
  20209. (unless (org-up-heading-safe) (error "No surrounding element"))
  20210. (let* ((elem (org-element-at-point))
  20211. (parent (org-element-property :parent elem)))
  20212. (if parent (goto-char (org-element-property :begin parent))
  20213. (if (org-with-limited-levels (org-before-first-heading-p))
  20214. (error "No surrounding element")
  20215. (org-with-limited-levels (org-back-to-heading)))))))
  20216. ;;;###autoload
  20217. (defvar org-element-greater-elements)
  20218. (defun org-down-element ()
  20219. "Move to inner element."
  20220. (interactive)
  20221. (let ((element (org-element-at-point)))
  20222. (cond
  20223. ((memq (org-element-type element) '(plain-list table))
  20224. (goto-char (org-element-property :contents-begin element))
  20225. (forward-char))
  20226. ((memq (org-element-type element) org-element-greater-elements)
  20227. ;; If contents are hidden, first disclose them.
  20228. (when (org-element-property :hiddenp element) (org-cycle))
  20229. (goto-char (or (org-element-property :contents-begin element)
  20230. (error "No content for this element"))))
  20231. (t (error "No inner element")))))
  20232. ;;;###autoload
  20233. (defun org-drag-element-backward ()
  20234. "Move backward element at point."
  20235. (interactive)
  20236. (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
  20237. (let* ((trail (org-element-at-point 'keep-trail))
  20238. (elem (car trail))
  20239. (prev-elem (nth 1 trail)))
  20240. ;; Error out if no previous element or previous element is
  20241. ;; a parent of the current one.
  20242. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  20243. (error "Cannot drag element backward")
  20244. (let ((pos (point)))
  20245. (org-element-swap-A-B prev-elem elem)
  20246. (goto-char (+ (org-element-property :begin prev-elem)
  20247. (- pos (org-element-property :begin elem)))))))))
  20248. ;;;###autoload
  20249. (defun org-drag-element-forward ()
  20250. "Move forward element at point."
  20251. (interactive)
  20252. (let* ((pos (point))
  20253. (elem (org-element-at-point)))
  20254. (when (= (point-max) (org-element-property :end elem))
  20255. (error "Cannot drag element forward"))
  20256. (goto-char (org-element-property :end elem))
  20257. (let ((next-elem (org-element-at-point)))
  20258. (when (or (org-element-nested-p elem next-elem)
  20259. (and (eq (org-element-type next-elem) 'headline)
  20260. (not (eq (org-element-type elem) 'headline))))
  20261. (goto-char pos)
  20262. (error "Cannot drag element forward"))
  20263. ;; Compute new position of point: it's shifted by NEXT-ELEM
  20264. ;; body's length (without final blanks) and by the length of
  20265. ;; blanks between ELEM and NEXT-ELEM.
  20266. (let ((size-next (- (save-excursion
  20267. (goto-char (org-element-property :end next-elem))
  20268. (skip-chars-backward " \r\t\n")
  20269. (forward-line)
  20270. ;; Small correction if buffer doesn't end
  20271. ;; with a newline character.
  20272. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  20273. (org-element-property :begin next-elem)))
  20274. (size-blank (- (org-element-property :end elem)
  20275. (save-excursion
  20276. (goto-char (org-element-property :end elem))
  20277. (skip-chars-backward " \r\t\n")
  20278. (forward-line)
  20279. (point)))))
  20280. (org-element-swap-A-B elem next-elem)
  20281. (goto-char (+ pos size-next size-blank))))))
  20282. ;;;###autoload
  20283. (defun org-mark-element ()
  20284. "Put point at beginning of this element, mark at end.
  20285. Interactively, if this command is repeated or (in Transient Mark
  20286. mode) if the mark is active, it marks the next element after the
  20287. ones already marked."
  20288. (interactive)
  20289. (let (deactivate-mark)
  20290. (if (and (org-called-interactively-p 'any)
  20291. (or (and (eq last-command this-command) (mark t))
  20292. (and transient-mark-mode mark-active)))
  20293. (set-mark
  20294. (save-excursion
  20295. (goto-char (mark))
  20296. (goto-char (org-element-property :end (org-element-at-point)))))
  20297. (let ((element (org-element-at-point)))
  20298. (end-of-line)
  20299. (push-mark (org-element-property :end element) t t)
  20300. (goto-char (org-element-property :begin element))))))
  20301. ;;;###autoload
  20302. (defun org-narrow-to-element ()
  20303. "Narrow buffer to current element."
  20304. (interactive)
  20305. (let ((elem (org-element-at-point)))
  20306. (cond
  20307. ((eq (car elem) 'headline)
  20308. (narrow-to-region
  20309. (org-element-property :begin elem)
  20310. (org-element-property :end elem)))
  20311. ((memq (car elem) org-element-greater-elements)
  20312. (narrow-to-region
  20313. (org-element-property :contents-begin elem)
  20314. (org-element-property :contents-end elem)))
  20315. (t
  20316. (narrow-to-region
  20317. (org-element-property :begin elem)
  20318. (org-element-property :end elem))))))
  20319. ;;;###autoload
  20320. (defun org-transpose-element ()
  20321. "Transpose current and previous elements, keeping blank lines between.
  20322. Point is moved after both elements."
  20323. (interactive)
  20324. (org-skip-whitespace)
  20325. (let ((end (org-element-property :end (org-element-at-point))))
  20326. (org-drag-element-backward)
  20327. (goto-char end)))
  20328. ;;;###autoload
  20329. (defun org-unindent-buffer ()
  20330. "Un-indent the visible part of the buffer.
  20331. Relative indentation (between items, inside blocks, etc.) isn't
  20332. modified."
  20333. (interactive)
  20334. (unless (eq major-mode 'org-mode)
  20335. (error "Cannot un-indent a buffer not in Org mode"))
  20336. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  20337. unindent-tree ; For byte-compiler.
  20338. (unindent-tree
  20339. (function
  20340. (lambda (contents)
  20341. (mapc
  20342. (lambda (element)
  20343. (if (memq (org-element-type element) '(headline section))
  20344. (funcall unindent-tree (org-element-contents element))
  20345. (save-excursion
  20346. (save-restriction
  20347. (narrow-to-region
  20348. (org-element-property :begin element)
  20349. (org-element-property :end element))
  20350. (org-do-remove-indentation)))))
  20351. (reverse contents))))))
  20352. (funcall unindent-tree (org-element-contents parse-tree))))
  20353. (defun org-show-subtree ()
  20354. "Show everything after this heading at deeper levels."
  20355. (interactive)
  20356. (outline-flag-region
  20357. (point)
  20358. (save-excursion
  20359. (org-end-of-subtree t t))
  20360. nil))
  20361. (defun org-show-entry ()
  20362. "Show the body directly following this heading.
  20363. Show the heading too, if it is currently invisible."
  20364. (interactive)
  20365. (save-excursion
  20366. (condition-case nil
  20367. (progn
  20368. (org-back-to-heading t)
  20369. (outline-flag-region
  20370. (max (point-min) (1- (point)))
  20371. (save-excursion
  20372. (if (re-search-forward
  20373. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  20374. (match-beginning 1)
  20375. (point-max)))
  20376. nil)
  20377. (org-cycle-hide-drawers 'children))
  20378. (error nil))))
  20379. (defun org-make-options-regexp (kwds &optional extra)
  20380. "Make a regular expression for keyword lines."
  20381. (concat
  20382. "^#\\+\\("
  20383. (mapconcat 'regexp-quote kwds "\\|")
  20384. (if extra (concat "\\|" extra))
  20385. "\\):[ \t]*\\(.*\\)"))
  20386. ;; Make isearch reveal the necessary context
  20387. (defun org-isearch-end ()
  20388. "Reveal context after isearch exits."
  20389. (when isearch-success ; only if search was successful
  20390. (if (featurep 'xemacs)
  20391. ;; Under XEmacs, the hook is run in the correct place,
  20392. ;; we directly show the context.
  20393. (org-show-context 'isearch)
  20394. ;; In Emacs the hook runs *before* restoring the overlays.
  20395. ;; So we have to use a one-time post-command-hook to do this.
  20396. ;; (Emacs 22 has a special variable, see function `org-mode')
  20397. (unless (and (boundp 'isearch-mode-end-hook-quit)
  20398. isearch-mode-end-hook-quit)
  20399. ;; Only when the isearch was not quitted.
  20400. (org-add-hook 'post-command-hook 'org-isearch-post-command
  20401. 'append 'local)))))
  20402. (defun org-isearch-post-command ()
  20403. "Remove self from hook, and show context."
  20404. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  20405. (org-show-context 'isearch))
  20406. ;;;; Integration with and fixes for other packages
  20407. ;;; Imenu support
  20408. (defvar org-imenu-markers nil
  20409. "All markers currently used by Imenu.")
  20410. (make-variable-buffer-local 'org-imenu-markers)
  20411. (defun org-imenu-new-marker (&optional pos)
  20412. "Return a new marker for use by Imenu, and remember the marker."
  20413. (let ((m (make-marker)))
  20414. (move-marker m (or pos (point)))
  20415. (push m org-imenu-markers)
  20416. m))
  20417. (defun org-imenu-get-tree ()
  20418. "Produce the index for Imenu."
  20419. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  20420. (setq org-imenu-markers nil)
  20421. (let* ((n org-imenu-depth)
  20422. (re (concat "^" (org-get-limited-outline-regexp)))
  20423. (subs (make-vector (1+ n) nil))
  20424. (last-level 0)
  20425. m level head)
  20426. (save-excursion
  20427. (save-restriction
  20428. (widen)
  20429. (goto-char (point-max))
  20430. (while (re-search-backward re nil t)
  20431. (setq level (org-reduced-level (funcall outline-level)))
  20432. (when (and (<= level n)
  20433. (looking-at org-complex-heading-regexp))
  20434. (setq head (org-link-display-format
  20435. (org-match-string-no-properties 4))
  20436. m (org-imenu-new-marker))
  20437. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  20438. (if (>= level last-level)
  20439. (push (cons head m) (aref subs level))
  20440. (push (cons head (aref subs (1+ level))) (aref subs level))
  20441. (loop for i from (1+ level) to n do (aset subs i nil)))
  20442. (setq last-level level)))))
  20443. (aref subs 1)))
  20444. (eval-after-load "imenu"
  20445. '(progn
  20446. (add-hook 'imenu-after-jump-hook
  20447. (lambda ()
  20448. (if (derived-mode-p 'org-mode)
  20449. (org-show-context 'org-goto))))))
  20450. (defun org-link-display-format (link)
  20451. "Replace a link with either the description, or the link target
  20452. if no description is present"
  20453. (save-match-data
  20454. (if (string-match org-bracket-link-analytic-regexp link)
  20455. (replace-match (if (match-end 5)
  20456. (match-string 5 link)
  20457. (concat (match-string 1 link)
  20458. (match-string 3 link)))
  20459. nil t link)
  20460. link)))
  20461. (defun org-toggle-link-display ()
  20462. "Toggle the literal or descriptive display of links."
  20463. (interactive)
  20464. (if org-descriptive-links
  20465. (progn (org-remove-from-invisibility-spec '(org-link))
  20466. (org-restart-font-lock)
  20467. (setq org-descriptive-links nil))
  20468. (progn (add-to-invisibility-spec '(org-link))
  20469. (org-restart-font-lock)
  20470. (setq org-descriptive-links t))))
  20471. ;; Speedbar support
  20472. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  20473. "Overlay marking the agenda restriction line in speedbar.")
  20474. (overlay-put org-speedbar-restriction-lock-overlay
  20475. 'face 'org-agenda-restriction-lock)
  20476. (overlay-put org-speedbar-restriction-lock-overlay
  20477. 'help-echo "Agendas are currently limited to this item.")
  20478. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  20479. (defun org-speedbar-set-agenda-restriction ()
  20480. "Restrict future agenda commands to the location at point in speedbar.
  20481. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  20482. (interactive)
  20483. (require 'org-agenda)
  20484. (let (p m tp np dir txt)
  20485. (cond
  20486. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20487. 'org-imenu t))
  20488. (setq m (get-text-property p 'org-imenu-marker))
  20489. (with-current-buffer (marker-buffer m)
  20490. (goto-char m)
  20491. (org-agenda-set-restriction-lock 'subtree)))
  20492. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  20493. 'speedbar-function 'speedbar-find-file))
  20494. (setq tp (previous-single-property-change
  20495. (1+ p) 'speedbar-function)
  20496. np (next-single-property-change
  20497. tp 'speedbar-function)
  20498. dir (speedbar-line-directory)
  20499. txt (buffer-substring-no-properties (or tp (point-min))
  20500. (or np (point-max))))
  20501. (with-current-buffer (find-file-noselect
  20502. (let ((default-directory dir))
  20503. (expand-file-name txt)))
  20504. (unless (derived-mode-p 'org-mode)
  20505. (error "Cannot restrict to non-Org-mode file"))
  20506. (org-agenda-set-restriction-lock 'file)))
  20507. (t (error "Don't know how to restrict Org-mode's agenda")))
  20508. (move-overlay org-speedbar-restriction-lock-overlay
  20509. (point-at-bol) (point-at-eol))
  20510. (setq current-prefix-arg nil)
  20511. (org-agenda-maybe-redo)))
  20512. (eval-after-load "speedbar"
  20513. '(progn
  20514. (speedbar-add-supported-extension ".org")
  20515. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  20516. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  20517. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  20518. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  20519. (add-hook 'speedbar-visiting-tag-hook
  20520. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  20521. ;;; Fixes and Hacks for problems with other packages
  20522. ;; Make flyspell not check words in links, to not mess up our keymap
  20523. (defun org-mode-flyspell-verify ()
  20524. "Don't let flyspell put overlays at active buttons, or on
  20525. {todo,all-time,additional-option-like}-keywords."
  20526. (let ((pos (max (1- (point)) (point-min)))
  20527. (word (thing-at-point 'word)))
  20528. (and (not (get-text-property pos 'keymap))
  20529. (not (get-text-property pos 'org-no-flyspell))
  20530. (not (member word org-todo-keywords-1))
  20531. (not (member word org-all-time-keywords))
  20532. (not (member word org-options-keywords))
  20533. (not (member word (mapcar 'car org-startup-options)))
  20534. (not (member word org-additional-option-like-keywords-for-flyspell)))))
  20535. (defun org-remove-flyspell-overlays-in (beg end)
  20536. "Remove flyspell overlays in region."
  20537. (and (org-bound-and-true-p flyspell-mode)
  20538. (fboundp 'flyspell-delete-region-overlays)
  20539. (flyspell-delete-region-overlays beg end))
  20540. (add-text-properties beg end '(org-no-flyspell t)))
  20541. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  20542. (eval-after-load "bookmark"
  20543. '(if (boundp 'bookmark-after-jump-hook)
  20544. ;; We can use the hook
  20545. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  20546. ;; Hook not available, use advice
  20547. (defadvice bookmark-jump (after org-make-visible activate)
  20548. "Make the position visible."
  20549. (org-bookmark-jump-unhide))))
  20550. ;; Make sure saveplace shows the location if it was hidden
  20551. (eval-after-load "saveplace"
  20552. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  20553. "Make the position visible."
  20554. (org-bookmark-jump-unhide)))
  20555. ;; Make sure ecb shows the location if it was hidden
  20556. (eval-after-load "ecb"
  20557. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  20558. "Make hierarchy visible when jumping into location from ECB tree buffer."
  20559. (if (derived-mode-p 'org-mode)
  20560. (org-show-context))))
  20561. (defun org-bookmark-jump-unhide ()
  20562. "Unhide the current position, to show the bookmark location."
  20563. (and (derived-mode-p 'org-mode)
  20564. (or (outline-invisible-p)
  20565. (save-excursion (goto-char (max (point-min) (1- (point))))
  20566. (outline-invisible-p)))
  20567. (org-show-context 'bookmark-jump)))
  20568. ;; Make session.el ignore our circular variable
  20569. (eval-after-load "session"
  20570. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  20571. ;;;; Experimental code
  20572. (defun org-closed-in-range ()
  20573. "Sparse tree of items closed in a certain time range.
  20574. Still experimental, may disappear in the future."
  20575. (interactive)
  20576. ;; Get the time interval from the user.
  20577. (let* ((time1 (org-float-time
  20578. (org-read-date nil 'to-time nil "Starting date: ")))
  20579. (time2 (org-float-time
  20580. (org-read-date nil 'to-time nil "End date:")))
  20581. ;; callback function
  20582. (callback (lambda ()
  20583. (let ((time
  20584. (org-float-time
  20585. (apply 'encode-time
  20586. (org-parse-time-string
  20587. (match-string 1))))))
  20588. ;; check if time in interval
  20589. (and (>= time time1) (<= time time2))))))
  20590. ;; make tree, check each match with the callback
  20591. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  20592. ;;;; Finish up
  20593. (provide 'org)
  20594. (run-hooks 'org-load-hook)
  20595. ;;; org.el ends here